1 .TH SLAPD.CONF 5 "28 May 2001" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2001 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
12 contains configuration information for the
14 daemon. This configuration file is also used by the
16 replication daemon and by the SLAPD tools
24 file consists of a series of global configuration options that apply to
26 as a whole (including all backends), followed by zero or more database
27 backend definitions that contain information specific to a backend
35 # comment - these options apply to every database
36 <global configuration options>
37 # first database definition & configuration options
38 database <backend 1 type>
39 <configuration options specific to backend 1>
40 # subsequent database definitions & configuration options
44 As many backend-specific sections as desired may be included. Global
45 options can be overridden in a backend (for options that appear more
46 than once, the last appearance in the
48 file is used). Blank lines and comment lines beginning with a `#'
49 character are ignored. If a line begins with white space, it is
50 considered a continuation of the previous line.
52 Arguments on configuration lines are separated by white space. If an
53 argument contains white space, the argument should be enclosed in
54 double quotes. If an argument contains a double quote (`"') or a
55 backslash character (`\\'), the character should be preceded by a
58 The specific configuration options available are discussed below
59 in the Global Configuration Options, General Backend Options,
60 General Database Options, LDBM Database-Specific Options, Shell
61 Database-Specific Options, and Password Database-Specific Options
62 sections. Refer to the "OpenLDAP Administrator's Guide" for more
63 details on the slapd configuration file.
64 .SH GLOBAL CONFIGURATION OPTIONS
65 Options described in this section apply to all backends, unless specifically
66 overridden in a backend definition. Arguments that should be replaced by
67 actual text are shown in brackets <>.
69 .B access to <what> [ by <who> <access> <control> ]+
70 Grant access (specified by <access>) to a set of entries and/or
71 attributes (specified by <what>) by one or more requestors (specified
73 See the "OpenLDAP's Administrator's Guide" for details.
76 Specify a set of features (separated by white space) to
79 allows Start TLS to force session to anonymous status (see also
83 .B argsfile <filename>
84 The ( absolute ) name of a file that will hold the
86 server's command line options
87 if started without the debugging command line option.
90 .B attributetype (\ <oid> [NAME\ <name>] [OBSOLETE]\
91 [DESC\ <description>]\
92 [SUP\ <oid>] [EQUALITY\ <oid>] [ORDERING\ <oid>]\
93 [SUBSTR\ <oid>] [SYNTAX\ <oidlen>] [SINGLE\-VALUE] [COLLECTIVE]\
94 [NO\-USER\-MODIFICATION] [USAGE\ <attributeUsage>]\ )
96 Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
97 The slapd parser extends the RFC 2252 definition by allowing string
98 forms as well as numeric OIDs to be used for the attribute OID and
102 description.) Currently the syntax name parser is case-sensitive.
103 The known syntax names are:
107 AttributeTypeDescription Audio Binary BitString Certificate CertificateList
108 CertificatePair DN DeliveryMethod DirectoryString DITContentRuleDescription
109 DITStructureRuleDescription EnhancedGuide FacsimileTelephoneNumber
110 GeneralizedTime Guide IA5String Integer MatchingRuleDescription
111 MatchingRuleUseDescription MailPreference NameAndOptionalUUID
112 NameFormDescription NumericString ObjectClassDescription OID
113 OtherMailbox OctetString PostalAddress ProtocolInformation
114 PresentationAddress PrintableString SupportedAlgorithm TelephoneNumber
115 TeletexTerminalIdentifier TelexNumber UTCTime LDAPSyntaxDescription
116 SubstringAssertion NISnetgrouptriple Bootparameter
122 .B concurrency <integer>
123 Specify a desired level of concurrency. Provided to the underlying
124 thread system as a hint. The default is not to provide any hint.
126 .B defaultaccess { none | auth | compare | search | read | write }
128 Specify the default access level to grant requestors when
129 no access directives were provided for the database.
130 The default behavior is to grant 'read' access. It is
133 directives be used instead.
136 .B defaultsearchbase <dn>
137 Specify a default search base to use when client submits a
138 non-base search request with an empty base DN.
140 .B disallow <features>
141 Specify a set of features (separated by white space) to
142 disallow (default none).
144 disables acceptance of LDAPv2 bind requests.
146 disables acceptance of anonymous bind requests.
148 disables anonymous bind creditials are not empty (e.g.
151 disables anonymous bind when DN is not empty.
153 disables simple (bind) authentication.
155 disables Kerberos V4 (bind) authentication.
157 disables StartTLS if authenticated (see also
161 .B idletimeout <integer>
162 Specify the number of seconds to wait before forcibly closing
163 an idle client connections. A idletimeout of 0 disables this
164 feature. The default is 0.
166 .B include <filename>
167 Read additional configuration information from the given file before
168 continuing with the next line of the current file.
170 .B loglevel <integer>
171 Specify the level at which debugging statements and operation
172 statistics should be syslogged (currently logged to the
174 LOG_LOCAL4 facility). Log levels are additive, and available levels
184 debug packet handling
187 heavy trace debugging
190 connection management
193 print out packets sent and received
196 search filter processing
199 configuration file processing
202 access control list processing
205 stats log connections/operations/results
208 stats log entries sent
211 print communication with shell backends
219 .B objectclass ( <oid> [NAME <name>] [DESC <description] [OBSOLETE]\
220 [SUP <oids>] [{ ABSTRACT | STRUCTURAL | AUXILIARY }] [MUST <oids>]\
223 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
224 The slapd parser extends the RFC 2252 definition by allowing string
225 forms as well as numeric OIDs to be used for the object class OID.
229 description.) Object classes are "STRUCTURAL" by default.
232 .B objectidentifier <name> { <oid> | <name>[:<suffix>] }
233 Define a string name that equates to the given OID. The string can be used
234 in place of the numeric OID in objectclass and attribute definitions. The
235 name can also be used with a suffix of the form ":xx" in which case the
236 value "oid.xx" will be used.
238 .B password-hash <hash>
239 The <hash> to use for userPassword generation. One of
249 .B password-crypt-salt-format <format>
250 Specify the format of the salt passed to
252 when generating {CRYPT} passwords.
253 This string needs to be in
255 format and may include one (and only one) %s conversion.
256 This conversion will be substituted with a string random
257 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
258 provides a two character salt and "$1$%.8s" tells some
259 versions of crypt(3) to use an MD5 algorithm and provides
260 8 random characters of salt. The default is "%s", which
261 provides 31 characters of salt.
263 .B pidfile <filename>
264 The ( absolute ) name of a file that will hold the
266 server's process ID ( see
268 ) if started without the debugging command line option.
271 Specify the referral to pass back when
273 cannot find a local database to handle a request.
274 If specified multiple times, each url is provided.
276 .B require <conditions>
277 Specify a set of conditions (separated by white space) to
278 require (default none).
279 The directive may be specified globally and/or per-database.
281 requires bind operation prior to directory operations.
283 requires session to be using LDAP version 3.
285 requires authentication prior to directory operations.
287 requires SASL authentication prior to directory operations.
289 requires strong authentication prior to directory operations.
294 conditions are currently same.
296 may be used to require no conditions (useful for clearly globally
297 set conditions within a particular database).
300 Used to specify the fully qualified domain name used for SASL processing.
302 .B sasl-realm <realm>
303 Specify SASL realm. Default is empty.
305 .B sasl-secprops <properties>
306 Used to specify Cyrus SASL security properties.
309 flag (without any other properities) causes the flag properites
310 default, "noanonymous,noplain", to be cleared.
313 flag disables mechanisms susceptible to simple passive attacks.
316 flag disables mechanisms susceptible to active attacks.
319 flag disables mechanisms susceptible to passive dictionary attacks.
322 flag disables mechanisms which support anonymous login.
325 flag require forward secrecy between sessions.
328 require mechanisms which pass client credentials (and allow
329 mechanisms which can pass credentials to do so).
332 property specifies the minimum acceptable
333 .I security strength factor
334 as an integer approximate to effective key length used for
335 encryption. 0 (zero) implies no protection, 1 implies integrity
336 protection only, 56 allows DES or other weak ciphers, 112
337 allows triple DES and other strong ciphers, 128 allows RC4,
338 Blowfish and other modern strong ciphers. The default is 0.
341 property specifies the maximum acceptable
342 .I security strength factor
343 as an integer (see minssf description). The default is INT_MAX.
346 property specifies the maximum security layer receive buffer
347 size allowed. 0 disables security layers. The default is 65536.
349 .B schemacheck { on | off }
350 Turn schema checking on or off. The default is on.
352 .B security <factors>
353 Specify a set of factors (separated by white space) to require.
354 An integer value is associated with each factor and is roughly
355 equivalent of the encryption key length to require. A value
356 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
357 The directive may be specified globally and/or per-database.
359 specifies the overall security strength factor.
361 specifies the transport security strength factor.
363 specifies the TLS security strength factor.
365 specifies the SASL security strength factor.
367 specifies the overall security strength factor to require for
369 .B update_transport=<n>
370 specifies the transport security strength factor to require for
373 specifies the TLS security strength factor to require for
376 specifies the SASL security strength factor to require for
380 factor is measure of security provided by the underlying transport,
381 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
383 .B schemacheck { on | off }
384 Turn schema checking on or off. The default is on.
386 .B sizelimit <integer>
387 Specify the maximum number of entries to return from a search operation.
388 The default size limit is 500.
390 .B sockbuf_max_incoming <integer>
391 Specify the maximum incoming LDAP PDU size for anonymous sessions.
392 The default is 262143.
394 .B sockbuf_max_incoming_auth <integer>
395 Specify the maximum incoming LDAP PDU size for authenticated sessions.
396 The default is 4194303.
399 Specify the srvtab file in which the kerberos keys necessary for
400 authenticating clients using kerberos can be found. This option is only
401 meaningful if you are using Kerberos authentication.
404 Specify the maximum size of the primary thread pool.
407 .B timelimit <integer>
408 Specify the maximum number of seconds (in real time)
410 will spend answering a search request. The default time limit is 3600.
414 is build with support for Transport Layer Security, there are more options
417 .B TLSCipherSuite <cipher-suite-spec>
418 Permits configuring what ciphers will be accepted and the preference order.
419 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
421 TLSCipherSuite HIGH:MEDIUM:+SSLv2
423 To check what ciphers a given spec selects, use:
425 openssl ciphers -v <cipher-suite-spec>
427 .B TLSCertificateFile <filename>
428 Specifies the file that contains the
432 .B TLSCertificateKeyFile <filename>
433 Specifies the file that contains the
435 server private key that matches the certificate stored in the
436 .B TLSCertificateFile
437 file. Currently, the private key must not be protected with a password, so
438 it is of critical importance that it is protected carefully.
440 .B TLSRandFile <filename>
441 Specifies the file to obtain random bits from when /dev/[u]random
442 is not available. Generally set to the name of the EGD/PRNGD socket.
443 The environment variable RANDFILE can also be used to specify the filename.
444 .SH GENERAL BACKEND OPTIONS
445 Options in this section only apply to the configuration file section
446 for the specified backend. They are supported by every
449 .B backend <databasetype>
450 Mark the beginning of a backend definition. <databasetype>
456 depending on which backend will serve the database.
458 .SH GENERAL DATABASE OPTIONS
459 Options in this section only apply to the configuration file section
460 for the database in which they are defined. They are supported by every
463 .B database <databasetype>
464 Mark the beginning of a new database instance definition. <databasetype>
470 depending on which backend will serve the database.
475 will automatically maintain the
476 modifiersName, modifyTimestamp, creatorsName, and
477 createTimestamp attributes for entries. By default, lastmod is on.
480 This option puts the database into "read-only" mode. Any attempts to
481 modify the database will return an "unwilling to perform" error. By
482 default, readonly is off.
484 .B replica host=<hostname>[:port] [tls=yes|critical]
485 .B [suffix=<suffix> [...]]
486 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
487 .B [saslmech=<SASL mech>] [secopts=<options>] [realm=<realm>]
488 .B [authcId=<authentication ID>] [authcId=<authentication ID>]
490 Specify a replication site for this database. Refer to the "OpenLDAP
491 Administrator's Guide" for detailed information on setting up a replicated
493 directory service. Zero or more
495 instances can be used to select the subtrees that will be replicated
496 (defaults to all the database). A
504 and should only be used when adequate security services
505 (e.g TLS or IPSEC) are in place. A
513 will use Kerberos, a kerberos instance should be given in
517 .B replogfile <filename>
518 Specify the name of the replication log file to log changes to.
519 The replication log is typically written by
525 for more information. The specified file should be located
526 in a directory with limited read/write/execute access as the replication
527 logs may contain sensitive information.
530 Specify the distinguished name that is not subject to access control
531 or administrative limit restrictions for operations on this database.
532 This DN may or may not be associated with an entry. An empty root
533 DN (the default) specifies no root access is to be granted. It is
534 recommended that the rootdn only be specified when needed (such as
535 when initially populating a database). If the rootdn is within
536 a namingContext (suffix) of the database, a simple bind password
537 may also be provided using the
542 Specify a password (or hash of the password) for the rootdn. If
543 the rootdn is not within the namingContext of the database, the
544 provided password is ignored.
545 This option accepts all RFC 2307 userPassword formats known to
548 desription) as well as cleartext.
550 may be used to generate a hash of a password. Cleartext
551 and \fB{CRYPT}\fP passwords are not recommended. If empty
552 (the default), authentication of the root DN is by other means
553 (e.g. SASL). Use of SASL is encouraged.
555 .B suffix <dn suffix>
556 Specify the DN suffix of queries that will be passed to this
557 backend database. Multiple suffix lines can be given and at least one is
558 required for each database definition.
561 This option is only applicable in a slave
563 It specifies the DN allowed to make changes to the replica (typically,
566 binds as when making changes to the replica).
569 Specify the referral to pass back when
571 is asked to modify a replicated local database.
572 If specified multiple times, each url is provided.
573 .\" .SH LDBM BACKEND-SPECIFIC OPTIONS
574 .\" Options in this category only apply to the LDBM backend. That is,
575 .\" they must follow "backend ldbm" line and come before any subsequent
576 .\" "backend" or "database" lines. The LDBM backend is a high-performance
577 .\" database that makes extensive use of indexing and caching to speed
579 .SH LDBM DATABASE-SPECIFIC OPTIONS
580 Options in this category only apply to the LDBM databases.
581 That is, they must follow "database ldbm" line and come before
582 any subsequent "backend" or "database" lines.
584 .B cachesize <integer>
585 Specify the size in entries of the in-memory cache maintained
586 by the LDBM backend database instance. The default is 1000 entries.
588 .B dbcachesize <integer>
589 Specify the size in bytes of the in-memory cache associated
590 with each open index file. If not supported by the underlying database
591 method, this option is ignored without comment. The default is 100000 bytes.
594 Specify that no database locking should be performed.
595 Enabling this option may improve performance at the expense of data security.
597 Specify that on-disk database contents should not be immediately
598 synchronized with in memory changes. Enabling this option may improve
599 performance at the expense of data security.
601 .B directory <directory>
602 Specify the directory where the LDBM files containing this database and
603 associated indexes live. A separate directory must be specified for
604 each database. The default is
605 .BR LOCALSTATEDIR/openldap-ldbm .
608 index {<attrlist>|default} [pres,eq,approx,sub,<special>]
609 Specify the indexes to maintain for the given attribute. If only
610 an <attr> is given, the indices specified for \fBdefault\fR
611 are maintained. A number of special index parameters may be
615 can be decomposed into
622 may be specified to allow use of this index by language subtypes.
625 may be specified to automatically maintain separate indices for each
629 may be specified to allow use of this index by named subtypes.
632 may be specified to automatically maintain separate indices for each
636 Specify the file protection mode that newly created database
637 index files should have. The default is 0600.
638 .SH SHELL DATABASE-SPECIFIC OPTIONS
639 Options in this category only apply to the SHELL backend database. That is,
640 they must follow a "database shell" line and come before any subsequent
641 "backend" or "database" lines. The Shell backend executes external programs to
642 implement operations, and is designed to make it easy to tie an existing
653 .B compare <pathname>
663 .B abandon <pathname>
664 These options specify the pathname of the command to execute in response
665 to the given LDAP operation.
667 Note that you need only supply configuration lines for those commands you
668 want the backend to handle. Operations for which a command is not
669 supplied will be refused with an "unwilling to perform" error.
670 .SH PASSWORD DATABASE-SPECIFIC OPTIONS
671 Options in this category only apply to the PASSWD backend database.
672 That is, they must follow a "database passwd" line and come before any
673 subsequent "backend" or "database" lines. The PASSWD database serves up the user
674 account information listed in the system
679 Specifies an alternate passwd file to use. The default is
682 "OpenLDAP Administrator's Guide" contains an annotated
683 example of a configuration file.
688 .BR slapd.replog (5),
695 .BR slappassword (8),
698 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
701 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
703 is derived from University of Michigan LDAP 3.3 Release.