base: Fix code spelling
[heimdal.git] / kdc / string2key.8
blob1b38d3322827a6fd47064525fbb1924769684a11
1 .\" Copyright (c) 2000 - 2002 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 March  4, 2000
35 .Dt STRING2KEY 8
36 .Os HEIMDAL
37 .Sh NAME
38 .Nm string2key
39 .Nd map a password into a key
40 .Sh SYNOPSIS
41 .Nm
42 .Op Fl 5 | Fl Fl version5
43 .Op Fl 4 | Fl Fl version4
44 .Op Fl a | Fl Fl afs
45 .Oo Fl c Ar cell \*(Ba Xo
46 .Fl Fl cell= Ns Ar cell
47 .Xc
48 .Oc
49 .Oo Fl w Ar password \*(Ba Xo
50 .Fl Fl password= Ns Ar password
51 .Xc
52 .Oc
53 .Oo Fl p Ar principal \*(Ba Xo
54 .Fl Fl principal= Ns Ar principal
55 .Xc
56 .Oc
57 .Oo Fl k Ar string \*(Ba Xo
58 .Fl Fl keytype= Ns Ar string
59 .Xc
60 .Oc
61 .Ar password
62 .Sh DESCRIPTION
63 .Nm
64 performs the string-to-key function.
65 This is useful when you want to handle the raw key instead of the password.
66 Supported options:
67 .Bl -tag -width Ds
68 .It Fl 5 , Fl Fl version5
69 Output Kerberos v5 string-to-key
70 .It Fl 4 , Fl Fl version4
71 Output Kerberos v4 string-to-key
72 .It Fl a , Fl Fl afs
73 Output AFS string-to-key
74 .It Fl c Ar cell , Fl Fl cell= Ns Ar cell
75 AFS cell to use
76 .It Fl w Ar password , Fl Fl password= Ns Ar password
77 Password to use
78 .It Fl p Ar principal , Fl Fl principal= Ns Ar principal
79 Kerberos v5 principal to use
80 .It Fl k Ar string , Fl Fl keytype= Ns Ar string
81 Keytype
82 .It Fl Fl version
83 print version
84 .It Fl Fl help
85 .El