crypto/dist/heimdal/kdc/kstash.8

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