lib/krb5/krb5.conf.5

   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
  58 sections:
  59         section sections
  60         section
  61
  62 section:
  63         '[' section_name ']' bindings
  64
  65 section_name:
  66         STRING
  67
  68 bindings:
  69         binding bindings
  70         binding
  71
  72 binding:
  73         name '=' STRING
  74         name '=' '{' bindings '}'
  75
  76 name:
  77         STRING
  78
  79 .Ed
  80 .Li STRINGs
  81 consists of one or more non-whitespace characters.
  82 .Pp
  83 STRINGs that are specified later in this man-page uses the following
  84 notation.
  85 .Bl -tag -width "xxx" -offset indent
  86 .It boolean
  87 values can be either yes/true or no/false.
  88 .It time
  89 values can be a list of year, month, day, hour, min, second.
  90 Example: 1 month 2 days 30 min.
  91 If no unit is given, seconds is assumed.
  92 .It etypes
  93 valid encryption types are: des-cbc-crc, des-cbc-md4, des-cbc-md5,
  94 des3-cbc-sha1, arcfour-hmac-md5, aes128-cts-hmac-sha1-96, and
  95 aes256-cts-hmac-sha1-96 .
  96 .It address
  97 an address can be either a IPv4 or a IPv6 address.
  98 .El
  99 .Pp
 100 Currently recognised sections and bindings are:
 101 .Bl -tag -width "xxx" -offset indent
 102 .It Li [appdefaults]
 103 Specifies the default values to be used for Kerberos applications.
 104 You can specify defaults per application, realm, or a combination of
 105 these.
 106 The preference order is:
 107 .Bl -enum -compact
 108 .It
 109 .Va application Va realm Va option
 110 .It
 111 .Va application Va option
 112 .It
 113 .Va realm Va option
 114 .It
 115 .Va option
 116 .El
 117 .Pp
 118 The supported options are:
 119 .Bl -tag -width "xxx" -offset indent
 120 .It Li forwardable = Va boolean
 121 When obtaining initial credentials, make the credentials forwardable.
 122 .It Li proxiable = Va boolean
 123 When obtaining initial credentials, make the credentials proxiable.
 124 .It Li no-addresses = Va boolean
 125 When obtaining initial credentials, request them for an empty set of
 126 addresses, making the tickets valid from any address.
 127 .It Li ticket_lifetime = Va time
 128 Default ticket lifetime.
 129 .It Li renew_lifetime = Va time
 130 Default renewable ticket lifetime.
 131 .It Li encrypt = Va boolean
 132 Use encryption, when available.
 133 .It Li forward = Va boolean
 134 Forward credentials to remote host (for
 135 .Xr rsh 1 ,
 136 .Xr telnet 1 ,
 137 etc).
 138 .El
 139 .It Li [libdefaults]
 140 .Bl -tag -width "xxx" -offset indent
 141 .It Li default_realm = Va REALM
 142 Default realm to use, this is also known as your
 143 .Dq local realm .
 144 The default is the result of
 145 .Fn krb5_get_host_realm "local hostname" .
 146 .It Li clockskew = Va time
 147 Maximum time differential (in seconds) allowed when comparing
 148 times.
 149 Default is 300 seconds (five minutes).
 150 .It Li kdc_timeout = Va time
 151 Maximum time to wait for a reply from the kdc, default is 3 seconds.
 152 .It Li v4_name_convert
 153 .It Li v4_instance_resolve
 154 These are described in the
 155 .Xr krb5_425_conv_principal  3
 156 manual page.
 157 .It Li capath = {
 158 .Bl -tag -width "xxx" -offset indent
 159 .It Va destination-realm Li = Va next-hop-realm
 160 .It ...
 161 .It Li }
 162 .El
 163 This is deprecated, see the
 164 .Li capaths
 165 section below.
 166 .It Li default_cc_type = Va cctype
 167 sets the default credentials type.
 168 .It Li default_cc_name = Va ccname
 169 the default credentials cache name.
 170 If you want to change the type only use
 171 .Li default_cc_type .
 172 The string can contain variables that are expanded on runtime.
 173 Only support variable now is
 174 .Li %{uid}
 175 that expands to the current user id.
 176 .It Li default_etypes = Va etypes ...
 177 A list of default encryption types to use.
 178 .It Li default_etypes_des = Va etypes ...
 179 A list of default encryption types to use when requesting a DES credential.
 180 .It Li default_keytab_name = Va keytab
 181 The keytab to use if no other is specified, default is
 182 .Dq FILE:/etc/krb5.keytab .
 183 .It Li dns_lookup_kdc = Va boolean
 184 Use DNS SRV records to lookup KDC services location.
 185 .It Li dns_lookup_realm = Va boolean
 186 Use DNS TXT records to lookup domain to realm mappings.
 187 .It Li kdc_timesync = Va boolean
 188 Try to keep track of the time differential between the local machine
 189 and the KDC, and then compensate for that when issuing requests.
 190 .It Li max_retries = Va number
 191 The max number of times to try to contact each KDC.
 192 .It Li large_msg_size = Va number
 193 The threshold where protocols with tiny maximum message sizes are not
 194 considered usable to send messages to the KDC.
 195 .It Li ticket_lifetime = Va time
 196 Default ticket lifetime.
 197 .It Li renew_lifetime = Va time
 198 Default renewable ticket lifetime.
 199 .It Li forwardable = Va boolean
 200 When obtaining initial credentials, make the credentials forwardable.
 201 This option is also valid in the [realms] section.
 202 .It Li proxiable = Va boolean
 203 When obtaining initial credentials, make the credentials proxiable.
 204 This option is also valid in the [realms] section.
 205 .It Li verify_ap_req_nofail = Va boolean
 206 If enabled, failure to verify credentials against a local key is a
 207 fatal error.
 208 The application has to be able to read the corresponding service key
 209 for this to work.
 210 Some applications, like
 211 .Xr su 1 ,
 212 enable this option unconditionally.
 213 .It Li warn_pwexpire = Va time
 214 How soon to warn for expiring password.
 215 Default is seven days.
 216 .It Li http_proxy = Va proxy-spec
 217 A HTTP-proxy to use when talking to the KDC via HTTP.
 218 .It Li dns_proxy = Va proxy-spec
 219 Enable using DNS via HTTP.
 220 .It Li extra_addresses = Va address ...
 221 A list of addresses to get tickets for along with all local addresses.
 222 .It Li time_format = Va string
 223 How to print time strings in logs, this string is passed to
 224 .Xr strftime 3 .
 225 .It Li date_format = Va string
 226 How to print date strings in logs, this string is passed to
 227 .Xr strftime 3 .
 228 .It Li log_utc = Va boolean
 229 Write log-entries using UTC instead of your local time zone.
 230 .It Li scan_interfaces = Va boolean
 231 Scan all network interfaces for addresses, as opposed to simply using
 232 the address associated with the system's host name.
 233 .It Li fcache_version = Va int
 234 Use file credential cache format version specified.
 235 .It Li krb4_get_tickets = Va boolean
 236 Also get Kerberos 4 tickets in
 237 .Nm kinit ,
 238 .Nm login ,
 239 and other programs.
 240 This option is also valid in the [realms] section.
 241 .It Li fcc-mit-ticketflags = Va boolean
 242 Use MIT compatible format for file credential cache.
 243 It's the field ticketflags that is stored in reverse bit order for
 244 older than Heimdal 0.7.
 245 Setting this flag to
 246 .Dv TRUE
 247 make it store the MIT way, this is default for Heimdal 0.7.
 248 .El
 249 .It Li [domain_realm]
 250 This is a list of mappings from DNS domain to Kerberos realm.
 251 Each binding in this section looks like:
 252 .Pp
 253 .Dl domain = realm
 254 .Pp
 255 The domain can be either a full name of a host or a trailing
 256 component, in the latter case the domain-string should start with a
 257 period.
 258 The trailing component only matches hosts that are in the same domain, ie
 259 .Dq .example.com
 260 matches
 261 .Dq foo.example.com ,
 262 but not
 263 .Dq foo.test.example.com .
 264 .Pp
 265 The realm may be the token `dns_locate', in which case the actual
 266 realm will be determined using DNS (independently of the setting
 267 of the `dns_lookup_realm' option).
 268 .It Li [realms]
 269 .Bl -tag -width "xxx" -offset indent
 270 .It Va REALM Li = {
 271 .Bl -tag -width "xxx" -offset indent
 272 .It Li kdc = Va [service/]host[:port]
 273 Specifies a list of kdcs for this realm.
 274 If the optional
 275 .Va port
 276 is absent, the
 277 default value for the
 278 .Dq kerberos/udp
 279 .Dq kerberos/tcp ,
 280 and
 281 .Dq http/tcp
 282 port (depending on service) will be used.
 283 The kdcs will be used in the order that they are specified.
 284 .Pp
 285 The optional
 286 .Va service
 287 specifies over what medium the kdc should be
 288 contacted.
 289 Possible services are
 290 .Dq udp ,
 291 .Dq tcp ,
 292 and
 293 .Dq http .
 294 Http can also be written as
 295 .Dq http:// .
 296 Default service is
 297 .Dq udp
 298 and
 299 .Dq tcp .
 300 .It Li admin_server = Va host[:port]
 301 Specifies the admin server for this realm, where all the modifications
 302 to the database are performed.
 303 .It Li kpasswd_server = Va host[:port]
 304 Points to the server where all the password changes are performed.
 305 If there is no such entry, the kpasswd port on the admin_server host
 306 will be tried.
 307 .It Li krb524_server = Va host[:port]
 308 Points to the server that does 524 conversions.
 309 If it is not mentioned, the krb524 port on the kdcs will be tried.
 310 .It Li v4_instance_convert
 311 .It Li v4_name_convert
 312 .It Li default_domain
 313 See
 314 .Xr krb5_425_conv_principal 3 .
 315 .It Li tgs_require_subkey
 316 a boolan variable that defaults to false.
 317 Old DCE secd (pre 1.1) might need this to be true.
 318 .El
 319 .It Li }
 320 .El
 321 .It Li [capaths]
 322 .Bl -tag -width "xxx" -offset indent
 323 .It Va client-realm Li = {
 324 .Bl -tag -width "xxx" -offset indent
 325 .It Va server-realm Li = Va hop-realm ...
 326 This serves two purposes. First the first listed
 327 .Va hop-realm
 328 tells a client which realm it should contact in order to ultimately
 329 obtain credentials for a service in the
 330 .Va server-realm .
 331 Secondly, it tells the KDC (and other servers) which realms are
 332 allowed in a multi-hop traversal from
 333 .Va client-realm
 334 to
 335 .Va server-realm .
 336 Except for the client case, the order of the realms are not important.
 337 .El
 338 .It Va }
 339 .El
 340 .It Li [logging]
 341 .Bl -tag -width "xxx" -offset indent
 342 .It Va entity Li = Va destination
 343 Specifies that
 344 .Va entity
 345 should use the specified
 346 .Li destination
 347 for logging.
 348 See the
 349 .Xr krb5_openlog 3
 350 manual page for a list of defined destinations.
 351 .El
 352 .It Li [kdc]
 353 .Bl -tag -width "xxx" -offset indent
 354 .It Li database Li = {
 355 .Bl -tag -width "xxx" -offset indent
 356 .It Li dbname Li = Va DATABASENAME
 357 Use this database for this realm.
 358 See the info documetation how to configure diffrent database backends.
 359 .It Li realm Li = Va REALM
 360 Specifies the realm that will be stored in this database.
 361 It realm isn't set, it will used as the default database, there can
 362 only be one entry that doesn't have a
 363 .Li realm
 364 stanza.
 365 .It Li mkey_file Li = Pa FILENAME
 366 Use this keytab file for the master key of this database.
 367 If not specified
 368 .Va DATABASENAME Ns .mkey
 369 will be used.
 370 .It Li acl_file Li = PA FILENAME
 371 Use this file for the ACL list of this database.
 372 .It Li log_file Li = Pa FILENAME
 373 Use this file as the log of changes performed to the database.
 374 This file is used by
 375 .Nm ipropd-master
 376 for propagating changes to slaves.
 377 .El
 378 .It Li }
 379 .It Li max-request = Va SIZE
 380 Maximum size of a kdc request.
 381 .It Li require-preauth = Va BOOL
 382 If set pre-authentication is required.
 383 Since krb4 requests are not pre-authenticated they will be rejected.
 384 .It Li ports = Va "list of ports"
 385 List of ports the kdc should listen to.
 386 .It Li addresses = Va "list of interfaces"
 387 List of addresses the kdc should bind to.
 388 .It Li enable-kerberos4 = Va BOOL
 389 Turn on Kerberos 4 support.
 390 .It Li v4-realm = Va REALM
 391 To what realm v4 requests should be mapped.
 392 .It Li enable-524 = Va BOOL
 393 Should the Kerberos 524 converting facility be turned on.
 394 Default is the same as
 395 .Va enable-kerberos4 .
 396 .It Li enable-http = Va BOOL
 397 Should the kdc answer kdc-requests over http.
 398 .It Li enable-kaserver = Va BOOL
 399 If this kdc should emulate the AFS kaserver.
 400 .It Li check-ticket-addresses = Va BOOL
 401 Verify the addresses in the tickets used in tgs requests.
 402 .\" XXX
 403 .It Li allow-null-ticket-addresses = Va BOOL
 404 Allow address-less tickets.
 405 .\" XXX
 406 .It Li allow-anonymous = Va BOOL
 407 If the kdc is allowed to hand out anonymous tickets.
 408 .It Li encode_as_rep_as_tgs_rep = Va BOOL
 409 Encode as-rep as tgs-rep tobe compatible with mistakes older DCE secd did.
 410 .\" XXX
 411 .It Li kdc_warn_pwexpire = Va TIME
 412 The time before expiration that the user should be warned that her
 413 password is about to expire.
 414 .It Li logging = Va Logging
 415 What type of logging the kdc should use, see also [logging]/kdc.
 416 .It Li use_2b = {
 417 .Bl -tag -width "xxx" -offset indent
 418 .It Va principal Li = Va BOOL
 419 boolean value if the 524 daemon should return AFS 2b tokens for
 420 .Fa principal .
 421 .It ...
 422 .El
 423 .It Li }
 424 .It Li hdb-ldap-structural-object Va structural object
 425 If the LDAP backend is used for storing principals, this is the
 426 structural object that will be used when creating and when reading
 427 objects.
 428 The default value is account .
 429 .It Li hdb-ldap-create-base Va creation dn
 430 is the dn that will be appended to the principal when creating entries.
 431 Default value is the search dn.
 432 .It Li enable-digest = Va BOOL
 433 Should the kdc answer digest requests. The default is FALSE.
 434 .It Li digests_allowed = Va list of digests
 435 Specifies the digests the kdc will reply to. The default is
 436 .Li ntlm-v2 .
 437 .El
 438 .It Li [kadmin]
 439 .Bl -tag -width "xxx" -offset indent
 440 .It Li require-preauth = Va BOOL
 441 If pre-authentication is required to talk to the kadmin server.
 442 .It Li password_lifetime = Va time
 443 If a principal already have its password set for expiration, this is
 444 the time it will be valid for after a change.
 445 .It Li default_keys = Va keytypes...
 446 For each entry in
 447 .Va default_keys
 448 try to parse it as a sequence of
 449 .Va etype:salttype:salt
 450 syntax of this if something like:
 451 .Pp
 452 [(des|des3|etype):](pw-salt|afs3-salt)[:string]
 453 .Pp
 454 If
 455 .Ar etype
 456 is omitted it means everything, and if string is omitted it means the
 457 default salt string (for that principal and encryption type).
 458 Additional special values of keytypes are:
 459 .Bl -tag -width "xxx" -offset indent
 460 .It Li v5
 461 The Kerberos 5 salt
 462 .Va pw-salt
 463 .It Li v4
 464 The Kerberos 4 salt
 465 .Va des:pw-salt:
 466 .El
 467 .It Li use_v4_salt = Va BOOL
 468 When true, this is the same as
 469 .Pp
 470 .Va default_keys = Va des3:pw-salt Va v4
 471 .Pp
 472 and is only left for backwards compatibility.
 473 .El
 474 .It Li [password-quality]
 475 Check the Password quality assurance in the info documentation for
 476 more information.
 477 .Bl -tag -width "xxx" -offset indent
 478 .It Li check_library = Va library-name
 479 Library name that contains the password check_function
 480 .It Li check_function = Va function-name
 481 Function name for checking passwords in check_library
 482 .It Li policy_libraries = Va library1 ... libraryN
 483 List of libraries that can do password policy checks
 484 .It Li policies = Va policy1 ... policyN
 485 List of policy names to apply to the password. Builtin policies are
 486 among other minimum-length, character-class, external-check.
 487 .El
 488 .El
 489 .Sh ENVIRONMENT
 490 .Ev KRB5_CONFIG
 491 points to the configuration file to read.
 492 .Sh FILES
 493 .Bl -tag -width "/etc/krb5.conf"
 494 .It Pa /etc/krb5.conf
 495 configuration file for Kerberos 5.
 496 .El
 497 .Sh EXAMPLES
 498 .Bd -literal -offset indent
 499 [libdefaults]
 500         default_realm = FOO.SE
 501 [domain_realm]
 502         .foo.se = FOO.SE
 503         .bar.se = FOO.SE
 504 [realms]
 505         FOO.SE = {
 506                 kdc = kerberos.foo.se
 507                 v4_name_convert = {
 508                         rcmd = host
 509                 }
 510                 v4_instance_convert = {
 511                         xyz = xyz.bar.se
 512                 }
 513                 default_domain = foo.se
 514         }
 515 [logging]
 516         kdc = FILE:/var/heimdal/kdc.log
 517         kdc = SYSLOG:INFO
 518         default = SYSLOG:INFO:USER
 519 .Ed
 520 .Sh DIAGNOSTICS
 521 Since
 522 .Nm
 523 is read and parsed by the krb5 library, there is not a lot of
 524 opportunities for programs to report parsing errors in any useful
 525 format.
 526 To help overcome this problem, there is a program
 527 .Nm verify_krb5_conf
 528 that reads
 529 .Nm
 530 and tries to emit useful diagnostics from parsing errors.
 531 Note that this program does not have any way of knowing what options
 532 are actually used and thus cannot warn about unknown or misspelled
 533 ones.
 534 .Sh SEE ALSO
 535 .Xr kinit 1 ,
 536 .Xr krb5_425_conv_principal 3 ,
 537 .Xr krb5_openlog 3 ,
 538 .Xr strftime 3 ,
 539 .Xr verify_krb5_conf 8