doc/admin/admin_commands/krb5kdc.rst

   1 .. _krb5kdc(8):
   2
   3 krb5kdc
   4 =======
   5
   6 SYNOPSIS
   7 --------
   8
   9 **krb5kdc**
  10 [**-x** *db_args*]
  11 [**-d** *dbname*]
  12 [**-k** *keytype*]
  13 [**-M** *mkeyname*]
  14 [**-p** *portnum*]
  15 [**-m**]
  16 [**-r** *realm*]
  17 [**-n**]
  18 [**-w** *numworkers*]
  19 [**-P** *pid_file*]
  20 [**-T** *time_offset*]
  21
  22
  23 DESCRIPTION
  24 -----------
  25
  26 krb5kdc is the Kerberos version 5 Authentication Service and Key
  27 Distribution Center (AS/KDC).
  28
  29
  30 OPTIONS
  31 -------
  32
  33 The **-r** *realm* option specifies the realm for which the server
  34 should provide service.
  35
  36 The **-d** *dbname* option specifies the name under which the
  37 principal database can be found.  This option does not apply to the
  38 LDAP database.
  39
  40 The **-k** *keytype* option specifies the key type of the master key
  41 to be entered manually as a password when **-m** is given; the default
  42 is ``des-cbc-crc``.
  43
  44 The **-M** *mkeyname* option specifies the principal name for the
  45 master key in the database (usually ``K/M`` in the KDC's realm).
  46
  47 The **-m** option specifies that the master database password should
  48 be fetched from the keyboard rather than from a stash file.
  49
  50 The **-n** option specifies that the KDC does not put itself in the
  51 background and does not disassociate itself from the terminal.  In
  52 normal operation, you should always allow the KDC to place itself in
  53 the background.
  54
  55 The **-P** *pid_file* option tells the KDC to write its PID into
  56 *pid_file* after it starts up.  This can be used to identify whether
  57 the KDC is still running and to allow init scripts to stop the correct
  58 process.
  59
  60 The **-p** *portnum* option specifies the default UDP and TCP port
  61 numbers which the KDC should listen on for Kerberos version 5
  62 requests, as a comma-separated list.  This value overrides the port
  63 numbers specified in the :ref:`kdcdefaults` section of
  64 :ref:`kdc.conf(5)`, but may be overridden by realm-specific values.
  65 If no value is given from any source, the default port is 88.
  66
  67 The **-w** *numworkers* option tells the KDC to fork *numworkers*
  68 processes to listen to the KDC ports and process requests in parallel.
  69 The top level KDC process (whose pid is recorded in the pid file if
  70 the **-P** option is also given) acts as a supervisor.  The supervisor
  71 will relay SIGHUP signals to the worker subprocesses, and will
  72 terminate the worker subprocess if the it is itself terminated or if
  73 any other worker process exits.
  74
  75 The **-x** *db_args* option specifies database-specific arguments.
  76 See :ref:`Database Options <dboptions>` in :ref:`kadmin(1)` for
  77 supported arguments.
  78
  79 The **-T** *offset* option specifies a time offset, in seconds, which
  80 the KDC will operate under.  It is intended only for testing purposes.
  81
  82 EXAMPLE
  83 -------
  84
  85 The KDC may service requests for multiple realms (maximum 32 realms).
  86 The realms are listed on the command line.  Per-realm options that can
  87 be specified on the command line pertain for each realm that follows
  88 it and are superseded by subsequent definitions of the same option.
  89
  90 For example::
  91
  92     krb5kdc -p 2001 -r REALM1 -p 2002 -r REALM2 -r REALM3
  93
  94 specifies that the KDC listen on port 2001 for REALM1 and on port 2002
  95 for REALM2 and REALM3.  Additionally, per-realm parameters may be
  96 specified in the :ref:`kdc.conf(5)` file.  The location of this file
  97 may be specified by the **KRB5_KDC_PROFILE** environment variable.
  98 Per-realm parameters specified in this file take precedence over
  99 options specified on the command line.  See the :ref:`kdc.conf(5)`
 100 description for further details.
 101
 102
 103 ENVIRONMENT
 104 -----------
 105
 106 See :ref:`kerberos(7)` for a description of Kerberos environment
 107 variables.
 108
 109
 110 SEE ALSO
 111 --------
 112
 113 :ref:`kdb5_util(8)`, :ref:`kdc.conf(5)`, :ref:`krb5.conf(5)`,
 114 :ref:`kdb5_ldap_util(8)`, :ref:`kerberos(7)`