git.sur5r.net Git - openldap/blob - doc/man/man5/slapd.conf.5

   1 .TH SLAPD.CONF 5 "5 August 1999" "OpenLDAP LDVERSION"
   2 .SH NAME
   3 slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
   4 .SH SYNOPSIS
   5 ETCDIR/slapd.conf
   6 .SH DESCRIPTION
   7 The file
   8 .B ETCDIR/slapd.conf
   9 contains configuration information for the
  10 .BR slapd (8)
  11 daemon.  This configuration file is also used by the
  12 .BR slurpd (8)
  13 replication daemon and by the SLAPD tools
  14 .BR slapadd (8),
  15 .BR slapcat (8),
  16 and
  17 .BR slapindex (8).
  18 .LP
  19 The
  20 .B slapd.conf
  21 file consists of a series of global configuration options that apply to
  22 .B slapd
  23 as a whole (including all backends), followed by zero or more database
  24 backend definitions that contain information specific to a backend
  25 instance.
  26 .LP
  27 The general format of
  28 .B slapd.conf
  29 is as follows:
  30 .LP
  31 .nf
  32     # comment - these options apply to every database
  33     <global configuration options>
  34     # first database definition & configuration options
  35     database    <backend 1 type>
  36     <configuration options specific to backend 1>
  37     # subsequent database definitions & configuration options
  38     ...
  39 .fi
  40 .LP
  41 As many backend-specific sections as desired may be included.  Global
  42 options can be overridden in a backend (for options that appear more
  43 than once, the last appearance in the
  44 .B slapd.conf
  45 file is used).  Blank lines and comment lines beginning with a `#'
  46 character are ignored. If a line begins with white space, it is
  47 considered a continuation of the previous line.
  48 .LP
  49 Arguments on configuration lines are separated by white space. If an
  50 argument contains white space, the argument should be enclosed in
  51 double quotes.  If an argument contains a double quote (`"') or a
  52 backslash character (`\\'), the character should be preceded by a
  53 backslash character.
  54 .LP
  55 The specific configuration options available are discussed below in the
  56 Global Configuration Options, General Backend Options, LDBM
  57 Backend-Specific Options, Shell Backend-Specific Options, and Password
  58 Backend-Specific Options sections.  Refer to "The SLAPD and SLURPD
  59 Administrator's Guide" for more details on the slapd configuration
  60 file.
  61 .SH GLOBAL CONFIGURATION OPTIONS
  62 Options described in this section apply to all backends, unless specifically
  63 overridden in a backend definition. Arguments that should be replaced by
  64 actual text are shown in brackets <>.
  65 .TP
  66 .B
  67 access to <what> [ by <who> <accesslevel> ]+
  68 Grant access (specified by <accesslevel>) to a set of entries and/or
  69 attributes (specified by <what>) by one or more requestors (specified
  70 by <who>).  Refer to "The SLAPD and SLURPD Administrator's Guide" for
  71 information on using the
  72 .B slapd
  73 access-control mechanisms.
  74 .TP
  75 .B
  76 attribute <name> [<name2>] { bin | ces | cis | tel | dn }
  77 Associate a syntax with an attribute name. By default, an
  78 attribute is assumed to have syntax
  79 .BR cis .
  80 An optional alternate name can be
  81 given for an attribute. The possible syntaxes and their meanings are:
  82 .RS
  83 .RS
  84 .PD 0
  85 .TP
  86 .B bin
  87 binary
  88 .TP
  89 .B ces
  90 case exact string
  91 .TP
  92 .B cis
  93 case ignore string
  94 .TP
  95 .B tel
  96 telephone number string
  97 .TP
  98 .B dn
  99 distinguished name
 100 .PD
 101 .RE
 102 .RE
 103 .TP
 104 .B
 105 defaultaccess [self]{ none | compare | search | read | write }
 106 Specify the default access to grant requestors not matched by
 107 any other access line.  The default behavior is to grant read access.
 108 .TP
 109 .B idletimeout <integer>
 110 Specify the number of seconds to wait before forcibly closing
 111 an idle client connections.  A idletimeout of 0 disables this
 112 feature.  The default is 0.
 113 .TP
 114 .B include <filename>
 115 Read additional configuration information from the given file before
 116 continuing with the next line of the current file.
 117 .TP
 118 .B pidfile <filename>
 119 The ( absolute ) name of a file that will hold the
 120 .B slapd
 121 server's process ID ( see
 122 .BR getpid (2)
 123 ) if started without the debugging command line option.
 124 .TP
 125 .B argsfile <filename>
 126 The ( absolute ) name of a file that will hold the
 127 .B slapd
 128 server's command line options
 129 if started without the debugging command line option.
 130 .TP
 131 .B
 132 locale { <locale-name> | on | off }
 133 Obey <locale-name>'s character classification and case conversion; i.e. the
 134 .BR locale (5)
 135 LC_CTYPE category.  See
 136 .BR locale (5)
 137 for details about locales.  "on" takes the locale from the environment,
 138 typically $LANG or $LC_CTYPE, and will only work properly if slapd will
 139 run with the same environment variables as when the database was
 140 generated.  "off" (the default setting) resets to the initial "C" locale.
 141 .TP
 142 .B loglevel <integer>
 143 Specify the level at which debugging statements and operation
 144 statistics should be syslogged (currently logged to the
 145 .BR syslogd (8)
 146 LOG_LOCAL4 facility).  Log levels are additive, and available levels
 147 are:
 148 .RS
 149 .RS
 150 .PD 0
 151 .TP
 152 .B 1
 153 trace function calls
 154 .TP
 155 .B 2
 156 debug packet handling
 157 .TP
 158 .B 4
 159 heavy trace debugging
 160 .TP
 161 .B 8
 162 connection management
 163 .TP
 164 .B 16
 165 print out packets sent and received
 166 .TP
 167 .B 32
 168 search filter processing
 169 .TP
 170 .B 64
 171 configuration file processing
 172 .TP
 173 .B 128
 174 access control list processing
 175 .TP
 176 .B 256
 177 stats log connections/operations/results
 178 .TP
 179 .B 512
 180 stats log entries sent
 181 .TP
 182 .B 1024
 183 print communication with shell backends
 184 .TP
 185 .B 2048
 186 entry parsing
 187 .PD
 188 .RE
 189 .RE
 190 .TP
 191 .B
 192 objectclass <name> requires <attrs> allows <attrs>
 193 Define the schema rules for the object class named <name>.  These are
 194 used in conjunction with the schemacheck option.
 195 .TP
 196 .B referral <url>
 197 Specify the referral to pass back when
 198 .BR slapd (8)
 199 cannot find a local database to handle a request.
 200 If specified multiple times, each url is provided.
 201 .TP
 202 .B schemacheck { on | off }
 203 Turn schema checking on or off. The default is on.
 204 .TP
 205 .B sizelimit <integer>
 206 Specify the maximum number of entries to return from a search operation.
 207 The default size limit is 500.
 208 .TP
 209 .B srvtab <filename>
 210 Specify the srvtab file in which the kerberos keys necessary for
 211 authenticating clients using kerberos can be found. This option is only
 212 meaningful if you are using Kerberos authentication.
 213 .TP
 214 .B timelimit <integer>
 215 Specify the maximum number of seconds (in real time)
 216 .B slapd
 217 will spend answering a search request.  The default time limit is 3600.
 218 .SH TLS OPTIONS
 219 If
 220 .B slapd
 221 is build with support for Transport Layer Security, there are more options
 222 you can specify.
 223 .TP
 224 .B TLSCipherSuite <cipher-suite-spec>
 225 Permits configuring what ciphers will be accepted and the preference order.
 226 <cipher-suite-spec> should be a cipher specification for OpenSSL.  Example:
 227
 228 TLSCipherSuite HIGH:MEDIUM:+SSLv2
 229
 230 To check what ciphers a given spec selects, use:
 231
 232 openssl ciphers -v <cipher-suite-spec>
 233 .TP
 234 .B TLSCertificateFile <filename>
 235 Specifies the file that contains the
 236 .B slapd
 237 server certificate.
 238 .TP
 239 .B TLSCertificateKeyFile <filename>
 240 Specifies the file that contains the
 241 .B slapd
 242 server private key that matches the certificate stored in the
 243 .B TLSCertificateFile
 244 file.  Currently, the private key must not be protected with a password, so
 245 it is of critical importance that it is protected carefully.
 246 .SH GENERAL BACKEND OPTIONS
 247 Options in this section only apply to the configuration file section
 248 for the backend in which they are defined.  They are supported by every
 249 type of backend.
 250 .TP
 251 .B database <databasetype>
 252 Mark the beginning of a new database instance definition. <databasetype>
 253 should be one of
 254 .B ldbm,
 255 .B shell,
 256 or
 257 .B passwd
 258 depending on which backend will serve the database.
 259 .TP
 260 .B lastmod on | off
 261 Controls whether
 262 .B slapd
 263 will automatically maintain the
 264 modifiersName, modifyTimestamp, creatorsName, and
 265 createTimestamp attributes for entries.  By default, lastmod is on.
 266 .TP
 267 .B readonly on | off
 268 This option puts the database into "read-only" mode.  Any attempts to
 269 modify the database will return an "unwilling to perform" error.  By
 270 default, readonly is off.
 271 .TP
 272 .B
 273 replica host=<hostname>[:port] "binddn=<DN>" bindmethod=simple |
 274 .B
 275 kerberos [credentials=<password>] [srvtab=<filename>]
 276 .br
 277 Specify a replication site for this database.  Refer to "The SLAPD and
 278 SLURPD Administrator's Guide" for detailed information on setting up
 279 a replicated
 280 .B slapd
 281 directory service.
 282 .TP
 283 .B replogfile <filename>
 284 Specify the name of the replication log file to log changes to.
 285 The replication log is typically written by
 286 .BR slapd (8)
 287 and read by
 288 .BR slurpd (8).
 289 See
 290 .BR slapd.replog (5)
 291 for more information.
 292 .TP
 293 .B rootdn <dn>
 294 Specify the DN of an entry that is not subject to access control
 295 or administrative limit restrictions for operations on this database.
 296 .TP
 297 .B rootpw <password>
 298 Specify a password (or hash of the password) for the rootdn.
 299 This option accepts all password formats known to the server
 300 including \fB{SHA}\fP, \fB{MD5}\fP, \fB{CRYPT}\fP, and cleartext.
 301 Cleartext passwords are not recommended.
 302 .TP
 303 .B suffix <dn suffix>
 304 Specify the DN suffix of queries that will be passed to this
 305 backend database.  Multiple suffix lines can be given and at least one is
 306 required for each database definition.
 307 .TP
 308 .B updatedn <dn>
 309 This option is only applicable in a slave
 310 .B slapd.
 311 It specifies the DN allowed to make changes to the replica (typically,
 312 this is the DN
 313 .BR slurpd (8)
 314 binds as when making changes to the replica).
 315 .TP
 316 .B updateref <url>
 317 Specify the referral to pass back when
 318 .BR slapd (8)
 319 is asked to modify a replicated local database.
 320 If specified multiple times, each url is provided.
 321 .SH LDBM BACKEND-SPECIFIC OPTIONS
 322 Options in this category only apply to the LDBM backend database. That is,
 323 they must follow a "database ldbm" line and come before any subsequent
 324 "database" lines.  The LDBM backend is a high-performance database that
 325 makes extensive use of indexing and caching to speed data access.
 326 .TP
 327 .B cachesize <integer>
 328 Specify the size in entries of the in-memory cache maintained
 329 by the LDBM backend database instance.  The default is 1000 entries.
 330 .TP
 331 .B dbcachesize <integer>
 332 Specify the size in bytes of the in-memory cache associated
 333 with each open index file. If not supported by the underlying database
 334 method, this option is ignored without comment.  The default is 100000 bytes.
 335 .TP
 336 .B dbcachenowsync
 337 Specify that database writes should not be immediately synchronized
 338 with in memory changes.  Enabling this option may improve performance
 339 at the expense of data security.
 340 .TP
 341 .B directory <directory>
 342 Specify the directory where the LDBM files containing the database and
 343 associated indexes live.  The default is
 344 .B /usr/tmp.
 345 .TP
 346 .B
 347 index { <attrlist> | default } [ pres,eq,approx,sub,none ]
 348 Specify the indexes to maintain for the given attribute. If only
 349 an <attr> is given, all possible indexes are maintained.
 350 .TP
 351 .B mode <integer>
 352 Specify the file protection mode that newly created database
 353 index files should have.  The default is 0600.
 354 .SH SHELL BACKEND-SPECIFIC OPTIONS
 355 Options in this category only apply to the SHELL backend database. That is,
 356 they must follow a "database shell" line and come before any subsequent
 357 "database" lines.  The Shell backend executes external programs to
 358 implement operations, and is designed to make it easy to tie an existing
 359 database to the
 360 .B slapd
 361 front-end.
 362 .TP
 363 .B bind <pathname>
 364 .TP
 365 .B unbind <pathname>
 366 .TP
 367 .B search <pathname>
 368 .TP
 369 .B compare <pathname>
 370 .TP
 371 .B modify <pathname>
 372 .TP
 373 .B modrdn <pathname>
 374 .TP
 375 .B add <pathname>
 376 .TP
 377 .B delete <pathname>
 378 .TP
 379 .B abandon <pathname>
 380 These options specify the pathname of the command to execute in response
 381 to the given LDAP operation. The command given should understand and
 382 follow the input/output conventions described in Appendix B of "The SLAPD
 383 and SLURPD Administrator's Guide."
 384 .LP
 385 Note that you need only supply configuration lines for those commands you
 386 want the backend to handle. Operations for which a command is not
 387 supplied will be refused with an "unwilling to perform" error.
 388 .SH PASSWORD BACKEND-SPECIFIC OPTIONS
 389 Options in this category only apply to the PASSWD backend database.
 390 That is, they must follow a "database passwd" line and come before any
 391 subsequent "database" lines.  The PASSWD database serves up the user
 392 account information listed in the system
 393 .BR passwd (5)
 394 file.
 395 .TP
 396 .B file <filename>
 397 Specifies an alternate passwd file to use.  The default is
 398 .B /etc/passwd.
 399 .SH EXAMPLE
 400 "The SLAPD and SLURPD Administrator's Guide" contains an annotated
 401 example of a configuration file.
 402 .SH FILES
 403 ETCDIR/slapd.conf
 404 .SH SEE ALSO
 405 .BR ldap (3),
 406 .BR slapd.replog (5),
 407 .BR locale (5),
 408 .BR passwd (5),
 409 .BR slapd (8),
 410 .BR slapadd (8),
 411 .BR slapcat (8),
 412 .BR slapindex (8),
 413 .BR slurpd (8),
 414 .LP
 415 "The SLAPD and SLURPD Administrator's Guide"
 416 .SH ACKNOWLEDGEMENTS
 417 .B      OpenLDAP
 418 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 419 .B      OpenLDAP
 420 is derived from University of Michigan LDAP 3.3 Release.