src/kdc/krb5kdc.M

   1 .\" kdc/krb5kdc.M
   2 .\"
   3 .\" Copyright 1990, 2008 by the Massachusetts Institute of Technology.
   4 .\"
   5 .\" Export of this software from the United States of America may
   6 .\"   require a specific license from the United States Government.
   7 .\"   It is the responsibility of any person or organization contemplating
   8 .\"   export to obtain such a license before exporting.
   9 .\"
  10 .\" WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
  11 .\" distribute this software and its documentation for any purpose and
  12 .\" without fee is hereby granted, provided that the above copyright
  13 .\" notice appear in all copies and that both that copyright notice and
  14 .\" this permission notice appear in supporting documentation, and that
  15 .\" the name of M.I.T. not be used in advertising or publicity pertaining
  16 .\" to distribution of the software without specific, written prior
  17 .\" permission.  Furthermore if you modify this software you must label
  18 .\" your software as modified software and not distribute it in such a
  19 .\" fashion that it might be confused with the original M.I.T. software.
  20 .\" M.I.T. makes no representations about the suitability of
  21 .\" this software for any purpose.  It is provided "as is" without express
  22 .\" or implied warranty.
  23 .\" "
  24 .TH KRB5KDC 8
  25 .SH NAME
  26 krb5kdc \- Kerberos V5 KDC
  27 .SH SYNOPSIS
  28 .B krb5kdc
  29 [
  30 .B \-x
  31 .I db_args
  32 ] [
  33 .B \-d
  34 .I dbname
  35 ] [
  36 .B \-k
  37 .I keytype
  38 ] [
  39 .B \-M
  40 .I mkeyname
  41 ] [
  42 .B \-p
  43 .I portnum
  44 ] [
  45 .B \-m
  46 ] [
  47 .B \-r
  48 .I realm
  49 ] [
  50 .B \-n
  51 ]
  52 .br
  53 .SH DESCRIPTION
  54 .I krb5kdc
  55 is the Kerberos version 5 Authentication Service and Key Distribution
  56 Center (AS/KDC).
  57 .PP
  58 The
  59 .B \-x
  60 .I db_args
  61 option specifies the database specific arguments.
  62
  63 Options supported for LDAP database are:
  64 .sp
  65 .nf
  66 .RS 8
  67 \-x nconns=<number_of_connections>
  68 .fi
  69 specifies the number of connections to be maintained per LDAP server.
  70
  71 .nf
  72 \-x host=<ldapuri>
  73 specifies the LDAP server to connect to by a LDAP URI.
  74
  75 \-x binddn=<binddn>
  76 .fi
  77 specifies the DN of the object used by the KDC server to bind to the LDAP server.
  78 This object should have the rights to read the realm container, principal container
  79 and the subtree that is referenced by the realm.
  80
  81 \-x bindpwd=<bind_password>
  82 .fi
  83 specifies the password for the above mentioned binddn. It is recommended not to use this option.
  84 Instead, the password can be stashed using the stashsrvpw command of kdb5_ldap_util.
  85 .RE
  86 .fi
  87 .PP
  88 The
  89 .B \-r
  90 .I realm
  91 option specifies the realm for which the server should provide service;
  92 by default the realm returned by
  93 .IR krb5_default_local_realm (3)
  94 is used.
  95 .PP
  96 The
  97 .B \-d
  98 .I dbname
  99 option specifies the name under which the principal database can be found; by
 100 default the database is in DEFAULT_DBM_FILE.
 101 This option does not apply to the LDAP database.
 102 .PP
 103 The
 104 .B \-k
 105 .I keytype
 106 option specifies the key type of the master key to be entered manually
 107 as a password when -m is given; the default is "des-cbc-crc".
 108 .PP
 109 The
 110 .B \-M
 111 .I mkeyname
 112 option specifies the principal name for the master key in the database;
 113 the default is KRB5_KDB_M_NAME (usually "K/M" in the KDC's realm).
 114 .PP
 115 The
 116 .B \-p
 117 .I portnum
 118 option specifies the default UDP port number which the KDC should listen on for
 119 Kerberos version 5 requests.  This value is used when no port is specified in
 120 the KDC profile and when no port is specified in the Kerberos configuration
 121 file.
 122 If no value is available, then the value in /etc/services for service
 123 "kerberos" is used.
 124 .PP
 125 The
 126 .B \-m
 127 option specifies that the master database password should be fetched
 128 from the keyboard rather than from a file on disk.
 129 .PP
 130 The
 131 .B \-n
 132 option specifies that the KDC does not put itself in the background
 133 and does not disassociate itself from the terminal.  In normal
 134 operation, you should always allow the KDC to place itself in
 135 the background.
 136 .PP
 137 The KDC may service requests for multiple realms (maximum 32 realms).  The
 138 realms are listed on the command line.  Per-realm options that can be
 139 specified on the command line pertain for each realm that follows it and are
 140 superceded by subsequent definitions of the same option.  For example,
 141 .PP
 142 .B krb5kdc
 143 .B \-p
 144 .I 2001
 145 .B \-r
 146 .I REALM1
 147 .B \-p
 148 .I 2002
 149 .B \-r
 150 .I REALM2
 151 .B \-r
 152 .I REALM3
 153 .PP
 154 specifies that the KDC listen on port 2001 for REALM1 and on port 2002 for
 155 REALM2 and REALM3.  Additionally, per-realm parameters may be specified in the
 156 .I kdc.conf
 157 file.  The location of this file may be specified by the
 158 .I KRB5_KDC_PROFILE
 159 environment variable.  Parameters specified in this file take precedence over
 160 options specified on the command line.  See the
 161 .I kdc.conf(5)
 162 description for further details.
 163 .SH SEE ALSO
 164 krb5(3), kdb5_util(8), kdc.conf(5), kdb5_ldap_util(8)
 165 .SH BUGS
 166
 167 It should fork and go into the background when it finishes reading the
 168 master password from the terminal.