xref: /freebsd/crypto/heimdal/kdc/string2key.8 (revision f0adf7f5cdd241db2f2c817683191a6ef64a4e95)
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: string2key.8,v 1.6 2003/02/16 21:10:21 lha Exp $
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 -version5
43.Op Fl 4 | Fl -version4
44.Op Fl a | Fl -afs
45.Oo Fl c Ar cell \*(Ba Xo
46.Fl -cell= Ns Ar cell
47.Xc
48.Oc
49.Oo Fl w Ar password \*(Ba Xo
50.Fl -password= Ns Ar password
51.Xc
52.Oc
53.Oo Fl p Ar principal \*(Ba Xo
54.Fl -principal= Ns Ar principal
55.Xc
56.Oc
57.Oo Fl k Ar string \*(Ba Xo
58.Fl -keytype= Ns Ar string
59.Xc
60.Oc
61.Ar password
62.Sh DESCRIPTION
63.Nm
64performs the string-to-key function.
65This is useful when you want to handle the raw key instead of the password.
66Supported options:
67.Bl -tag -width Ds
68.It Xo
69.Fl 5 ,
70.Fl -version5
71.Xc
72Output Kerberos v5 string-to-key
73.It Xo
74.Fl 4 ,
75.Fl -version4
76.Xc
77Output Kerberos v4 string-to-key
78.It Xo
79.Fl a ,
80.Fl -afs
81.Xc
82Output AFS string-to-key
83.It Xo
84.Fl c Ar cell ,
85.Fl -cell= Ns Ar cell
86.Xc
87AFS cell to use
88.It Xo
89.Fl w Ar password ,
90.Fl -password= Ns Ar password
91.Xc
92Password to use
93.It Xo
94.Fl p Ar principal ,
95.Fl -principal= Ns Ar principal
96.Xc
97Kerberos v5 principal to use
98.It Xo
99.Fl k Ar string ,
100.Fl -keytype= Ns Ar string
101.Xc
102Keytype
103.It Xo
104.Fl -version
105.Xc
106print version
107.It Xo
108.Fl -help
109.Xc
110.El
111