1 .\" Copyright (c) 1999 - 2005 Kungliga Tekniska Högskolan
2 .\" (Royal Institute of Technology, Stockholm, Sweden).
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
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.
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.
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
39 .Nd configuration file for Kerberos 5
45 file specifies several configuration parameters for the Kerberos 5
46 library, as well as for some programs.
48 The file consists of one or more sections, containing a number of
50 The value of each binding can be either a string or a list of other
52 The grammar looks like:
53 .Bd -literal -offset indent
64 '[' section_name ']' bindings
75 name '=' '{' bindings '}'
88 consists of one or more non-whitespace characters.
90 Files and directories may be included by absolute path, with percent
91 token expansion (see the TOKEN EXPANSION section). Including a
92 directory causes all files in the directory to be included as if each
93 file had been included separately, but only files whose names consist of
94 alphanumeric, hyphen, and underscore are included, though they may also
97 STRINGs that are specified later in this man-page uses the following
99 .Bl -tag -width "xxx" -offset indent
101 values can be either yes/true or no/false.
103 values can be a list of year, month, day, hour, min, second.
104 Example: 1 month 2 days 30 min.
105 If no unit is given, seconds is assumed.
107 valid encryption types are: des-cbc-crc, des-cbc-md4, des-cbc-md5,
108 des3-cbc-sha1, arcfour-hmac-md5, aes128-cts-hmac-sha1-96, aes256-cts-hmac-sha1-96,
109 aes128-cts-hmac-sha256-128, and aes256-cts-hmac-sha384-192.
111 an address can be either a IPv4 or a IPv6 address.
114 Currently recognised sections and bindings are:
115 .Bl -tag -width "xxx" -offset indent
117 Specifies the default values to be used for Kerberos applications.
118 You can specify defaults per application, realm, or a combination of
120 The preference order is:
123 .Va application Va realm Va option
125 .Va application Va option
132 The supported options are:
133 .Bl -tag -width "xxx" -offset indent
134 .It Li forwardable = Va boolean
135 When obtaining initial credentials, make the credentials forwardable.
136 .It Li proxiable = Va boolean
137 When obtaining initial credentials, make the credentials proxiable.
138 .It Li no-addresses = Va boolean
139 When obtaining initial credentials, request them for an empty set of
140 addresses, making the tickets valid from any address.
141 .It Li ticket_lifetime = Va time
142 Default ticket lifetime.
143 .It Li renew_lifetime = Va time
144 Default renewable ticket lifetime.
145 .It Li encrypt = Va boolean
146 Use encryption, when available.
147 .It Li forward = Va boolean
148 Forward credentials to remote host (for
152 .It Li historical_anon_pkinit = Va boolean
153 Enable legacy anonymous pkinit command-line syntax.
154 With this option set to
159 command with no principal argument specified will request an anonymous pkinit
160 ticket from the default realm.
161 If a principal argument is specified, it is used as an explicit realm name for
162 anonymous pkinit even without an
165 .It Li delegate-destination-tgt = Va boolean
166 When forwarding credentials to a remote host, forward a TGT for the
167 realm of the destination host rather than a TGT for the user's realm.
168 This is useful when hosts in the remote realm should not or cannot
169 (e.g. firewalled from user realm's KDC) obtain tickets for services
170 in the user's realm. When the user's realm and the host's realm are
171 the same, this parameter has no effect. The setting can be applied
172 to a single realm as follows:
173 .Bd -literal -offset indent
175 delegate-destination-tgt = true
178 .It Li pkinit_pool = Va HX509-STORE
179 This is a multi-valued parameter naming one or more stores of
180 intermediate certification authority (CA) certificates for the
181 client's end entity certificate.
182 .It Li pkinit_anchors = Va HX509-STORE ...
183 This is a multi-valued parameter naming one or more stores of
184 anchors for PKINIT KDC certificates.
185 .It Li pkinit_revoke = Va HX509-STORE ...
186 This is a multi-valued parameter naming one or more stores of
187 of CRLs for the issuers of PKINIT KDC certificates.
188 If no CRLs are configured, then CRLs will not be checked.
189 This is because hx509 currently lacks support.
192 .Bl -tag -width "xxx" -offset indent
193 .It Li default_realm = Va REALM
194 Default realm to use, this is also known as your
196 The default is the result of
197 .Fn krb5_get_host_realm "local hostname" .
198 .It Li allow_weak_crypto = Va boolean
199 are weak crypto algorithms allowed to be used, among others, DES is
201 .It Li clockskew = Va time
202 Maximum time differential (in seconds) allowed when comparing
204 Default is 300 seconds (five minutes).
205 .It Li kdc_timeout = Va time
206 Maximum time to wait for a reply from the kdc, default is 3 seconds.
208 .Bl -tag -width "xxx" -offset indent
209 .It Va destination-realm Li = Va next-hop-realm
213 This is deprecated, see the
216 .It Li default_cc_type = Va cctype
217 sets the default credentials type.
218 .It Li default_cc_name = Va ccname
219 the default credentials cache name.
220 If you want to change the type only use
221 .Li default_cc_type .
222 The string can contain variables that are expanded at runtime. See the TOKEN
224 .It Li default_file_cache_collections = Va FILE:/path/with/tokens ...
225 This multi-valued parameter allows more than one path to be
226 configured for the FILE credentials cache type to look in. The FILE
227 credentials cache type will also consider file names whose prefixes
228 match these and end in
230 as subsidiary caches in the collection. The values of this
231 parameter are subject to token expansion. See the TOKEN EXPANSION
233 .It Li enable_file_cache_iteration = Va boolean
236 credential cache type will support iteration of all subsidiary
237 caches in the default collection, meaning that
240 option will list them. This does require scanning the directory
243 ccache, which, if it is
245 may be a slow operation. Defaults to false.
246 .It Li default_etypes = Va etypes ...
247 A list of default encryption types to use. (Default: all enctypes if
248 allow_weak_crypto = TRUE, else all enctypes except single DES enctypes.)
249 .It Li default_as_etypes = Va etypes ...
250 A list of default encryption types to use in AS requests. (Default: the
251 value of default_etypes.)
252 .It Li default_tgs_etypes = Va etypes ...
253 A list of default encryption types to use in TGS requests. (Default:
254 the value of default_etypes.)
255 .It Li default_etypes_des = Va etypes ...
256 A list of default encryption types to use when requesting a DES credential.
257 .It Li default_keytab_name = Va keytab
258 The keytab to use if no other is specified, default is
259 .Dq FILE:/etc/krb5.keytab .
260 .It Li default_client_keytab_name = Va keytab
261 The keytab to use for client credential acquisition if no other is
262 specified, default is
263 .Dq FILE:%{LOCALSTATEDIR}/user/%{euid}/client.keytab .
264 See the TOKEN EXPANSION section.
265 .It Li dns_lookup_kdc = Va boolean
266 Use DNS SRV records to lookup KDC services location.
267 .It Li dns_lookup_realm = Va boolean
268 Use DNS TXT records to lookup domain to realm mappings.
269 .It Li enforce_ok_as_delegate = Va boolean
270 If this flag to true, GSSAPI credential delegation will be
273 flag is not set in the service ticket.
274 If this flag is false, the
276 ticket flag is only enforced when an application specifically
277 requests enforcement.
278 The default value is false.
279 .It Li kdc_timesync = Va boolean
280 Try to keep track of the time differential between the local machine
281 and the KDC, and then compensate for that when issuing requests.
282 .It Li max_retries = Va number
283 The max number of times to try to contact each KDC.
284 .It Li large_msg_size = Va number
285 The threshold where protocols with tiny maximum message sizes are not
286 considered usable to send messages to the KDC.
287 .It Li ticket_lifetime = Va time
288 Default ticket lifetime.
289 .It Li renew_lifetime = Va time
290 Default renewable ticket lifetime.
291 .It Li forwardable = Va boolean
292 When obtaining initial credentials, make the credentials forwardable.
293 This option is also valid in the [realms] section.
294 .It Li proxiable = Va boolean
295 When obtaining initial credentials, make the credentials proxiable.
296 This option is also valid in the [realms] section.
297 .It Li verify_ap_req_nofail = Va boolean
298 If enabled, failure to verify credentials against a local key is a
300 The application has to be able to read the corresponding service key
302 Some applications, like
304 enable this option unconditionally.
305 .It Li warn_pwexpire = Va time
306 How soon to warn for expiring password.
307 Default is seven days.
308 .It Li http_proxy = Va proxy-spec
309 A HTTP-proxy to use when talking to the KDC via HTTP.
310 .It Li dns_proxy = Va proxy-spec
311 Enable using DNS via HTTP.
312 .It Li extra_addresses = Va address ...
313 A list of addresses to get tickets for along with all local addresses.
314 .It Li time_format = Va string
315 How to print time strings in logs, this string is passed to
317 .It Li date_format = Va string
318 How to print date strings in logs, this string is passed to
320 .It Li log_utc = Va boolean
321 Write log-entries using UTC instead of your local time zone.
322 .It Li scan_interfaces = Va boolean
323 Scan all network interfaces for addresses, as opposed to simply using
324 the address associated with the system's host name.
325 .It Li fcache_version = Va int
326 Use file credential cache format version specified.
327 .It Li fcc-mit-ticketflags = Va boolean
328 Use MIT compatible format for file credential cache.
329 It's the field ticketflags that is stored in reverse bit order for
330 older than Heimdal 0.7.
333 makes it store the MIT way, this is default for Heimdal 0.7.
334 .It Li check-rd-req-server
335 If set to "ignore", the framework will ignore any of the server input to
337 this is very useful when the GSS-API server input the
338 wrong server name into the gss_accept_sec_context call.
339 .It Li k5login_directory = Va directory
340 Alternative location for user .k5login files. This option is provided
341 for compatibility with MIT krb5 configuration files. This path is
342 subject to percent token expansion (see TOKEN EXPANSION).
343 .It Li k5login_authoritative = Va boolean
344 If true then if a principal is not found in k5login files then
346 will not fallback on principal to username mapping. This option is
347 provided for compatibility with MIT krb5 configuration files.
348 .It Li kuserok = Va rule ...
351 behavior. If multiple values are given, then
353 will evaluate them in order until one succeeds or all fail. Rules are
354 implemented by plugins, with three built-in plugins
355 described below. Default: USER-K5LOGIN SIMPLE DENY.
356 .It Li kuserok = Va DENY
357 If set and evaluated then
359 will deny access to the given username no matter what the principal name
361 .It Li kuserok = Va SIMPLE
362 If set and evaluated then
364 will use principal to username mapping (see auth_to_local below). If
365 the principal maps to the requested username then access is allowed.
366 .It Li kuserok = Va SYSTEM-K5LOGIN[:directory]
367 If set and evaluated then
369 will use k5login files named after the
373 in the given directory or in
374 .Pa /etc/k5login.d/ .
375 K5login files are text files, with each line containing just a principal
376 name; principals apearing in a user's k5login file are permitted access
377 to the user's account. Note: this rule performs no ownership nor
378 permissions checks on k5login files; proper ownership and
379 permissions/ACLs are expected due to the k5login location being a
381 .It Li kuserok = Va USER-K5LOGIN
382 If set and evaluated then
387 .Pa ~luser/.k5login.d/* .
388 User k5login files and directories must be owned by the user and must
389 not have world nor group write permissions.
390 .It Li aname2lname-text-db = Va filename
391 The named file must be a sorted (in increasing order) text file where
392 every line consists of an unparsed principal name optionally followed by
393 whitespace and a username. The aname2lname function will do a binary
394 search on this file, if configured, looking for lines that match the
395 given principal name, and if found the given username will be used, or,
396 if the username is missing, an error will be returned. If the file
397 doesn't exist, or if no matching line is found then other plugins will
399 .It Li fcache_strict_checking
400 strict checking in FILE credential caches that owner, no symlink and
401 permissions is correct.
402 .It Li moduli = Va FILE
403 Names a file that contains acceptable modular Diffie-Hellman
405 The given file should contain lines with whitespace-separated
406 fields in this order:
407 .Va name, nbits, p, g, q .
408 Lines starting with a
411 .It Li pkinit_dh_min_bits = Va NUMBER
412 PKINIT client's minimum acceptable modular Diffie-Hellman public
414 .It Li enable-kx509 = Va boolean
415 Enable use of kx509 so that every TGT that can has a corresponding
416 PKIX certificate. Default: false.
417 .It Li kx509_gen_key_type = Va public-key-type
418 Type of public key for kx509 private key generation. Defaults to
423 .It Li kx509_gen_rsa_key_size = Va number-of-bits
424 RSA key size for kx509. Defaults to 2048.
425 .It Li kx509_store = path
426 A file path into which to write a certificate obtained with
427 kx509, and its private key, when attempting kx509 optimistically
428 using credentials from a default ccache. Tokens will be
430 .It Li kx509_hostname = Va hostname
431 If set, then the kx509 client will use this hostname for the
432 kx509 service. This can also be set in the
434 section on a per-realm basis. If not set then a TGS name will be
436 .It Li name_canon_rules = Va rules
437 One or more service principal name canonicalization rules. Each rule
438 consists of one or more tokens separated by colon (':'). Currently
439 these rules are used only for hostname canonicalization (usually when
440 getting a service ticket, from a ccache or a TGS, but also when
441 acquiring GSS initiator credentials from a keytab). These rules can be
442 used to implement DNS resolver-like search lists without having to use
445 NOTE: Name canonicalization rules are an experimental feature.
447 The first token is a rule type, one of:
452 Any remaining tokens must be options tokens:
454 (use FAST to protect TGS exchanges; currently not supported),
456 (use DNSSEC to protect hostname lookups; currently not supported),
474 When trying to obtain a service ticket for a host-based service
475 principal name, name canonicalization rules are applied to that name in
476 the order given, one by one, until one succeds (a service ticket is
477 obtained), or all fail. Similarly when acquiring GSS initiator
478 credentials from a keytab, and when comparing a non-canonical GSS name
481 For each rule the system checks that the hostname has at least
483 periods (if given) in it, at most
485 periods (if given), that the hostname ends in the given
488 and that the realm of the principal matches the
493 rules leave the hostname unmodified but may set a realm.
495 rules qualify the hostname with the given
497 and also may set the realm.
500 rule uses the system resolver to lookup the host's canonical name and is
501 usually not secure. Note that using the
503 rule type implies having to have principal aliases in the HDB (though
504 not necessarily in keytabs).
506 The empty realm denotes "ask the client's realm's TGS". The empty realm
507 may be set as well as matched.
509 The order in which rules are applied is as follows: first all the rules
512 then all other rules in the order in which they appear. If any two
513 rules have the same explicit
515 their order of appearance in krb5.conf breaks the tie. Explicitly
516 specifying order can be useful where tools read and write the
517 configuration file without preserving parameter order.
519 Malformed rules are ignored.
520 .It Li allow_hierarchical_capaths = Va boolean
521 When validating cross-realm transit paths, absent any explicit capath from the
522 client realm to the server realm, allow a hierarchical transit path via the
523 common ancestor domain of the two realms.
525 Note, absent an explicit setting, hierarchical capaths are always used by
526 the KDC when generating a referral to a destination with which is no direct
528 .It Li client_aware_channel_bindings = Va boolean
529 If this flag is true, then all application protocol authentication
530 requests will be flagged to indicate that the application supports
531 channel bindings when operating over a secure channel.
532 The default value is false.
533 .It Li check_pac = Va boolean
534 If this flag is true and a Windows Privilege Attribute Certificate (PAC)
535 is present in the ticket authorization data, then
537 will validate the PAC before returning success. The default value is true.
538 .It Li report_canonical_client_name = Va boolean
539 If this flag is true, then the canonical client name from the PAC will
540 be used instead of the client name in the ticket. The default value is false.
541 Note that setting it to true implicitly sets
545 .It Li [domain_realm]
546 This is a list of mappings from DNS domain to Kerberos realm.
548 It is used by the client and the TGS both to determine the realm
549 of host-based service principal names based on the principal's
552 The client may try DNS to determine a host's realm; see the
553 `dns_lookup_realm' parameter, and see below.
555 The TGS will issue a referral when a host-based service does not
556 exist in the requested realm but can be mapped with these rules
557 to a different realm.
558 The TGS will also issue a referral when a host-based service
559 exists in the requested realm as an alias of a service in another
562 Each binding in this section looks like:
566 The domain can be either a full name of a host or a trailing
567 component, in the latter case the domain-string should start with a
569 The trailing component only matches hosts that are in the same domain, ie
572 .Dq foo.example.com ,
574 .Dq foo.test.example.com .
576 The realm may be the token `dns_locate', in which case the actual
577 realm will be determined using DNS (independently of the setting
578 of the `dns_lookup_realm' option).
580 .Bl -tag -width "xxx" -offset indent
582 .Bl -tag -width "xxx" -offset indent
583 .It Li kdc = Va [service/]host[:port]
584 Specifies a list of kdcs for this realm.
588 default value for the
593 port (depending on service) will be used.
594 The kdcs will be used in the order that they are specified.
598 specifies over what medium the kdc should be
600 Possible services are
605 Http can also be written as
611 .It Li admin_server = Va host[:port]
612 Specifies the admin server for this realm, where all the modifications
613 to the database are performed.
614 .It Li kpasswd_server = Va host[:port]
615 Points to the server where all the password changes are performed.
616 If there is no such entry, the kpasswd port on the admin_server host
618 .It Li tgs_require_subkey
619 a boolan variable that defaults to false.
620 Old DCE secd (pre 1.1) might need this to be true.
621 .It Li auth_to_local_names = {
622 .Bl -tag -width "xxx" -offset indent
623 .It Va principal_name = Va username
626 will be mapped to the given
633 .It Li auth_to_local = HEIMDAL_DEFAULT
634 Use the Heimdal default principal to username mapping.
635 Applies to principals from the
640 .It Li auth_to_local = DEFAULT
641 Use the MIT default principal to username mapping.
642 Applies to principals from the
647 .It Li auth_to_local = DB:/path/to/db.txt
648 Use a binary search of the given DB. The DB must be a flat-text
649 file sortedf in the "C" locale, with each record being a line
650 (separated by either LF or CRLF) consisting of a principal name
651 followed by whitespace followed by a username.
652 Applies to principals from the
657 .It Li auth_to_local = DB:/path/to/db
658 Use the given DB, if there's a plugin for it.
659 Applies to principals from the
664 .It Li auth_to_local = RULE:...
665 Use the given rule, if there's a plugin for it.
666 Applies to principals from the
671 .It Li auth_to_local = NONE
672 No additional principal to username mapping is done. Note that
673 .Va auth_to_local_names
676 rules have precedence.
677 .It Li pkinit_require_eku = BOOL
680 then the KDC PKINIT Extended Key Usage (EKU) OID (1.3.6.5.2.3.5)
681 must be present in KDCs' PKINIT certificates.
684 .It Li pkinit_require_krbtgt_otherName = BOOL
687 then the PKINIT Subject Alternative Name (SAN) for the TGS must
688 be present in KDCs' PKINIT certificates, and must match their
692 .It Li pkinit_require_hostname_match = BOOL
695 then KDCs' PKINIT certificates must match their hostnames.
698 .It Li pkinit_trustedCertifiers = BOOL
701 then PKINIT client will tell KDCs which trust anchors it trusts.
704 .It Li disable_pac = BOOL
707 then the KDC will not sign tickets with PAC, which disables S4U2Proxy support.
714 .Bl -tag -width "xxx" -offset indent
715 .It Va client-realm Li = {
716 .Bl -tag -width "xxx" -offset indent
717 .It Va server-realm Li = Va hop-realm ...
718 This serves two purposes. First the first listed
720 tells a client which realm it should contact in order to ultimately
721 obtain credentials for a service in the
723 Secondly, it tells the KDC (and other servers) which realms are
724 allowed in a multi-hop traversal from
728 Except for the client case, the order of the realms are not important.
733 .Bl -tag -width "xxx" -offset indent
734 .It Va entity Li = Va destination
737 should use the specified
742 manual page for a list of defined destinations.
745 .Bl -tag -width "xxx" -offset indent
746 .It Li database Li = {
747 .Bl -tag -width "xxx" -offset indent
748 .It Li dbname Li = Va [DATBASETYPE:]DATABASENAME
749 Use this database for this realm. The
751 should be one of 'lmdb', 'db3', 'db1', 'db', 'sqlite', or 'ldap'.
752 See the info documetation how to configure different database backends.
753 .It Li realm Li = Va REALM
754 Specifies the realm that will be stored in this database.
755 It realm isn't set, it will used as the default database, there can
756 only be one entry that doesn't have a
759 .It Li mkey_file Li = Pa FILENAME
760 Use this keytab file for the master key of this database.
762 .Va DATABASENAME Ns .mkey
764 .It Li acl_file Li = PA FILENAME
765 Use this file for the ACL list of this database.
766 .It Li log_file Li = Pa FILENAME
767 Use this file as the log of changes performed to the database.
770 for propagating changes to slaves. It is also used by
776 option), and by all applications using
778 with the local backend, for two-phase commit functionality. Slaves also
779 use this. Setting this to
781 disables two-phase commit and incremental propagation. Use
783 to show the contents of this log file.
784 .It Li log-max-size = Pa number
785 When the log reaches this size (in bytes), the log will be truncated,
786 saving some entries, and keeping the latest version number so as to not
787 disrupt incremental propagation. If set to a negative value then
788 automatic log truncation will be disabled. Defaults to 52428800 (50MB).
791 .It Li max-request = Va SIZE
792 Maximum size of a kdc request.
793 .It Li require-preauth = Va BOOL
794 If set pre-authentication is required.
795 .It Li ports = Va "list of ports"
796 List of ports the kdc should listen to.
797 .It Li addresses = Va "list of interfaces"
798 List of addresses the kdc should bind to.
799 .It Li enable-http = Va BOOL
800 Should the kdc answer kdc-requests over http.
801 .It Li tgt-use-strongest-session-key = Va BOOL
802 If this is TRUE then the KDC will prefer the strongest key from the
803 client's AS-REQ or TGS-REQ enctype list for the ticket session key that
804 is supported by the KDC and the target principal when the target
805 principal is a krbtgt principal. Else it will prefer the first key from
806 the client's AS-REQ enctype list that is also supported by the KDC and
807 the target principal. Defaults to FALSE.
808 .It Li svc-use-strongest-session-key = Va BOOL
809 Like tgt-use-strongest-session-key, but applies to the session key
810 enctype of tickets for services other than krbtgt principals. Defaults
812 .It Li preauth-use-strongest-session-key = Va BOOL
813 If TRUE then select the strongest possible enctype from the client's
814 AS-REQ for PA-ETYPE-INFO2 (i.e., for password-based pre-authentication).
815 Else pick the first supported enctype from the client's AS-REQ. Defaults
817 .It Li use-strongest-server-key = Va BOOL
818 If TRUE then the KDC picks, for the ticket encrypted part's key, the
819 first supported enctype from the target service principal's hdb entry's
820 current keyset. Else the KDC picks the first supported enctype from the
821 target service principal's hdb entry's current keyset. Defaults to TRUE.
822 .It Li check-ticket-addresses = Va BOOL
823 Verify the addresses in the tickets used in tgs requests.
825 .It Li warn_ticket_addresses = Va BOOL
826 Warn about, but allow, usage of tickets from hosts that don't match the
827 addresses in the tickets.
828 .It Li allow-null-ticket-addresses = Va BOOL
829 Allow address-less tickets.
831 .It Li enable_fast = Va BOOL
832 Enable RFC 6113 FAST support, this is enabled by default.
833 .It Li enable_armored_pa_enc_timestamp = Va BOOL
834 Enable armored encrypted timestamp pre-authentication with key
836 RFC 6113 says not to use PA-ENC-TIMESTAMP in FAST armored tunnels
837 as there is a newer replacement, PA-ENC-CHALLENGE, but for
838 interoperability with earlier versions of Heimdal, this is
839 enabled by default for now.
840 .It Li enable_unarmored_pa_enc_timestamp = Va BOOL
841 Enable unarmored encrypted timestamp pre-authentication.
842 Enabled by default for now, but in a future release will be
844 .It Li enable-pkinit = Va BOOL
845 Enable PKINIT (disabled by default).
846 .It Li allow-anonymous = Va BOOL
847 If the kdc is allowed to hand out anonymous tickets.
848 .It Li synthetic_clients = Va BOOL
849 If enabled then the KDC will issue tickets for clients that don't
850 exist in the HDB provided that they use PKINIT, that PKINIT is
851 enabled, and that the client's have certificates with PKINIT
852 subject alternative names (SANs).
853 .It Li synthetic_clients_max_life = Va TIME
854 Maximum ticket lifetime for synthetic clients.
856 .It Li synthetic_clients_max_renew = Va TIME
857 Maximum ticket renewable lifetime for synthetic clients.
859 .It Li pkinit_identity = Va HX509-STORE
860 This is an HX509 store containing the KDC's PKINIT credential
861 (private key and end-entity certificate).
862 This is single valued, though multiple stores can be specified by
863 separating them with commas.
871 .Va FILE, Va PEM-FILE, Va DER-FILE, Va PKCS12, Va PKCS11,
879 .Va FILE, Va PEM-FILE, Va DER-FILE,
885 See the Heimdal hx509 documentation for more information.
886 .It Li pkinit_pool = Va HX509-STORE
887 This is a multi-valued parameter naming one or more stores of
888 intermediate certification authority (CA) certificates for the
889 KDC's end entity certificate.
890 .It Li pkinit_anchors = Va HX509-STORE ...
891 This is a multi-valued parameter naming one or more stores of
892 anchors for PKINIT client certificates.
897 is also supported here.
899 type stores are OpenSSL-style CA certificate hash directories.
900 .It Li pkinit_revoke = Va HX509-STORE ...
901 This is a multi-valued parameter naming one or more stores of
902 of CRLs for the issuers of PKINIT client certificates.
903 If no CRLs are configured, then CRLs will not be checked.
904 This is because the KDC will not dereference CRL distribution
905 points nor request OCSP responses.
906 .It Li pkinit_kdc_ocsp = Va PATH
907 This names a file whose contents is the DER encoding of an
908 OCSPResponse for the KDC's end entity certificate.
909 .It Li pkinit_kdc_friendly_name = Va NAME
910 This is an optional friendly name of the KDC's end entity
912 This is only helpful when the
914 store contains many credentials.
915 .It Li pkinit_principal_in_certificate = Va BOOL
918 then the KDC will match AS-REQ client principal names to the
920 .Va subjectAlternativeName
921 values from the clients' certificates.
924 .It Li pkinit_dh_min_bits = Va NUMBER
925 Minimum acceptable modular Diffie-Hellman public key size in
927 .It Li pkinit_max_life_from_cert_extension = Va BOOL
930 then the KDC will override the
932 attribute of the client principal's HDB record with a maximum
933 ticket life taken from a certificate extension with OID
934 .Va { iso(1) member-body(2) se(752) su(43) heim-pkix(16) 4 }
935 and the DER encoding of an
938 Alternatively, if the extended key usage OID
939 .Va { iso(1) member-body(2) se(752) su(43) heim-pkix(16) 3 }
940 is included in the client's certificate, then the
942 minus the current time will be used.
943 .It Li pkinit_max_life_bound = Va TIME
944 If set, this will be a hard bound on the maximum ticket lifetime
945 taken from the client's certificate.
948 can be given as a number followed by a unit, such as
952 .It Li pkinit_max_life_from_cert = Va TIME
953 If set, this will override the
955 attribute of the client principal's HDB record with the
957 of the client's certificate minus the current time, bounded to
961 .Li pkinit_max_life_from_cert_extension
962 parameter is set and the client's certificate has that extension.
965 can be given as a number followed by a unit, such as
969 .It Li enable_gss_preauth = Va boolean
970 Enables pre-authentication using a GSS-API mechanism supported by the client and KDC.
971 The GSS-API initiator and AS request client names must match, unless the
972 .Li WELLKNOWN/FEDERATED
973 name was used in the AS request, in which case the AS reply will contain the
974 GSS-API initiator name. Authorization and mapping behavior may be customized
975 by plugins. If synthetic clients are enabled, then the GSS-API initiator need
976 not exist in the local database. GSS-API pre-authentication is disabled by
978 .It Li enable_gss_auth_data = Va boolean
979 When using GSS-API pre-authentication, includes a Kerberos authorization data
980 element containing naming attributes associated with the GSS-API initiator. This
981 is disabled by default as it may significantly increase the size of returned
983 .It Li gss_mechanisms_allowed = Va mechs ...
984 A list of GSS-API mechanisms that may be used for GSS-API pre-authentication.
985 .It Li gss_cross_realm_mechanisms_allowed = Va mechs ...
986 A list of GSS-API mechanisms that, when using the default authorization
987 mechanism, will be permitted to map Kerberos principals in foreign realms. The
988 list is empty by default. Initiator names from mechanisms not on this list will
989 be mapped to an enterprise principal in the AS-REQ realm. This option is
990 intended to avoid conflating GSS-API pre-authentication and Kerberos
991 cross-realm authentication. The behavior is provided by the default
992 authorization mechanism and will be overridden by an authorization plugin.
993 Mechanisms may be identified by dot-separated OID or a short name.
994 .It Li historical_anon_realm = Va boolean
995 Enables pre-7.0 non-RFC-comformant KDC behavior.
996 With this option set to
998 the client realm in anonymous pkinit AS replies will be the requested realm,
999 rather than the RFC-conformant
1000 .Li WELLKNOWN:ANONYMOUS
1002 This can have a security impact on servers that expect to grant access to
1003 anonymous-but-authenticated to the KDC users of the realm in question:
1004 they would also grant access to unauthenticated anonymous users.
1005 As such, it is not recommend to set this option to
1007 .It Li encode_as_rep_as_tgs_rep = Va BOOL
1008 Encode as-rep as tgs-rep to be compatible with mistakes older DCE secd did.
1010 .It Li kdc_warn_pwexpire = Va TIME
1011 The time before expiration that the user should be warned that her
1012 password is about to expire.
1013 .It Li logging = Va Logging
1014 What type of logging the kdc should use, see also [logging]/kdc.
1015 .It Li hdb-ldap-structural-object Va structural object
1016 If the LDAP backend is used for storing principals, this is the
1017 structural object that will be used when creating and when reading
1019 The default value is account .
1020 .It Li hdb-ldap-create-base Va creation dn
1021 is the dn that will be appended to the principal when creating entries.
1022 Default value is the search dn.
1023 .It Li enable-digest = Va BOOL
1024 Should the kdc answer digest requests. The default is FALSE.
1025 .It Li digests_allowed = Va list of digests
1026 Specifies the digests the kdc will reply to. The default is
1028 .It Li enable-kx509 = Va boolean
1029 Enables kx509 service.
1031 The kx509 service is configurable for a number of cases:
1032 .Bl -tag -width "" -offset indent
1033 .It Li default certificates for user or service principals,
1034 .It Li non-default certificate requests including subject alternative names (SAN) and extended key usage (EKU) certificate extensions, for either client, server, or mixed usage.
1037 Distinct configurations are supported for all of these cases as
1039 .Bd -literal -offset indent
1041 enable-kx509 = yes | no
1042 require_csr = yes | no
1043 require_initial_kca_tickets = yes | no
1050 hostbased_service = {
1062 .Bl -tag -width "xxx" -offset indent
1064 for default certificates for user principals,
1066 for default certificates for root user principals,
1068 for default certificates for admin user principals,
1069 .It Li hostbased_service
1070 for default certificates for host-based service principals, in which case the
1071 service name is used as shown above,
1073 for non-default client certificates,
1075 for non-default server certificates,
1077 for non-default client and server certificates.
1079 and where the parameters are as follows:
1080 .Bl -tag -width "xxx" -offset indent
1082 Specifies the PEM credentials for the kx509 / bx509d certification
1084 If not specified for any specific use-case, then that use-case
1086 .It Li max_cert_lifetime = Va NUMunit
1087 Specifies the maximum certificate lifetime as a decimal number
1088 and an optional unit (the default unit is
1091 .It Li force_cert_lifetime = Va NUMunit
1092 Specifies a minimum certificate lifetime as a decimal number and
1093 an optional unit (the default unit is
1096 .It Li allow_extra_lifetime = Va boolean
1097 Indicates whether a client may request longer lifetimes than
1098 their authentication credentials.
1100 .It Li require_initial_kca_tickets = Va boolean
1101 Specified whether to require that tickets for the
1103 service principal be INITIAL.
1104 This may be set on a per-realm basis as well as globally.
1105 Defaults to true for the global setting.
1106 .It Li include_pkinit_san = Va boolean
1107 If true then the kx509 client principal's name and realm will be
1110 subject alternative name certificate extension.
1111 This can be set on a per-realm basis as well as globally.
1112 Defaults to true for the global setting.
1113 .It Li email_domain = Va domain
1114 If set then the kx509 client user principal's name at the given
1115 domain will be included in an
1117 subject alternative name certificate extension.
1118 This can be set on a per-realm basis as well as globally.
1119 Defaults to false for the global setting.
1120 .It Li include_dnsname_san = Va boolean
1121 If true then a kx509 host-based or domain-based client
1122 principal's hostname will be included in an
1124 subject alternative name certificate extension, with the
1125 downcased realm as the domainname. This can be set on a
1126 per-realm basis as well as
1127 globally. Defaults to false for the global setting.
1128 .It Li ekus = Va OID
1129 List of OIDs to include as EKUs.
1130 .It Li subject_name = Va DN
1131 Specifies a subject name that should either be empty or contain
1132 variable interpolation as described below for
1134 The subject may be the empty string, causing the issued
1135 certificates' subject names to be empty.
1136 .It Li template_cert = Va store
1137 Specifies the hx509 store (e.g.,
1140 for the certificates to be issued to kx509 clients whose
1141 principal names have one component (i.e., are user principals).
1142 A template is a certificate with variables to be interpolated in
1143 the subjectName. The following variables can be interpolated in
1144 the subject name using
1147 .Bl -tag -width "xxx" -offset indent
1149 The full name of the kx509 client principal.
1150 .It principal-name-without-realm
1151 The full name of the kx509 client principal, excluding the realm name.
1152 .It principal-name-realm
1153 The name of the client principal's realm.
1154 .It principal-component0
1155 The first component of the client principal.
1156 .It principal-component1
1157 The second component of the client principal.
1158 .It principal-component2
1159 The third component of the client principal.
1160 .It principal-service-name
1161 The name of the service.
1162 .It principal-host-name
1163 The name of the host.
1166 If a template and subject name are not specified and no default
1167 SANs are configured, then no certificate will be issued.
1168 Otherwise if a template and subject name are not specified, then
1169 subject of the certificate will be empty.
1174 .Bl -tag -width "xxx" -offset indent
1175 .It Li db-dir = Va path
1176 This parameter defines a directory that can contain:
1177 .Bl -tag -width "xxx" -offset indent
1179 A configuration file with the same format as krb5.conf that will
1182 The master key file.
1184 The default logfile for the KDC when a logfile is not specified in
1187 The access controls for
1190 The (binary) log of transactions used for
1199 The default PKINIT mapping file if one is not specified in
1200 .Va [kdc] pkinit_mappings_file .
1202 and other files related to
1205 .It Li new_service_key_delay = Va time
1206 Sets a bias such that new keys are not taken into service until
1207 after the given time has passed since they were set.
1208 This is useful for key rotation on concrete principals shared by
1209 multiple instances of an application: set this time to twice or
1210 more the keytab fetch period used by applications.
1211 .It Li enable_virtual_hostbased_princs = Va boolean
1212 Heimdal supports a notion of virtual host-based service
1213 principals whose keys are derived from those of a base namespace
1214 principal of the form
1215 .Nm WELLKNOWN/HOSTBASED-NAMESPACE/svc/hostname .
1216 The service name can be wild-carded as
1218 Non-wildcarded services have to be listed in the
1219 .Li virtual_hostbased_princ_svcs
1220 parameter (see below).
1221 This parameter enables this feature, which is disabled by
1223 .It Li virtual_hostbased_princ_ndots = Va Integer
1224 Minimum number of label-separating periods in virtual host-based
1225 service principals' hostname component.
1226 .It Li virtual_hostbased_princ_maxdots = Va Integer
1227 Maximum number of label-separating periods in namespaces'
1229 .It Li virtual_hostbased_princ_svcs = Va service-name
1230 This multi-valued parameter lists service names not to wildcard
1231 when searching for a namespace for a virtual host-based service
1233 Other service names will have keys derived from a matching
1234 namespace with a wild-carded service name.
1235 This allows one to have different attributes for different
1239 service can be configured to have the ok-as-delegate flag while
1244 This section contains online certification authority configuration, much
1249 section, but with the
1252 .Bd -literal -offset indent
1261 .Bl -tag -width "xxx" -offset indent
1262 .It Li no_addresses = Va BOOL
1269 service will issue address-less TGTs.
1276 service will include the client's IP address in the TGT it issues
1280 .It Li allow_addresses = Va BOOL
1287 service will add arbitrary addresses requested by clients to the
1288 TGTs it issues them.
1293 Certification authority related parameters are as for
1296 .Bl -tag -width "xxx" -offset indent
1297 .It Li password_lifetime = Va time
1298 If a principal already have its password set for expiration, this is
1299 the time it will be valid for after a change.
1300 .It Li default_keys = Va keytypes...
1303 try to parse it as a sequence of
1304 .Va etype:salttype:salt
1305 syntax of this if something like:
1307 [(des|des3|etype):](pw-salt|afs3-salt)[:string]
1311 is omitted it means everything, and if string is omitted it means the
1312 default salt string (for that principal and encryption type).
1313 Additional special values of keytypes are:
1314 .Bl -tag -width "xxx" -offset indent
1319 .It Li default_key_rules = Va {
1320 .Bl -tag -width "xxx" -offset indent
1321 .It Va globing-rule Li = Va keytypes...
1322 a globbing rule to matching a principal, and when true, use the
1323 keytypes as specified the same format as [kadmin]default_keys .
1326 .It Li prune-key-history = Va BOOL
1327 When adding keys to the key history, drop keys that are too old to match
1328 unexpired tickets (based on the principal's maximum ticket lifetime).
1329 If the KDC keystore is later compromised traffic protected with the
1330 discarded older keys may remain protected. This also keeps the HDB
1331 records for principals with key history from growing without bound.
1332 The default (backwards compatible) value is "false".
1333 .It Li use_v4_salt = Va BOOL
1334 When true, this is the same as
1336 .Va default_keys = Va des3:pw-salt Va v4
1338 and is only left for backwards compatibility.
1339 .It Li [password_quality]
1340 Check the Password quality assurance in the info documentation for
1342 .Bl -tag -width "xxx" -offset indent
1343 .It Li check_library = Va library-name
1344 Library name that contains the password check_function
1345 .It Li check_function = Va function-name
1346 Function name for checking passwords in check_library
1347 .It Li policy_libraries = Va library1 ... libraryN
1348 List of libraries that can do password policy checks
1349 .It Li policies = Va policy1 ... policyN
1350 List of policy names to apply to the password. Builtin policies are
1351 among other minimum-length, character-class, external-check.
1356 The values of some parameters are subject to percent token expansion.
1357 Expansions supported on all platforms:
1358 .Bl -tag -width "xxx" -offset indent
1360 The install location of Heimdal libraries.
1362 The install location of Heimdal user programs.
1364 The install location of Heimdal services.
1366 The install location of Heimdal admin programs.
1368 The current username.
1370 A temporary directory.
1372 The current user's SID (Windows) or effective user ID (POSIX).
1374 The current user's SID (Windows) or real user ID (POSIX). On POSIX it is best
1377 token instead (see below).
1382 Expansions supported on POSIX-like platforms:
1383 .Bl -tag -width "xxx" -offset indent
1385 The current effective user ID.
1387 The username of the logged-in user for this terminal.
1388 .It %{LOCALSTATEDIR}
1389 The install location of Heimdal databases.
1392 On Windows, several additional tokens can also be expanded:
1393 .Bl -tag -width "xxx" -offset indent
1395 Roaming application data (for current user).
1396 .It %{COMMON_APPDATA}
1397 Application data (all users).
1398 .It %{LOCAL_APPDATA}
1399 Local application data (for current user).
1401 Windows System folder.
1405 Per user Heimdal configuration file path.
1407 Common Heimdal configuration file path.
1411 points to the configuration file to read.
1413 .Bl -tag -width "/etc/krb5.conf"
1414 .It Pa /etc/krb5.conf
1415 configuration file for Kerberos 5.
1418 .Bd -literal -offset indent
1420 default_realm = FOO.SE
1421 name_canon_rules = as-is:realm=FOO.SE
1422 name_canon_rules = qualify:domain=foo.se:realm=FOO.SE
1423 name_canon_rules = qualify:domain=bar.se:realm=FOO.SE
1424 name_canon_rules = nss
1430 kdc = kerberos.foo.se
1431 default_domain = foo.se
1434 kdc = FILE:/var/heimdal/kdc.log
1436 default = SYSLOG:INFO:USER
1438 default_key_rules = {
1439 */ppp@* = arcfour-hmac-md5:pw-salt
1445 is read and parsed by the krb5 library, there is not a lot of
1446 opportunities for programs to report parsing errors in any useful
1448 To help overcome this problem, there is a program
1449 .Nm verify_krb5_conf
1452 and tries to emit useful diagnostics from parsing errors.
1453 Note that this program does not have any way of knowing what options
1454 are actually used and thus cannot warn about unknown or misspelled
1458 .Xr krb5_openlog 3 ,
1460 .Xr verify_krb5_conf 8