Remove an outdated parenthetical comment about master_kdc; we actually
[krb5.git] / doc / krb5conf.texinfo
1 The @code{krb5.conf} file contains Kerberos configuration information,
2 including the locations of KDCs and admin servers for the Kerberos
3 realms of interest, defaults for the current realm and for Kerberos
4 applications, and mappings of hostnames onto Kerberos realms.  Normally,
5 you should install your @code{krb5.conf} file in the directory
6 @code{/etc}.  You can override the default location by setting the
7 environment variable @samp{KRB5_CONFIG}.
8
9 The @code{krb5.conf} file is set up in the style of a Windows INI file.
10 Sections are headed by the section name, in square brackets.  Each
11 section may contain zero or more relations, of the form:
12
13 @smallexample
14 foo = bar
15 @end smallexample
16
17 @noindent
18 or
19
20 @smallexample
21 @group
22 fubar = @{
23         foo = bar
24         baz = quux
25 @}
26 @end group
27 @end smallexample
28
29 Placing a `*' at the end of a line indicates that this is the
30 @dfn{final} value for the tag.  This means that neither the remainder
31 of this configuration file nor any other configuration file will be
32 checked for any other values for this tag.
33
34 For example, if you have the following lines:
35
36 @smallexample
37 foo = bar*
38 foo = baz
39 @end smallexample
40
41 then the second value of foo (baz) would never be read.
42
43 The @code{krb5.conf} file may contain any or all of the following 
44 sections:
45
46 @table @b
47 @itemx libdefaults
48 Contains default values used by the Kerberos V5 library.
49
50 @itemx login
51 Contains default values used by the Kerberos V5 login program.
52
53 @itemx appdefaults
54 Contains default values that can be used by Kerberos V5 applications.
55
56 @itemx realms
57 Contains subsections keyed by Kerberos realm names.  Each subsection
58 describes realm-specific information, including where to find the
59 Kerberos servers for that realm.
60
61 @itemx domain_realm
62 Contains relations which map domain names and subdomains onto Kerberos
63 realm names.  This is used by programs to determine what realm a host
64 should be in, given its fully qualified domain name.
65
66 @itemx logging
67 Contains relations which determine how Kerberos programs are to perform
68 logging.
69
70 @itemx capaths
71 Contains the authentication paths used with direct (nonhierarchical)
72 cross-realm authentication.  Entries in this section are used by the
73 client to determine the intermediate realms which may be used in
74 cross-realm authentication.  It is also used by the end-service when
75 checking the transited field for trusted intermediate realms.
76
77 @ignore
78 this doesn't seem to be used
79 @itemx kdc
80 For a KDC, may contain the location of the kdc.conf file.
81 @end ignore
82
83 @end table