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 password-crypt-salt-format <format>
244 Specify the format of the salt passed to
246 when generating {CRYPT} passwords.
247 This string needs to be in
249 format and may include one (and only one) %s conversion.
250 This conversion will be substituted with a string random
251 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
252 provides a two character salt and "$1$%.8s" tells some
253 versions of crypt(3) to use an MD5 algorithm and provides
254 8 random characters of salt. The default is "%s", which
255 provides 31 characters of salt.
257 .B pidfile <filename>
258 The ( absolute ) name of a file that will hold the
260 server's process ID ( see
262 ) if started without the debugging command line option.
265 Specify the referral to pass back when
267 cannot find a local database to handle a request.
268 If specified multiple times, each url is provided.
270 .B require <conditions>
271 Specify a set of conditions (separated by white space) to
272 require (default none).
273 The directive may be specified globally and/or per-database.
275 requires bind operation prior to directory operations.
277 requires session to be using LDAP version 3.
279 requires authentication prior to directory operations.
281 requires SASL authentication prior to directory operations.
283 requires strong authentication prior to directory operations.
288 conditions are currently same.
290 may be used to require no conditions (useful for clearly globally
291 set conditions within a particular database).
294 Used to specify the fully qualified domain name used for SASL processing.
296 .B sasl-realm <realm>
297 Specify SASL realm. Default is empty.
299 .B sasl-regexp <match> <replace>
300 Used by the SASL authorization mechanism to convert a SASL authenticated
301 username to an LDAP DN. When an authorization request is received, the SASL
305 are taken, when available, and combined into a SASL name of the
310 .B uid=<UID>[,cn=<REALM>][,cn=<MECH>],cn=AUTHZ
313 This SASL name is then compared against the
315 regular expression, and if the match is successful, the SASL name is
318 string. If there are wildcard strings in the
320 regular expression that are enclosed in parenthesis, e.g.
324 .B uid=(.*)\\\\+realm=.*
328 then the portion of the SASL name that matched the wildcard will be stored
329 in the numbered placeholder variable $1. If there are other wildcard strings
330 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
331 placeholders can then be used in the
337 .B cn=$1,ou=Accounts,dc=$2,dc=$4.
341 The replaced SASL name can be either a DN or an LDAP URI. If the latter, the slapd
342 server will use the URI to search its own database, and if the search returns
343 exactly one entry, the SASL name is replaced by the DN of that entry.
346 options can be given in the configuration file to allow for multiple matching
347 and replacement patterns. The matching patterns are checked in the order they
348 appear in the file, stopping at the first successful match.
351 Because the plus sign + is a character recognized by the regular expression engine,
352 and it will appear in SASL names that include a REALM, be careful to escape the
353 plus sign with a backslash \\+ to remove the character's special meaning.
356 .B sasl-secprops <properties>
357 Used to specify Cyrus SASL security properties.
360 flag (without any other properities) causes the flag properites
361 default, "noanonymous,noplain", to be cleared.
364 flag disables mechanisms susceptible to simple passive attacks.
367 flag disables mechanisms susceptible to active attacks.
370 flag disables mechanisms susceptible to passive dictionary attacks.
373 flag disables mechanisms which support anonymous login.
376 flag require forward secrecy between sessions.
379 require mechanisms which pass client credentials (and allow
380 mechanisms which can pass credentials to do so).
383 property specifies the minimum acceptable
384 .I security strength factor
385 as an integer approximate to effective key length used for
386 encryption. 0 (zero) implies no protection, 1 implies integrity
387 protection only, 56 allows DES or other weak ciphers, 112
388 allows triple DES and other strong ciphers, 128 allows RC4,
389 Blowfish and other modern strong ciphers. The default is 0.
392 property specifies the maximum acceptable
393 .I security strength factor
394 as an integer (see minssf description). The default is INT_MAX.
397 property specifies the maximum security layer receive buffer
398 size allowed. 0 disables security layers. The default is 65536.
400 .B schemacheck { on | off }
401 Turn schema checking on or off. The default is on.
403 .B security <factors>
404 Specify a set of factors (separated by white space) to require.
405 An integer value is associated with each factor and is roughly
406 equivalent of the encryption key length to require. A value
407 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
408 The directive may be specified globally and/or per-database.
410 specifies the overall security strength factor.
412 specifies the transport security strength factor.
414 specifies the TLS security strength factor.
416 specifies the SASL security strength factor.
418 specifies the overall security strength factor to require for
420 .B update_transport=<n>
421 specifies the transport security strength factor to require for
424 specifies the TLS security strength factor to require for
427 specifies the SASL security strength factor to require for
431 factor is measure of security provided by the underlying transport,
432 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
434 .B schemacheck { on | off }
435 Turn schema checking on or off. The default is on.
437 .B sizelimit <integer>
438 Specify the maximum number of entries to return from a search operation.
439 The default size limit is 500.
441 .B sockbuf_max_incoming <integer>
442 Specify the maximum incoming LDAP PDU size for anonymous sessions.
443 The default is 262143.
445 .B sockbuf_max_incoming_auth <integer>
446 Specify the maximum incoming LDAP PDU size for authenticated sessions.
447 The default is 4194303.
450 Specify the srvtab file in which the kerberos keys necessary for
451 authenticating clients using kerberos can be found. This option is only
452 meaningful if you are using Kerberos authentication.
455 Specify the maximum size of the primary thread pool.
458 .B timelimit <integer>
459 Specify the maximum number of seconds (in real time)
461 will spend answering a search request. The default time limit is 3600.
465 is build with support for Transport Layer Security, there are more options
468 .B TLSCipherSuite <cipher-suite-spec>
469 Permits configuring what ciphers will be accepted and the preference order.
470 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
472 TLSCipherSuite HIGH:MEDIUM:+SSLv2
474 To check what ciphers a given spec selects, use:
476 openssl ciphers -v <cipher-suite-spec>
478 .B TLSCertificateFile <filename>
479 Specifies the file that contains the
483 .B TLSCertificateKeyFile <filename>
484 Specifies the file that contains the
486 server private key that matches the certificate stored in the
487 .B TLSCertificateFile
488 file. Currently, the private key must not be protected with a password, so
489 it is of critical importance that it is protected carefully.
491 .B TLSRandFile <filename>
492 Specifies the file to obtain random bits from when /dev/[u]random
493 is not available. Generally set to the name of the EGD/PRNGD socket.
494 The environment variable RANDFILE can also be used to specify the filename.
495 .SH GENERAL BACKEND OPTIONS
496 Options in this section only apply to the configuration file section
497 for the specified backend. They are supported by every
500 .B backend <databasetype>
501 Mark the beginning of a backend definition. <databasetype>
507 depending on which backend will serve the database.
509 .SH GENERAL DATABASE OPTIONS
510 Options in this section only apply to the configuration file section
511 for the database in which they are defined. They are supported by every
514 .B database <databasetype>
515 Mark the beginning of a new database instance definition. <databasetype>
521 depending on which backend will serve the database.
526 will automatically maintain the
527 modifiersName, modifyTimestamp, creatorsName, and
528 createTimestamp attributes for entries. By default, lastmod is on.
531 This option puts the database into "read-only" mode. Any attempts to
532 modify the database will return an "unwilling to perform" error. By
533 default, readonly is off.
535 .B replica host=<hostname>[:port] [tls=yes|critical]
536 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
537 .B [saslmech=<SASL mech>] [secopts=<options>] [realm=<realm>]
538 .B [authcId=<authentication ID>] [authcId=<authentication ID>]
540 Specify a replication site for this database. Refer to the "OpenLDAP
541 Administrator's Guide" for detailed information on setting up a replicated
551 and should only be used when adequate security services
552 (e.g TLS or IPSEC) are in place. A
560 will use Kerberos, a kerberos instance should be given in
564 .B replogfile <filename>
565 Specify the name of the replication log file to log changes to.
566 The replication log is typically written by
572 for more information. The specified file should be located
573 in a directory with limited read/write/execute access as the replication
574 logs may contain sensitive information.
577 Specify the distinguished name that is not subject to access control
578 or administrative limit restrictions for operations on this database.
579 This DN may or may not be associated with an entry. An empty root
580 DN (the default) specifies no root access is to be granted. It is
581 recommended that the rootdn only be specified when needed (such as
582 when initially populating a database). If the rootdn is within
583 a namingContext (suffix) of the database, a simple bind password
584 may also be provided using the
589 Specify a password (or hash of the password) for the rootdn. If
590 the rootdn is not within the namingContext of the database, the
591 provided password is ignored.
592 This option accepts all RFC 2307 userPassword formats known to
595 desription) as well as cleartext.
597 may be used to generate a hash of a password. Cleartext
598 and \fB{CRYPT}\fP passwords are not recommended. If empty
599 (the default), authentication of the root DN is by other means
600 (e.g. SASL). Use of SASL is encouraged.
602 .B suffix <dn suffix>
603 Specify the DN suffix of queries that will be passed to this
604 backend database. Multiple suffix lines can be given and at least one is
605 required for each database definition.
608 This option is only applicable in a slave
610 It specifies the DN allowed to make changes to the replica (typically,
613 binds as when making changes to the replica).
616 Specify the referral to pass back when
618 is asked to modify a replicated local database.
619 If specified multiple times, each url is provided.
620 .SH LDBM BACKEND-SPECIFIC OPTIONS
621 Options in this category only apply to the LDBM backend. That is,
622 they must follow "backend ldbm" line and come before any subsequent
623 "backend" or "database" lines. The LDBM backend is a high-performance
624 database that makes extensive use of indexing and caching to speed
627 .B directory <directory>
628 Specify the directory where shared LDBM files, namely those associated
629 with a BerkeleyDB environment, for all LDBM databases are kept.
630 The default is unset.
631 .SH LDBM DATABASE-SPECIFIC OPTIONS
632 Options in this category only apply to the LDBM databases. That is,
633 they must follow "database ldbm" line and come before any subsequent
634 "backend" or "database" lines.
636 .B cachesize <integer>
637 Specify the size in entries of the in-memory cache maintained
638 by the LDBM backend database instance. The default is 1000 entries.
640 .B dbcachesize <integer>
641 Specify the size in bytes of the in-memory cache associated
642 with each open index file. If not supported by the underlying database
643 method, this option is ignored without comment. The default is 100000 bytes.
646 Specify that no database locking should be performed.
647 Enabling this option may improve performance at the expense of data security.
649 Specify that on-disk database contents should not be immediately
650 synchronized with in memory changes. Enabling this option may improve
651 performance at the expense of data security.
653 .B directory <directory>
654 Specify the directory where the LDBM files containing this database and
655 associated indexes live. A separate directory must be specified for
656 each database. The default is
657 .BR LOCALSTATEDIR/openldap-ldbm .
660 index {<attrlist>|default} [pres,eq,approx,sub,<special>]
661 Specify the indexes to maintain for the given attribute. If only
662 an <attr> is given, the indices specified for \fBdefault\fR
663 are maintained. A number of special index parameters may be
667 can be decomposed into
674 may be specified to allow use of this index by language subtypes.
677 may be specified to automatically maintain separate indices for each
681 may be specified to allow use of this index by named subtypes.
684 may be specified to automatically maintain separate indices for each
688 Specify the file protection mode that newly created database
689 index files should have. The default is 0600.
690 .SH SHELL DATABASE-SPECIFIC OPTIONS
691 Options in this category only apply to the SHELL backend database. That is,
692 they must follow a "database shell" line and come before any subsequent
693 "backend" or "database" lines. The Shell backend executes external programs to
694 implement operations, and is designed to make it easy to tie an existing
705 .B compare <pathname>
715 .B abandon <pathname>
716 These options specify the pathname of the command to execute in response
717 to the given LDAP operation.
719 Note that you need only supply configuration lines for those commands you
720 want the backend to handle. Operations for which a command is not
721 supplied will be refused with an "unwilling to perform" error.
722 .SH PASSWORD DATABASE-SPECIFIC OPTIONS
723 Options in this category only apply to the PASSWD backend database.
724 That is, they must follow a "database passwd" line and come before any
725 subsequent "backend" or "database" lines. The PASSWD database serves up the user
726 account information listed in the system
731 Specifies an alternate passwd file to use. The default is
734 "OpenLDAP Administrator's Guide" contains an annotated
735 example of a configuration file.
740 .BR slapd.replog (5),
747 .BR slappassword (8),
750 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
753 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
755 is derived from University of Michigan LDAP 3.3 Release.