| 1 |
.. _kadmind(8): |
| 2 |
|
| 3 |
kadmind |
| 4 |
======= |
| 5 |
|
| 6 |
SYNOPSIS |
| 7 |
-------- |
| 8 |
|
| 9 |
**kadmind** |
| 10 |
[**-x** *db_args*] |
| 11 |
[**-r** *realm*] |
| 12 |
[**-m**] |
| 13 |
[**-nofork**] |
| 14 |
[**-proponly**] |
| 15 |
[**-port** *port-number*] |
| 16 |
[**-P** *pid_file*] |
| 17 |
[**-p** *kdb5_util_path*] |
| 18 |
[**-K** *kprop_path*] |
| 19 |
[**-k** *kprop_port*] |
| 20 |
[**-F** *dump_file*] |
| 21 |
|
| 22 |
DESCRIPTION |
| 23 |
----------- |
| 24 |
|
| 25 |
kadmind starts the Kerberos administration server. kadmind typically |
| 26 |
runs on the primary Kerberos server, which stores the KDC database. |
| 27 |
If the KDC database uses the LDAP module, the administration server |
| 28 |
and the KDC server need not run on the same machine. kadmind accepts |
| 29 |
remote requests from programs such as :ref:`kadmin(1)` and |
| 30 |
:ref:`kpasswd(1)` to administer the information in these database. |
| 31 |
|
| 32 |
kadmind requires a number of configuration files to be set up in order |
| 33 |
for it to work: |
| 34 |
|
| 35 |
:ref:`kdc.conf(5)` |
| 36 |
The KDC configuration file contains configuration information for |
| 37 |
the KDC and admin servers. kadmind uses settings in this file to |
| 38 |
locate the Kerberos database, and is also affected by the |
| 39 |
**acl_file**, **dict_file**, **kadmind_port**, and iprop-related |
| 40 |
settings. |
| 41 |
|
| 42 |
:ref:`kadm5.acl(5)` |
| 43 |
kadmind's ACL (access control list) tells it which principals are |
| 44 |
allowed to perform administration actions. The pathname to the |
| 45 |
ACL file can be specified with the **acl_file** :ref:`kdc.conf(5)` |
| 46 |
variable; by default, it is |kdcdir|\ ``/kadm5.acl``. |
| 47 |
|
| 48 |
After the server begins running, it puts itself in the background and |
| 49 |
disassociates itself from its controlling terminal. |
| 50 |
|
| 51 |
kadmind can be configured for incremental database propagation. |
| 52 |
Incremental propagation allows replica KDC servers to receive |
| 53 |
principal and policy updates incrementally instead of receiving full |
| 54 |
dumps of the database. This facility can be enabled in the |
| 55 |
:ref:`kdc.conf(5)` file with the **iprop_enable** option. Incremental |
| 56 |
propagation requires the principal ``kiprop/PRIMARY\@REALM`` (where |
| 57 |
PRIMARY is the primary KDC's canonical host name, and REALM the realm |
| 58 |
name). In release 1.13, this principal is automatically created and |
| 59 |
registered into the datebase. |
| 60 |
|
| 61 |
|
| 62 |
OPTIONS |
| 63 |
------- |
| 64 |
|
| 65 |
**-r** *realm* |
| 66 |
specifies the realm that kadmind will serve; if it is not |
| 67 |
specified, the default realm of the host is used. |
| 68 |
|
| 69 |
**-m** |
| 70 |
causes the master database password to be fetched from the |
| 71 |
keyboard (before the server puts itself in the background, if not |
| 72 |
invoked with the **-nofork** option) rather than from a file on |
| 73 |
disk. |
| 74 |
|
| 75 |
**-nofork** |
| 76 |
causes the server to remain in the foreground and remain |
| 77 |
associated to the terminal. |
| 78 |
|
| 79 |
**-proponly** |
| 80 |
causes the server to only listen and respond to Kerberos replica |
| 81 |
incremental propagation polling requests. This option can be used |
| 82 |
to set up a hierarchical propagation topology where a replica KDC |
| 83 |
provides incremental updates to other Kerberos replicas. |
| 84 |
|
| 85 |
**-port** *port-number* |
| 86 |
specifies the port on which the administration server listens for |
| 87 |
connections. The default port is determined by the |
| 88 |
**kadmind_port** configuration variable in :ref:`kdc.conf(5)`. |
| 89 |
|
| 90 |
**-P** *pid_file* |
| 91 |
specifies the file to which the PID of kadmind process should be |
| 92 |
written after it starts up. This file can be used to identify |
| 93 |
whether kadmind is still running and to allow init scripts to stop |
| 94 |
the correct process. |
| 95 |
|
| 96 |
**-p** *kdb5_util_path* |
| 97 |
specifies the path to the kdb5_util command to use when dumping the |
| 98 |
KDB in response to full resync requests when iprop is enabled. |
| 99 |
|
| 100 |
**-K** *kprop_path* |
| 101 |
specifies the path to the kprop command to use to send full dumps |
| 102 |
to replicas in response to full resync requests. |
| 103 |
|
| 104 |
**-k** *kprop_port* |
| 105 |
specifies the port by which the kprop process that is spawned by |
| 106 |
kadmind connects to the replica kpropd, in order to transfer the |
| 107 |
dump file during an iprop full resync request. |
| 108 |
|
| 109 |
**-F** *dump_file* |
| 110 |
specifies the file path to be used for dumping the KDB in response |
| 111 |
to full resync requests when iprop is enabled. |
| 112 |
|
| 113 |
**-x** *db_args* |
| 114 |
specifies database-specific arguments. See :ref:`Database Options |
| 115 |
<dboptions>` in :ref:`kadmin(1)` for supported arguments. |
| 116 |
|
| 117 |
|
| 118 |
ENVIRONMENT |
| 119 |
----------- |
| 120 |
|
| 121 |
See :ref:`kerberos(7)` for a description of Kerberos environment |
| 122 |
variables. |
| 123 |
|
| 124 |
As of release 1.22, kadmind supports systemd socket activation via the |
| 125 |
LISTEN_PID and LISTEN_FDS environment variables. Sockets provided by |
| 126 |
the caller must correspond to configured listener addresses (via the |
| 127 |
**kadmind_listen** or **kpasswd_listen** variables or equivalents) or |
| 128 |
they will be ignored. Any configured listener addresses that do not |
| 129 |
correspond to caller-provided sockets will be ignored if socket |
| 130 |
activation is used. |
| 131 |
|
| 132 |
|
| 133 |
SEE ALSO |
| 134 |
-------- |
| 135 |
|
| 136 |
:ref:`kpasswd(1)`, :ref:`kadmin(1)`, :ref:`kdb5_util(8)`, |
| 137 |
:ref:`kdb5_ldap_util(8)`, :ref:`kadm5.acl(5)`, :ref:`kerberos(7)` |