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