Fixes https://github.com/heimdal/heimdal/issues/294
[heimdal.git] / kuser / kdigest.8
blob6b633c3f53ddf092a0b93e788089c0858164f5da
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 userland tool to access digest interface in the KDC
40 .Sh SYNOPSIS
41 .Nm
42 .Op Fl Fl ccache= Ns Ar string
43 .Op Fl Fl version
44 .Op Fl Fl help
45 command
46 .Op arguments
47 .Sh DESCRIPTION
48 Supported options:
49 .Bl -tag -width Ds
50 .It Xo
51 .Fl Fl ccache= Ns Ar string
52 .Xc
53 credential cache
54 .It Xo
55 .Fl Fl version
56 .Xc
57 print version
58 .It Xo
59 .Fl Fl help
60 .Xc
61 .El
62 .Pp
63 Available commands are:
64 .Bl -tag -width Ds
65 .It Xo digest-probe
66 .Op Fl Fl realm= Ns Ar string
67 .Op Fl h | Fl Fl help
68 .Xc
69 .Bl -tag -width Ds
70 .It Xo
71 .Fl Fl realm= Ns Ar string
72 .Xc
73 Kerberos realm to communicate with
74 .El
75 .It Xo digest-server-init
76 .Op Fl Fl type= Ns Ar string
77 .Op Fl Fl kerberos-realm= Ns Ar realm
78 .Op Fl Fl digest= Ns Ar digest-type
79 .Op Fl Fl cb-type= Ns Ar type
80 .Op Fl Fl cb-value= Ns Ar value
81 .Op Fl Fl hostname= Ns Ar hostname
82 .Op Fl Fl realm= Ns Ar string
83 .Xc
84 .Bl -tag -width Ds
85 .It Xo
86 .Fl Fl type= Ns Ar string
87 .Xc
88 digest type
89 .It Xo
90 .Fl Fl kerberos-realm= Ns Ar realm
91 .Xc
92 .It Xo
93 .Fl Fl digest= Ns Ar digest-type
94 .Xc
95 digest type to use in the algorithm
96 .It Xo
97 .Fl Fl cb-type= Ns Ar type
98 .Xc
99 type of channel bindings
100 .It Xo
101 .Fl Fl cb-value= Ns Ar value
103 value of channel bindings
104 .It Xo
105 .Fl Fl hostname= Ns Ar hostname
107 hostname of the server
108 .It Xo
109 .Fl Fl realm= Ns Ar string
111 Kerberos realm to communicate with
113 .It Xo digest-server-request
114 .Op Fl Fl type= Ns Ar string
115 .Op Fl Fl kerberos-realm= Ns Ar realm
116 .Op Fl Fl username= Ns Ar name
117 .Op Fl Fl server-nonce= Ns Ar nonce
118 .Op Fl Fl server-identifier= Ns Ar nonce
119 .Op Fl Fl client-nonce= Ns Ar nonce
120 .Op Fl Fl client-response= Ns Ar response
121 .Op Fl Fl opaque= Ns Ar string
122 .Op Fl Fl authentication-name= Ns Ar name
123 .Op Fl Fl realm= Ns Ar realm
124 .Op Fl Fl method= Ns Ar method
125 .Op Fl Fl uri= Ns Ar uri
126 .Op Fl Fl nounce-count= Ns Ar count
127 .Op Fl Fl qop= Ns Ar qop
128 .Op Fl Fl ccache= Ns Ar ccache
130 .Bl -tag -width Ds
131 .It Xo
132 .Fl Fl type= Ns Ar string
134 digest type
135 .It Xo
136 .Fl Fl kerberos-realm= Ns Ar realm
138 .It Xo
139 .Fl Fl username= Ns Ar name
141 digest type
142 .It Xo
143 .Fl Fl server-nonce= Ns Ar nonce
145 .It Xo
146 .Fl Fl server-identifier= Ns Ar nonce
148 .It Xo
149 .Fl Fl client-nonce= Ns Ar nonce
151 .It Xo
152 .Fl Fl client-response= Ns Ar response
154 .It Xo
155 .Fl Fl opaque= Ns Ar string
157 .It Xo
158 .Fl Fl authentication-name= Ns Ar name
160 .It Xo
161 .Fl Fl realm= Ns Ar realm
163 .It Xo
164 .Fl Fl method= Ns Ar method
166 .It Xo
167 .Fl Fl uri= Ns Ar uri
169 .It Xo
170 .Fl Fl nounce-count= Ns Ar count
172 .It Xo
173 .Fl Fl qop= Ns Ar qop
175 .It Xo
176 .Fl Fl ccache= Ns Ar ccache
178 Where the the credential cache is created when the KDC returns tickets
180 .It Xo digest-client-request
181 .Op Fl Fl type= Ns Ar string
182 .Op Fl Fl username= Ns Ar name
183 .Op Fl Fl password= Ns Ar password
184 .Op Fl Fl server-nonce= Ns Ar nonce
185 .Op Fl Fl server-identifier= Ns Ar nonce
186 .Op Fl Fl client-nonce= Ns Ar nonce
187 .Op Fl Fl opaque= Ns Ar string
188 .Op Fl Fl realm= Ns Ar realm
189 .Op Fl Fl method= Ns Ar method
190 .Op Fl Fl uri= Ns Ar uri
191 .Op Fl Fl nounce-count= Ns Ar count
192 .Op Fl Fl qop= Ns Ar qop
194 .Bl -tag -width Ds
195 .It Xo
196 .Fl Fl type= Ns Ar string
198 digest type
199 .It Xo
200 .Fl Fl username= Ns Ar name
202 digest type
203 .It Xo
204 .Fl Fl password= Ns Ar password
206 .It Xo
207 .Fl Fl server-nonce= Ns Ar nonce
209 .It Xo
210 .Fl Fl server-identifier= Ns Ar nonce
212 .It Xo
213 .Fl Fl client-nonce= Ns Ar nonce
215 .It Xo
216 .Fl Fl opaque= Ns Ar string
218 .It Xo
219 .Fl Fl realm= Ns Ar realm
221 .It Xo
222 .Fl Fl method= Ns Ar method
224 .It Xo
225 .Fl Fl uri= Ns Ar uri
227 .It Xo
228 .Fl Fl nounce-count= Ns Ar count
230 .It Xo
231 .Fl Fl qop= Ns Ar qop
234 .It Xo ntlm-server-init
235 .Op Fl Fl version= Ns Ar integer
236 .Op Fl Fl kerberos-realm= Ns Ar string
238 .Bl -tag -width Ds
239 .It Xo
240 .Fl Fl version= Ns Ar integer
242 ntlm version
243 .It Xo
244 .Fl Fl kerberos-realm= Ns Ar string
246 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