crypto/dist/heimdal/admin/ktutil-commands.in

   1 /*
   2  * Copyright (c) 2004 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33 /* $Heimdal: ktutil-commands.in 14793 2005-04-14 16:45:14Z lha $
  34    $NetBSD$ */
  35
  36 command = {
  37         name = "add"
  38         option = {
  39                 long = "principal"
  40                 short = "p"
  41                 type = "string"
  42                 help = "principal to add"
  43                 argument = "principal"
  44                 default = ""
  45         }
  46         option = {
  47                 long = "kvno"
  48                 short = "V"
  49                 type = "integer"
  50                 help = "key version number"
  51                 default = "-1"
  52         }
  53         option = {
  54                 long = "enctype"
  55                 short = "e"
  56                 type = "string"
  57                 argument = "enctype"
  58                 help = "encryption type"
  59         }
  60         option = {
  61                 long = "password"
  62                 short = "w"
  63                 type = "string"
  64                 help = "password for key"
  65         }
  66         option = {
  67                 long = "salt"
  68                 short = "s"
  69                 type = "-flag"
  70                 help = "use unsalted keys"
  71                 default = "1"
  72         }
  73         option = {
  74                 long = "random"
  75                 short = "r"
  76                 type = "flag"
  77                 help = "generate random key"
  78         }
  79         option = {
  80                 long = "hex"
  81                 short = "H"
  82                 type = "flag"
  83                 help = "password is a hexadecimal string"
  84         }
  85         function = "kt_add"
  86         help = "Adds a key to a keytab."
  87         max_args = "0"
  88 }
  89 command = {
  90         name = "change"
  91         option = {
  92                 long = "realm"
  93                 short = "r"
  94                 type = "string"
  95                 argument = "realm"
  96                 help = "realm to use"
  97         }
  98         option = {
  99                 long = "admin-server"
 100                 short = "a"
 101                 type = "string"
 102                 argument = "host"
 103                 help = "server to contact"
 104         }
 105         option = {
 106                 long = "server-port"
 107                 short = "s"
 108                 type = "integer"
 109                 argument = "port number"
 110                 help = "port number on server"
 111         }
 112         function = "kt_change"
 113         argument = "[principal...]"
 114         help = "Change keys for specified principals (default all)."
 115 }
 116 command = {
 117         name = "copy"
 118         function = "kt_copy"
 119         argument = "source destination"
 120         min_args = "2"
 121         max_args = "2"
 122         help = "Copies one keytab to another."
 123 }
 124 command = {
 125         name = "get"
 126         option = {
 127                 long = "principal"
 128                 short = "p"
 129                 type = "string"
 130                 help = "admin principal"
 131                 argument = "principal"
 132         }
 133         option = {
 134                 long = "enctypes"
 135                 short = "e"
 136                 type = "strings"
 137                 help = "encryption types to use"
 138                 argument = "enctype"
 139         }
 140         option = {
 141                 long = "realm"
 142                 short = "r"
 143                 type = "string"
 144                 argument = "realm"
 145                 help = "realm to use"
 146         }
 147         option = {
 148                 long = "admin-server"
 149                 short = "a"
 150                 type = "string"
 151                 argument = "host"
 152                 help = "server to contact"
 153         }
 154         option = {
 155                 long = "server-port"
 156                 short = "s"
 157                 type = "integer"
 158                 argument = "port number"
 159                 help = "port number on server"
 160         }
 161         function = "kt_get"
 162         min_args = "1"
 163         argument = "principal..."
 164         help = "Change keys for specified principals, and add them to the keytab."
 165 }
 166 command = {
 167         name = "list"
 168         option = {
 169                 long = "keys"
 170                 type = "flag"
 171                 help = "show key values"
 172         }
 173         option = {
 174                 long = "timestamp"
 175                 type = "flag"
 176                 help = "show timestamps"
 177         }
 178         max_args = "0"
 179         function = "kt_list"
 180         help = "Show contents of keytab."
 181 }
 182 command = {
 183         name = "purge"
 184         option = {
 185                 long = "age"
 186                 type = "string"
 187                 help = "age to retiere"
 188                 default = "1 week";
 189                 argument = "time"
 190         }
 191         max_args = "0"
 192         function = "kt_purge"
 193         help = "Remove superceded keys from keytab."
 194 }
 195 command = {
 196         name = "remove"
 197         name = "delete"
 198         option = {
 199                 long = "principal"
 200                 short = "p"
 201                 type = "string"
 202                 help = "principal to remove"
 203                 argument = "principal"
 204         }
 205         option = {
 206                 long = "kvno"
 207                 short = "V"
 208                 type = "integer"
 209                 help = "key version to remove"
 210                 argument = "enctype"
 211                 default = "0"
 212         }
 213         option = {
 214                 long = "enctype"
 215                 short = "e"
 216                 type = "string"
 217                 help = "enctype to remove"
 218                 argument = "enctype"
 219         }
 220         max_args = "0"
 221         function = "kt_remove"
 222         help = "Remove keys from keytab."
 223 }
 224 command = {
 225         name = "rename"
 226         function = "kt_rename"
 227         argument = "from to"
 228         min_args = "2"
 229         max_args = "2"
 230         help = "Renames an entry in the keytab."
 231 }
 232 command = {
 233         name = "srvconvert"
 234         name = "srv2keytab"
 235         option = {
 236                 long = "srvtab"
 237                 short = "s"
 238                 type = "string"
 239                 argument = "file"
 240                 help = "name of Kerberos 4 srvtab"
 241                 default = "/etc/srvtab"
 242         }
 243         max_args = "0"
 244         function = "srvconv"
 245         help = "Convert a Kerberos 4 srvtab to a keytab."
 246 }
 247 command = {
 248         name = "srvcreate"
 249         name = "key2srvtab"
 250         option = {
 251                 long = "srvtab"
 252                 short = "s"
 253                 type = "string"
 254                 argument = "file"
 255                 help = "name of Kerberos 4 srvtab"
 256                 default = "/etc/srvtab"
 257         }
 258         max_args = "0"
 259         function = "srvcreate"
 260         help = "Convert a keytab to a Kerberos 4 srvtab."
 261 }
 262 command = {
 263         name = "help"
 264         argument = "command"
 265         max_args = "1"
 266         function = "help"
 267 }