src/man/kpropd.man

   1 .TH "KPROPD" "8" " " "0.0.1" "MIT Kerberos"
   2 .SH NAME
   3 kpropd \- Kerberos V5 slave KDC update server
   4 .
   5 .nr rst2man-indent-level 0
   6 .
   7 .de1 rstReportMargin
   8 \\$1 \\n[an-margin]
   9 level \\n[rst2man-indent-level]
  10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  11 -
  12 \\n[rst2man-indent0]
  13 \\n[rst2man-indent1]
  14 \\n[rst2man-indent2]
  15 ..
  16 .de1 INDENT
  17 .\" .rstReportMargin pre:
  18 . RS \\$1
  19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  20 . nr rst2man-indent-level +1
  21 .\" .rstReportMargin post:
  22 ..
  23 .de UNINDENT
  24 . RE
  25 .\" indent \\n[an-margin]
  26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  27 .nr rst2man-indent-level -1
  28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  30 ..
  31 .\" Man page generated from reStructeredText.
  32 .
  33 .SH SYNOPSIS
  34 .sp
  35 \fBkpropd\fP
  36 [\fB\-r\fP \fIrealm\fP]
  37 [\fB\-a\fP \fIacl_file\fP]
  38 [\fB\-f\fP \fIslave_dumpfile\fP]
  39 [\fB\-F\fP \fIprincipal_database\fP]
  40 [\fB\-p\fP \fIkdb5_util_prog\fP]
  41 [\fB\-P\fP \fIport\fP]
  42 [\fB\-d\fP]
  43 [\fB\-S\fP]
  44 .SH DESCRIPTION
  45 .sp
  46 The \fIkpropd\fP command runs on the slave KDC server.  It listens for
  47 update requests made by the \fIkprop(8)\fP program.  If incremental
  48 propagation is enabled, it periodically requests incremental updates
  49 from the master KDC.
  50 .sp
  51 When the slave receives a kprop request from the master, kpropd
  52 accepts the dumped KDC database and places it in a file, and then runs
  53 \fIkdb5_util(8)\fP to load the dumped database into the active
  54 database which is used by \fIkrb5kdc(8)\fP.  This allows the master
  55 Kerberos server to use \fIkprop(8)\fP to propagate its database to
  56 the slave servers.  Upon a successful download of the KDC database
  57 file, the slave Kerberos server will have an up\-to\-date KDC database.
  58 .sp
  59 Normally, kpropd is invoked out of inetd(8).  This is done by adding
  60 a line to the \fB/etc/inetd.conf\fP file which looks like this:
  61 .INDENT 0.0
  62 .INDENT 3.5
  63 .sp
  64 .nf
  65 .ft C
  66 kprop  stream  tcp  nowait  root  /usr/local/sbin/kpropd  kpropd
  67 .ft P
  68 .fi
  69 .UNINDENT
  70 .UNINDENT
  71 .sp
  72 kpropd can also run as a standalone daemon by specifying the \fB\-S\fP
  73 option.  This is done for debugging purposes, or if for some reason
  74 the system administrator just doesn\(aqt want to run it out of inetd(8).
  75 .sp
  76 Incremental propagation may be enabled with the \fBiprop_enable\fP
  77 variable in \fIkdc.conf(5)\fP.  If incremental propagation is
  78 enabled, the slave periodically polls the master KDC for updates, at
  79 an interval determined by the \fBiprop_slave_poll\fP variable.  If the
  80 slave receives updates, kpropd updates its log file with any updates
  81 from the master.  \fIkproplog(8)\fP can be used to view a summary of
  82 the update entry log on the slave KDC.  If incremental propagation is
  83 enabled, the principal \fBkiprop/slavehostname@REALM\fP (where
  84 \fIslavehostname\fP is the name of the slave KDC host, and \fIREALM\fP is the
  85 name of the Kerberos realm) must be present in the slave\(aqs keytab
  86 file.
  87 .SH OPTIONS
  88 .INDENT 0.0
  89 .TP
  90 .B \fB\-r\fP \fIrealm\fP
  91 .sp
  92 Specifies the realm of the master server.
  93 .TP
  94 .B \fB\-f\fP \fIfile\fP
  95 .sp
  96 Specifies the filename where the dumped principal database file is
  97 to be stored; by default the dumped database file is \fB@LOCALSTATEDIR@/krb5kdc\fP\fB/from_master\fP.
  98 .TP
  99 .B \fB\-p\fP
 100 .sp
 101 Allows the user to specify the pathname to the \fIkdb5_util(8)\fP
 102 program; by default the pathname used is \fB@SBINDIR@\fP\fB/kdb5_util\fP.
 103 .TP
 104 .B \fB\-S\fP
 105 .sp
 106 Turn on standalone mode.  Normally, kpropd is invoked out of
 107 inetd(8) so it expects a network connection to be passed to it
 108 from inetd(8).  If the \fB\-S\fP option is specified, kpropd will put
 109 itself into the background, and wait for connections on port 754
 110 (or the port specified with the \fB\-P\fP option if given).
 111 .TP
 112 .B \fB\-d\fP
 113 .sp
 114 Turn on debug mode.  In this mode, if the \fB\-S\fP option is
 115 selected, kpropd will not detach itself from the current job and
 116 run in the background.  Instead, it will run in the foreground and
 117 print out debugging messages during the database propagation.
 118 .TP
 119 .B \fB\-P\fP
 120 .sp
 121 Allow for an alternate port number for kpropd to listen on.  This
 122 is only useful in combination with the \fB\-S\fP option.
 123 .TP
 124 .B \fB\-a\fP \fIacl_file\fP
 125 .sp
 126 Allows the user to specify the path to the kpropd.acl file; by
 127 default the path used is \fB@LOCALSTATEDIR@/krb5kdc\fP\fB/kpropd.acl\fP.
 128 .UNINDENT
 129 .SH ENVIRONMENT
 130 .sp
 131 kpropd uses the following environment variables:
 132 .INDENT 0.0
 133 .IP \(bu 2
 134 .
 135 \fBKRB5_CONFIG\fP
 136 .IP \(bu 2
 137 .
 138 \fBKRB5_KDC_PROFILE\fP
 139 .UNINDENT
 140 .SH FILES
 141 .INDENT 0.0
 142 .TP
 143 .B kpropd.acl
 144 .
 145 Access file for kpropd; the default location is
 146 \fB/usr/local/var/krb5kdc/kpropd.acl\fP.  Each entry is a line
 147 containing the principal of a host from which the local machine
 148 will allow Kerberos database propagation via \fIkprop(8)\fP.
 149 .UNINDENT
 150 .SH SEE ALSO
 151 .sp
 152 \fIkprop(8)\fP, \fIkdb5_util(8)\fP, \fIkrb5kdc(8)\fP, inetd(8)
 153 .SH AUTHOR
 154 MIT
 155 .SH COPYRIGHT
 156 2011, MIT
 157 .\" Generated by docutils manpage writer.
 158 .