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