pull up r24469, r24530, r24533, r24534, r24535, r24537 from trunk
[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 can include other files using either of the
44 following directives at the beginning of a line:
45
46 @smallexample
47 include @var{FILENAME}
48 includedir @var{DIRNAME}
49 @end smallexample
50
51 @var{FILENAME} or @var{DIRNAME} should be an absolute path.  The named
52 file or directory must exist and be readable.  Including a directory
53 includes all files within the directory whose names consist solely of
54 alphanumeric characters, dashes, or underscores.  Included profile files
55 are syntactically independent of their parents, so each included file
56 must begin with a section header.
57
58 The @code{krb5.conf} file may contain any or all of the following 
59 sections:
60
61 @table @b
62 @itemx libdefaults
63 Contains default values used by the Kerberos V5 library.
64
65 @itemx login
66 Contains default values used by the Kerberos V5 login program.
67
68 @itemx appdefaults
69 Contains default values that can be used by Kerberos V5 applications.
70
71 @itemx realms
72 Contains subsections keyed by Kerberos realm names.  Each subsection
73 describes realm-specific information, including where to find the
74 Kerberos servers for that realm.
75
76 @itemx domain_realm
77 Contains relations which map domain names and subdomains onto Kerberos
78 realm names.  This is used by programs to determine what realm a host
79 should be in, given its fully qualified domain name.
80
81 @itemx logging
82 Contains relations which determine how Kerberos programs are to perform
83 logging.
84
85 @itemx capaths
86 Contains the authentication paths used with direct (nonhierarchical)
87 cross-realm authentication.  Entries in this section are used by the
88 client to determine the intermediate realms which may be used in
89 cross-realm authentication.  It is also used by the end-service when
90 checking the transited field for trusted intermediate realms.
91
92 @itemx plugins
93 Contains tags to register dynamic plugin modules and to turn modules on
94 and off.
95
96 @ignore
97 this doesn't seem to be used
98 @itemx kdc
99 For a KDC, may contain the location of the kdc.conf file.
100 @end ignore
101
102 @end table