Debian Codegraph @

lib/krb5/krb5.conf.5

raw ◀ ▶
1 Debian patch touch this file
1 .\" Copyright (c) 1999 - 2005 Kungliga Tekniska Högskolan
2 .\" (Royal Institute of Technology, Stockholm, Sweden).
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\"
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\"
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
15 .\"
16 .\" 3. Neither the name of the Institute nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\" $Id$
33 .\"
34 .Dd May 4, 2005
35 .Dt KRB5.CONF 5
36 .Os HEIMDAL
37 .Sh NAME
38 .Nm krb5.conf
39 .Nd configuration file for Kerberos 5
40 .Sh SYNOPSIS
41 .In krb5.h
42 .Sh DESCRIPTION
43 The
44 .Nm
45 file specifies several configuration parameters for the Kerberos 5
46 library, as well as for some programs.
47 .Pp
48 The file consists of one or more sections, containing a number of
49 bindings.
50 The value of each binding can be either a string or a list of other
51 bindings.
52 The grammar looks like:
53 .Bd -literal -offset indent
54 file:
55 /* empty */
56 sections
•57 includes
58
59 sections:
60 section sections
61 section
62
63 section:
64 '[' section_name ']' bindings
65
66 section_name:
67 STRING
68
69 bindings:
70 binding bindings
71 binding
72
73 binding:
74 name '=' STRING
75 name '=' '{' bindings '}'
76
77 name:
78 STRING
79
•80 includes:
81 'include' path
82 'includedir' path
83
84 path: STRING
85
86 .Ed
87 .Li STRINGs
88 consists of one or more non-whitespace characters.
89 .Pp
•90 Files and directories may be included by absolute path. Including a
91 directory causes all files in the directory to be included as if each
92 file had been included separately, but only files whose names consist of
93 alphanumeric, hyphen, and underscore are included, though they may also
94 end in '.conf'.
95 .Pp
96 STRINGs that are specified later in this man-page uses the following
97 notation.
98 .Bl -tag -width "xxx" -offset indent
99 .It boolean
100 values can be either yes/true or no/false.
101 .It time
102 values can be a list of year, month, day, hour, min, second.
103 Example: 1 month 2 days 30 min.
104 If no unit is given, seconds is assumed.
105 .It etypes
106 valid encryption types are: des-cbc-crc, des-cbc-md4, des-cbc-md5,
107 des3-cbc-sha1, arcfour-hmac-md5, aes128-cts-hmac-sha1-96, and
108 aes256-cts-hmac-sha1-96 .
109 .It address
110 an address can be either a IPv4 or a IPv6 address.
111 .El
112 .Pp
113 Currently recognised sections and bindings are:
114 .Bl -tag -width "xxx" -offset indent
115 .It Li [appdefaults]
116 Specifies the default values to be used for Kerberos applications.
117 You can specify defaults per application, realm, or a combination of
118 these.
119 The preference order is:
120 .Bl -enum -compact
121 .It
122 .Va application Va realm Va option
123 .It
124 .Va application Va option
125 .It
126 .Va realm Va option
127 .It
128 .Va option
129 .El
130 .Pp
131 The supported options are:
132 .Bl -tag -width "xxx" -offset indent
133 .It Li forwardable = Va boolean
134 When obtaining initial credentials, make the credentials forwardable.
135 .It Li proxiable = Va boolean
136 When obtaining initial credentials, make the credentials proxiable.
137 .It Li no-addresses = Va boolean
138 When obtaining initial credentials, request them for an empty set of
139 addresses, making the tickets valid from any address.
140 .It Li ticket_lifetime = Va time
141 Default ticket lifetime.
142 .It Li renew_lifetime = Va time
143 Default renewable ticket lifetime.
144 .It Li encrypt = Va boolean
145 Use encryption, when available.
146 .It Li forward = Va boolean
147 Forward credentials to remote host (for
148 .Xr rsh 1 ,
149 .Xr telnet 1 ,
150 etc).
151 .It Li historical_anon_pkinit = Va boolean
152 Enable legacy anonymous pkinit command-line syntax.
153 With this option set to
154 .Li true,
155 the
156 .Xr kinit 1
157 .Fl Fl anonymous
158 command with no principal argument specified will request an anonymous pkinit
159 ticket from the default realm.
160 If a principal argument is specified, it is used as an explicit realm name for
161 anonymous pkinit even without an
162 .Li @
163 prefix.
164 .El
165 .It Li [libdefaults]
166 .Bl -tag -width "xxx" -offset indent
167 .It Li default_realm = Va REALM
168 Default realm to use, this is also known as your
169 .Dq local realm .
170 The default is the result of
171 .Fn krb5_get_host_realm "local hostname" .
172 .It Li allow_weak_crypto = Va boolean
173 are weak crypto algorithms allowed to be used, among others, DES is
174 considered weak.
175 .It Li clockskew = Va time
176 Maximum time differential (in seconds) allowed when comparing
177 times.
178 Default is 300 seconds (five minutes).
179 .It Li kdc_timeout = Va time
180 Maximum time to wait for a reply from the kdc, default is 3 seconds.
181 .It Li capath = {
182 .Bl -tag -width "xxx" -offset indent
183 .It Va destination-realm Li = Va next-hop-realm
184 .It ...
185 .It Li }
186 .El
187 This is deprecated, see the
188 .Li capaths
189 section below.
190 .It Li default_cc_type = Va cctype
191 sets the default credentials type.
192 .It Li default_cc_name = Va ccname
193 the default credentials cache name.
194 If you want to change the type only use
195 .Li default_cc_type .
196 The string can contain variables that are expanded on runtime.
197 The Only supported variable currently is
198 .Li %{uid}
199 which expands to the current user id.
200 .It Li default_etypes = Va etypes ...
201 A list of default encryption types to use. (Default: all enctypes if
202 allow_weak_crypto = TRUE, else all enctypes except single DES enctypes.)
203 .It Li default_as_etypes = Va etypes ...
204 A list of default encryption types to use in AS requests. (Default: the
205 value of default_etypes.)
206 .It Li default_tgs_etypes = Va etypes ...
207 A list of default encryption types to use in TGS requests. (Default:
208 the value of default_etypes.)
209 .It Li default_etypes_des = Va etypes ...
210 A list of default encryption types to use when requesting a DES credential.
211 .It Li default_keytab_name = Va keytab
212 The keytab to use if no other is specified, default is
213 .Dq FILE:/etc/krb5.keytab .
214 .It Li dns_lookup_kdc = Va boolean
215 Use DNS SRV records to lookup KDC services location.
216 .It Li dns_lookup_realm = Va boolean
217 Use DNS TXT records to lookup domain to realm mappings.
218 .It Li kdc_timesync = Va boolean
219 Try to keep track of the time differential between the local machine
220 and the KDC, and then compensate for that when issuing requests.
221 .It Li max_retries = Va number
222 The max number of times to try to contact each KDC.
223 .It Li large_msg_size = Va number
224 The threshold where protocols with tiny maximum message sizes are not
225 considered usable to send messages to the KDC.
226 .It Li ticket_lifetime = Va time
227 Default ticket lifetime.
228 .It Li renew_lifetime = Va time
229 Default renewable ticket lifetime.
230 .It Li forwardable = Va boolean
231 When obtaining initial credentials, make the credentials forwardable.
232 This option is also valid in the [realms] section.
233 .It Li proxiable = Va boolean
234 When obtaining initial credentials, make the credentials proxiable.
235 This option is also valid in the [realms] section.
236 .It Li verify_ap_req_nofail = Va boolean
237 If enabled, failure to verify credentials against a local key is a
238 fatal error.
239 The application has to be able to read the corresponding service key
240 for this to work.
241 Some applications, like
242 .Xr su 1 ,
243 enable this option unconditionally.
244 .It Li warn_pwexpire = Va time
245 How soon to warn for expiring password.
246 Default is seven days.
247 .It Li http_proxy = Va proxy-spec
248 A HTTP-proxy to use when talking to the KDC via HTTP.
249 .It Li dns_proxy = Va proxy-spec
250 Enable using DNS via HTTP.
251 .It Li extra_addresses = Va address ...
252 A list of addresses to get tickets for along with all local addresses.
253 .It Li time_format = Va string
254 How to print time strings in logs, this string is passed to
255 .Xr strftime 3 .
256 .It Li date_format = Va string
257 How to print date strings in logs, this string is passed to
258 .Xr strftime 3 .
259 .It Li log_utc = Va boolean
260 Write log-entries using UTC instead of your local time zone.
261 .It Li scan_interfaces = Va boolean
262 Scan all network interfaces for addresses, as opposed to simply using
263 the address associated with the system's host name.
264 .It Li fcache_version = Va int
265 Use file credential cache format version specified.
266 .It Li fcc-mit-ticketflags = Va boolean
267 Use MIT compatible format for file credential cache.
268 It's the field ticketflags that is stored in reverse bit order for
269 older than Heimdal 0.7.
270 Setting this flag to
271 .Dv TRUE
272 makes it store the MIT way, this is default for Heimdal 0.7.
273 .It Li check-rd-req-server
274 If set to "ignore", the framework will ignore any of the server input to
275 .Xr krb5_rd_req 3 ,
276 this is very useful when the GSS-API server input the
277 wrong server name into the gss_accept_sec_context call.
278 .It Li k5login_directory = Va directory
279 Alternative location for user .k5login files. This option is provided
280 for compatibility with MIT krb5 configuration files.
281 .It Li k5login_authoritative = Va boolean
282 If true then if a principal is not found in k5login files then
283 .Xr krb5_userok 3
284 will not fallback on principal to username mapping. This option is
285 provided for compatibility with MIT krb5 configuration files.
286 .It Li kuserok = Va rule ...
287 Specifies
288 .Xr krb5_userok 3
289 behavior. If multiple values are given, then
290 .Xr krb5_userok 3
291 will evaluate them in order until one succeeds or all fail. Rules are
292 implemented by plugins, with three built-in plugins
293 described below. Default: USER-K5LOGIN SIMPLE DENY.
294 .It Li kuserok = Va DENY
295 If set and evaluated then
296 .Xr krb5_userok 3
297 will deny access to the given username no matter what the principal name
298 might be.
299 .It Li kuserok = Va SIMPLE
300 If set and evaluated then
301 .Xr krb5_userok 3
302 will use principal to username mapping (see auth_to_local below). If
303 the principal maps to the requested username then access is allowed.
304 .It Li kuserok = Va SYSTEM-K5LOGIN[:directory]
305 If set and evaluated then
306 .Xr krb5_userok 3
307 will use k5login files named after the
308 .Va luser
309 argument to
310 .Xr krb5_userok 3
311 in the given directory or in
312 .Pa /etc/k5login.d/ .
313 K5login files are text files, with each line containing just a principal
314 name; principals apearing in a user's k5login file are permitted access
315 to the user's account. Note: this rule performs no ownership nor
316 permissions checks on k5login files; proper ownership and
317 permissions/ACLs are expected due to the k5login location being a
318 system location.
319 .It Li kuserok = Va USER-K5LOGIN
320 If set and evaluated then
321 .Xr krb5_userok 3
322 will use
323 .Pa ~luser/.k5login
324 and
325 .Pa ~luser/.k5login.d/* .
326 User k5login files and directories must be owned by the user and must
327 not have world nor group write permissions.
328 .It Li aname2lname-text-db = Va filename
329 The named file must be a sorted (in increasing order) text file where
330 every line consists of an unparsed principal name optionally followed by
331 whitespace and a username. The aname2lname function will do a binary
332 search on this file, if configured, looking for lines that match the
333 given principal name, and if found the given username will be used, or,
334 if the username is missing, an error will be returned. If the file
335 doesn't exist, or if no matching line is found then other plugins will
336 be allowed to run.
337 .It Li fcache_strict_checking
338 strict checking in FILE credential caches that owner, no symlink and
339 permissions is correct.
340 .It Li name_canon_rules = Va rules
341 One or more service principal name canonicalization rules. Each rule
342 consists of one or more tokens separated by colon (':'). Currently
343 these rules are used only for hostname canonicalization (usually when
344 getting a service ticket, from a ccache or a TGS, but also when
345 acquiring GSS initiator credentials from a keytab). These rules can be
346 used to implement DNS resolver-like search lists without having to use
347 DNS.
348 .Pp
349 NOTE: Name canonicalization rules are an experimental feature.
350 .Pp
351 The first token is a rule type, one of:
352 .Va as-is,
353 .Va qualify, or
354 .Va nss.
355 .Pp
356 Any remaining tokens must be options tokens:
357 .Va use_fast
358 (use FAST to protect TGS exchanges; currently not supported),
359 .Va use_dnssec
360 (use DNSSEC to protect hostname lookups; currently not supported),
361 .Va ccache_only
362 ,
363 .Va use_referrals,
364 .Va no_referrals,
365 .Va lookup_realm,
366 .Va mindots=N,
367 .Va maxdots=N,
368 .Va order=N,
369 domain=
370 .Va domain,
371 realm=
372 .Va realm,
373 match_domain=
374 .Va domain,
375 and match_realm=
376 .Va realm.
377 .Pp
378 When trying to obtain a service ticket for a host-based service
379 principal name, name canonicalization rules are applied to that name in
380 the order given, one by one, until one succeds (a service ticket is
381 obtained), or all fail. Similarly when acquiring GSS initiator
382 credentials from a keytab, and when comparing a non-canonical GSS name
383 to a canonical one.
384 .Pp
385 For each rule the system checks that the hostname has at least
386 .Va mindots
387 periods (if given) in it, at most
388 .Va maxdots
389 periods (if given), that the hostname ends in the given
390 .Va match_domain
391 (if given),
392 and that the realm of the principal matches the
393 .Va match_realm
394 (if given).
395 .Pp
396 .Va As-is
397 rules leave the hostname unmodified but may set a realm.
398 .Va Qualify
399 rules qualify the hostname with the given
400 .Va domain
401 and also may set the realm.
402 The
403 .Va nss
404 rule uses the system resolver to lookup the host's canonical name and is
405 usually not secure. Note that using the
406 .Va nss
407 rule type implies having to have principal aliases in the HDB (though
408 not necessarily in keytabs).
409 .Pp
410 The empty realm denotes "ask the client's realm's TGS". The empty realm
411 may be set as well as matched.
412 .Pp
413 The order in which rules are applied is as follows: first all the rules
414 with explicit
415 .Va order
416 then all other rules in the order in which they appear. If any two
417 rules have the same explicit
418 .Va order ,
419 their order of appearance in krb5.conf breaks the tie. Explicitly
420 specifying order can be useful where tools read and write the
421 configuration file without preserving parameter order.
422 .Pp
423 Malformed rules are ignored.
424 .It Li allow_hierarchical_capaths = Va boolean
425 When validating cross-realm transit paths, absent any explicit capath from the
426 client realm to the server realm, allow a hierarchical transit path via the
427 common ancestor domain of the two realms.
428 Defaults to true.
429 Note, absent an explicit setting, hierarchical capaths are always used by
430 the KDC when generating a referral to a destination with which is no direct
431 trust.
432 .El
433 .It Li [domain_realm]
434 This is a list of mappings from DNS domain to Kerberos realm.
435 Each binding in this section looks like:
436 .Pp
437 .Dl domain = realm
438 .Pp
439 The domain can be either a full name of a host or a trailing
440 component, in the latter case the domain-string should start with a
441 period.
442 The trailing component only matches hosts that are in the same domain, ie
443 .Dq .example.com
444 matches
445 .Dq foo.example.com ,
446 but not
447 .Dq foo.test.example.com .
448 .Pp
449 The realm may be the token `dns_locate', in which case the actual
450 realm will be determined using DNS (independently of the setting
451 of the `dns_lookup_realm' option).
452 .It Li [realms]
453 .Bl -tag -width "xxx" -offset indent
454 .It Va REALM Li = {
455 .Bl -tag -width "xxx" -offset indent
456 .It Li kdc = Va [service/]host[:port]
457 Specifies a list of kdcs for this realm.
458 If the optional
459 .Va port
460 is absent, the
461 default value for the
462 .Dq kerberos/udp
463 .Dq kerberos/tcp ,
464 and
465 .Dq http/tcp
466 port (depending on service) will be used.
467 The kdcs will be used in the order that they are specified.
468 .Pp
469 The optional
470 .Va service
471 specifies over what medium the kdc should be
472 contacted.
473 Possible services are
474 .Dq udp ,
475 .Dq tcp ,
476 and
477 .Dq http .
478 Http can also be written as
479 .Dq http:// .
480 Default service is
481 .Dq udp
482 and
483 .Dq tcp .
484 .It Li admin_server = Va host[:port]
485 Specifies the admin server for this realm, where all the modifications
486 to the database are performed.
487 .It Li kpasswd_server = Va host[:port]
488 Points to the server where all the password changes are performed.
489 If there is no such entry, the kpasswd port on the admin_server host
490 will be tried.
491 .It Li tgs_require_subkey
492 a boolan variable that defaults to false.
493 Old DCE secd (pre 1.1) might need this to be true.
494 .It Li auth_to_local_names = {
495 .Bl -tag -width "xxx" -offset indent
496 .It Va principal_name = Va username
497 The given
498 .Va principal_name
499 will be mapped to the given
500 .Va username
501 if the
502 .Va REALM
503 is a default realm.
504 .El
505 .It Li }
506 .It Li auth_to_local = HEIMDAL_DEFAULT
507 Use the Heimdal default principal to username mapping.
508 Applies to principals from the
509 .Va REALM
510 if and only if
511 .Va REALM
512 is a default realm.
513 .It Li auth_to_local = DEFAULT
514 Use the MIT default principal to username mapping.
515 Applies to principals from the
516 .Va REALM
517 if and only if
518 .Va REALM
519 is a default realm.
520 .It Li auth_to_local = DB:/path/to/db.txt
521 Use a binary search of the given DB. The DB must be a flat-text
522 file sortedf in the "C" locale, with each record being a line
523 (separated by either LF or CRLF) consisting of a principal name
524 followed by whitespace followed by a username.
525 Applies to principals from the
526 .Va REALM
527 if and only if
528 .Va REALM
529 is a default realm.
530 .It Li auth_to_local = DB:/path/to/db
531 Use the given DB, if there's a plugin for it.
532 Applies to principals from the
533 .Va REALM
534 if and only if
535 .Va REALM
536 is a default realm.
537 .It Li auth_to_local = RULE:...
538 Use the given rule, if there's a plugin for it.
539 Applies to principals from the
540 .Va REALM
541 if and only if
542 .Va REALM
543 is a default realm.
544 .It Li auth_to_local = NONE
545 No additional principal to username mapping is done. Note that
546 .Va auth_to_local_names
547 and any preceding
548 .Va auth_to_local
549 rules have precedence.
550 .El
551 .It Li }
552 .El
553 .It Li [capaths]
554 .Bl -tag -width "xxx" -offset indent
555 .It Va client-realm Li = {
556 .Bl -tag -width "xxx" -offset indent
557 .It Va server-realm Li = Va hop-realm ...
558 This serves two purposes. First the first listed
559 .Va hop-realm
560 tells a client which realm it should contact in order to ultimately
561 obtain credentials for a service in the
562 .Va server-realm .
563 Secondly, it tells the KDC (and other servers) which realms are
564 allowed in a multi-hop traversal from
565 .Va client-realm
566 to
567 .Va server-realm .
568 Except for the client case, the order of the realms are not important.
569 .El
570 .It Va }
571 .El
572 .It Li [logging]
573 .Bl -tag -width "xxx" -offset indent
574 .It Va entity Li = Va destination
575 Specifies that
576 .Va entity
577 should use the specified
578 .Li destination
579 for logging.
580 See the
581 .Xr krb5_openlog 3
582 manual page for a list of defined destinations.
583 .El
584 .It Li [kdc]
585 .Bl -tag -width "xxx" -offset indent
586 .It Li database Li = {
587 .Bl -tag -width "xxx" -offset indent
588 .It Li dbname Li = Va [DATBASETYPE:]DATABASENAME
589 Use this database for this realm. The
590 .Va DATABASETYPE
591 should be one of 'lmdb', 'db3', 'db1', 'db', 'sqlite', or 'ldap'.
592 See the info documetation how to configure different database backends.
593 .It Li realm Li = Va REALM
594 Specifies the realm that will be stored in this database.
595 It realm isn't set, it will used as the default database, there can
596 only be one entry that doesn't have a
597 .Li realm
598 stanza.
599 .It Li mkey_file Li = Pa FILENAME
600 Use this keytab file for the master key of this database.
601 If not specified
602 .Va DATABASENAME Ns .mkey
603 will be used.
604 .It Li acl_file Li = PA FILENAME
605 Use this file for the ACL list of this database.
606 .It Li log_file Li = Pa FILENAME
607 Use this file as the log of changes performed to the database.
608 This file is used by
609 .Nm ipropd-master
610 for propagating changes to slaves. It is also used by
611 .Nm kadmind
612 and
613 .Nm kadmin
614 (when used with the
615 .Li -l
616 option), and by all applications using
617 .Nm libkadm5
618 with the local backend, for two-phase commit functionality. Slaves also
619 use this. Setting this to
620 .Nm /dev/null
621 disables two-phase commit and incremental propagation. Use
622 .Nm iprop-log
623 to show the contents of this log file.
624 .It Li log-max-size = Pa number
625 When the log reaches this size (in bytes), the log will be truncated,
626 saving some entries, and keeping the latest version number so as to not
627 disrupt incremental propagation. If set to a negative value then
628 automatic log truncation will be disabled. Defaults to 52428800 (50MB).
629 .El
630 .It Li }
631 .It Li max-request = Va SIZE
632 Maximum size of a kdc request.
633 .It Li require-preauth = Va BOOL
634 If set pre-authentication is required.
635 .It Li ports = Va "list of ports"
636 List of ports the kdc should listen to.
637 .It Li addresses = Va "list of interfaces"
638 List of addresses the kdc should bind to.
639 .It Li enable-http = Va BOOL
640 Should the kdc answer kdc-requests over http.
641 .It Li tgt-use-strongest-session-key = Va BOOL
642 If this is TRUE then the KDC will prefer the strongest key from the
643 client's AS-REQ or TGS-REQ enctype list for the ticket session key that
644 is supported by the KDC and the target principal when the target
645 principal is a krbtgt principal. Else it will prefer the first key from
646 the client's AS-REQ enctype list that is also supported by the KDC and
647 the target principal. Defaults to FALSE.
648 .It Li svc-use-strongest-session-key = Va BOOL
649 Like tgt-use-strongest-session-key, but applies to the session key
650 enctype of tickets for services other than krbtgt principals. Defaults
651 to FALSE.
652 .It Li preauth-use-strongest-session-key = Va BOOL
653 If TRUE then select the strongest possible enctype from the client's
654 AS-REQ for PA-ETYPE-INFO2 (i.e., for password-based pre-authentication).
655 Else pick the first supported enctype from the client's AS-REQ. Defaults
656 to FALSE.
657 .It Li use-strongest-server-key = Va BOOL
658 If TRUE then the KDC picks, for the ticket encrypted part's key, the
659 first supported enctype from the target service principal's hdb entry's
660 current keyset. Else the KDC picks the first supported enctype from the
661 target service principal's hdb entry's current keyset. Defaults to TRUE.
662 .It Li check-ticket-addresses = Va BOOL
663 Verify the addresses in the tickets used in tgs requests.
664 .\" XXX
665 .It Li allow-null-ticket-addresses = Va BOOL
666 Allow address-less tickets.
667 .\" XXX
668 .It Li allow-anonymous = Va BOOL
669 If the kdc is allowed to hand out anonymous tickets.
670 .It Li historical_anon_realm = Va boolean
671 Enables pre-7.0 non-RFC-comformant KDC behavior.
672 With this option set to
673 .Li true
674 the client realm in anonymous pkinit AS replies will be the requested realm,
675 rather than the RFC-conformant
676 .Li WELLKNOWN:ANONYMOUS
677 realm.
678 This can have a security impact on servers that expect to grant access to
679 anonymous-but-authenticated to the KDC users of the realm in question:
680 they would also grant access to unauthenticated anonymous users.
681 As such, it is not recommend to set this option to
682 .Li true.
683 .It Li encode_as_rep_as_tgs_rep = Va BOOL
684 Encode as-rep as tgs-rep to be compatible with mistakes older DCE secd did.
685 .\" XXX
686 .It Li kdc_warn_pwexpire = Va TIME
687 The time before expiration that the user should be warned that her
688 password is about to expire.
689 .It Li logging = Va Logging
690 What type of logging the kdc should use, see also [logging]/kdc.
691 .It Li hdb-ldap-structural-object Va structural object
692 If the LDAP backend is used for storing principals, this is the
693 structural object that will be used when creating and when reading
694 objects.
695 The default value is account .
696 .It Li hdb-ldap-create-base Va creation dn
697 is the dn that will be appended to the principal when creating entries.
698 Default value is the search dn.
699 .It Li enable-digest = Va BOOL
700 Should the kdc answer digest requests. The default is FALSE.
701 .It Li digests_allowed = Va list of digests
702 Specifies the digests the kdc will reply to. The default is
703 .Li ntlm-v2 .
704 .It Li kx509_ca = Va file
705 Specifies the PEM credentials for the kx509 certification authority.
706 .It Li require_initial_kca_tickets = Va boolean
707 Specified whether to require that tickets for the
708 .Li kca_service
709 service principal be INITIAL.
710 This may be set on a per-realm basis as well as globally.
711 Defaults to true for the global setting.
712 .It Li kx509_include_pkinit_san = Va boolean
713 If true then the kx509 client principal's name and realm will be
714 included in an
715 .Li id-pkinit-san
716 certificate extension.
717 This can be set on a per-realm basis as well as globally.
718 Defaults to true for the global setting.
719 .It Li kx509_template = Va file
720 Specifies the PEM file with a template for the certificates to be
721 issued.
722 The following variables can be interpolated in the subject name using
723 ${variable} syntax:
724 .Bl -tag -width "xxx" -offset indent
725 .It principal-name
726 The full name of the kx509 client principal.
727 .It principal-name-without-realm
728 The full name of the kx509 client principal, excluding the realm name.
729 .It principal-name-realm
730 The name of the client principal's realm.
731 .El
732 .El
733 The
734 .Li kx509 ,
735 .Li kx509_template ,
736 .Li kx509_include_pkinit_san ,
737 and
738 .Li require_initial_kca_tickets
739 parameters may be set on a per-realm basis as well.
740 .It Li [kadmin]
741 .Bl -tag -width "xxx" -offset indent
742 .It Li password_lifetime = Va time
743 If a principal already have its password set for expiration, this is
744 the time it will be valid for after a change.
745 .It Li default_keys = Va keytypes...
746 For each entry in
747 .Va default_keys
748 try to parse it as a sequence of
749 .Va etype:salttype:salt
750 syntax of this if something like:
751 .Pp
752 [(des|des3|etype):](pw-salt|afs3-salt)[:string]
753 .Pp
754 If
755 .Ar etype
756 is omitted it means everything, and if string is omitted it means the
757 default salt string (for that principal and encryption type).
758 Additional special values of keytypes are:
759 .Bl -tag -width "xxx" -offset indent
760 .It Li v5
761 The Kerberos 5 salt
762 .Va pw-salt
763 .El
764 .It Li default_key_rules = Va {
765 .Bl -tag -width "xxx" -offset indent
766 .It Va globing-rule Li = Va keytypes...
767 a globbing rule to matching a principal, and when true, use the
768 keytypes as specified the same format as [kadmin]default_keys .
769 .El
770 .It Li }
771 .It Li prune-key-history = Va BOOL
772 When adding keys to the key history, drop keys that are too old to match
773 unexpired tickets (based on the principal's maximum ticket lifetime).
774 If the KDC keystore is later compromised traffic protected with the
775 discarded older keys may remain protected. This also keeps the HDB
776 records for principals with key history from growing without bound.
777 The default (backwards compatible) value is "false".
778 .It Li use_v4_salt = Va BOOL
779 When true, this is the same as
780 .Pp
781 .Va default_keys = Va des3:pw-salt Va v4
782 .Pp
783 and is only left for backwards compatibility.
784 .It Li [password_quality]
785 Check the Password quality assurance in the info documentation for
786 more information.
787 .Bl -tag -width "xxx" -offset indent
788 .It Li check_library = Va library-name
789 Library name that contains the password check_function
790 .It Li check_function = Va function-name
791 Function name for checking passwords in check_library
792 .It Li policy_libraries = Va library1 ... libraryN
793 List of libraries that can do password policy checks
794 .It Li policies = Va policy1 ... policyN
795 List of policy names to apply to the password. Builtin policies are
796 among other minimum-length, character-class, external-check.
797 .El
798 .El
799 .El
800 .Sh ENVIRONMENT
801 .Ev KRB5_CONFIG
802 points to the configuration file to read.
803 .Sh FILES
804 .Bl -tag -width "/etc/krb5.conf"
805 .It Pa /etc/krb5.conf
806 configuration file for Kerberos 5.
807 .El
808 .Sh EXAMPLES
809 .Bd -literal -offset indent
810 [libdefaults]
811 default_realm = FOO.SE
812 name_canon_rules = as-is:realm=FOO.SE
813 name_canon_rules = qualify:domain=foo.se:realm=FOO.SE
814 name_canon_rules = qualify:domain=bar.se:realm=FOO.SE
815 name_canon_rules = nss
816 [domain_realm]
817 .foo.se = FOO.SE
818 .bar.se = FOO.SE
819 [realms]
820 FOO.SE = {
821 kdc = kerberos.foo.se
822 default_domain = foo.se
823 }
824 [logging]
825 kdc = FILE:/var/heimdal/kdc.log
826 kdc = SYSLOG:INFO
827 default = SYSLOG:INFO:USER
828 [kadmin]
829 default_key_rules = {
830 */ppp@* = arcfour-hmac-md5:pw-salt
831 }
832 .Ed
833 .Sh DIAGNOSTICS
834 Since
835 .Nm
836 is read and parsed by the krb5 library, there is not a lot of
837 opportunities for programs to report parsing errors in any useful
838 format.
839 To help overcome this problem, there is a program
840 .Nm verify_krb5_conf
841 that reads
842 .Nm
843 and tries to emit useful diagnostics from parsing errors.
844 Note that this program does not have any way of knowing what options
845 are actually used and thus cannot warn about unknown or misspelled
846 ones.
847 .Sh SEE ALSO
848 .Xr kinit 1 ,
849 .Xr krb5_openlog 3 ,
850 .Xr strftime 3 ,
851 .Xr verify_krb5_conf 8