Patrick Welche <prlw1@cam.ac.uk>
[netbsd-mini2440.git] / crypto / dist / heimdal / kdc / string2key.8
blob688dccb52ea8938d5759fb2caee82be4853fad55
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 .\" $Heimdal: string2key.8 11648 2003-02-16 21:10:32Z lha $
33 .\" $NetBSD: string2key.8,v 1.7 2008/03/22 08:37:03 mlelstv Exp $
34 .\"
35 .Dd March  4, 2000
36 .Dt STRING2KEY 8
37 .Os
38 .Sh NAME
39 .Nm string2key
40 .Nd map a password into a key
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl 5 | Fl -version5
44 .Op Fl 4 | Fl -version4
45 .Op Fl a | Fl -afs
46 .Oo Fl c Ar cell \*(Ba Xo
47 .Fl -cell= Ns Ar cell
48 .Xc
49 .Oc
50 .Oo Fl w Ar password \*(Ba Xo
51 .Fl -password= Ns Ar password
52 .Xc
53 .Oc
54 .Oo Fl p Ar principal \*(Ba Xo
55 .Fl -principal= Ns Ar principal
56 .Xc
57 .Oc
58 .Oo Fl k Ar string \*(Ba Xo
59 .Fl -keytype= Ns Ar string
60 .Xc
61 .Oc
62 .Ar password
63 .Sh DESCRIPTION
64 .Nm
65 performs the string-to-key function.
66 This is useful when you want to handle the raw key instead of the password.
67 Supported options:
68 .Bl -tag -width Ds
69 .It Fl 5 , Fl -version5
70 Output Kerberos v5 string-to-key
71 .It Fl 4 , Fl -version4
72 Output Kerberos v4 string-to-key
73 .It Fl a , Fl -afs
74 Output AFS string-to-key
75 .It Fl c Ar cell , Fl -cell= Ns Ar cell
76 AFS cell to use
77 .It Fl w Ar password , Fl -password= Ns Ar password
78 Password to use
79 .It Fl p Ar principal , Fl -principal= Ns Ar principal
80 Kerberos v5 principal to use
81 .It Fl k Ar string , Fl -keytype= Ns Ar string
82 Keytype
83 .It Fl -version
84 print version
85 .It Fl -help
86 .El