share/man/man8/kpropd.8

   1 '\" te
   2 .\" Copyright 1987, 1989 by the Student Information Processing Board of the Massachusetts Institute of Technology.  For copying and distribution information,  please see the file kerberosv5/mit-sipb-copyright.h.
   3 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH KPROPD 8 "Jul 11, 2005"
   8 .SH NAME
   9 kpropd \- Kerberos propagation daemon for slave KDCs
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/usr/lib/krb5/kpropd\fR [\fB-d\fR] [\fB-f\fR \fItemp_dbfile\fR] [\fB-F\fR \fIdbfile\fR]
  14      [\fB-p\fR \fIkdb_util\fR] [\fB-P\fR \fIport_number\fR] [\fB-r\fR \fIrealm\fR]
  15      [\fB-s\fR \fIsrv_tabfile\fR] [\fB-S\fR] [\fB-a\fR \fIacl_file\fR]
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBkpropd\fR command runs on the slave KDC server. It listens for update
  22 requests made by \fBkprop\fR(8) from the master KDC and periodically requests
  23 incremental updates from the master KDC.
  24 .sp
  25 .LP
  26 When the slave receives a kprop request from the master, \fBkpropd\fR copies
  27 principal data to a temporary text file. Next, \fBkpropd\fR invokes
  28 \fBkdb5_util\fR(8) (unless a different database utility is selected) to load
  29 the text file in database format.
  30 .sp
  31 .LP
  32 When the slave periodically requests incremental updates, \fBkpropd\fR update
  33 its \fBprincipal.ulog\fR file with any updates from the master.
  34 \fBkproplog\fR(8) can be used to view a summary of the update entry log on the
  35 slave KDC.
  36 .sp
  37 .LP
  38 kpropd is not configured for incremental database propagation by default. These
  39 settings can be changed in the \fBkdc.conf\fR(4) file:
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fBsunw_dbprop_enable = [true | false]\fR\fR
  44 .ad
  45 .sp .6
  46 .RS 4n
  47 Enables or disables incremental database propagation. Default is \fBfalse\fR.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBsunw_dbprop_slave_poll = N[s, m, h]\fR\fR
  54 .ad
  55 .sp .6
  56 .RS 4n
  57 Specifies how often the slave KDC polls for any updates that the master might
  58 have. Default is \fB2m\fR (two minutes).
  59 .RE
  60
  61 .sp
  62 .LP
  63 The \fBkiprop/\fI<hostname>\fR@\fI<REALM>\fR\fR principal must exist in the
  64 slave's \fBkeytab\fR file to enable the master to authenticate incremental
  65 propagation requests from the slave. In this syntax, \fI<hostname>\fR is the
  66 slave KDC's host name and \fI<REALM>\fR is the realm in which the slave KDC
  67 resides.
  68 .SH OPTIONS
  69 .sp
  70 .LP
  71 The following options are supported:
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fB-d\fR\fR
  76 .ad
  77 .RS 18n
  78 Enable debug mode. Default is debug mode disabled.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fB-f\fR \fItemp_dbfile\fR\fR
  85 .ad
  86 .RS 18n
  87 The location of the slave's temporary principal database file. Default is
  88 \fB/var/krb5/from_master\fR.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fB-F\fR \fIdbfile\fR\fR
  95 .ad
  96 .RS 18n
  97 The location of the slave's principal database file. Default is
  98 \fB/var/krb5/principal\fR.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fB-p\fR \fIkdb_util\fR\fR
 105 .ad
 106 .RS 18n
 107 The location of the Kerberos database utility used for loading principal
 108 databases. Default is \fB/usr/sbin/kdb5_util\fR.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fB-P\fR \fIport_number\fR\fR
 115 .ad
 116 .RS 18n
 117 Specifies the port number on which \fBkpropd\fR will listen. Default is 754
 118 (service name: \fBkrb5_prop\fR).
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fB-r\fR \fIrealm\fR\fR
 125 .ad
 126 .RS 18n
 127 Specifies from which Kerberos realm kpropd will receive information. Default is
 128 specified in \fB/etc/krb5/krb5.conf\fR.
 129 .RE
 130
 131 .sp
 132 .ne 2
 133 .na
 134 \fB\fB-s\fR \fIsrv_tabfile\fR\fR
 135 .ad
 136 .RS 18n
 137 The location of the service table file used to authenticate the \fBkpropd\fR
 138 daemon.
 139 .RE
 140
 141 .sp
 142 .ne 2
 143 .na
 144 \fB\fB-S\fR\fR
 145 .ad
 146 .RS 18n
 147 Run the daemon in standalone mode, instead of having \fBinetd\fR listen for
 148 requests. Default is non-standalone mode.
 149 .RE
 150
 151 .sp
 152 .ne 2
 153 .na
 154 \fB\fB-a\fR \fIacl_file\fR\fR
 155 .ad
 156 .RS 18n
 157 The location of the \fBkpropd\fR's access control list to verify if this server
 158 can run the \fBkpropd\fR daemon. The file contains a list of principal name(s)
 159 that will be receiving updates. Default is \fB/etc/krb5/kpropd.acl\fR.
 160 .RE
 161
 162 .SH FILES
 163 .sp
 164 .ne 2
 165 .na
 166 \fB\fB/var/krb5/principal\fR\fR
 167 .ad
 168 .RS 28n
 169 Kerberos principal database.
 170 .RE
 171
 172 .sp
 173 .ne 2
 174 .na
 175 \fB\fB/var/krb5/principal.ulog\fR\fR
 176 .ad
 177 .RS 28n
 178 The update log file.
 179 .RE
 180
 181 .sp
 182 .ne 2
 183 .na
 184 \fB\fB/etc/krb5/kdc.conf\fR\fR
 185 .ad
 186 .RS 28n
 187 KDC configuration information.
 188 .RE
 189
 190 .sp
 191 .ne 2
 192 .na
 193 \fB\fB/etc/krb5/kpropd.acl\fR\fR
 194 .ad
 195 .RS 28n
 196 List of principals of all the KDCs; resides on each slave KDC.
 197 .RE
 198
 199 .sp
 200 .ne 2
 201 .na
 202 \fB\fB/var/krb5/from_master\fR\fR
 203 .ad
 204 .RS 28n
 205 Temporary file used by kpropd before loading this to the principal database.
 206 .RE
 207
 208 .SH ATTRIBUTES
 209 .sp
 210 .LP
 211 See \fBattributes\fR(5) for descriptions of the following attributes:
 212 .sp
 213
 214 .sp
 215 .TS
 216 box;
 217 c | c
 218 l | l .
 219 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 220 _
 221 Interface Stability     Evolving
 222 .TE
 223
 224 .SH SEE ALSO
 225 .sp
 226 .LP
 227 \fBkdb5_util\fR(8), \fBkprop\fR(8), \fBkproplog\fR(8), \fBkdc.conf\fR(4),
 228 \fBkrb5.conf\fR(4), \fBattributes\fR(5), \fBkerberos\fR(5)
 229 .SH NOTES
 230 .sp
 231 .LP
 232 The \fBkprop\fR service is managed by the service management facility,
 233 \fBsmf\fR(5), under the service identifier:
 234 .sp
 235 .in +2
 236 .nf
 237 svc:/network/security/krb5_prop:default
 238 .fi
 239 .in -2
 240 .sp
 241
 242 .sp
 243 .LP
 244 Administrative actions on this service, such as enabling, disabling, or
 245 requesting restart, can be performed using \fBsvcadm\fR(8). Responsibility for
 246 initiating and restarting this service is delegated to \fBinetd\fR(8). Use
 247 \fBinetadm\fR(8) to make configuration changes and to view configuration
 248 information for this service. The service's status can be queried using the
 249 \fBsvcs\fR(1) command.