crypto/kerberosIV/man/ksrvutil.8

   1 .\" $Id: ksrvutil.8,v 1.3 1996/06/12 21:29:27 bg Exp $
   2 .\" $FreeBSD: src/crypto/kerberosIV/man/ksrvutil.8,v 1.3.2.1 2001/05/08 15:08:10 assar Exp $
   3 .\" Copyright 1989 by the Massachusetts Institute of Technology.
   4 .\"
   5 .\" For copying and distribution information,
   6 .\" please see the file <mit-copyright.h>.
   7 .\"
   8 .Dd May 4, 1996
   9 .Dt KSRVUTIL 8
  10 .Os KTH-KRB
  11 .Sh NAME
  12 .Nm ksrvutil
  13 .Nd "host kerberos keyfile (srvtab) manipulation utility"
  14 .Sh SYNOPSIS
  15 .Nm
  16 .Op Fl f Pa keyfile
  17 .Op Fl i
  18 .Op Fl k
  19 .Op Fl p Ar principal
  20 .Op Fl r Ar realm
  21 .Ar operation
  22 .Sh DESCRIPTION
  23 .Nm
  24 allows a system manager to list or change keys currently in his
  25 keyfile or to add new keys to the keyfile.
  26 .Pp
  27 Operation must be one of the following:
  28 .Bl -tag -width indent
  29 .It list
  30 lists the keys in a keyfile showing version number and principal name.
  31 If the
  32 .Fl k
  33 option is given, keys will also be shown.
  34 .It change
  35 changes all the keys in the keyfile by using the regular admin
  36 protocol.  If the
  37 .Fl i
  38 flag is given,
  39 .Nm ksrvutil
  40 will prompt for yes or no before changing each key.  If the
  41 .Fl k
  42 option is used, the old and new keys will be displayed.
  43 .It add
  44 allows the user to add a key.
  45 add
  46 prompts for name, instance, realm, and key version number, asks
  47 for confirmation, and then asks for a password.
  48 .Nm
  49 then converts the password to a key and appends the keyfile with the
  50 new information.  If the
  51 .Fl k
  52 option is used, the key is displayed.
  53 .It get
  54 gets a service from the Kerberos server, possibly creating the
  55 principal. Names, instances and realms for the service keys to get are
  56 prompted for. The default principal used in the kadmin transcation is
  57 your root instance. This can be changed with the
  58 .Fl p
  59 option.
  60 .El
  61 .Pp
  62 In all cases, the default file used is KEY_FILE as defined in krb.h
  63 unless this is overridden by the
  64 .Fl f
  65 option.
  66 .Pp
  67 A good use for
  68 .Nm
  69 would be for adding keys to a keyfile.  A system manager could
  70 ask a kerberos administrator to create a new service key with
  71 .Xr kadmin 8
  72 and could supply an initial password.  Then, he could use
  73 .Nm
  74 to add the key to the keyfile and then to change the key so that it
  75 will be random and unknown to either the system manager or the
  76 kerberos administrator.
  77 .Pp
  78 .Nm
  79 always makes a backup copy of the keyfile before making any changes.
  80 .Sh DIAGNOSTICS
  81 If
  82 .Nm
  83 should exit on an error condition at any time during a change or add,
  84 a copy of the original keyfile can be found in
  85 .Pa filename Ns .old
  86 where
  87 .Pa filename
  88 is the name of the keyfile, and a copy of the file with all new
  89 keys changed or added so far can be found in
  90 .Pa filename Ns .work .
  91 The original keyfile is left unmodified until the program exits at
  92 which point it is removed and replaced it with the workfile.
  93 Appending the workfile to the backup copy and replacing the keyfile
  94 with the result should always give a usable keyfile, although the
  95 resulting keyfile will have some out of date keys in it.
  96 .Sh SEE ALSO
  97 .Xr kadmin 8 ,
  98 .Xr ksrvtgt 1
  99 .Sh AUTHOR
 100 Emanuel Jay Berkenbilt, MIT Project Athena