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