doc/setup.texi

   1 @node Setting up a realm, Kerberos 4 issues, Building and Installing, Top
   2 @chapter Setting up a realm
   3
   4 A
   5 @cindex realm
   6 realm is an administrative domain.  Kerberos realms usually consists of
   7 an Internet domain name in uppercase. Call your realm the same as your
   8 Internet domain name if you do not have strong reasons for not doing so.
   9 It will make life easier for you and everyone else.
  10
  11 To setup a realm you will first have to create a configuration file:
  12 @file{/etc/krb5.conf}. The @file{krb5.conf} file can contain many
  13 configuration options, some which are described here.
  14
  15 The confguration file is a hierarchial structure consisting of sections,
  16 each containing a list of bindings (either variable assignments or
  17 subsections). A section starts with @samp{[section-name]}.  A binding
  18 consists of a left hand side, an equal (@samp{=}) and a right hand
  19 side. The left hand side tag must be separated from the equal with some
  20 whitespace. Subsections has a @samp{@{} as the first non-whitespace
  21 character after the equal. All other bindings are treated as variable
  22 assignments. The value of a variable extends to the end of the line.
  23
  24 @example
  25 [section1]
  26         a-subsection = @{
  27                 var = value1
  28                 other-var = value with @{@}
  29                 sub-sub-section = @{
  30                         var = 123
  31                 @}
  32         @}
  33         var = some other value
  34 [section2]
  35         var = yet another value
  36 @end example
  37
  38 To denote entries in the config file, the names of sections and bindings
  39 will be given separated with slashes (@samp{/}). The @samp{other-var}
  40 variable will thus be @samp{section1/a-subsection/other-var}.
  41
  42 For in-depth information about the contents of the config file, refer to
  43 the @file{krb5.conf} manual page. Some of the more important sections
  44 are briefly described here. The @samp{libdefaults} section contains a
  45 list of library configuration parameters, such as the default realm and
  46 the timeout for kdc responses. The @samp{realms} section contains
  47 information about specific realms, such as where they hide their
  48 KDC. This section serves the same purpose as the Kerberos 4
  49 @file{krb.conf} file, but can contain more information. Finally the
  50 @samp{domain_realm} section contains a list of mappings from domains to
  51 realms, equivalent to the Kerberos 4 @file{krb.realms} file.
  52
  53 To continue with the realm setup, you will have to create a config file,
  54 with contents similar to the following.
  55
  56 @example
  57 [libdefaults]
  58         default_realm = MY.REALM
  59 [realms]
  60         MY.REALM = @{
  61                 kdc = my.kdc
  62         @}
  63 [domain_realm]
  64 .my.domain = MY.REALM
  65
  66 @end example
  67
  68 If you use a realm name equal to your domain name, you can omit the
  69 @samp{libdefaults}, and @samp{domain_realm}, sections.
  70
  71 The database library will look for the database in @file{/var/heimdal},
  72 so you should probably create that directory.
  73
  74 To initialise the database use the @code{kdb_edit} program. First issue
  75 a @kbd{init MY.REALM} command. This will create the database and insert
  76 default principals for that realm. You can have more than one realm in
  77 one database, so @samp{init} does not destroy any old database.
  78
  79 Before creating the database, @samp{init} will ask you some questions
  80 about default and max ticket lifes. The default values should be fine.
  81
  82 After creating the database you should probably add yourself. You do
  83 this with the @samp{ank} command. It takes as argument the name of a
  84 principal. The principal should contain a realm, so if you haven't setup
  85 a default realm, you will need to explicitly include the realm.
  86
  87 @example
  88 # kdb_edit
  89 kdb_edit> init MY.REALM
  90 Realm max ticket life: [infinite]
  91 Realm max renewable ticket life: [infinite]
  92 Default ticket life: [1 day]
  93 Default renewable ticket life: [7 days]
  94 kdb_edit> ank me
  95 Max ticket life [1 day]:
  96 Max renewable ticket [7 days]:
  97 Password:
  98 Verifying password - Password:
  99 @end example
 100
 101 Now start the KDC and try getting a ticket.
 102
 103 @example
 104 # kdc &
 105 # kinit me
 106 me@@MY.REALMS's Password:
 107 # klist
 108 Credentials cache: /tmp/krb5cc_3008
 109         Principal: me@@MY.REALM
 110
 111   Issued           Expires          Principal
 112 Aug 25 07:25:55  Aug 25 17:25:55  krbtgt/MY.REALM@@MY.REALM
 113 @end example