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
180 .Bl -tag -width "xxx" -offset indent
181 .It Li default_realm = Va REALM
182 Default realm to use, this is also known as your
184 The default is the result of
185 .Fn krb5_get_host_realm "local hostname" .
186 .It Li allow_weak_crypto = Va boolean
187 are weak crypto algorithms allowed to be used, among others, DES is
189 .It Li clockskew = Va time
190 Maximum time differential (in seconds) allowed when comparing
192 Default is 300 seconds (five minutes).
193 .It Li kdc_timeout = Va time
194 Maximum time to wait for a reply from the kdc, default is 3 seconds.
196 .Bl -tag -width "xxx" -offset indent
197 .It Va destination-realm Li = Va next-hop-realm
201 This is deprecated, see the
204 .It Li default_cc_type = Va cctype
205 sets the default credentials type.
206 .It Li default_cc_name = Va ccname
207 the default credentials cache name.
208 If you want to change the type only use
209 .Li default_cc_type .
210 The string can contain variables that are expanded at runtime. See the TOKEN
212 .It Li default_file_cache_collections = Va FILE:/path/with/tokens ...
213 This multi-valued parameter allows more than one path to be
214 configured for the FILE credentials cache type to look in. The FILE
215 credentials cache type will also consider file names whose prefixes
216 match these and end in
218 as subsidiary caches in the collection. The values of this
219 parameter are subject to token expansion. See the TOKEN EXPANSION
221 .It Li enable_file_cache_iteration = Va boolean
224 credential cache type will support iteration of all subsidiary
225 caches in the default collection, meaning that
228 option will list them. This does require scanning the directory
231 ccache, which, if it is
233 may be a slow operation. Defaults to false.
234 .It Li default_etypes = Va etypes ...
235 A list of default encryption types to use. (Default: all enctypes if
236 allow_weak_crypto = TRUE, else all enctypes except single DES enctypes.)
237 .It Li default_as_etypes = Va etypes ...
238 A list of default encryption types to use in AS requests. (Default: the
239 value of default_etypes.)
240 .It Li default_tgs_etypes = Va etypes ...
241 A list of default encryption types to use in TGS requests. (Default:
242 the value of default_etypes.)
243 .It Li default_etypes_des = Va etypes ...
244 A list of default encryption types to use when requesting a DES credential.
245 .It Li default_keytab_name = Va keytab
246 The keytab to use if no other is specified, default is
247 .Dq FILE:/etc/krb5.keytab .
248 .It Li default_client_keytab_name = Va keytab
249 The keytab to use for client credential acquisition if no other is
250 specified, default is
251 .Dq FILE:%{LOCALSTATEDIR}/user/%{euid}/client.keytab .
252 See the TOKEN EXPANSION section.
253 .It Li dns_lookup_kdc = Va boolean
254 Use DNS SRV records to lookup KDC services location.
255 .It Li dns_lookup_realm = Va boolean
256 Use DNS TXT records to lookup domain to realm mappings.
257 .It Li enforce_ok_as_delegate = Va boolean
258 If this flag to true, GSSAPI credential delegation will be
261 flag is not set in the service ticket.
262 If this flag is false, the
264 ticket flag is only enforced when an application specifically
265 requests enforcement.
266 The default value is false.
267 .It Li kdc_timesync = Va boolean
268 Try to keep track of the time differential between the local machine
269 and the KDC, and then compensate for that when issuing requests.
270 .It Li max_retries = Va number
271 The max number of times to try to contact each KDC.
272 .It Li large_msg_size = Va number
273 The threshold where protocols with tiny maximum message sizes are not
274 considered usable to send messages to the KDC.
275 .It Li ticket_lifetime = Va time
276 Default ticket lifetime.
277 .It Li renew_lifetime = Va time
278 Default renewable ticket lifetime.
279 .It Li forwardable = Va boolean
280 When obtaining initial credentials, make the credentials forwardable.
281 This option is also valid in the [realms] section.
282 .It Li proxiable = Va boolean
283 When obtaining initial credentials, make the credentials proxiable.
284 This option is also valid in the [realms] section.
285 .It Li verify_ap_req_nofail = Va boolean
286 If enabled, failure to verify credentials against a local key is a
288 The application has to be able to read the corresponding service key
290 Some applications, like
292 enable this option unconditionally.
293 .It Li warn_pwexpire = Va time
294 How soon to warn for expiring password.
295 Default is seven days.
296 .It Li http_proxy = Va proxy-spec
297 A HTTP-proxy to use when talking to the KDC via HTTP.
298 .It Li dns_proxy = Va proxy-spec
299 Enable using DNS via HTTP.
300 .It Li extra_addresses = Va address ...
301 A list of addresses to get tickets for along with all local addresses.
302 .It Li time_format = Va string
303 How to print time strings in logs, this string is passed to
305 .It Li date_format = Va string
306 How to print date strings in logs, this string is passed to
308 .It Li log_utc = Va boolean
309 Write log-entries using UTC instead of your local time zone.
310 .It Li scan_interfaces = Va boolean
311 Scan all network interfaces for addresses, as opposed to simply using
312 the address associated with the system's host name.
313 .It Li fcache_version = Va int
314 Use file credential cache format version specified.
315 .It Li fcc-mit-ticketflags = Va boolean
316 Use MIT compatible format for file credential cache.
317 It's the field ticketflags that is stored in reverse bit order for
318 older than Heimdal 0.7.
321 makes it store the MIT way, this is default for Heimdal 0.7.
322 .It Li check-rd-req-server
323 If set to "ignore", the framework will ignore any of the server input to
325 this is very useful when the GSS-API server input the
326 wrong server name into the gss_accept_sec_context call.
327 .It Li k5login_directory = Va directory
328 Alternative location for user .k5login files. This option is provided
329 for compatibility with MIT krb5 configuration files. This path is
330 subject to percent token expansion (see TOKEN EXPANSION).
331 .It Li k5login_authoritative = Va boolean
332 If true then if a principal is not found in k5login files then
334 will not fallback on principal to username mapping. This option is
335 provided for compatibility with MIT krb5 configuration files.
336 .It Li kuserok = Va rule ...
339 behavior. If multiple values are given, then
341 will evaluate them in order until one succeeds or all fail. Rules are
342 implemented by plugins, with three built-in plugins
343 described below. Default: USER-K5LOGIN SIMPLE DENY.
344 .It Li kuserok = Va DENY
345 If set and evaluated then
347 will deny access to the given username no matter what the principal name
349 .It Li kuserok = Va SIMPLE
350 If set and evaluated then
352 will use principal to username mapping (see auth_to_local below). If
353 the principal maps to the requested username then access is allowed.
354 .It Li kuserok = Va SYSTEM-K5LOGIN[:directory]
355 If set and evaluated then
357 will use k5login files named after the
361 in the given directory or in
362 .Pa /etc/k5login.d/ .
363 K5login files are text files, with each line containing just a principal
364 name; principals apearing in a user's k5login file are permitted access
365 to the user's account. Note: this rule performs no ownership nor
366 permissions checks on k5login files; proper ownership and
367 permissions/ACLs are expected due to the k5login location being a
369 .It Li kuserok = Va USER-K5LOGIN
370 If set and evaluated then
375 .Pa ~luser/.k5login.d/* .
376 User k5login files and directories must be owned by the user and must
377 not have world nor group write permissions.
378 .It Li aname2lname-text-db = Va filename
379 The named file must be a sorted (in increasing order) text file where
380 every line consists of an unparsed principal name optionally followed by
381 whitespace and a username. The aname2lname function will do a binary
382 search on this file, if configured, looking for lines that match the
383 given principal name, and if found the given username will be used, or,
384 if the username is missing, an error will be returned. If the file
385 doesn't exist, or if no matching line is found then other plugins will
387 .It Li fcache_strict_checking
388 strict checking in FILE credential caches that owner, no symlink and
389 permissions is correct.
390 .It Li moduli = Va FILE
391 Names a file that contains acceptable modular Diffie-Hellman
393 The given file should contain lines with whitespace-separated
394 fields in this order:
395 .Va name, nbits, p, g, q .
396 Lines starting with a
399 .It Li pkinit_dh_min_bits = Va NUMBER
400 PKINIT client's minimum acceptable modular Diffie-Hellman public
402 .It Li enable-kx509 = Va boolean
403 Enable use of kx509 so that every TGT that can has a corresponding
404 PKIX certificate. Default: false.
405 .It Li kx509_gen_key_type = Va public-key-type
406 Type of public key for kx509 private key generation. Defaults to
411 .It Li kx509_gen_rsa_key_size = Va number-of-bits
412 RSA key size for kx509. Defaults to 2048.
413 .It Li kx509_store = path
414 A file path into which to write a certificate obtained with
415 kx509, and its private key, when attempting kx509 optimistically
416 using credentials from a default ccache. Tokens will be
418 .It Li kx509_hostname = Va hostname
419 If set, then the kx509 client will use this hostname for the
420 kx509 service. This can also be set in the
422 section on a per-realm basis. If not set then a TGS name will be
424 .It Li name_canon_rules = Va rules
425 One or more service principal name canonicalization rules. Each rule
426 consists of one or more tokens separated by colon (':'). Currently
427 these rules are used only for hostname canonicalization (usually when
428 getting a service ticket, from a ccache or a TGS, but also when
429 acquiring GSS initiator credentials from a keytab). These rules can be
430 used to implement DNS resolver-like search lists without having to use
433 NOTE: Name canonicalization rules are an experimental feature.
435 The first token is a rule type, one of:
440 Any remaining tokens must be options tokens:
442 (use FAST to protect TGS exchanges; currently not supported),
444 (use DNSSEC to protect hostname lookups; currently not supported),
462 When trying to obtain a service ticket for a host-based service
463 principal name, name canonicalization rules are applied to that name in
464 the order given, one by one, until one succeds (a service ticket is
465 obtained), or all fail. Similarly when acquiring GSS initiator
466 credentials from a keytab, and when comparing a non-canonical GSS name
469 For each rule the system checks that the hostname has at least
471 periods (if given) in it, at most
473 periods (if given), that the hostname ends in the given
476 and that the realm of the principal matches the
481 rules leave the hostname unmodified but may set a realm.
483 rules qualify the hostname with the given
485 and also may set the realm.
488 rule uses the system resolver to lookup the host's canonical name and is
489 usually not secure. Note that using the
491 rule type implies having to have principal aliases in the HDB (though
492 not necessarily in keytabs).
494 The empty realm denotes "ask the client's realm's TGS". The empty realm
495 may be set as well as matched.
497 The order in which rules are applied is as follows: first all the rules
500 then all other rules in the order in which they appear. If any two
501 rules have the same explicit
503 their order of appearance in krb5.conf breaks the tie. Explicitly
504 specifying order can be useful where tools read and write the
505 configuration file without preserving parameter order.
507 Malformed rules are ignored.
508 .It Li allow_hierarchical_capaths = Va boolean
509 When validating cross-realm transit paths, absent any explicit capath from the
510 client realm to the server realm, allow a hierarchical transit path via the
511 common ancestor domain of the two realms.
513 Note, absent an explicit setting, hierarchical capaths are always used by
514 the KDC when generating a referral to a destination with which is no direct
516 .It Li client_aware_channel_bindings = Va boolean
517 If this flag is true, then all application protocol authentication
518 requests will be flagged to indicate that the application supports
519 channel bindings when operating over a secure channel.
520 The default value is false.
522 .It Li [domain_realm]
523 This is a list of mappings from DNS domain to Kerberos realm.
525 It is used by the client and the TGS both to determine the realm
526 of host-based service principal names based on the principal's
529 The client may try DNS to determine a host's realm; see the
530 `dns_lookup_realm' parameter, and see below.
532 The TGS will issue a referral when a host-based service does not
533 exist in the requested realm but can be mapped with these rules
534 to a different realm.
535 The TGS will also issue a referral when a host-based service
536 exists in the requested realm as an alias of a service in another
539 Each binding in this section looks like:
543 The domain can be either a full name of a host or a trailing
544 component, in the latter case the domain-string should start with a
546 The trailing component only matches hosts that are in the same domain, ie
549 .Dq foo.example.com ,
551 .Dq foo.test.example.com .
553 The realm may be the token `dns_locate', in which case the actual
554 realm will be determined using DNS (independently of the setting
555 of the `dns_lookup_realm' option).
557 .Bl -tag -width "xxx" -offset indent
559 .Bl -tag -width "xxx" -offset indent
560 .It Li kdc = Va [service/]host[:port]
561 Specifies a list of kdcs for this realm.
565 default value for the
570 port (depending on service) will be used.
571 The kdcs will be used in the order that they are specified.
575 specifies over what medium the kdc should be
577 Possible services are
582 Http can also be written as
588 .It Li admin_server = Va host[:port]
589 Specifies the admin server for this realm, where all the modifications
590 to the database are performed.
591 .It Li kpasswd_server = Va host[:port]
592 Points to the server where all the password changes are performed.
593 If there is no such entry, the kpasswd port on the admin_server host
595 .It Li tgs_require_subkey
596 a boolan variable that defaults to false.
597 Old DCE secd (pre 1.1) might need this to be true.
598 .It Li auth_to_local_names = {
599 .Bl -tag -width "xxx" -offset indent
600 .It Va principal_name = Va username
603 will be mapped to the given
610 .It Li auth_to_local = HEIMDAL_DEFAULT
611 Use the Heimdal default principal to username mapping.
612 Applies to principals from the
617 .It Li auth_to_local = DEFAULT
618 Use the MIT default principal to username mapping.
619 Applies to principals from the
624 .It Li auth_to_local = DB:/path/to/db.txt
625 Use a binary search of the given DB. The DB must be a flat-text
626 file sortedf in the "C" locale, with each record being a line
627 (separated by either LF or CRLF) consisting of a principal name
628 followed by whitespace followed by a username.
629 Applies to principals from the
634 .It Li auth_to_local = DB:/path/to/db
635 Use the given DB, if there's a plugin for it.
636 Applies to principals from the
641 .It Li auth_to_local = RULE:...
642 Use the given rule, if there's a plugin for it.
643 Applies to principals from the
648 .It Li auth_to_local = NONE
649 No additional principal to username mapping is done. Note that
650 .Va auth_to_local_names
653 rules have precedence.
654 .It Li pkinit_require_eku = BOOL
657 then the KDC PKINIT Extended Key Usage (EKU) OID (1.3.6.5.2.3.5)
658 must be present in KDCs' PKINIT certificates.
661 .It Li pkinit_require_krbtgt_otherName = BOOL
664 then the PKINIT Subject Alternative Name (SAN) for the TGS must
665 be present in KDCs' PKINIT certificates, and must match their
669 .It Li pkinit_require_hostname_match = BOOL
672 then KDCs' PKINIT certificates must match their hostnames.
675 .It Li pkinit_trustedCertifiers = BOOL
678 then PKINIT client will tell KDCs which trust anchors it trusts.
681 .It Li disable_pac = BOOL
684 then the KDC will not sign tickets with PAC, which disables S4U2Proxy support.
691 .Bl -tag -width "xxx" -offset indent
692 .It Va client-realm Li = {
693 .Bl -tag -width "xxx" -offset indent
694 .It Va server-realm Li = Va hop-realm ...
695 This serves two purposes. First the first listed
697 tells a client which realm it should contact in order to ultimately
698 obtain credentials for a service in the
700 Secondly, it tells the KDC (and other servers) which realms are
701 allowed in a multi-hop traversal from
705 Except for the client case, the order of the realms are not important.
710 .Bl -tag -width "xxx" -offset indent
711 .It Va entity Li = Va destination
714 should use the specified
719 manual page for a list of defined destinations.
722 .Bl -tag -width "xxx" -offset indent
723 .It Li database Li = {
724 .Bl -tag -width "xxx" -offset indent
725 .It Li dbname Li = Va [DATBASETYPE:]DATABASENAME
726 Use this database for this realm. The
728 should be one of 'lmdb', 'db3', 'db1', 'db', 'sqlite', or 'ldap'.
729 See the info documetation how to configure different database backends.
730 .It Li realm Li = Va REALM
731 Specifies the realm that will be stored in this database.
732 It realm isn't set, it will used as the default database, there can
733 only be one entry that doesn't have a
736 .It Li mkey_file Li = Pa FILENAME
737 Use this keytab file for the master key of this database.
739 .Va DATABASENAME Ns .mkey
741 .It Li acl_file Li = PA FILENAME
742 Use this file for the ACL list of this database.
743 .It Li log_file Li = Pa FILENAME
744 Use this file as the log of changes performed to the database.
747 for propagating changes to slaves. It is also used by
753 option), and by all applications using
755 with the local backend, for two-phase commit functionality. Slaves also
756 use this. Setting this to
758 disables two-phase commit and incremental propagation. Use
760 to show the contents of this log file.
761 .It Li log-max-size = Pa number
762 When the log reaches this size (in bytes), the log will be truncated,
763 saving some entries, and keeping the latest version number so as to not
764 disrupt incremental propagation. If set to a negative value then
765 automatic log truncation will be disabled. Defaults to 52428800 (50MB).
768 .It Li max-request = Va SIZE
769 Maximum size of a kdc request.
770 .It Li require-preauth = Va BOOL
771 If set pre-authentication is required.
772 .It Li ports = Va "list of ports"
773 List of ports the kdc should listen to.
774 .It Li addresses = Va "list of interfaces"
775 List of addresses the kdc should bind to.
776 .It Li enable-http = Va BOOL
777 Should the kdc answer kdc-requests over http.
778 .It Li tgt-use-strongest-session-key = Va BOOL
779 If this is TRUE then the KDC will prefer the strongest key from the
780 client's AS-REQ or TGS-REQ enctype list for the ticket session key that
781 is supported by the KDC and the target principal when the target
782 principal is a krbtgt principal. Else it will prefer the first key from
783 the client's AS-REQ enctype list that is also supported by the KDC and
784 the target principal. Defaults to FALSE.
785 .It Li svc-use-strongest-session-key = Va BOOL
786 Like tgt-use-strongest-session-key, but applies to the session key
787 enctype of tickets for services other than krbtgt principals. Defaults
789 .It Li preauth-use-strongest-session-key = Va BOOL
790 If TRUE then select the strongest possible enctype from the client's
791 AS-REQ for PA-ETYPE-INFO2 (i.e., for password-based pre-authentication).
792 Else pick the first supported enctype from the client's AS-REQ. Defaults
794 .It Li use-strongest-server-key = Va BOOL
795 If TRUE then the KDC picks, for the ticket encrypted part's key, the
796 first supported enctype from the target service principal's hdb entry's
797 current keyset. Else the KDC picks the first supported enctype from the
798 target service principal's hdb entry's current keyset. Defaults to TRUE.
799 .It Li check-ticket-addresses = Va BOOL
800 Verify the addresses in the tickets used in tgs requests.
802 .It Li warn_ticket_addresses = Va BOOL
803 Warn about, but allow, usage of tickets from hosts that don't match the
804 addresses in the tickets.
805 .It Li allow-null-ticket-addresses = Va BOOL
806 Allow address-less tickets.
808 .It Li enable_armored_pa_enc_timestamp = Va BOOL
809 Enable armored encrypted timestamp pre-authentication with key
811 RFC 6113 says not to use PA-ENC-TIMESTAMP in FAST armored tunnels
812 as there is a newer replacement, PA-ENC-CHALLENGE, but for
813 interoperability with earlier versions of Heimdal, this is
814 enabled by default for now.
815 .It Li enable_unarmored_pa_enc_timestamp = Va BOOL
816 Enable unarmored encrypted timestamp pre-authentication.
817 Enabled by default for now, but in a future release will be
819 .It Li allow-anonymous = Va BOOL
820 If the kdc is allowed to hand out anonymous tickets.
821 .It Li synthetic_clients = Va BOOL
822 If enabled then the KDC will issue tickets for clients that don't
823 exist in the HDB provided that they use PKINIT, that PKINIT is
824 enabled, and that the client's have certificates with PKINIT
825 subject alternative names (SANs).
826 .It Li synthetic_clients_max_life = Va TIME
827 Maximum ticket lifetime for synthetic clients.
829 .It Li synthetic_clients_max_renew = Va TIME
830 Maximum ticket renewable lifetime for synthetic clients.
832 .It Li pkinit_identity = Va HX509-STORE
833 This is an HX509 store containing the KDC's PKINIT credential
834 (private key and end-entity certificate).
835 This is single valued, though multiple stores can be specified by
836 separating them with commas.
844 .Va FILE, Va PEM-FILE, Va DER-FILE, Va PKCS12, Va PKCS11,
852 .Va FILE, Va PEM-FILE, Va DER-FILE,
858 See the Heimdal hx509 documentation for more information.
859 .It Li pkinit_pool = Va HX509-STORE
860 This is a multi-valued parameter naming one or more stores of
861 intermediate certification authority (CA) certificates for the
862 KDC's end entity certificate.
863 .It Li pkinit_anchors = Va HX509-STORE
864 This is a multi-valued parameter naming one or more stores of
865 anchors for PKINIT client certificates.
870 is also supported here.
872 type stores are OpenSSL-style CA certificate hash directories.
873 .It Li pkinit_kdc_ocsp = Va PATH
874 This names a file whose contents is the DER encoding of an
875 OCSPResponse for the KDC's end entity certificate.
876 .It Li pkinit_kdc_friendly_name = Va NAME
877 This is an optional friendly name of the KDC's end entity
879 This is only helpful when the
881 store contains many credentials.
882 .It Li pkinit_principal_in_certificate = Va BOOL
885 then the KDC will match AS-REQ client principal names to the
887 .Va subjectAlternativeName
888 values from the clients' certificates.
891 .It Li pkinit_dh_min_bits = Va NUMBER
892 Minimum acceptable modular Diffie-Hellman public key size in
894 .It Li pkinit_max_life_from_cert_extension = Va BOOL
897 then the KDC will override the
899 attribute of the client principal's HDB record with a maximum
900 ticket life taken from a certificate extension with OID
901 .Va { iso(1) member-body(2) se(752) su(43) heim-pkix(16) 4 }
902 and the DER encoding of an
905 Alternatively, if the extended key usage OID
906 .Va { iso(1) member-body(2) se(752) su(43) heim-pkix(16) 3 }
907 is included in the client's certificate, then the
909 minus the current time will be used.
910 .It Li pkinit_max_life_bound = Va TIME
911 If set, this will be a hard bound on the maximum ticket lifetime
912 taken from the client's certificate.
915 can be given as a number followed by a unit, such as
919 .It Li pkinit_max_life_from_cert = Va TIME
920 If set, this will override the
922 attribute of the client principal's HDB record with the
924 of the client's certificate minus the current time, bounded to
928 .Li pkinit_max_life_from_cert_extension
929 parameter is set and the client's certificate has that extension.
932 can be given as a number followed by a unit, such as
936 .It Li enable_gss_preauth = Va boolean
937 Enables pre-authentication using a GSS-API mechanism supported by the client and KDC.
938 The GSS-API initiator and AS request client names must match, unless the
939 .Li WELLKNOWN/FEDERATED
940 name was used in the AS request, in which case the AS reply will contain the
941 GSS-API initiator name. Authorization and mapping behavior may be customized
942 by plugins. If synthetic clients are enabled, then the GSS-API initiator need
943 not exist in the local database. GSS-API pre-authentication is disabled by
945 .It Li enable_gss_auth_data = Va boolean
946 When using GSS-API pre-authentication, includes a Kerberos authorization data
947 element containing naming attributes associated with the GSS-API initiator. This
948 is disabled by default as it may significantly increase the size of returned
950 .It Li gss_mechanisms_allowed = Va mechs ...
951 A list of GSS-API mechanisms that may be used for GSS-API pre-authentication.
952 .It Li gss_cross_realm_mechanisms_allowed = Va mechs ...
953 A list of GSS-API mechanisms that, when using the default authorization
954 mechanism, will be permitted to map Kerberos principals in foreign realms. The
955 list is empty by default. Initiator names from mechanisms not on this list will
956 be mapped to an enterprise principal in the AS-REQ realm. This option is
957 intended to avoid conflating GSS-API pre-authentication and Kerberos
958 cross-realm authentication. The behavior is provided by the default
959 authorization mechanism and will be overridden by an authorization plugin.
960 Mechanisms may be identified by dot-separated OID or a short name.
961 .It Li historical_anon_realm = Va boolean
962 Enables pre-7.0 non-RFC-comformant KDC behavior.
963 With this option set to
965 the client realm in anonymous pkinit AS replies will be the requested realm,
966 rather than the RFC-conformant
967 .Li WELLKNOWN:ANONYMOUS
969 This can have a security impact on servers that expect to grant access to
970 anonymous-but-authenticated to the KDC users of the realm in question:
971 they would also grant access to unauthenticated anonymous users.
972 As such, it is not recommend to set this option to
974 .It Li encode_as_rep_as_tgs_rep = Va BOOL
975 Encode as-rep as tgs-rep to be compatible with mistakes older DCE secd did.
977 .It Li kdc_warn_pwexpire = Va TIME
978 The time before expiration that the user should be warned that her
979 password is about to expire.
980 .It Li logging = Va Logging
981 What type of logging the kdc should use, see also [logging]/kdc.
982 .It Li hdb-ldap-structural-object Va structural object
983 If the LDAP backend is used for storing principals, this is the
984 structural object that will be used when creating and when reading
986 The default value is account .
987 .It Li hdb-ldap-create-base Va creation dn
988 is the dn that will be appended to the principal when creating entries.
989 Default value is the search dn.
990 .It Li enable-digest = Va BOOL
991 Should the kdc answer digest requests. The default is FALSE.
992 .It Li digests_allowed = Va list of digests
993 Specifies the digests the kdc will reply to. The default is
995 .It Li enable-kx509 = Va boolean
996 Enables kx509 service.
998 The kx509 service is configurable for a number of cases:
999 .Bl -tag -width "" -offset indent
1000 .It Li default certificates for user or service principals,
1001 .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.
1004 Distinct configurations are supported for all of these cases as
1006 .Bd -literal -offset indent
1008 enable-kx509 = yes | no
1009 require_csr = yes | no
1010 require_initial_kca_tickets = yes | no
1017 hostbased_service = {
1029 .Bl -tag -width "xxx" -offset indent
1031 for default certificates for user principals,
1033 for default certificates for root user principals,
1035 for default certificates for admin user principals,
1036 .It Li hostbased_service
1037 for default certificates for host-based service principals, in which case the
1038 service name is used as shown above,
1040 for non-default client certificates,
1042 for non-default server certificates,
1044 for non-default client and server certificates.
1046 and where the parameters are as follows:
1047 .Bl -tag -width "xxx" -offset indent
1049 Specifies the PEM credentials for the kx509 / bx509d certification
1051 If not specified for any specific use-case, then that use-case
1053 .It Li max_cert_lifetime = Va NUMunit
1054 Specifies the maximum certificate lifetime as a decimal number
1055 and an optional unit (the default unit is
1058 .It Li force_cert_lifetime = Va NUMunit
1059 Specifies a minimum certificate lifetime as a decimal number and
1060 an optional unit (the default unit is
1063 .It Li allow_extra_lifetime = Va boolean
1064 Indicates whether a client may request longer lifetimes than
1065 their authentication credentials.
1068 .Li force_cert_lifetime
1070 .Li allow_extra_lifetime
1071 is implicitly forced to
1073 .It Li require_initial_kca_tickets = Va boolean
1074 Specified whether to require that tickets for the
1076 service principal be INITIAL.
1077 This may be set on a per-realm basis as well as globally.
1078 Defaults to true for the global setting.
1079 .It Li include_pkinit_san = Va boolean
1080 If true then the kx509 client principal's name and realm will be
1083 subject alternative name certificate extension.
1084 This can be set on a per-realm basis as well as globally.
1085 Defaults to true for the global setting.
1086 .It Li email_domain = Va domain
1087 If set then the kx509 client user principal's name at the given
1088 domain will be included in an
1090 subject alternative name certificate extension.
1091 This can be set on a per-realm basis as well as globally.
1092 Defaults to false for the global setting.
1093 .It Li include_dnsname_san = Va boolean
1094 If true then a kx509 host-based or domain-based client
1095 principal's hostname will be included in an
1097 subject alternative name certificate extension, with the
1098 downcased realm as the domainname. This can be set on a
1099 per-realm basis as well as
1100 globally. Defaults to false for the global setting.
1101 .It Li ekus = Va OID
1102 List of OIDs to include as EKUs.
1103 .It Li subject_name = Va DN
1104 Specifies a subject name that should either be empty or contain
1105 variable interpolation as described below for
1107 The subject may be the empty string, causing the issued
1108 certificates' subject names to be empty.
1109 .It Li template_cert = Va store
1110 Specifies the hx509 store (e.g.,
1113 for the certificates to be issued to kx509 clients whose
1114 principal names have one component (i.e., are user principals).
1115 A template is a certificate with variables to be interpolated in
1116 the subjectName. The following variables can be interpolated in
1117 the subject name using
1120 .Bl -tag -width "xxx" -offset indent
1122 The full name of the kx509 client principal.
1123 .It principal-name-without-realm
1124 The full name of the kx509 client principal, excluding the realm name.
1125 .It principal-name-realm
1126 The name of the client principal's realm.
1127 .It principal-component0
1128 The first component of the client principal.
1129 .It principal-component1
1130 The second component of the client principal.
1131 .It principal-component2
1132 The third component of the client principal.
1133 .It principal-service-name
1134 The name of the service.
1135 .It principal-host-name
1136 The name of the host.
1139 If a template and subject name are not specified and no default
1140 SANs are configured, then no certificate will be issued.
1141 Otherwise if a template and subject name are not specified, then
1142 subject of the certificate will be empty.
1147 .Bl -tag -width "xxx" -offset indent
1148 .It Li db-dir = Va path
1149 This parameter defines a directory that can contain:
1150 .Bl -tag -width "xxx" -offset indent
1152 A configuration file with the same format as krb5.conf that will
1155 The master key file.
1157 The default logfile for the KDC when a logfile is not specified in
1160 The access controls for
1163 The (binary) log of transactions used for
1172 The default PKINIT mapping file if one is not specified in
1173 .Va [kdc] pkinit_mappings_file .
1175 and other files related to
1178 .It Li new_service_key_delay = Va time
1179 Sets a bias such that new keys are not taken into service until
1180 after the given time has passed since they were set.
1181 This is useful for key rotation on concrete principals shared by
1182 multiple instances of an application: set this time to twice or
1183 more the keytab fetch period used by applications.
1184 .It Li enable_virtual_hostbased_princs = Va boolean
1185 Heimdal supports a notion of virtual host-based service
1186 principals whose keys are derived from those of a base namespace
1187 principal of the form
1188 .Nm WELLKNOWN/HOSTBASED-NAMESPACE/svc/hostname .
1189 The service name can be wild-carded as
1191 Non-wildcarded services have to be listed in the
1192 .Li virtual_hostbased_princ_svcs
1193 parameter (see below).
1194 This parameter enables this feature, which is disabled by
1196 .It Li virtual_hostbased_princ_ndots = Va Integer
1197 Minimum number of label-separating periods in virtual host-based
1198 service principals' hostname component.
1199 .It Li virtual_hostbased_princ_maxdots = Va Integer
1200 Maximum number of label-separating periods in namespaces'
1202 .It Li virtual_hostbased_princ_svcs = Va service-name
1203 This multi-valued parameter lists service names not to wildcard
1204 when searching for a namespace for a virtual host-based service
1206 Other service names will have keys derived from a matching
1207 namespace with a wild-carded service name.
1208 This allows one to have different attributes for different
1212 service can be configured to have the ok-as-delegate flag while
1217 This section contains online certification authority configuration, much
1222 section, but with the
1225 .Bd -literal -offset indent
1234 .Bl -tag -width "xxx" -offset indent
1235 .It Li no_addresses = Va BOOL
1242 service will issue address-less TGTs.
1249 service will include the client's IP address in the TGT it issues
1253 .It Li allow_addresses = Va BOOL
1260 service will add arbitrary addresses requested by clients to the
1261 TGTs it issues them.
1266 Certification authority related parameters are as for
1269 .Bl -tag -width "xxx" -offset indent
1270 .It Li password_lifetime = Va time
1271 If a principal already have its password set for expiration, this is
1272 the time it will be valid for after a change.
1273 .It Li default_keys = Va keytypes...
1276 try to parse it as a sequence of
1277 .Va etype:salttype:salt
1278 syntax of this if something like:
1280 [(des|des3|etype):](pw-salt|afs3-salt)[:string]
1284 is omitted it means everything, and if string is omitted it means the
1285 default salt string (for that principal and encryption type).
1286 Additional special values of keytypes are:
1287 .Bl -tag -width "xxx" -offset indent
1292 .It Li default_key_rules = Va {
1293 .Bl -tag -width "xxx" -offset indent
1294 .It Va globing-rule Li = Va keytypes...
1295 a globbing rule to matching a principal, and when true, use the
1296 keytypes as specified the same format as [kadmin]default_keys .
1299 .It Li prune-key-history = Va BOOL
1300 When adding keys to the key history, drop keys that are too old to match
1301 unexpired tickets (based on the principal's maximum ticket lifetime).
1302 If the KDC keystore is later compromised traffic protected with the
1303 discarded older keys may remain protected. This also keeps the HDB
1304 records for principals with key history from growing without bound.
1305 The default (backwards compatible) value is "false".
1306 .It Li use_v4_salt = Va BOOL
1307 When true, this is the same as
1309 .Va default_keys = Va des3:pw-salt Va v4
1311 and is only left for backwards compatibility.
1312 .It Li [password_quality]
1313 Check the Password quality assurance in the info documentation for
1315 .Bl -tag -width "xxx" -offset indent
1316 .It Li check_library = Va library-name
1317 Library name that contains the password check_function
1318 .It Li check_function = Va function-name
1319 Function name for checking passwords in check_library
1320 .It Li policy_libraries = Va library1 ... libraryN
1321 List of libraries that can do password policy checks
1322 .It Li policies = Va policy1 ... policyN
1323 List of policy names to apply to the password. Builtin policies are
1324 among other minimum-length, character-class, external-check.
1329 The values of some parameters are subject to percent token expansion.
1330 Expansions supported on all platforms:
1331 .Bl -tag -width "xxx" -offset indent
1333 The install location of Heimdal libraries.
1335 The install location of Heimdal user programs.
1337 The install location of Heimdal services.
1339 The install location of Heimdal admin programs.
1341 The current username.
1343 A temporary directory.
1345 The current user's SID (Windows) or effective user ID (POSIX).
1347 The current user's SID (Windows) or real user ID (POSIX). On POSIX it is best
1350 token instead (see below).
1355 Expansions supported on POSIX-like platforms:
1356 .Bl -tag -width "xxx" -offset indent
1358 The current effective user ID.
1360 The username of the logged-in user for this terminal.
1361 .It %{LOCALSTATEDIR}
1362 The install location of Heimdal databases.
1365 On Windows, several additional tokens can also be expanded:
1366 .Bl -tag -width "xxx" -offset indent
1368 Roaming application data (for current user).
1369 .It %{COMMON_APPDATA}
1370 Application data (all users).
1371 .It %{LOCAL_APPDATA}
1372 Local application data (for current user).
1374 Windows System folder.
1378 Per user Heimdal configuration file path.
1380 Common Heimdal configuration file path.
1384 points to the configuration file to read.
1386 .Bl -tag -width "/etc/krb5.conf"
1387 .It Pa /etc/krb5.conf
1388 configuration file for Kerberos 5.
1391 .Bd -literal -offset indent
1393 default_realm = FOO.SE
1394 name_canon_rules = as-is:realm=FOO.SE
1395 name_canon_rules = qualify:domain=foo.se:realm=FOO.SE
1396 name_canon_rules = qualify:domain=bar.se:realm=FOO.SE
1397 name_canon_rules = nss
1403 kdc = kerberos.foo.se
1404 default_domain = foo.se
1407 kdc = FILE:/var/heimdal/kdc.log
1409 default = SYSLOG:INFO:USER
1411 default_key_rules = {
1412 */ppp@* = arcfour-hmac-md5:pw-salt
1418 is read and parsed by the krb5 library, there is not a lot of
1419 opportunities for programs to report parsing errors in any useful
1421 To help overcome this problem, there is a program
1422 .Nm verify_krb5_conf
1425 and tries to emit useful diagnostics from parsing errors.
1426 Note that this program does not have any way of knowing what options
1427 are actually used and thus cannot warn about unknown or misspelled
1431 .Xr krb5_openlog 3 ,
1433 .Xr verify_krb5_conf 8