changed `struct fd_set' to `fd_set'
[heimdal.git] / lib / krb5 / krb5.conf.5
blob6baa25e7d071cae0d672ef5f56d7695cfa1ada39
1 .\" $Id$
2 .\"
3 .Dd July 27, 1997
4 .Dt KRB5.CONF 5
5 .Os HEIMDAL
6 .Sh NAME
7 .Nm /etc/krb5.conf
8 .Nd
9 Configuration file for Kerberos 5
10 .Sh DESCRIPTION
11 The 
12 .Nm
13 file specifies several configuration parameters for the Kerberos 5
14 library, as well as for some programs.
15 .Pp
16 The file consists of one or more sections, containing a number of
17 bindings. The value of each binding can be either a string or a list
18 of other bindings. The grammar looks like:
19 .Bd -literal -offset indent
20 file:
21         /* empty */
22         sections
24 sections:
25         section sections
26         section
28 section:
29         '[' section_name ']' bindings
31 section_name:
32         STRING
34 bindings:
35         binding bindings
36         binding
38 binding:
39         name '=' STRING
40         name '=' '{' bindings '}'
42 name:
43         STRING
45 .Ed
46 .Li STRINGs
47 consists of one or more non-white space characters.
48 Currently recognised sections and bindings are:
50 .Bl -tag -width "xxx" -offset indent
51 .It Li [libdefaults]
52 .Bl -tag -width "xxx" -offset indent
53 .It Li default_realm = Va REALM
54 Default realm to use, this is also known as your 
55 .Dq local realm .
56 The default is the result of
57 .Fn krb5_get_host_realm "local hostname" .
58 .It Li clockskew = Va time
59 Maximum time differential (in seconds) allowed when comparing
60 times. Default is 300 seconds (five minutes).
61 .It Li kdc_timeout = Va time
62 Maximum time to wait for a reply from the kdc, default is 3 seconds.
63 .It v4_name_convert
64 .It v4_instance_resolve
65 These are decribed in the 
66 .Xr krb5_425_conv_principal 
67 manual page.
68 .El
69 .It Li [domain_realm]
70 This is a list of mappings from DNS domain to Kerberos realm. Each
71 binding in this section looks like:
72 .Pp
73 .Dl domain = realm
74 .Pp
75 The domain can be either a full name of a host or a trailing
76 component, in the latter case the domain-string should start with a
77 perid.
78 .It Li [realms]
79 .Bl -tag -width "xxx" -offset indent
80 .It Va REALM Li = {
81 .Bl -tag -width "xxx" -offset indent
82 .It Li kdc = Va host[:port]
83 Specifies a kdc for this realm. If the optional port is absent, the
84 default value for the
85 .Dq kerberos/udp
86 service will be used.
87 .It Li v4_instance_convert
88 .It Li v4_name_convert
89 .It Li default_domain
90 See
91 .Xr krb5_425_conv_principal 3 .
92 .El
93 .It Li }
94 .El
95 .It Li [logging]
96 .Bl -tag -width "xxx" -offset indent
97 .It Va entity Li = Va destination
98 Specifies that
99 .Va entity
100 should use the specified
101 .Li destination
102 for logging. See the
103 .Xr krb5_openlog 3
104 manual page for a list of defined destinations.
107 .Sh EXAMPLE
108 .Bd -literal -offset indent
109 [lib_defaults]
110         default_domain = FOO.SE
111 [domain_realm]
112         .foo.se = FOO.SE
113         .bar.se = FOO.SE
114 [realms]
115         FOO.SE = {
116                 kdc = kerberos.foo.se
117                 v4_name_convert = {
118                         rcmd = host
119                 }
120                 v4_instance_convert = {
121                         xyz = xyz.bar.se
122                 }
123                 default_domain = foo.se
124         }
125 [logging]
126         kdc = FILE:/var/heimdal/kdc.log
127         kdc = SYSLOG:INFO
128         default = SYSLOG:INFO:USER
130 .Sh SEE ALSO
131 .Xr Source tm