xref: /freebsd/crypto/heimdal/kdc/kstash.8 (revision 9a14aa017b21c292740c00ee098195cd46642730)
1.\" Copyright (c) 1997 - 2004 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: kstash.8 20316 2007-04-11 11:53:20Z lha $
33.\"
34.Dd April 10, 2007
35.Dt KSTASH 8
36.Os HEIMDAL
37.Sh NAME
38.Nm kstash
39.Nd "store the KDC master password in a file"
40.Sh SYNOPSIS
41.Nm
42.Bk -words
43.Oo Fl e Ar string \*(Ba Xo
44.Fl -enctype= Ns Ar string
45.Xc
46.Oc
47.Oo Fl k Ar file \*(Ba Xo
48.Fl -key-file= Ns Ar file
49.Xc
50.Oc
51.Op Fl -convert-file
52.Op Fl -random-key
53.Op Fl -master-key-fd= Ns Ar fd
54.Op Fl -random-key
55.Op Fl h | Fl -help
56.Op Fl -version
57.Ek
58.Sh DESCRIPTION
59.Nm
60reads the Kerberos master key and stores it in a file that will be
61used by the KDC.
62.Pp
63Supported options:
64.Bl -tag -width Ds
65.It Xo
66.Fl e Ar string ,
67.Fl -enctype= Ns Ar string
68.Xc
69the encryption type to use, defaults to DES3-CBC-SHA1.
70.It Xo
71.Fl k Ar file ,
72.Fl -key-file= Ns Ar file
73.Xc
74the name of the master key file.
75.It Xo
76.Fl -convert-file
77.Xc
78don't ask for a new master key, just read an old master key file, and
79write it back in the new keyfile format.
80.It Xo
81.Fl -random-key
82.Xc
83generate a random master key.
84.It Xo
85.Fl -master-key-fd= Ns Ar fd
86.Xc
87filedescriptor to read passphrase from, if not specified the
88passphrase will be read from the terminal.
89.El
90.\".Sh ENVIRONMENT
91.Sh FILES
92.Pa /var/heimdal/m-key
93is the default keyfile if no other keyfile is specified.
94The format of a Heimdal master key is the same as a keytab, so
95.Nm ktutil
96list can be used to list the content of the file.
97.\".Sh EXAMPLES
98.\".Sh DIAGNOSTICS
99.Sh SEE ALSO
100.Xr kdc 8
101.\".Sh STANDARDS
102.\".Sh HISTORY
103.\".Sh AUTHORS
104.\".Sh BUGS
105