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 in the
59 Global Configuration Options, General Backend Options, General Database
60 Options, LDBM Backend-Specific Options, LDBM Database-Specific Options,
61 Shell Database-Specific Options, and Password
62 Database-Specific Options sections. Refer to the "OpenLDAP
63 Administrator's Guide" for more details on the slapd configuration
65 .SH GLOBAL CONFIGURATION OPTIONS
66 Options described in this section apply to all backends, unless specifically
67 overridden in a backend definition. Arguments that should be replaced by
68 actual text are shown in brackets <>.
70 .B access to <what> [ by <who> <access> <control> ]+
71 Grant access (specified by <access>) to a set of entries and/or
72 attributes (specified by <what>) by one or more requestors (specified
74 See the "OpenLDAP's Administrator's Guide" for details.
77 Specify a set of features (separated by white space) to
80 allows Start TLS to force session to anonymous status (see also
84 .B argsfile <filename>
85 The ( absolute ) name of a file that will hold the
87 server's command line options
88 if started without the debugging command line option.
91 .B attributetype (\ <oid> [NAME\ <name>] [OBSOLETE]\
92 [DESC\ <description>]\
93 [SUP\ <oid>] [EQUALITY\ <oid>] [ORDERING\ <oid>]\
94 [SUBSTR\ <oid>] [SYNTAX\ <oidlen>] [SINGLE\-VALUE] [COLLECTIVE]\
95 [NO\-USER\-MODIFICATION] [USAGE\ <attributeUsage>]\ )
97 Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
98 The slapd parser extends the RFC 2252 definition by allowing string
99 forms as well as numeric OIDs to be used for the attribute OID and
100 attribute syntax OID.
103 description.) Currently the syntax name parser is case-sensitive.
104 The known syntax names are:
108 AttributeTypeDescription Audio Binary BitString Certificate CertificateList
109 CertificatePair DN DeliveryMethod DirectoryString DITContentRuleDescription
110 DITStructureRuleDescription EnhancedGuide FacsimileTelephoneNumber
111 GeneralizedTime Guide IA5String Integer MatchingRuleDescription
112 MatchingRuleUseDescription MailPreference NameAndOptionalUUID
113 NameFormDescription NumericString ObjectClassDescription OID
114 OtherMailbox OctetString PostalAddress ProtocolInformation
115 PresentationAddress PrintableString SupportedAlgorithm TelephoneNumber
116 TeletexTerminalIdentifier TelexNumber UTCTime LDAPSyntaxDescription
117 SubstringAssertion NISnetgrouptriple Bootparameter
123 .B concurrency <integer>
124 Specify a desired level of concurrency. Provided to the underlying
125 thread system as a hint. The default is not to provide any hint.
127 .B defaultsearchbase <dn>
128 Specify a default search base to use when client submits a
129 non-base search request with an empty base DN.
131 .B disallow <features>
132 Specify a set of features (separated by white space) to
133 disallow (default none).
135 disables acceptance of LDAPv2 bind requests.
137 disables acceptance of anonymous bind requests.
139 disables anonymous bind creditials are not empty (e.g.
142 disables anonymous bind when DN is not empty.
144 disables simple (bind) authentication.
146 disables Kerberos V4 (bind) authentication.
148 disables StartTLS if authenticated (see also
152 .B idletimeout <integer>
153 Specify the number of seconds to wait before forcibly closing
154 an idle client connections. A idletimeout of 0 disables this
155 feature. The default is 0.
157 .B include <filename>
158 Read additional configuration information from the given file before
159 continuing with the next line of the current file.
161 .B loglevel <integer>
162 Specify the level at which debugging statements and operation
163 statistics should be syslogged (currently logged to the
165 LOG_LOCAL4 facility). Log levels are additive, and available levels
175 debug packet handling
178 heavy trace debugging
181 connection management
184 print out packets sent and received
187 search filter processing
190 configuration file processing
193 access control list processing
196 stats log connections/operations/results
199 stats log entries sent
202 print communication with shell backends
210 .B objectclass ( <oid> [NAME <name>] [DESC <description] [OBSOLETE]\
211 [SUP <oids>] [{ ABSTRACT | STRUCTURAL | AUXILIARY }] [MUST <oids>]\
214 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
215 The slapd parser extends the RFC 2252 definition by allowing string
216 forms as well as numeric OIDs to be used for the object class OID.
220 description.) Object classes are "STRUCTURAL" by default.
223 .B objectidentifier <name> { <oid> | <name>[:<suffix>] }
224 Define a string name that equates to the given OID. The string can be used
225 in place of the numeric OID in objectclass and attribute definitions. The
226 name can also be used with a suffix of the form ":xx" in which case the
227 value "oid.xx" will be used.
229 .B password-hash <hash>
230 The <hash> to use for userPassword generation. One of
243 .B pidfile <filename>
244 The ( absolute ) name of a file that will hold the
246 server's process ID ( see
248 ) if started without the debugging command line option.
251 Specify the referral to pass back when
253 cannot find a local database to handle a request.
254 If specified multiple times, each url is provided.
256 .B require <conditions>
257 Specify a set of conditions (separated by white space) to
258 require (default none).
259 The directive may be specified globally and/or per-database.
261 requires bind operation prior to directory operations.
263 requires session to be using LDAP version 3.
265 requires authentication prior to directory operations.
267 requires SASL authentication prior to directory operations.
269 requires strong authentication prior to directory operations.
274 conditions are currently same.
276 may be used to require no conditions (useful for clearly globally
277 set conditions within a particular database).
280 Used to specify the fully qualified domain name used for SASL processing.
282 .B sasl-realm <realm>
283 Specify SASL realm. Default is empty.
285 .B sasl-regexp <match> <replace>
286 Used by the SASL authorization mechanism to convert a SASL authenticated
287 username to an LDAP DN. When an authorization request is received, the SASL
291 are taken, when available, and combined into a SASL name of the
296 .B uid=<UID>[,cn=<REALM>][,cn=<MECH>],cn=AUTHZ
299 This SASL name is then compared against the
301 regular expression, and if the match is successful, the SASL name is
304 string. If there are wildcard strings in the
306 regular expression that are enclosed in parenthesis, e.g.
310 .B uid=(.*)\\\\+realm=.*
314 then the portion of the SASL name that matched the wildcard will be stored
315 in the numbered placeholder variable $1. If there are other wildcard strings
316 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
317 placeholders can then be used in the
323 .B cn=$1,ou=Accounts,dc=$2,dc=$4.
327 The replaced SASL name can be either a DN or an LDAP URI. If the latter, the slapd
328 server will use the URI to search its own database, and if the search returns
329 exactly one entry, the SASL name is replaced by the DN of that entry.
332 options can be given in the configuration file to allow for multiple matching
333 and replacement patterns. The matching patterns are checked in the order they
334 appear in the file, stopping at the first successful match.
337 Because the plus sign + is a character recognized by the regular expression engine,
338 and it will appear in SASL names that include a REALM, be careful to escape the
339 plus sign with a backslash \\+ to remove the character's special meaning.
342 .B sasl-secprops <properties>
343 Used to specify Cyrus SASL security properties.
346 flag (without any other properities) causes the flag properites
347 default, "noanonymous,noplain", to be cleared.
350 flag disables mechanisms susceptible to simple passive attacks.
353 flag disables mechanisms susceptible to active attacks.
356 flag disables mechanisms susceptible to passive dictionary attacks.
359 flag disables mechanisms which support anonymous login.
362 flag require forward secrecy between sessions.
365 require mechanisms which pass client credentials (and allow
366 mechanisms which can pass credentials to do so).
369 property specifies the minimum acceptable
370 .I security strength factor
371 as an integer approximate to effective key length used for
372 encryption. 0 (zero) implies no protection, 1 implies integrity
373 protection only, 56 allows DES or other weak ciphers, 112
374 allows triple DES and other strong ciphers, 128 allows RC4,
375 Blowfish and other modern strong ciphers. The default is 0.
378 property specifies the maximum acceptable
379 .I security strength factor
380 as an integer (see minssf description). The default is INT_MAX.
383 property specifies the maximum security layer receive buffer
384 size allowed. 0 disables security layers. The default is 65536.
386 .B schemacheck { on | off }
387 Turn schema checking on or off. The default is on.
389 .B security <factors>
390 Specify a set of factors (separated by white space) to require.
391 An integer value is associated with each factor and is roughly
392 equivalent of the encryption key length to require. A value
393 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
394 The directive may be specified globally and/or per-database.
396 specifies the overall security strength factor.
398 specifies the transport security strength factor.
400 specifies the TLS security strength factor.
402 specifies the SASL security strength factor.
404 specifies the overall security strength factor to require for
406 .B update_transport=<n>
407 specifies the transport security strength factor to require for
410 specifies the TLS security strength factor to require for
413 specifies the SASL security strength factor to require for
417 factor is measure of security provided by the underlying transport,
418 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
420 .B schemacheck { on | off }
421 Turn schema checking on or off. The default is on.
423 .B sizelimit <integer>
424 Specify the maximum number of entries to return from a search operation.
425 The default size limit is 500.
427 .B sockbuf_max_incoming <integer>
428 Specify the maximum incoming LDAP PDU size for anonymous sessions.
429 The default is 262143.
431 .B sockbuf_max_incoming_auth <integer>
432 Specify the maximum incoming LDAP PDU size for authenticated sessions.
433 The default is 4194303.
436 Specify the srvtab file in which the kerberos keys necessary for
437 authenticating clients using kerberos can be found. This option is only
438 meaningful if you are using Kerberos authentication.
441 Specify the maximum size of the primary thread pool.
444 .B timelimit <integer>
445 Specify the maximum number of seconds (in real time)
447 will spend answering a search request. The default time limit is 3600.
451 is build with support for Transport Layer Security, there are more options
454 .B TLSCipherSuite <cipher-suite-spec>
455 Permits configuring what ciphers will be accepted and the preference order.
456 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
458 TLSCipherSuite HIGH:MEDIUM:+SSLv2
460 To check what ciphers a given spec selects, use:
462 openssl ciphers -v <cipher-suite-spec>
464 .B TLSCertificateFile <filename>
465 Specifies the file that contains the
469 .B TLSCertificateKeyFile <filename>
470 Specifies the file that contains the
472 server private key that matches the certificate stored in the
473 .B TLSCertificateFile
474 file. Currently, the private key must not be protected with a password, so
475 it is of critical importance that it is protected carefully.
477 .B TLSRandFile <filename>
478 Specifies the file to obtain random bits from when /dev/[u]random
479 is not available. Generally set to the name of the EGD/PRNGD socket.
480 The environment variable RANDFILE can also be used to specify the filename.
481 .SH GENERAL BACKEND OPTIONS
482 Options in this section only apply to the configuration file section
483 for the specified backend. They are supported by every
486 .B backend <databasetype>
487 Mark the beginning of a backend definition. <databasetype>
493 depending on which backend will serve the database.
495 .SH GENERAL DATABASE OPTIONS
496 Options in this section only apply to the configuration file section
497 for the database in which they are defined. They are supported by every
500 .B database <databasetype>
501 Mark the beginning of a new database instance definition. <databasetype>
507 depending on which backend will serve the database.
512 will automatically maintain the
513 modifiersName, modifyTimestamp, creatorsName, and
514 createTimestamp attributes for entries. By default, lastmod is on.
517 This option puts the database into "read-only" mode. Any attempts to
518 modify the database will return an "unwilling to perform" error. By
519 default, readonly is off.
521 .B replica host=<hostname>[:port] [tls=yes|critical]
522 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
523 .B [saslmech=<SASL mech>] [secopts=<options>] [realm=<realm>]
524 .B [authcId=<authentication ID>] [authcId=<authentication ID>]
526 Specify a replication site for this database. Refer to the "OpenLDAP
527 Administrator's Guide" for detailed information on setting up a replicated
537 and should only be used when adequate security services
538 (e.g TLS or IPSEC) are in place. A
546 will use Kerberos, a kerberos instance should be given in
550 .B replogfile <filename>
551 Specify the name of the replication log file to log changes to.
552 The replication log is typically written by
558 for more information. The specified file should be located
559 in a directory with limited read/write/execute access as the replication
560 logs may contain sensitive information.
563 Specify the distinguished name that is not subject to access control
564 or administrative limit restrictions for operations on this database.
565 This DN may or may not be associated with an entry. An empty root
566 DN (the default) specifies no root access is to be granted. It is
567 recommended that the rootdn only be specified when needed (such as
568 when initially populating a database). If the rootdn is within
569 a namingContext (suffix) of the database, a simple bind password
570 may also be provided using the
575 Specify a password (or hash of the password) for the rootdn. If
576 the rootdn is not within the namingContext of the database, the
577 provided password is ignored.
578 This option accepts all RFC 2307 userPassword formats known to
581 desription) as well as cleartext.
583 may be used to generate a hash of a password. Cleartext
584 and \fB{CRYPT}\fP passwords are not recommended. If empty
585 (the default), authentication of the root DN is by other means
586 (e.g. SASL). Use of SASL is encouraged.
588 .B suffix <dn suffix>
589 Specify the DN suffix of queries that will be passed to this
590 backend database. Multiple suffix lines can be given and at least one is
591 required for each database definition.
594 This option is only applicable in a slave
596 It specifies the DN allowed to make changes to the replica (typically,
599 binds as when making changes to the replica).
602 Specify the referral to pass back when
604 is asked to modify a replicated local database.
605 If specified multiple times, each url is provided.
606 .SH LDBM BACKEND-SPECIFIC OPTIONS
607 Options in this category only apply to the LDBM backend. That is,
608 they must follow "backend ldbm" line and come before any subsequent
609 "backend" or "database" lines. The LDBM backend is a high-performance
610 database that makes extensive use of indexing and caching to speed
613 .B directory <directory>
614 Specify the directory where shared LDBM files, namely those associated
615 with a BerkeleyDB environment, for all LDBM databases are kept.
616 The default is unset.
617 .SH LDBM DATABASE-SPECIFIC OPTIONS
618 Options in this category only apply to the LDBM databases. That is,
619 they must follow "database ldbm" line and come before any subsequent
620 "backend" or "database" lines.
622 .B cachesize <integer>
623 Specify the size in entries of the in-memory cache maintained
624 by the LDBM backend database instance. The default is 1000 entries.
626 .B dbcachesize <integer>
627 Specify the size in bytes of the in-memory cache associated
628 with each open index file. If not supported by the underlying database
629 method, this option is ignored without comment. The default is 100000 bytes.
632 Specify that no database locking should be performed.
633 Enabling this option may improve performance at the expense of data security.
635 Specify that on-disk database contents should not be immediately
636 synchronized with in memory changes. Enabling this option may improve
637 performance at the expense of data security.
639 .B directory <directory>
640 Specify the directory where the LDBM files containing this database and
641 associated indexes live. A separate directory must be specified for
642 each database. The default is
643 .BR LOCALSTATEDIR/openldap-ldbm .
646 index {<attrlist>|default} [pres,eq,approx,sub,<special>]
647 Specify the indexes to maintain for the given attribute. If only
648 an <attr> is given, the indices specified for \fBdefault\fR
649 are maintained. A number of special index parameters may be
653 can be decomposed into
660 may be specified to allow use of this index by language subtypes.
663 may be specified to automatically maintain separate indices for each
667 may be specified to allow use of this index by named subtypes.
670 may be specified to automatically maintain separate indices for each
674 Specify the file protection mode that newly created database
675 index files should have. The default is 0600.
676 .SH SHELL DATABASE-SPECIFIC OPTIONS
677 Options in this category only apply to the SHELL backend database. That is,
678 they must follow a "database shell" line and come before any subsequent
679 "backend" or "database" lines. The Shell backend executes external programs to
680 implement operations, and is designed to make it easy to tie an existing
691 .B compare <pathname>
701 .B abandon <pathname>
702 These options specify the pathname of the command to execute in response
703 to the given LDAP operation.
705 Note that you need only supply configuration lines for those commands you
706 want the backend to handle. Operations for which a command is not
707 supplied will be refused with an "unwilling to perform" error.
708 .SH PASSWORD DATABASE-SPECIFIC OPTIONS
709 Options in this category only apply to the PASSWD backend database.
710 That is, they must follow a "database passwd" line and come before any
711 subsequent "backend" or "database" lines. The PASSWD database serves up the user
712 account information listed in the system
717 Specifies an alternate passwd file to use. The default is
720 "OpenLDAP Administrator's Guide" contains an annotated
721 example of a configuration file.
726 .BR slapd.replog (5),
733 .BR slappassword (8),
736 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
739 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
741 is derived from University of Michigan LDAP 3.3 Release.