fix
[heimdal.git] / kdc / kdc.8
blob768487761ae1102ba4c32a9fb361a054d68fb588
1 .\" $Id$
2 .\"
3 .Dd July 27, 1997
4 .Dt KDC 8
5 .Os HEIMDAL
6 .Sh NAME
7 .Nm kdc
8 .Nd
9 Kerberos 5 server
10 .Sh SYNOPSIS
11 .Nm
12 .Op Fl c Ar file
13 .Op Fl -config-file= Ns Ar file
14 .Op Fl k Ar file
15 .Op Fl -key-file= Ns Ar file
16 .Op Fl p
17 .Op Fl -no-require-preauth
18 .Op Fl r Ar realm
19 .Op Fl -v4-realm= Ns Ar realm
21 .Sh DESCRIPTION
22 .Nm
23 serves requests for tickets. When it starts, it first checks the flags
24 passed, any options that are not specified with a command line flag is
25 taken from a config file, or from a default compiled-in value.
26 .Pp
27 Options supported:
28 .Bl -tag -width Ds
29 .It Fl c Ar file
30 .It Fl -config-file= Ns Ar file
31 Specifies the location of the config file, the default is
32 .Pa /var/heimdal/kdc.conf .
33 This is the only value that can't be specified in the config file.
34 .It Fl k Ar file
35 .It Fl -key-file= Ns Ar file
36 The location of the master-key file. All keys in the database is
37 encrypted with this master key. The use of a master key is currently
38 optional, so there is no default. 
39 .Em "Don't specify a master key file if your database is not encrypted."
40 .It Fl p
41 .It Fl -no-require-preauth
42 Turn off the requirement for pre-autentication in the initial
43 AS-REQ. The use of pre-authentication makes it more difficult to do
44 offline password attacks. You might want to turn it off if you have
45 clients that doesn't do pre-authentication. Since the version 4
46 protocol doesn't support any pre-authentication, so serving version 4
47 clients is just about the same as not requiring pre-athentication. The
48 default is to require pre-authentication.
49 .It Fl r Ar realm
50 .It Fl -v4-realm= Ns Ar realm
51 What realm this server should act as when dealing with version 4
52 requests. The database can contain any number of realms, but since the
53 version 4 protocol doesn't contain a realm for the server, it must be
54 explicitly specified. The default is whatever is returned by
55 .Fn krb_get_lrealm .
56 This option is only availabe if the KDC has been compiled with version
57 4 support.
58 .El
59 .Pp
60 All activities , are logged to one or more destinations, see 
61 .Xr krb5.conf 5 ,
62 and
63 .Xr krb5_openlog 3 .
64 The entity used for logging is
65 .Nm kdc .
66 .Sh CONFIGURATION FILE
67 The configuration file has the same syntax as the 
68 .Pa krb5.conf
69 file (you can actually put the configuration in
70 .Pa /etc/krb5.conf ,
71 and then start the KDC with
72 .Fl -config-file= Ns Ar /etc/krb5.conf ) .
73 All options should be in a section called
74 .Dq kdc .
75 Options are called the same as the long option name, and takes the
76 same arguments. The only difference is the pre-authentication flag,
77 that has to be specified as:
78 .Pp
79 .Dl require-preauth = no
80 .Pp
81 (in fact you can specify the option as
82 .Fl -require-preauth=no ) .
83 .Pp
84 An example of a config file:
85 .Bd -literal -offset indent
86 [kdc]
87         require-preauth = no
88         v4-realm = FOO.SE
89         key-file = /key-file
90 .Ed
91 .Sh SEE ALSO
92 .Xr kinit 1