heimdal: Fix the 32-bit build on FreeBSD
[heimdal.git] / kuser / heimtools-commands.in
blobea8b073f6edf8f8020b74001ed07358ec6fca551
1 /*
2  * Copyright (c) 2010 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  */
34 command = {
35         name = "klist"
36         name = "list"
37         help = "List kerberos tickets"
38         option = {
39                 long = "cache"
40                 short = "c"
41                 type = "string"
42                 help = "credential cache to list"
43         }
44         option = {
45                 name = "flags"
46                 short = "f"
47                 type = "flag"
48                 help = "list flags"
49         }
50         option = {
51                 long = "test"
52                 short = "t"
53                 type = "flag"
54                 help = "test for having tickets"
55         }
56         option = {
57                 name = "s"
58                 short = "s"
59                 type = "flag"
60         }
61         option = {
62                 long = "tokens"
63                 short = "T"
64                 type = "flag"
65                 help = "display AFS tokens"
66         }
67         option = {
68                 long = "v5"
69                 short = "5"
70                 type = "flag"
71                 default = "1"
72                 help = "display v5 credential tokens"
73         }
74         option = {
75                 long = "all-content"
76                 short = "A"
77                 type = "flag"
78                 help = "List all caches with their content"
79         }
80         option = {
81                 long = "list-all"
82                 short = "l"
83                 type = "flag"
84                 help = "List all caches"
85         }
86         option = {
87                 long = "json"
88                 type = "flag"
89                 help = "JSON formated output"
90         }
91         option = {
92                 long = "verbose"
93                 short = "v"
94                 type = "flag"
95                 help = "Verbose output"
96         }
97         option = {
98                 long = "version"
99                 type = "flag"
100                 help = "version"
101         }
102         option = {
103                 name = "a"
104                 short = "a"
105                 type = "flag"
106         }
107         option = {
108                 name = "n"
109                 short = "n"
110                 type = "flag"
111         }
112         option = {
113                 long = "hidden"
114                 type = "flag"
115                 help = "Verbose output"
116         }
118 command = {
119         name = "kgetcred"
120         help = "Acquire a Kerberos ticket"
121         option = {
122                long = "enctype"
123                short = "e"
124                type = "string"
125                argument = "enctype"
126                help = "Encryption type to use"
127         }
128         option = {
129                long = "cache"
130                short = "c"
131                type = "string"
132                argument = "cachename"
133                help = "Credentials cache"
134         }
136 command = {
137         name = "kswitch"
138         name = "switch"
139         help = "Switch default kerberos cache"
140         option = {
141                 long = "type"
142                 short = "t"
143                 type = "string"
144                 help = "type of credential cache"
145         }
146         option = {
147                 long = "cache"
148                 short = "c"
149                 type = "string"
150                 help = "name of credential cache"
151         }
152         option = {
153                 long = "principal"
154                 short = "p"
155                 type = "string"
156                 help = "name of principal"
157         }
158         option = {
159                 long = "interactive"
160                 short = "i"
161                 type = "flag"
162                 help = "interactive selection"
163         }
165 command = {
166         name = "kvno"
167         help = "Acquire a Kerberos ticket"
168         option = {
169                long = "enctype"
170                short = "e"
171                type = "string"
172                argument = "enctype"
173                help = "Encryption type to use"
174         }
175         option = {
176                long = "cache"
177                short = "c"
178                type = "string"
179                argument = "cachename"
180                help = "Credentials cache"
181         }
182         option = {
183                long = "keytab"
184                short = "k"
185                type = "string"
186                argument = "keytabname"
187                help = "Keytab to use"
188         }
189         option = {
190                long = "server"
191                short = "S"
192                type = "string"
193                argument = "principal"
194                help = "Server to get ticket for"
195         }
196         option = {
197                long = "quiet"
198                short = "q"
199                type = "flag"
200                help = "Quiet"
201         }
203 command = {
204         name = "copy_cred_cache"
205         option = {
206                long = "krbtgt-only"
207                type = "flag"
208                help = "only copy local krbtgt"
209         }
210         option = {
211                long = "service"
212                type = "string"
213                help = "limit to this service"
214                argument = "service"
215         }
216         option = {
217                long = "enctype"
218                type = "string"
219                help = "limit to this enctype"
220                argument = "enctype"
221         }
222         option = {
223                long = "flags"
224                type = "string"
225                help = "limit to these flags"
226         }
227         option = {
228                long = "valid-for"
229                type = "string"
230                help = "limit to creds valid for at least this long"
231                argument =  "time"
232         }
233         option = {
234                long = "fcache-version"
235                type = "integer"
236                help = "file cache version to create"
237         }
238         min_args = "1"
239         max_args = "2"
240         help = "Copies credential caches"
241         argument = "[source] destination"
243 command = {
244         name = "kx509"
245         help = "Acquire or extract certificates"
246         option = {
247                 long = "cache"
248                 short = "c"
249                 type = "string"
250                 help = "Kerberos credential cache"
251         }
252         option = {
253                 long = "save"
254                 short = "s"
255                 type = "flag"
256                 help = "save the certificate and private key in the Kerberos credential cache"
257         }
258         option = {
259                 long = "out"
260                 short = "o"
261                 type = "string"
262                 help = "hx509 store for kx509 certificate and private key"
263         }
264         option = {
265                 long = "extract"
266                 short = "x"
267                 type = "flag"
268                 help = "extract certificate and private key from credential cache"
269         }
270         option = {
271                 long = "test"
272                 short = "t"
273                 type = "integer"
274                 help = "check for certificate with at least given time left"
275         }
276         option = {
277                 name = "private-key"
278                 short = "K"
279                 type = "string"
280                 help = "hx509 store containing private key"
281         }
282         option = {
283                 name = "csr"
284                 short = "C"
285                 type = "string"
286                 help = "file containing DER-encoded PKCS#10 certificate request"
287         }
288         option = {
289                 name = "realm"
290                 short = "r"
291                 type = "string"
292                 help = "realm from which to acquire certificate"
293         }
294         min_args = "0"
295         max_args = "0"
297 command = {
298         name = "help"
299         name = "?"
300         argument = "[command]"
301         min_args = "0"
302         max_args = "1"
303         help = "Help! I need somebody."