share/man/man8/krb5kdc.8

   1 '\" te
   2 .\" Copyright 1987, 1989 by the Student Information Processing Board of the Massachusetts Institute of Technology.  For copying and distribution information,  please see the file kerberosv5/mit-sipb-copyright.h.
   3 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH KRB5KDC 8 "Oct 29, 2015"
   8 .SH NAME
   9 krb5kdc \- KDC daemon
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/usr/lib/krb5/krb5kdc\fR [\fB-d\fR \fIdbpath\fR] [\fB-r\fR \fIrealm\fR]  [\fB-m\fR]
  14      [\fB-k\fR \fImasterenctype\fR] [\fB-M\fR \fImasterkeyname\fR]
  15      [\fB-p\fR \fIport\fR] [\fB-n\fR] [\fB-x\fR \fIdb_args\fR]...
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 \fBkrb5kdc\fR is the daemon that runs on the master and slave \fBKDC\fRs to
  22 process the Kerberos tickets. For Kerberos to function properly, \fBkrb5kdc\fR
  23 must be running on at least one \fBKDC\fR that the Kerberos clients can access.
  24 Prior to running \fBkrb5kdc\fR, you must initialize the Kerberos database using
  25 \fBkdb5_util\fR(8). See the \fI\fR for information regarding how to set up
  26 \fBKDC\fRs and initialize the Kerberos database.
  27 .SH OPTIONS
  28 .sp
  29 .LP
  30 The following options are supported:
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fB-d\fR \fIdbpath\fR\fR
  35 .ad
  36 .sp .6
  37 .RS 4n
  38 Specify the path to the database; default value is \fB/var/krb5\fR.
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fB-k\fR \fImasterenctype\fR\fR
  45 .ad
  46 .sp .6
  47 .RS 4n
  48 Specify the encryption type for encrypting the database. The default value is
  49 \fBdes-cbc-crc\fR. \fBdes3-cbc-sha1\fR, \fBarcfour-hmac-md5\fR,
  50 \fBarcfour-hmac-md5-exp\fR, \fBaes128-cts-hmac-sha1-96\fR, and
  51 \fBaes256-cts-hmac-sha1-96\fR are also valid.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fB-m\fR\fR
  58 .ad
  59 .sp .6
  60 .RS 4n
  61 Specify that the master key for the database is to be entered manually.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fB-M\fR \fImasterkeyname\fR\fR
  68 .ad
  69 .sp .6
  70 .RS 4n
  71 Specify the principal to retrieve the master Key for the database.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fB-n\fR\fR
  78 .ad
  79 .sp .6
  80 .RS 4n
  81 Specify that \fBkrb5kdc\fR should not detach from the terminal.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fB-p\fR \fIport\fR\fR
  88 .ad
  89 .sp .6
  90 .RS 4n
  91 Specify the port that will be used by the \fBKDC\fR to listen for incoming
  92 requests.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fB-r\fR \fIrealm\fR\fR
  99 .ad
 100 .sp .6
 101 .RS 4n
 102 Specify the realm name; default is the local realm name.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fB-x\fR \fIdb_args\fR\fR
 109 .ad
 110 .sp .6
 111 .RS 4n
 112 Pass database-specific arguments to \fBkadmin\fR. Supported arguments are for
 113 the LDAP plug-in. These arguments are:
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBbinddn\fR=\fIbinddn\fR\fR
 118 .ad
 119 .sp .6
 120 .RS 4n
 121 Specifies the DN of the object used by the KDC server to bind to the LDAP
 122 server. This object should have the rights to read the realm container,
 123 principal container and the subtree that is referenced by the realm. Overrides
 124 the \fBldap_kdc_dn\fR parameter setting in \fBkrb5.conf\fR(4).
 125 .RE
 126
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fBbindpwd\fR=\fIbindpwd\fR\fR
 131 .ad
 132 .sp .6
 133 .RS 4n
 134 Specifies the password for the above-mentioned \fIbinddn\fR. It is recommended
 135 not to use this option. Instead, the password can be stashed using the
 136 \fBstashsrvpw\fR command of \fBkdb5_ldap_util\fR(8).
 137 .RE
 138
 139 .sp
 140 .ne 2
 141 .na
 142 \fB\fBnconns\fR=\fInum\fR\fR
 143 .ad
 144 .sp .6
 145 .RS 4n
 146 Specifies the number of connections to be maintained per LDAP server.
 147 .RE
 148
 149 .sp
 150 .ne 2
 151 .na
 152 \fB\fBhost\fR=\fIldapuri\fR\fR
 153 .ad
 154 .sp .6
 155 .RS 4n
 156 Specifies, by an LDAP URI, the LDAP server to which to connect.
 157 .RE
 158
 159 .RE
 160
 161 .SH FILES
 162 .sp
 163 .ne 2
 164 .na
 165 \fB\fB/var/krb5/principal.db\fR\fR
 166 .ad
 167 .sp .6
 168 .RS 4n
 169 Kerberos principal database.
 170 .RE
 171
 172 .sp
 173 .ne 2
 174 .na
 175 \fB\fB/var/krb5/principal.kadm5\fR\fR
 176 .ad
 177 .sp .6
 178 .RS 4n
 179 Kerberos administrative database. This file contains policy information.
 180 .RE
 181
 182 .sp
 183 .ne 2
 184 .na
 185 \fB\fB/var/krb5/principal.kadm5.lock\fR\fR
 186 .ad
 187 .sp .6
 188 .RS 4n
 189 Kerberos administrative database lock file. This file works backwards from most
 190 other lock files (that is, \fBkadmin\fR will exit with an error if this file
 191 does \fInot\fR exist).
 192 .RE
 193
 194 .sp
 195 .ne 2
 196 .na
 197 \fB\fB/etc/krb5/kdc.conf\fR\fR
 198 .ad
 199 .sp .6
 200 .RS 4n
 201 \fBKDC\fR configuration file. This file is read at startup.
 202 .RE
 203
 204 .sp
 205 .ne 2
 206 .na
 207 \fB\fB/etc/krb5/kpropd.acl\fR\fR
 208 .ad
 209 .sp .6
 210 .RS 4n
 211 File that defines the access control list for propagating the Kerberos database
 212 using \fBkprop\fR.
 213 .RE
 214
 215 .SH SEE ALSO
 216 .sp
 217 .LP
 218 \fBkill\fR(1), \fBkpasswd\fR(1), \fBkadmind\fR(8),
 219 \fBkadmin.local\fR(8), \fBkdb5_util\fR(8), \fBkdb5_ldap_util\fR(8),
 220 \fBlogadm\fR(8), \fBkrb5.conf\fR(4), \fBattributes\fR(5), \fBkrb5envvar\fR(5),
 221 \fBkerberos\fR(5),
 222 .sp
 223 .LP
 224 \fI\fR
 225 .SH NOTES
 226 .sp
 227 .LP
 228 The following signal has the specified effect when sent to the server process
 229 using the \fBkill\fR(1)command:
 230 .sp
 231 .ne 2
 232 .na
 233 \fB\fBSIGHUP\fR\fR
 234 .ad
 235 .sp .6
 236 .RS 4n
 237 \fBkrb5kdc\fR closes and re-opens log files that it directly opens. This can be
 238 useful for external log-rotation utilities such as \fBlogadm\fR(8). If this
 239 method is used for log file rotation, set the \fBkrb5.conf\fR(4)
 240 \fBkdc_rotate\fR period relation to \fBnever\fR.
 241 .RE
 242