src/man/kadmind.8

   1 .TH "KADMIND" "8" "January 06, 2012" "0.0.1" "MIT Kerberos"
   2 .SH NAME
   3 kadmind \- KADM5 administration server
   4 .
   5 .nr rst2man-indent-level 0
   6 .
   7 .de1 rstReportMargin
   8 \\$1 \\n[an-margin]
   9 level \\n[rst2man-indent-level]
  10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  11 -
  12 \\n[rst2man-indent0]
  13 \\n[rst2man-indent1]
  14 \\n[rst2man-indent2]
  15 ..
  16 .de1 INDENT
  17 .\" .rstReportMargin pre:
  18 . RS \\$1
  19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  20 . nr rst2man-indent-level +1
  21 .\" .rstReportMargin post:
  22 ..
  23 .de UNINDENT
  24 . RE
  25 .\" indent \\n[an-margin]
  26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  27 .nr rst2man-indent-level -1
  28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  30 ..
  31 .\" Man page generated from reStructeredText.
  32 .
  33 .SH SYNOPSIS
  34 .sp
  35 \fBkadmind\fP [\fB\-x\fP \fIdb_args\fP] [\fB\-r\fP \fIrealm\fP] [\fB\-m\fP] [\fB\-nofork\fP] [\fB\-port\fP \fIport\-number\fP] [\fB\-P\fP \fIpid_file\fP]
  36 .SH DESCRIPTION
  37 .sp
  38 This command starts the KADM5 administration server. If the database is db2, the administration server runs on the master Kerberos server,
  39 which stores the KDC principal database and the KADM5 policy database. If the database is LDAP, the administration server and
  40 the KDC server need not run on the same machine.  \fIkadmind\fP accepts remote requests to administer the information in these databases.
  41 Remote requests are sent, for example, by kadmin(8) and the kpasswd(1) command, both of which are clients of \fIkadmind\fP.
  42 .sp
  43 \fIkadmind\fP requires a number of configuration files to be set up in order for it to work:
  44 .INDENT 0.0
  45 .TP
  46 .B \fIkdc.conf\fP
  47 .sp
  48 The KDC configuration file contains configuration information for the KDC and the KADM5 system.  \fIkadmind\fP understands a number
  49 of  variable  settings in this file, some of which are mandatory and some of which are optional.
  50 See the CONFIGURATION VALUES section below.
  51 .TP
  52 .B \fIACL\fP file
  53 .sp
  54 \fIkadmind\fP\(aqs \fIACL\fP (access control list) tells it which principals are allowed to perform KADM5 administration actions.
  55 The  path of  the \fIACL\fP file is specified via the acl_file configuration variable (see CONFIGURATION VALUES).
  56 The syntax of the \fIACL\fP file is specified in the \fIACL\fP FILE SYNTAX section below.
  57 .sp
  58 If the \fIkadmind\fP\(aqs ACL file is modified, the \fIkadmind\fP daemon needs to be restarted for changes to take effect.
  59 .UNINDENT
  60 .sp
  61 After the server begins running, it puts itself in the background and disassociates itself from its controlling terminal.
  62 .sp
  63 \fIkadmind\fP can be configured for incremental database propagation.  Incremental propagation allows slave KDC servers to receive  principal
  64 and  policy  updates  incrementally instead of receiving full dumps of the database.  This facility can be enabled in the \fIkdc.conf\fP file
  65 with the \fIiprop_enable\fP option.  See the \fIkdc.conf\fP documentation for other options for tuning incremental propagation parameters.
  66 Incremental propagation requires the principal "kiprop/MASTER@REALM"
  67 (where MASTER is the master KDC\(aqs canonical host name, and REALM the realm name) to be registered in the database.
  68 .SH OPTIONS
  69 .INDENT 0.0
  70 .INDENT 3.5
  71 .INDENT 0.0
  72 .TP
  73 .B \fB\-x\fP \fIdb_args\fP
  74 .sp
  75 specifies the database specific arguments.
  76 .sp
  77 Options supported for LDAP database are:
  78 .INDENT 7.0
  79 .INDENT 3.5
  80 .INDENT 0.0
  81 .TP
  82 .B \fB\-x\fP \fInconns\fP =<number_of_connections>
  83 .sp
  84 specifies the number of connections to be maintained per LDAP server.
  85 .TP
  86 .B \fB\-x\fP \fIhost\fP =<ldapuri>
  87 .sp
  88 specifies the LDAP server to connect to by a LDAP URI.
  89 .TP
  90 .B \fB\-x\fP \fIbinddn\fP =<binddn>
  91 .sp
  92 specifies the DN of the object used by the administration server to bind to the LDAP server.  This object should have the
  93 read and write rights on the realm container, principal container and the subtree that is referenced by the realm.
  94 .TP
  95 .B \fB\-x\fP \fIbindpwd\fP =<bind_password>
  96 .sp
  97 specifies the password for the above mentioned binddn. It is recommended not to use this option.
  98 Instead, the password can be stashed using the stashsrvpw command of kdb5_ldap_util.
  99 .UNINDENT
 100 .UNINDENT
 101 .UNINDENT
 102 .TP
 103 .B \fB\-r\fP \fIrealm\fP
 104 .sp
 105 specifies the default realm that \fIkadmind\fP will serve; if it is not specified, the default realm of the host is used.
 106 \fIkadmind\fP will answer requests for any realm that exists in the local KDC database and for which the appropriate principals are in its keytab.
 107 .TP
 108 .B \fB\-m\fP
 109 .sp
 110 specifies that the master database password should be fetched from the keyboard rather than from a file on disk.
 111 Note that the server gets the password prior to putting itself in the background;
 112 in combination with the \fI\-nofork\fP option, you must place it in the background by hand.
 113 .TP
 114 .B \fB\-nofork\fP
 115 .sp
 116 specifies that the server does not put itself in the background and does not disassociate itself from the terminal.
 117 In normal operation, you should always allow the server place itself in the background.
 118 .TP
 119 .B \fB\-port\fP \fIport\-number\fP
 120 .sp
 121 specifies the port on which the administration server listens for connections.  The default is is controlled by the \fIkadmind_port\fP
 122 configuration variable (see below).
 123 .TP
 124 .B \fB\-P\fP \fIpid_file\fP
 125 .sp
 126 specifies the file to which the PID of \fIkadmind\fP process should be written to after it starts up.  This can be used to identify
 127 whether \fIkadmind\fP is still running and to allow init scripts to stop the correct process.
 128 .UNINDENT
 129 .UNINDENT
 130 .UNINDENT
 131 .SH CONFIGURATION VALUES
 132 .sp
 133 In addition to the relations defined in kdc.conf(5), \fIkadmind\fP understands the following relations,
 134 all of which should appear in the [realms] section:
 135 .INDENT 0.0
 136 .INDENT 3.5
 137 .INDENT 0.0
 138 .TP
 139 .B \fBacl_file\fP
 140 .sp
 141 The path of \fIkadmind\fP\(aqs \fIACL\fP file.  \fBMandatory\fP.  No default.
 142 .TP
 143 .B \fBdict_file\fP
 144 .sp
 145 The path of \fIkadmind\fP\(aqs password dictionary.  A principal with any password policy will not be allowed to select any  password  in
 146 the dictionary.  Optional.  No default.
 147 .TP
 148 .B \fBkadmind_port\fP
 149 .sp
 150 The TCP port on which \fIkadmind\fP will listen.  The default is 749.
 151 .UNINDENT
 152 .UNINDENT
 153 .UNINDENT
 154 .SH ACL FILE SYNTAX
 155 .sp
 156 The \fIACL\fP file controls which principals can or cannot perform which administrative functions.  For operations  that  affect  principals,
 157 the  \fIACL\fP file also controls which principals can operate on which other principals.  This file can contain comment lines, null lines or
 158 lines which contain \fIACL\fP entries.  Comment lines start with the sharp sign (#) and continue until the end of the line.
 159 Lines containing \fIACL\fP entries have the format of principal whitespace \fIoperation\-mask\fP [whitespace \fIoperation\-target\fP]
 160 .sp
 161 Ordering  is important.  The first matching entry is the one which will control access for a particular principal on a particular principal.
 162 .INDENT 0.0
 163 .INDENT 3.5
 164 .INDENT 0.0
 165 .TP
 166 .B \fBprincipal\fP
 167 .sp
 168 may specify a partially or fully qualified Kerberos version 5 principal name.  Each component of  the  name  may  be  wildcarded
 169 using the asterisk ( * ) character.
 170 .TP
 171 .B \fBoperation\-target\fP
 172 .sp
 173 [Optional]  may specify a partially or fully qualified Kerberos version 5 principal name.  Each component of the name may be
 174 wildcarded using the asterisk ( * ) character.
 175 .TP
 176 .B \fBoperation\-mask\fP
 177 .sp
 178 Specifies what operations may or may not be performed by a principal matching a particular entry.  This is a string of one or
 179 more of the following list of characters or their upper\-case counterparts.  If the character is upper\-case, then the operation
 180 is disallowed.  If the character is lower\-case, then the operation is permitted.
 181 .sp
 182 .nf
 183 .ft C
 184 a    [Dis]allows the addition of principals or policies in the database.
 185 d    [Dis]allows the deletion of principals or policies in the database.
 186 m    [Dis]allows the modification of principals or policies in the database.
 187 c    [Dis]allows the changing of passwords for principals in the database.
 188 i    [Dis]allows inquiries to the database.
 189 l    [Dis]allows the listing of principals or policies in the database.
 190 p    [Dis]allows the propagation of the principal database.
 191 x    Short for admcil.
 192 *    Same as x.
 193 .ft P
 194 .fi
 195 .sp
 196 Some examples of valid entries here are:
 197 .INDENT 7.0
 198 .TP
 199 .B \fIuser/instance@realm adm\fP
 200 .sp
 201 A standard fully qualified name.
 202 The \fIoperation\-mask\fP only applies to this principal and specifies that [s]he may add,
 203 delete  or modify principals and policies, but not change anybody else\(aqs password.
 204 .TP
 205 .B \fIuser/instance@realm cim service/instance@realm\fP
 206 .sp
 207 A  standard fully qualified name and a standard fully qualified target.
 208 The \fIoperation\-mask\fP only applies to this principal operating on this target and specifies
 209 that [s]he may change the target\(aqs password, request information about the target and  modify it.
 210 .TP
 211 .B \fIuser/*@realm ac\fP
 212 .sp
 213 A  wildcarded name.  The \fIoperation\-mask\fP applies to all principals in realm "realm" whose first component is "user" and specifies
 214 that [s]he may add principals and change anybody\(aqs password.
 215 .TP
 216 .B \fIuser/*@realm i */instance@realm\fP
 217 .sp
 218 A wildcarded name and target.  The \fIoperation\-mask\fP applies to all principals in realm "realm" whose first component is "user" and
 219 specifies that [s]he may perform inquiries on principals whose second component is "instance" and realm is "realm".
 220 .UNINDENT
 221 .UNINDENT
 222 .UNINDENT
 223 .UNINDENT
 224 .SH FILES
 225 .sp
 226 Note: The first three files are specific to db2 database.
 227 .TS
 228 center;
 229 |l|l|.
 230 _
 231 T{
 232 principal.db
 233 T}      T{
 234 default name for Kerberos principal database
 235 T}
 236 _
 237 T{
 238 <dbname>.kadm5
 239 T}      T{
 240 KADM5  administrative database.  (This would be "principal.kadm5", if you use the default database name.)  Contains policy information.
 241 T}
 242 _
 243 T{
 244 <dbname>.kadm5.lock
 245 T}      T{
 246 lock file for the KADM5 administrative database.  This file works backwards from most other lock files.  I.e., kadmin will exit with an error if this file does not exist.
 247 T}
 248 _
 249 T{
 250 kadm5.acl
 251 T}      T{
 252 file containing list of principals and their kadmin administrative privileges.  See above for a description.
 253 T}
 254 _
 255 T{
 256 kadm5.keytab
 257 T}      T{
 258 keytab file for \fIkadmin/admin\fP principal.
 259 T}
 260 _
 261 T{
 262 kadm5.dict
 263 T}      T{
 264 file containing dictionary of strings explicitly disallowed as passwords.
 265 T}
 266 _
 267 .TE
 268 .SH SEE ALSO
 269 .sp
 270 kpasswd(1), kadmin(8), kdb5_util(8), kadm5_export(8), kadm5_import(8), kdb5_ldap_util(8)
 271 .SH AUTHOR
 272 MIT
 273 .SH COPYRIGHT
 274 2011, MIT
 275 .\" Generated by docutils manpage writer.
 276 .