Merge from vendor branch OPENSSH:
[dragonfly.git] / crypto / heimdal / kdc / string2key.8
1 .\" $Id: string2key.8,v 1.5 2002/08/20 16:37:16 joda Exp $
2 .\"
3 .Dd March  4, 2000
4 .Dt STRING2KEY 8
5 .Os HEIMDAL
6 .Sh NAME
7 .Nm string2key
8 .Nd map a password into a key
9 .Sh SYNOPSIS
10 .Nm
11 .Op Fl 5 | Fl -version5
12 .Op Fl 4 | Fl -version4
13 .Op Fl a | Fl -afs
14 .Oo Fl c Ar cell \*(Ba Xo
15 .Fl -cell= Ns Ar cell
16 .Xc
17 .Oc
18 .Oo Fl w Ar password \*(Ba Xo
19 .Fl -password= Ns Ar password
20 .Xc
21 .Oc
22 .Oo Fl p Ar principal \*(Ba Xo
23 .Fl -principal= Ns Ar principal
24 .Xc
25 .Oc
26 .Oo Fl k Ar string \*(Ba Xo
27 .Fl -keytype= Ns Ar string
28 .Xc
29 .Oc
30 .Ar password
31 .Sh DESCRIPTION
32 .Nm
33 performs the string-to-key function.
34 This is useful when you want to handle the raw key instead of the password.
35 Supported options:
36 .Bl -tag -width Ds
37 .It Xo
38 .Fl 5 ,
39 .Fl -version5
40 .Xc
41 Output Kerberos v5 string-to-key
42 .It Xo
43 .Fl 4 ,
44 .Fl -version4
45 .Xc
46 Output Kerberos v4 string-to-key
47 .It Xo
48 .Fl a ,
49 .Fl -afs
50 .Xc
51 Output AFS string-to-key
52 .It Xo
53 .Fl c Ar cell ,
54 .Fl -cell= Ns Ar cell
55 .Xc
56 AFS cell to use
57 .It Xo
58 .Fl w Ar password ,
59 .Fl -password= Ns Ar password
60 .Xc
61 Password to use
62 .It Xo
63 .Fl p Ar principal ,
64 .Fl -principal= Ns Ar principal
65 .Xc
66 Kerberos v5 principal to use
67 .It Xo
68 .Fl k Ar string ,
69 .Fl -keytype= Ns Ar string
70 .Xc
71 Keytype
72 .It Xo
73 .Fl -version
74 .Xc
75 print version
76 .It Xo
77 .Fl -help
78 .Xc
79 .El