Debian Codegraph @

doc/admin/conf_files/kdc_conf.rst

raw
1 .. _kdc.conf(5):
2
3 kdc.conf
4 ========
5
6 The kdc.conf file supplements :ref:`krb5.conf(5)` for programs which
7 are typically only used on a KDC, such as the :ref:`krb5kdc(8)` and
8 :ref:`kadmind(8)` daemons and the :ref:`kdb5_util(8)` program.
9 Relations documented here may also be specified in krb5.conf; for the
10 KDC programs mentioned, krb5.conf and kdc.conf will be merged into a
11 single configuration profile.
12
13 Normally, the kdc.conf file is found in the KDC state directory,
14 |kdcdir|. You can override the default location by setting the
15 environment variable **KRB5_KDC_PROFILE**.
16
17 Please note that you need to restart the KDC daemon for any configuration
18 changes to take effect.
19
20 Structure
21 ---------
22
23 The kdc.conf file is set up in the same format as the
24 :ref:`krb5.conf(5)` file.
25
26
27 Sections
28 --------
29
30 The kdc.conf file may contain the following sections:
31
32 ==================== =================================================
33 :ref:`kdcdefaults` Default values for KDC behavior
34 :ref:`kdc_realms` Realm-specific database configuration and settings
35 :ref:`dbdefaults` Default database settings
36 :ref:`dbmodules` Per-database settings
37 :ref:`logging` Controls how Kerberos daemons perform logging
38 ==================== =================================================
39
40
41 .. _kdcdefaults:
42
43 [kdcdefaults]
44 ~~~~~~~~~~~~~
45
46 Some relations in the [kdcdefaults] section specify default values for
47 realm variables, to be used if the [realms] subsection does not
48 contain a relation for the tag. See the :ref:`kdc_realms` section for
49 the definitions of these relations.
50
51 * **host_based_services**
52 * **kdc_listen**
53 * **kdc_ports**
54 * **kdc_tcp_listen**
55 * **kdc_tcp_ports**
56 * **no_host_referral**
57 * **restrict_anonymous_to_tgt**
58
59 The following [kdcdefaults] variables have no per-realm equivalent:
60
61 **kdc_max_dgram_reply_size**
62 Specifies the maximum packet size that can be sent over UDP. The
63 default value is 4096 bytes.
64
65 **kdc_tcp_listen_backlog**
66 (Integer.) Set the size of the listen queue length for the KDC
67 daemon. The value may be limited by OS settings. The default
68 value is 5.
69
70 **spake_preauth_kdc_challenge**
71 (String.) Specifies the group for a SPAKE optimistic challenge.
72 See the **spake_preauth_groups** variable in :ref:`libdefaults`
73 for possible values. The default is not to issue an optimistic
74 challenge. (New in release 1.17.)
75
76
77 .. _kdc_realms:
78
79 [realms]
80 ~~~~~~~~
81
82 Each tag in the [realms] section is the name of a Kerberos realm. The
83 value of the tag is a subsection where the relations define KDC
84 parameters for that particular realm. The following example shows how
85 to define one parameter for the ATHENA.MIT.EDU realm::
86
87 [realms]
88 ATHENA.MIT.EDU = {
89 max_renewable_life = 7d 0h 0m 0s
90 }
91
92 The following tags may be specified in a [realms] subsection:
93
94 **acl_file**
95 (String.) Location of the access control list file that
96 :ref:`kadmind(8)` uses to determine which principals are allowed
97 which permissions on the Kerberos database. To operate without an
98 ACL file, set this relation to the empty string with ``acl_file =
99 ""``. The default value is |kdcdir|\ ``/kadm5.acl``. For more
100 information on Kerberos ACL file see :ref:`kadm5.acl(5)`.
101
102 **database_module**
103 (String.) This relation indicates the name of the configuration
104 section under :ref:`dbmodules` for database-specific parameters
105 used by the loadable database library. The default value is the
106 realm name. If this configuration section does not exist, default
107 values will be used for all database parameters.
108
109 **database_name**
110 (String, deprecated.) This relation specifies the location of the
111 Kerberos database for this realm, if the DB2 module is being used
112 and the :ref:`dbmodules` configuration section does not specify a
113 database name. The default value is |kdcdir|\ ``/principal``.
114
115 **default_principal_expiration**
116 (:ref:`abstime` string.) Specifies the default expiration date of
117 principals created in this realm. The default value is 0, which
118 means no expiration date.
119
120 **default_principal_flags**
121 (Flag string.) Specifies the default attributes of principals
122 created in this realm. The format for this string is a
123 comma-separated list of flags, with '+' before each flag that
124 should be enabled and '-' before each flag that should be
125 disabled. The **postdateable**, **forwardable**, **tgt-based**,
126 **renewable**, **proxiable**, **dup-skey**, **allow-tickets**, and
127 **service** flags default to enabled.
128
129 There are a number of possible flags:
130
131 **allow-tickets**
132 Enabling this flag means that the KDC will issue tickets for
133 this principal. Disabling this flag essentially deactivates
134 the principal within this realm.
135
136 **dup-skey**
137 Enabling this flag allows the KDC to issue user-to-user
138 service tickets for this principal.
139
140 **forwardable**
141 Enabling this flag allows the principal to obtain forwardable
142 tickets.
143
144 **hwauth**
145 If this flag is enabled, then the principal is required to
146 preauthenticate using a hardware device before receiving any
147 tickets.
148
149 **no-auth-data-required**
150 Enabling this flag prevents PAC or AD-SIGNEDPATH data from
151 being added to service tickets for the principal.
152
153 **ok-as-delegate**
154 If this flag is enabled, it hints the client that credentials
155 can and should be delegated when authenticating to the
156 service.
157
158 **ok-to-auth-as-delegate**
159 Enabling this flag allows the principal to use S4USelf tickets.
160
161 **postdateable**
162 Enabling this flag allows the principal to obtain postdateable
163 tickets.
164
165 **preauth**
166 If this flag is enabled on a client principal, then that
167 principal is required to preauthenticate to the KDC before
168 receiving any tickets. On a service principal, enabling this
169 flag means that service tickets for this principal will only
170 be issued to clients with a TGT that has the preauthenticated
171 bit set.
172
173 **proxiable**
174 Enabling this flag allows the principal to obtain proxy
175 tickets.
176
177 **pwchange**
178 Enabling this flag forces a password change for this
179 principal.
180
181 **pwservice**
182 If this flag is enabled, it marks this principal as a password
183 change service. This should only be used in special cases,
184 for example, if a user's password has expired, then the user
185 has to get tickets for that principal without going through
186 the normal password authentication in order to be able to
187 change the password.
188
189 **renewable**
190 Enabling this flag allows the principal to obtain renewable
191 tickets.
192
193 **service**
194 Enabling this flag allows the the KDC to issue service tickets
195 for this principal. In release 1.17 and later, user-to-user
196 service tickets are still allowed if the **dup-skey** flag is
197 set.
198
199 **tgt-based**
200 Enabling this flag allows a principal to obtain tickets based
201 on a ticket-granting-ticket, rather than repeating the
202 authentication process that was used to obtain the TGT.
203
204 **dict_file**
205 (String.) Location of the dictionary file containing strings that
206 are not allowed as passwords. The file should contain one string
207 per line, with no additional whitespace. If none is specified or
208 if there is no policy assigned to the principal, no dictionary
209 checks of passwords will be performed.
210
211 **disable_pac**
212 (Boolean value.) If true, the KDC will not issue PACs for this
213 realm, and S4U2Self and S4U2Proxy operations will be disabled.
214 The default is false, which will permit the KDC to issue PACs.
215 New in release 1.20.
216
217 **encrypted_challenge_indicator**
218 (String.) Specifies the authentication indicator value that the KDC
219 asserts into tickets obtained using FAST encrypted challenge
220 pre-authentication. New in 1.16.
221
222 **host_based_services**
223 (Whitespace- or comma-separated list.) Lists services which will
224 get host-based referral processing even if the server principal is
225 not marked as host-based by the client.
226
227 **iprop_enable**
228 (Boolean value.) Specifies whether incremental database
229 propagation is enabled. The default value is false.
230
231 **iprop_ulogsize**
232 (Integer.) Specifies the maximum number of log entries to be
233 retained for incremental propagation. The default value is 1000.
234 Prior to release 1.11, the maximum value was 2500. New in release
235 1.19.
236
237 **iprop_master_ulogsize**
238 The name for **iprop_ulogsize** prior to release 1.19. Its value is
239 used as a fallback if **iprop_ulogsize** is not specified.
240
241 **iprop_replica_poll**
242 (Delta time string.) Specifies how often the replica KDC polls
243 for new updates from the primary. The default value is ``2m``
244 (that is, two minutes). New in release 1.17.
245
246 **iprop_slave_poll**
247 (Delta time string.) The name for **iprop_replica_poll** prior to
248 release 1.17. Its value is used as a fallback if
249 **iprop_replica_poll** is not specified.
250
251 **iprop_listen**
252 (Whitespace- or comma-separated list.) Specifies the iprop RPC
253 listening addresses and/or ports for the :ref:`kadmind(8)` daemon.
254 Each entry may be an interface address, a port number, or an
255 address and port number separated by a colon. If the address
256 contains colons, enclose it in square brackets. If no address is
257 specified, the wildcard address is used. If kadmind fails to bind
258 to any of the specified addresses, it will fail to start. The
259 default (when **iprop_enable** is true) is to bind to the wildcard
260 address at the port specified in **iprop_port**. New in release
261 1.15.
262
263 **iprop_port**
264 (Port number.) Specifies the port number to be used for
265 incremental propagation. When **iprop_enable** is true, this
266 relation is required in the replica KDC configuration file, and
267 this relation or **iprop_listen** is required in the primary
268 configuration file, as there is no default port number. Port
269 numbers specified in **iprop_listen** entries will override this
270 port number for the :ref:`kadmind(8)` daemon.
271
272 **iprop_resync_timeout**
273 (Delta time string.) Specifies the amount of time to wait for a
274 full propagation to complete. This is optional in configuration
275 files, and is used by replica KDCs only. The default value is 5
276 minutes (``5m``). New in release 1.11.
277
278 **iprop_logfile**
279 (File name.) Specifies where the update log file for the realm
280 database is to be stored. The default is to use the
281 **database_name** entry from the realms section of the krb5 config
282 file, with ``.ulog`` appended. (NOTE: If **database_name** isn't
283 specified in the realms section, perhaps because the LDAP database
284 back end is being used, or the file name is specified in the
285 [dbmodules] section, then the hard-coded default for
286 **database_name** is used. Determination of the **iprop_logfile**
287 default value will not use values from the [dbmodules] section.)
288
289 **kadmind_listen**
290 (Whitespace- or comma-separated list.) Specifies the kadmin RPC
291 listening addresses and/or ports for the :ref:`kadmind(8)` daemon.
292 Each entry may be an interface address, a port number, an address
293 and port number separated by a colon, or a UNIX domain socket
294 pathname. If the address contains colons, enclose it in square
295 brackets. If no address is specified, the wildcard address is
296 used. To disable listening for kadmin RPC connections, set this
297 relation to the empty string with ``kadmind_listen = ""``. If
298 kadmind fails to bind to any of the specified addresses, it will
299 fail to start. The default is to bind to the wildcard address at
300 the port specified in **kadmind_port**, or the standard kadmin
301 port (749). New in release 1.15.
302
303 **kadmind_port**
304 (Port number.) Specifies the port on which the :ref:`kadmind(8)`
305 daemon is to listen for this realm. Port numbers specified in
306 **kadmind_listen** entries will override this port number. The
307 assigned port for kadmind is 749, which is used by default.
308
309 **key_stash_file**
310 (String.) Specifies the location where the master key has been
311 stored (via kdb5_util stash). The default is |kdcdir|\
312 ``/.k5.REALM``, where *REALM* is the Kerberos realm.
313
314 **kdc_listen**
315 (Whitespace- or comma-separated list.) Specifies the listening
316 addresses and/or ports for the :ref:`krb5kdc(8)` daemon. Each
317 entry may be an interface address, a port number, an address and
318 port number separated by a colon, or a UNIX domain socket
319 pathname. If the address contains colons, enclose it in square
320 brackets. If no address is specified, the wildcard address is
321 used. If no port is specified, the standard port (88) is used.
322 To disable listening on UDP, set this relation to the empty string
323 with ``kdc_listen = ""``. If the KDC daemon fails to bind to any
324 of the specified addresses, it will fail to start. The default is
325 to bind to the wildcard address on the standard port. New in
326 release 1.15.
327
328 **kdc_ports**
329 (Whitespace- or comma-separated list, deprecated.) Prior to
330 release 1.15, this relation lists the ports for the
331 :ref:`krb5kdc(8)` daemon to listen on for UDP requests. In
332 release 1.15 and later, it has the same meaning as **kdc_listen**
333 if that relation is not defined.
334
335 **kdc_tcp_listen**
336 (Whitespace- or comma-separated list.) Specifies the TCP
337 listening addresses and/or ports for the :ref:`krb5kdc(8)` daemon.
338 The syntax is identical to that of **kdc_listen**. To disable
339 listening on TCP, set this relation to the empty string with
340 ``kdc_tcp_listen = ""``. The default is to bind to the same
341 addresses and ports as for UDP. New in release 1.15.
342
343 **kdc_tcp_ports**
344 (Whitespace- or comma-separated list, deprecated.) Prior to
345 release 1.15, this relation lists the ports for the
346 :ref:`krb5kdc(8)` daemon to listen on for UDP requests. In
347 release 1.15 and later, it has the same meaning as
348 **kdc_tcp_listen** if that relation is not defined.
349
350 **kpasswd_listen**
351 (Comma-separated list.) Specifies the kpasswd listening
352 addresses and/or ports for the :ref:`kadmind(8)` daemon. Each
353 entry may be an interface address, a port number, an address and
354 port number separated by a colon, or a UNIX domain socket
355 pathname. If the address contains colons, enclose it in square
356 brackets. If no address is specified, the wildcard address is
357 used. To disable listening for kpasswd requests, set this
358 relation to the empty string with ``kpasswd_listen = ""``. If
359 kadmind fails to bind to any of the specified addresses, it will
360 fail to start. The default is to bind to the wildcard address at
361 the port specified in **kpasswd_port**, or the standard kpasswd
362 port (464). New in release 1.15.
363
364 **kpasswd_port**
365 (Port number.) Specifies the port on which the :ref:`kadmind(8)`
366 daemon is to listen for password change requests for this realm.
367 Port numbers specified in **kpasswd_listen** entries will override
368 this port number. The assigned port for password change requests
369 is 464, which is used by default.
370
371 **master_key_name**
372 (String.) Specifies the name of the principal associated with the
373 master key. The default is ``K/M``.
374
375 **master_key_type**
376 (Key type string.) Specifies the master key's key type. The
377 default value for this is |defmkey|. For a list of all possible
378 values, see :ref:`Encryption_types`.
379
380 **max_life**
381 (:ref:`duration` string.) Specifies the maximum time period for
382 which a ticket may be valid in this realm. The default value is
383 24 hours.
384
385 **max_renewable_life**
386 (:ref:`duration` string.) Specifies the maximum time period
387 during which a valid ticket may be renewed in this realm.
388 The default value is 0.
389
390 **no_host_referral**
391 (Whitespace- or comma-separated list.) Lists services to block
392 from getting host-based referral processing, even if the client
393 marks the server principal as host-based or the service is also
394 listed in **host_based_services**. ``no_host_referral = *`` will
395 disable referral processing altogether.
396
397 **reject_bad_transit**
398 (Boolean value.) If set to true, the KDC will check the list of
399 transited realms for cross-realm tickets against the transit path
400 computed from the realm names and the capaths section of its
401 :ref:`krb5.conf(5)` file; if the path in the ticket to be issued
402 contains any realms not in the computed path, the ticket will not
403 be issued, and an error will be returned to the client instead.
404 If this value is set to false, such tickets will be issued
405 anyways, and it will be left up to the application server to
406 validate the realm transit path.
407
408 If the disable-transited-check flag is set in the incoming
409 request, this check is not performed at all. Having the
410 **reject_bad_transit** option will cause such ticket requests to
411 be rejected always.
412
413 This transit path checking and config file option currently apply
414 only to TGS requests.
415
416 The default value is true.
417
418 **restrict_anonymous_to_tgt**
419 (Boolean value.) If set to true, the KDC will reject ticket
420 requests from anonymous principals to service principals other
421 than the realm's ticket-granting service. This option allows
422 anonymous PKINIT to be enabled for use as FAST armor tickets
423 without allowing anonymous authentication to services. The
424 default value is false. New in release 1.9.
425
426 **spake_preauth_indicator**
427 (String.) Specifies an authentication indicator value that the
428 KDC asserts into tickets obtained using SPAKE pre-authentication.
429 The default is not to add any indicators. This option may be
430 specified multiple times. New in release 1.17.
431
432 **supported_enctypes**
433 (List of *key*:*salt* strings.) Specifies the default key/salt
434 combinations of principals for this realm. Any principals created
435 through :ref:`kadmin(1)` will have keys of these types. The
436 default value for this tag is |defkeysalts|. For lists of
437 possible values, see :ref:`Keysalt_lists`.
438
439
440 .. _dbdefaults:
441
442 [dbdefaults]
443 ~~~~~~~~~~~~
444
445 The [dbdefaults] section specifies default values for some database
446 parameters, to be used if the [dbmodules] subsection does not contain
447 a relation for the tag. See the :ref:`dbmodules` section for the
448 definitions of these relations.
449
450 * **ldap_kerberos_container_dn**
451 * **ldap_kdc_dn**
452 * **ldap_kdc_sasl_authcid**
453 * **ldap_kdc_sasl_authzid**
454 * **ldap_kdc_sasl_mech**
455 * **ldap_kdc_sasl_realm**
456 * **ldap_kadmind_dn**
457 * **ldap_kadmind_sasl_authcid**
458 * **ldap_kadmind_sasl_authzid**
459 * **ldap_kadmind_sasl_mech**
460 * **ldap_kadmind_sasl_realm**
461 * **ldap_service_password_file**
462 * **ldap_conns_per_server**
463
464
465 .. _dbmodules:
466
467 [dbmodules]
468 ~~~~~~~~~~~
469
470 The [dbmodules] section contains parameters used by the KDC database
471 library and database modules. Each tag in the [dbmodules] section is
472 the name of a Kerberos realm or a section name specified by a realm's
473 **database_module** parameter. The following example shows how to
474 define one database parameter for the ATHENA.MIT.EDU realm::
475
476 [dbmodules]
477 ATHENA.MIT.EDU = {
478 disable_last_success = true
479 }
480
481 The following tags may be specified in a [dbmodules] subsection:
482
483 **database_name**
484 This DB2-specific tag indicates the location of the database in
485 the filesystem. The default is |kdcdir|\ ``/principal``.
486
487 **db_library**
488 This tag indicates the name of the loadable database module. The
489 value should be ``db2`` for the DB2 module, ``klmdb`` for the LMDB
490 module, or ``kldap`` for the LDAP module.
491
492 **disable_last_success**
493 If set to ``true``, suppresses KDC updates to the "Last successful
494 authentication" field of principal entries requiring
495 preauthentication. Setting this flag may improve performance.
496 (Principal entries which do not require preauthentication never
497 update the "Last successful authentication" field.). First
498 introduced in release 1.9.
499
500 **disable_lockout**
501 If set to ``true``, suppresses KDC updates to the "Last failed
502 authentication" and "Failed password attempts" fields of principal
503 entries requiring preauthentication. Setting this flag may
504 improve performance, but also disables account lockout. First
505 introduced in release 1.9.
506
507 **ldap_conns_per_server**
508 This LDAP-specific tag indicates the number of connections to be
509 maintained per LDAP server.
510
511 **ldap_kdc_dn** and **ldap_kadmind_dn**
512 These LDAP-specific tags indicate the default DN for binding to
513 the LDAP server. The :ref:`krb5kdc(8)` daemon uses
514 **ldap_kdc_dn**, while the :ref:`kadmind(8)` daemon and other
515 administrative programs use **ldap_kadmind_dn**. The kadmind DN
516 must have the rights to read and write the Kerberos data in the
517 LDAP database. The KDC DN must have the same rights, unless
518 **disable_lockout** and **disable_last_success** are true, in
519 which case it only needs to have rights to read the Kerberos data.
520 These tags are ignored if a SASL mechanism is set with
521 **ldap_kdc_sasl_mech** or **ldap_kadmind_sasl_mech**.
522
523 **ldap_kdc_sasl_mech** and **ldap_kadmind_sasl_mech**
524 These LDAP-specific tags specify the SASL mechanism (such as
525 ``EXTERNAL``) to use when binding to the LDAP server. New in
526 release 1.13.
527
528 **ldap_kdc_sasl_authcid** and **ldap_kadmind_sasl_authcid**
529 These LDAP-specific tags specify the SASL authentication identity
530 to use when binding to the LDAP server. Not all SASL mechanisms
531 require an authentication identity. If the SASL mechanism
532 requires a secret (such as the password for ``DIGEST-MD5``), these
533 tags also determine the name within the
534 **ldap_service_password_file** where the secret is stashed. New
535 in release 1.13.
536
537 **ldap_kdc_sasl_authzid** and **ldap_kadmind_sasl_authzid**
538 These LDAP-specific tags specify the SASL authorization identity
539 to use when binding to the LDAP server. In most circumstances
540 they do not need to be specified. New in release 1.13.
541
542 **ldap_kdc_sasl_realm** and **ldap_kadmind_sasl_realm**
543 These LDAP-specific tags specify the SASL realm to use when
544 binding to the LDAP server. In most circumstances they do not
545 need to be set. New in release 1.13.
546
547 **ldap_kerberos_container_dn**
548 This LDAP-specific tag indicates the DN of the container object
549 where the realm objects will be located.
550
551 **ldap_servers**
552 This LDAP-specific tag indicates the list of LDAP servers that the
553 Kerberos servers can connect to. The list of LDAP servers is
554 whitespace-separated. The LDAP server is specified by a LDAP URI.
555 It is recommended to use ``ldapi:`` or ``ldaps:`` URLs to connect
556 to the LDAP server.
557
558 **ldap_service_password_file**
559 This LDAP-specific tag indicates the file containing the stashed
560 passwords (created by ``kdb5_ldap_util stashsrvpw``) for the
561 **ldap_kdc_dn** and **ldap_kadmind_dn** objects, or for the
562 **ldap_kdc_sasl_authcid** or **ldap_kadmind_sasl_authcid** names
563 for SASL authentication. This file must be kept secure.
564
565 **mapsize**
566 This LMDB-specific tag indicates the maximum size of the two
567 database environments in megabytes. The default value is 128.
568 Increase this value to address "Environment mapsize limit reached"
569 errors. New in release 1.17.
570
571 **max_readers**
572 This LMDB-specific tag indicates the maximum number of concurrent
573 reading processes for the databases. The default value is 128.
574 New in release 1.17.
575
576 **nosync**
577 This LMDB-specific tag can be set to improve the throughput of
578 kadmind and other administrative agents, at the expense of
579 durability (recent database changes may not survive a power outage
580 or other sudden reboot). It does not affect the throughput of the
581 KDC. The default value is false. New in release 1.17.
582
583 **unlockiter**
584 If set to ``true``, this DB2-specific tag causes iteration
585 operations to release the database lock while processing each
586 principal. Setting this flag to ``true`` can prevent extended
587 blocking of KDC or kadmin operations when dumps of large databases
588 are in progress. First introduced in release 1.13.
589
590 The following tag may be specified directly in the [dbmodules]
591 section to control where database modules are loaded from:
592
593 **db_module_dir**
594 This tag controls where the plugin system looks for database
595 modules. The value should be an absolute path.
596
597 .. _logging:
598
599 [logging]
600 ~~~~~~~~~
601
602 The [logging] section indicates how :ref:`krb5kdc(8)` and
603 :ref:`kadmind(8)` perform logging. It may contain the following
604 relations:
605
606 **admin_server**
607 Specifies how :ref:`kadmind(8)` performs logging.
608
609 **kdc**
610 Specifies how :ref:`krb5kdc(8)` performs logging.
611
612 **default**
613 Specifies how either daemon performs logging in the absence of
614 relations specific to the daemon.
615
616 **debug**
617 (Boolean value.) Specifies whether debugging messages are
618 included in log outputs other than SYSLOG. Debugging messages are
619 always included in the system log output because syslog performs
620 its own priority filtering. The default value is false. New in
621 release 1.15.
622
623 Logging specifications may have the following forms:
624
625 **FILE=**\ *filename* or **FILE:**\ *filename*
626 This value causes the daemon's logging messages to go to the
627 *filename*. If the ``=`` form is used, the file is overwritten.
628 If the ``:`` form is used, the file is appended to.
629
630 **STDERR**
631 This value causes the daemon's logging messages to go to its
632 standard error stream.
633
634 **CONSOLE**
635 This value causes the daemon's logging messages to go to the
636 console, if the system supports it.
637
638 **DEVICE=**\ *<devicename>*
639 This causes the daemon's logging messages to go to the specified
640 device.
641
642 **SYSLOG**\ [\ **:**\ *severity*\ [\ **:**\ *facility*\ ]]
643 This causes the daemon's logging messages to go to the system log.
644
645 For backward compatibility, a severity argument may be specified,
646 and must be specified in order to specify a facility. This
647 argument will be ignored.
648
649 The facility argument specifies the facility under which the
650 messages are logged. This may be any of the following facilities
651 supported by the syslog(3) call minus the LOG\_ prefix: **KERN**,
652 **USER**, **MAIL**, **DAEMON**, **AUTH**, **LPR**, **NEWS**,
653 **UUCP**, **CRON**, and **LOCAL0** through **LOCAL7**. If no
654 facility is specified, the default is **AUTH**.
655
656 In the following example, the logging messages from the KDC will go to
657 the console and to the system log under the facility LOG_DAEMON, and
658 the logging messages from the administrative server will be appended
659 to the file ``/var/adm/kadmin.log`` and sent to the device
660 ``/dev/tty04``. ::
661
662 [logging]
663 kdc = CONSOLE
664 kdc = SYSLOG:INFO:DAEMON
665 admin_server = FILE:/var/adm/kadmin.log
666 admin_server = DEVICE=/dev/tty04
667
668 If no logging specification is given, the default is to use syslog.
669 To disable logging entirely, specify ``default = DEVICE=/dev/null``.
670
671
672 .. _otp:
673
674 [otp]
675 ~~~~~
676
677 Each subsection of [otp] is the name of an OTP token type. The tags
678 within the subsection define the configuration required to forward a
679 One Time Password request to a RADIUS server.
680
681 For each token type, the following tags may be specified:
682
683 **server**
684 This is the server to send the RADIUS request to. It can be a
685 hostname with optional port, an ip address with optional port, or
686 a Unix domain socket address. The default is
687 |kdcdir|\ ``/<name>.socket``.
688
689 **secret**
690 This tag indicates a filename (which may be relative to |kdcdir|)
691 containing the secret used to encrypt the RADIUS packets. The
692 secret should appear in the first line of the file by itself;
693 leading and trailing whitespace on the line will be removed. If
694 the value of **server** is a Unix domain socket address, this tag
695 is optional, and an empty secret will be used if it is not
696 specified. Otherwise, this tag is required.
697
698 **timeout**
699 An integer which specifies the time in seconds during which the
700 KDC should attempt to contact the RADIUS server. This tag is the
701 total time across all retries and should be less than the time
702 which an OTP value remains valid for. The default is 5 seconds.
703
704 **retries**
705 This tag specifies the number of retries to make to the RADIUS
706 server. The default is 3 retries (4 tries).
707
708 **strip_realm**
709 If this tag is ``true``, the principal without the realm will be
710 passed to the RADIUS server. Otherwise, the realm will be
711 included. The default value is ``true``.
712
713 **indicator**
714 This tag specifies an authentication indicator to be included in
715 the ticket if this token type is used to authenticate. This
716 option may be specified multiple times. (New in release 1.14.)
717
718 In the following example, requests are sent to a remote server via UDP::
719
720 [otp]
721 MyRemoteTokenType = {
722 server = radius.mydomain.com:1812
723 secret = SEmfiajf42$
724 timeout = 15
725 retries = 5
726 strip_realm = true
727 }
728
729 An implicit default token type named ``DEFAULT`` is defined for when
730 the per-principal configuration does not specify a token type. Its
731 configuration is shown below. You may override this token type to
732 something applicable for your situation::
733
734 [otp]
735 DEFAULT = {
736 strip_realm = false
737 }
738
739 PKINIT options
740 --------------
741
742 .. note::
743
744 The following are pkinit-specific options. These values may
745 be specified in [kdcdefaults] as global defaults, or within
746 a realm-specific subsection of [realms]. Also note that a
747 realm-specific value over-rides, does not add to, a generic
748 [kdcdefaults] specification. The search order is:
749
750 1. realm-specific subsection of [realms]::
751
752 [realms]
753 EXAMPLE.COM = {
754 pkinit_anchors = FILE:/usr/local/example.com.crt
755 }
756
757 2. generic value in the [kdcdefaults] section::
758
759 [kdcdefaults]
760 pkinit_anchors = DIR:/usr/local/generic_trusted_cas/
761
762 For information about the syntax of some of these options, see
763 :ref:`Specifying PKINIT identity information <pkinit_identity>` in
764 :ref:`krb5.conf(5)`.
765
766 **pkinit_anchors**
767 Specifies the location of trusted anchor (root) certificates which
768 the KDC trusts to sign client certificates. This option is
769 required if pkinit is to be supported by the KDC. This option may
770 be specified multiple times.
771
772 **pkinit_dh_min_bits**
773 Specifies the minimum strength of Diffie-Hellman group the KDC is
774 willing to accept for key exchange. Valid values in order of
775 increasing strength are 1024, 2048, P-256, 4096, P-384, and P-521.
776 The default is 2048. (P-256, P-384, and P-521 are new in release
777 1.22.)
778
779 **pkinit_allow_upn**
780 Specifies that the KDC is willing to accept client certificates
781 with the Microsoft UserPrincipalName (UPN) Subject Alternative
782 Name (SAN). This means the KDC accepts the binding of the UPN in
783 the certificate to the Kerberos principal name. The default value
784 is false.
785
786 Without this option, the KDC will only accept certificates with
787 the id-pkinit-san as defined in :rfc:`4556`. There is currently
788 no option to disable SAN checking in the KDC.
789
790 **pkinit_eku_checking**
791 This option specifies what Extended Key Usage (EKU) values the KDC
792 is willing to accept in client certificates. The values
793 recognized in the kdc.conf file are:
794
795 **kpClientAuth**
796 This is the default value and specifies that client
797 certificates must have the id-pkinit-KPClientAuth EKU as
798 defined in :rfc:`4556`.
799
800 **scLogin**
801 If scLogin is specified, client certificates with the
802 Microsoft Smart Card Login EKU (id-ms-kp-sc-logon) will be
803 accepted.
804
805 **none**
806 If none is specified, then client certificates will not be
807 checked to verify they have an acceptable EKU. The use of
808 this option is not recommended.
809
810 **pkinit_identity**
811 Specifies the location of the KDC's X.509 identity information.
812 This option is required if pkinit is to be supported by the KDC.
813
814 **pkinit_indicator**
815 Specifies an authentication indicator to include in the ticket if
816 pkinit is used to authenticate. This option may be specified
817 multiple times. (New in release 1.14.)
818
819 **pkinit_pool**
820 Specifies the location of intermediate certificates which may be
821 used by the KDC to complete the trust chain between a client's
822 certificate and a trusted anchor. This option may be specified
823 multiple times.
824
825 **pkinit_revoke**
826 Specifies the location of Certificate Revocation List (CRL)
827 information to be used by the KDC when verifying the validity of
828 client certificates. This option may be specified multiple times.
829
830 **pkinit_require_crl_checking**
831 The default certificate verification process will always check the
832 available revocation information to see if a certificate has been
833 revoked. If a match is found for the certificate in a CRL,
834 verification fails. If the certificate being verified is not
835 listed in a CRL, or there is no CRL present for its issuing CA,
836 and **pkinit_require_crl_checking** is false, then verification
837 succeeds.
838
839 However, if **pkinit_require_crl_checking** is true and there is
840 no CRL information available for the issuing CA, then verification
841 fails.
842
843 **pkinit_require_crl_checking** should be set to true if the
844 policy is such that up-to-date CRLs must be present for every CA.
845
846 **pkinit_require_freshness**
847 Specifies whether to require clients to include a freshness token
848 in PKINIT requests. The default value is false. (New in release
849 1.17.)
850
851 .. _Encryption_types:
852
853 Encryption types
854 ----------------
855
856 Any tag in the configuration files which requires a list of encryption
857 types can be set to some combination of the following strings.
858 Encryption types marked as "weak" and "deprecated" are available for
859 compatibility but not recommended for use.
860
861 ==================================================== =========================================================
862 des3-cbc-raw Triple DES cbc mode raw (weak)
863 des3-cbc-sha1 des3-hmac-sha1 des3-cbc-sha1-kd Triple DES cbc mode with HMAC/sha1 (deprecated)
864 aes256-cts-hmac-sha1-96 aes256-cts aes256-sha1 AES-256 CTS mode with 96-bit SHA-1 HMAC
865 aes128-cts-hmac-sha1-96 aes128-cts aes128-sha1 AES-128 CTS mode with 96-bit SHA-1 HMAC
866 aes256-cts-hmac-sha384-192 aes256-sha2 AES-256 CTS mode with 192-bit SHA-384 HMAC
867 aes128-cts-hmac-sha256-128 aes128-sha2 AES-128 CTS mode with 128-bit SHA-256 HMAC
868 arcfour-hmac rc4-hmac arcfour-hmac-md5 RC4 with HMAC/MD5 (deprecated)
869 arcfour-hmac-exp rc4-hmac-exp arcfour-hmac-md5-exp Exportable RC4 with HMAC/MD5 (weak)
870 camellia256-cts-cmac camellia256-cts Camellia-256 CTS mode with CMAC
871 camellia128-cts-cmac camellia128-cts Camellia-128 CTS mode with CMAC
872 des3 The triple DES family: des3-cbc-sha1
873 aes The AES family: aes256-cts-hmac-sha1-96, aes128-cts-hmac-sha1-96, aes256-cts-hmac-sha384-192, and aes128-cts-hmac-sha256-128
874 rc4 The RC4 family: arcfour-hmac
875 camellia The Camellia family: camellia256-cts-cmac and camellia128-cts-cmac
876 ==================================================== =========================================================
877
878 The string **DEFAULT** can be used to refer to the default set of
879 types for the variable in question. Types or families can be removed
880 from the current list by prefixing them with a minus sign ("-").
881 Types or families can be prefixed with a plus sign ("+") for symmetry;
882 it has the same meaning as just listing the type or family. For
883 example, "``DEFAULT -rc4``" would be the default set of encryption
884 types with RC4 types removed, and "``des3 DEFAULT``" would be the
885 default set of encryption types with triple DES types moved to the
886 front.
887
888 While **aes128-cts** and **aes256-cts** are supported for all Kerberos
889 operations, they are not supported by very old versions of our GSSAPI
890 implementation (krb5-1.3.1 and earlier). Services running versions of
891 krb5 without AES support must not be given keys of these encryption
892 types in the KDC database.
893
894 The **aes128-sha2** and **aes256-sha2** encryption types are new in
895 release 1.15. Services running versions of krb5 without support for
896 these newer encryption types must not be given keys of these
897 encryption types in the KDC database.
898
899
900 .. _Keysalt_lists:
901
902 Keysalt lists
903 -------------
904
905 Kerberos keys for users are usually derived from passwords. Kerberos
906 commands and configuration parameters that affect generation of keys
907 take lists of enctype-salttype ("keysalt") pairs, known as *keysalt
908 lists*. Each keysalt pair is an enctype name followed by a salttype
909 name, in the format *enc*:*salt*. Individual keysalt list members are
910 separated by comma (",") characters or space characters. For example::
911
912 kadmin -e aes256-cts:normal,aes128-cts:normal
913
914 would start up kadmin so that by default it would generate
915 password-derived keys for the **aes256-cts** and **aes128-cts**
916 encryption types, using a **normal** salt.
917
918 To ensure that people who happen to pick the same password do not have
919 the same key, Kerberos 5 incorporates more information into the key
920 using something called a salt. The supported salt types are as
921 follows:
922
923 ================= ============================================
924 normal default for Kerberos Version 5
925 norealm same as the default, without using realm information
926 onlyrealm uses only realm information as the salt
927 special generate a random salt
928 ================= ============================================
929
930
931 Sample kdc.conf File
932 --------------------
933
934 Here's an example of a kdc.conf file::
935
936 [kdcdefaults]
937 kdc_listen = 88
938 kdc_tcp_listen = 88
939 [realms]
940 ATHENA.MIT.EDU = {
941 kadmind_port = 749
942 max_life = 12h 0m 0s
943 max_renewable_life = 7d 0h 0m 0s
944 master_key_type = aes256-cts-hmac-sha1-96
945 supported_enctypes = aes256-cts-hmac-sha1-96:normal aes128-cts-hmac-sha1-96:normal
946 database_module = openldap_ldapconf
947 }
948
949 [logging]
950 kdc = FILE:/usr/local/var/krb5kdc/kdc.log
951 admin_server = FILE:/usr/local/var/krb5kdc/kadmin.log
952
953 [dbdefaults]
954 ldap_kerberos_container_dn = cn=krbcontainer,dc=mit,dc=edu
955
956 [dbmodules]
957 openldap_ldapconf = {
958 db_library = kldap
959 disable_last_success = true
960 ldap_kdc_dn = "cn=krbadmin,dc=mit,dc=edu"
961 # this object needs to have read rights on
962 # the realm container and principal subtrees
963 ldap_kadmind_dn = "cn=krbadmin,dc=mit,dc=edu"
964 # this object needs to have read and write rights on
965 # the realm container and principal subtrees
966 ldap_service_password_file = /etc/kerberos/service.keyfile
967 ldap_servers = ldaps://kerberos.mit.edu
968 ldap_conns_per_server = 5
969 }
970
971
972 FILES
973 ------
974
975 |kdcdir|\ ``/kdc.conf``
976
977
978 SEE ALSO
979 ---------
980
981 :ref:`krb5.conf(5)`, :ref:`krb5kdc(8)`, :ref:`kadm5.acl(5)`