crypto/kerberosIV/man/kadmin.8

   1 .\" $Id: kadmin.8,v 1.6 1998/12/18 16:56:29 assar Exp $
   2 .\" Copyright 1989 by the Massachusetts Institute of Technology.
   3 .\"
   4 .\" For copying and distribution information,
   5 .\" please see the file <mit-copyright.h>.
   6 .\"
   7 .Dd February  3, 1998
   8 .Dt KADMIN 8
   9 .Os "KTH-KRB"
  10 .Sh NAME
  11 .Nm kadmin
  12 .Nd "network utility for Kerberos database administration"
  13 .Sh SYNOPSIS
  14 .Nm
  15 .Op Fl p Ar principal
  16 .Op Fl u Ar username
  17 .Op Fl r Ar realm
  18 .Op Fl m
  19 .Op Fl T Ar timeout
  20 .Op Fl t
  21 .Op Fl -version
  22 .Op Fl h
  23 .Op Fl -help
  24 .Op Ar command
  25 .Sh DESCRIPTION
  26 This utility provides a unified administration interface to the
  27 Kerberos master database.  Kerberos administrators use
  28 .Nm
  29 to register new users and services to the master database, and to
  30 change information about existing database entries, such as changing a
  31 user's Kerberos password. A Kerberos administrator is a user with an
  32 .Dq admin
  33 instance whose name appears on one of the Kerberos administration
  34 access control lists.
  35 .Pp
  36 Supported options:
  37 .Bl -tag -width Ds
  38 .It Fl p Ar principal
  39 This is the adminstrator principal to use when talking to the Kadmin
  40 server. The default is taken from the users environment.
  41 .It Fl r Ar realm
  42 This is the default realm to use for transactions. Default is the
  43 local realm.
  44 .It Fl u Ar username
  45 This is similar to
  46 .Fl p ,
  47 but specifies a name, that gets appended with a
  48 .Dq admin
  49 instance.
  50 .It Fl T Ar timeout
  51 To prevent someone from walking up to an unguarded terminal and doing
  52 malicious things, administrator tickets are destroyed after a period
  53 of inactivity. This flag changes the timeout from the default of one
  54 minute. A timeout of zero seconds disables this functionality.
  55 .It Fl m
  56 Historically
  57 .Nm
  58 destroyed tickets after every command; this flag used to stop this
  59 behaviour (only destroying tickets upon exit). Now it's just a synonym
  60 for
  61 .Fl T Ar 0 .
  62 .It Fl t
  63 Use existing tickets (if any are available), this also disbles
  64 timeout, and doesn't destroy any tickets upon exit.
  65 .Pp
  66 These tickets have to be for the changepw.kerberos service.  Use
  67 .Nm kinit -p
  68 to acquire them.
  69 .El
  70 .Pp
  71 The
  72 .Nm
  73 program communicates over the network with the
  74 .Nm kadmind
  75 program, which runs on the machine housing the Kerberos master
  76 database, and does the actual modifications to the database.
  77 .Pp
  78 When you enter the
  79 .Nm
  80 command, the program displays a message that welcomes you and explains
  81 how to ask for help.  Then
  82 .Nm
  83 waits for you to enter commands (which are described below).  It then
  84 asks you for your administrator's password before accessing the
  85 database.
  86 .Pp
  87 All commands can be abbreviated as long as they are unique.  Some
  88 short versions of the commands are also recognized for backwards
  89 compatibility.
  90 .Pp
  91 Recognised commands:
  92 .Bl -tag -width Ds
  93 .It add_new_key Ar principal
  94 Creates a new principal in the Kerberos database. You give the name of
  95 the new principal as an argument. You will then be asked for a maximum
  96 ticket lifetime, attributes, the expiration date of the principal, and
  97 finally the password of the principal.
  98 .It change_password Ar principal
  99 Changes a principal's password. You will be prompted for the new
 100 password.
 101 .It change_key Ar principal
 102 This is the same as change_password, but the password is given as a
 103 raw DES key (for the few occations when you need this).
 104 .It change_admin_password
 105 Changes your own admin password. It will prompt you for you old and
 106 new passwords.
 107 .It del_entry Ar principal
 108 Removes principal from the database.
 109 .It get_entry Ar principal
 110 Show various information for the given principal. Note that the key is
 111 shown as zeros.
 112 .It mod_entry Ar principal
 113 Modifies a particular entry, for instance to change the expiration
 114 date.
 115 .It destroy_tickets
 116 Destroys your admin tickets explicitly.
 117 .It quit
 118 Obvious.
 119 .El
 120 .\".Sh ENVIRONMENT
 121 .\".Sh FILES
 122 .\".Sh EXAMPLES
 123 .\".Sh DIAGNOSTICS
 124 .Sh SEE ALSO
 125 .Xr kerberos 1 ,
 126 .Xr kadmind 8 ,
 127 .Xr kpasswd 1 ,
 128 .Xr kinit 1 ,
 129 .Xr ksrvutil 8
 130 .\".Sh STANDARDS
 131 .\".Sh HISTORY
 132 .Sh AUTHORS
 133 Jeffrey I. Schiller, MIT Project Athena
 134 .Pp
 135 Emanuel Jay Berkenbilt, MIT Project Athena
 136 .Sh BUGS
 137 The user interface is primitive, and the command names could be
 138 better.