switch to calloc() so that NULL compare works below
[heimdal.git] / kuser / kdigest.8
blobdd882efd02660b7fd2733db71ca3cf3ba24088e2
1 .\" Copyright (c) 2008 Kungliga Tekniska Högskolan
2 .\" (Royal Institute of Technology, Stockholm, Sweden). 
3 .\" All rights reserved. 
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without 
6 .\" modification, are permitted provided that the following conditions 
7 .\" are met: 
8 .\"
9 .\" 1. Redistributions of source code must retain the above copyright 
10 .\"    notice, this list of conditions and the following disclaimer. 
11 .\"
12 .\" 2. Redistributions in binary form must reproduce the above copyright 
13 .\"    notice, this list of conditions and the following disclaimer in the 
14 .\"    documentation and/or other materials provided with the distribution. 
15 .\"
16 .\" 3. Neither the name of the Institute nor the names of its contributors 
17 .\"    may be used to endorse or promote products derived from this software 
18 .\"    without specific prior written permission. 
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND 
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE 
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
30 .\" SUCH DAMAGE. 
31 .\" 
32 .\" $Id$
33 .\"
34 .Dd September 25, 2008
35 .Dt KDIGEST 8
36 .Os HEIMDAL
37 .Sh NAME
38 .Nm kdigest
39 .Nd
40 userland tool to access digest interface in the KDC
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl -ccache= Ns Ar string
44 .Op Fl -version
45 .Op Fl -help
46 command
47 .Op arguments
48 .Sh DESCRIPTION
49 Supported options:
50 .Bl -tag -width Ds
51 .It Xo
52 .Fl -ccache= Ns Ar string
53 .Xc
54 credential cache
55 .It Xo
56 .Fl -version
57 .Xc
58 print version
59 .It Xo
60 .Fl -help
61 .Xc
62 .El
63 .Pp
64 Available commands are:
65 .Bl -tag -width Ds
66 .It Xo digest-probe
67 .Op Fl -realm= Ns Ar string
68 .Op Fl h | Fl -help
69 .Xc
70 .Bl -tag -width Ds
71 .It Xo
72 .Fl -realm= Ns Ar string
73 .Xc
74 Kerberos realm to communicate with
75 .El
76 .It Xo digest-server-init
77 .Op Fl -type= Ns Ar string
78 .Op Fl -kerberos-realm= Ns Ar realm
79 .Op Fl -digest= Ns Ar digest-type
80 .Op Fl -cb-type= Ns Ar type
81 .Op Fl -cb-value= Ns Ar value
82 .Op Fl -hostname= Ns Ar hostname
83 .Op Fl -realm= Ns Ar string
84 .Xc
85 .Bl -tag -width Ds
86 .It Xo
87 .Fl -type= Ns Ar string
88 .Xc
89 digest type
90 .It Xo
91 .Fl -kerberos-realm= Ns Ar realm
92 .Xc
93 .It Xo
94 .Fl -digest= Ns Ar digest-type
95 .Xc
96 digest type to use in the algorithm
97 .It Xo
98 .Fl -cb-type= Ns Ar type
99 .Xc
100 type of channel bindings
101 .It Xo
102 .Fl -cb-value= Ns Ar value
104 value of channel bindings
105 .It Xo
106 .Fl -hostname= Ns Ar hostname
108 hostname of the server
109 .It Xo
110 .Fl -realm= Ns Ar string
112 Kerberos realm to communicate with
114 .It Xo digest-server-request
115 .Op Fl -type= Ns Ar string
116 .Op Fl -kerberos-realm= Ns Ar realm
117 .Op Fl -username= Ns Ar name
118 .Op Fl -server-nonce= Ns Ar nonce
119 .Op Fl -server-identifier= Ns Ar nonce
120 .Op Fl -client-nonce= Ns Ar nonce
121 .Op Fl -client-response= Ns Ar response
122 .Op Fl -opaque= Ns Ar string
123 .Op Fl -authentication-name= Ns Ar name
124 .Op Fl -realm= Ns Ar realm
125 .Op Fl -method= Ns Ar method
126 .Op Fl -uri= Ns Ar uri
127 .Op Fl -nounce-count= Ns Ar count
128 .Op Fl -qop= Ns Ar qop
129 .Op Fl -ccache= Ns Ar ccache
131 .Bl -tag -width Ds
132 .It Xo
133 .Fl -type= Ns Ar string
135 digest type
136 .It Xo
137 .Fl -kerberos-realm= Ns Ar realm
139 .It Xo
140 .Fl -username= Ns Ar name
142 digest type
143 .It Xo
144 .Fl -server-nonce= Ns Ar nonce
146 .It Xo
147 .Fl -server-identifier= Ns Ar nonce
149 .It Xo
150 .Fl -client-nonce= Ns Ar nonce
152 .It Xo
153 .Fl -client-response= Ns Ar response
155 .It Xo
156 .Fl -opaque= Ns Ar string
158 .It Xo
159 .Fl -authentication-name= Ns Ar name
161 .It Xo
162 .Fl -realm= Ns Ar realm
164 .It Xo
165 .Fl -method= Ns Ar method
167 .It Xo
168 .Fl -uri= Ns Ar uri
170 .It Xo
171 .Fl -nounce-count= Ns Ar count
173 .It Xo
174 .Fl -qop= Ns Ar qop
176 .It Xo
177 .Fl -ccache= Ns Ar ccache
179 Where the the credential cache is created when the KDC returns tickets
181 .It Xo digest-client-request
182 .Op Fl -type= Ns Ar string
183 .Op Fl -username= Ns Ar name
184 .Op Fl -password= Ns Ar password
185 .Op Fl -server-nonce= Ns Ar nonce
186 .Op Fl -server-identifier= Ns Ar nonce
187 .Op Fl -client-nonce= Ns Ar nonce
188 .Op Fl -opaque= Ns Ar string
189 .Op Fl -realm= Ns Ar realm
190 .Op Fl -method= Ns Ar method
191 .Op Fl -uri= Ns Ar uri
192 .Op Fl -nounce-count= Ns Ar count
193 .Op Fl -qop= Ns Ar qop
195 .Bl -tag -width Ds
196 .It Xo
197 .Fl -type= Ns Ar string
199 digest type
200 .It Xo
201 .Fl -username= Ns Ar name
203 digest type
204 .It Xo
205 .Fl -password= Ns Ar password
207 .It Xo
208 .Fl -server-nonce= Ns Ar nonce
210 .It Xo
211 .Fl -server-identifier= Ns Ar nonce
213 .It Xo
214 .Fl -client-nonce= Ns Ar nonce
216 .It Xo
217 .Fl -opaque= Ns Ar string
219 .It Xo
220 .Fl -realm= Ns Ar realm
222 .It Xo
223 .Fl -method= Ns Ar method
225 .It Xo
226 .Fl -uri= Ns Ar uri
228 .It Xo
229 .Fl -nounce-count= Ns Ar count
231 .It Xo
232 .Fl -qop= Ns Ar qop
235 .It Xo ntlm-server-init
236 .Op Fl -version= Ns Ar integer
237 .Op Fl -kerberos-realm= Ns Ar string
239 .Bl -tag -width Ds
240 .It Xo
241 .Fl -version= Ns Ar integer
243 ntlm version
244 .It Xo
245 .Fl -kerberos-realm= Ns Ar string
247 Kerberos realm to communicate with
249 .\".Sh ENVIRONMENT
250 .\".Sh FILES
251 .\".Sh EXAMPLES
252 .\".Sh DIAGNOSTICS
253 .\".Sh SEE ALSO
254 .\".Sh STANDARDS
255 .\".Sh HISTORY
256 .\".Sh AUTHORS
257 .\".Sh BUGS