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 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 limits [dn[.{exact|regex}]=]<pattern> <limit> [...]
162 Specify time and size limits based on the distinguished name that
163 initiated an operation.
166 contains the DN the limits are applied to.
167 It is a distinguished name in case of
169 match, or an Extended Regex pattern in case of
172 The currently supported limits are "size" and "time".
174 The syntax for time limits is
175 .BR time[.{soft|hard}]=<integer> ,
178 is the number of seconds slapd will spend answering a search request.
179 If no time limit is explicitly requested by the client, the
181 limit is used; if the requested time limit exceedes the
183 limit, an "Unwilling to perform" is returned.
186 limit is set to 0 or to the keyword "soft", the soft limit is used
187 in either case; if it is set to -1 or to the keyword "none",
188 no hard limit is enforced.
189 Explicit requests for time limits smaller or equal to the
192 If no flag is set, the value is assigned to the
196 limit is set to zero, to preserve the original behavior.
198 The syntax for size limits is
199 .BR size[.{soft|hard|unchecked}]=<integer> ,
202 is the maximum number of entries slapd will return answering a search
204 If no size limit is explicitly requested by the client, the
206 limit is used; if the requested size limit exceedes the
208 limit, an "Unwilling to perform" is returned.
211 limit is set to 0 or to the keyword "soft", the soft limit is used
212 in either case; if it is set to -1 or to the keyword "none",
213 no hard limit is enforced.
214 Explicit requests for size limits smaller or equal to the
219 flag sets a limit on the number of candidates a search request is allowed
221 If the selected candidates exceed the
223 limit, the search will abort with "Unwilling to perform".
224 If it is set to -1 or to the keyword "none", no limit is applied (the default).
225 If no flag is set, the value is assigned to the
229 limit is set to zero, to preserve the original behavior.
231 In case of no match, the global limits are used.
232 The default values are the same of
238 This feature is currently exploited by the ldbm backend only.
240 .B loglevel <integer>
241 Specify the level at which debugging statements and operation
242 statistics should be syslogged (currently logged to the
244 LOG_LOCAL4 facility). Log levels are additive, and available levels
254 debug packet handling
257 heavy trace debugging
260 connection management
263 print out packets sent and received
266 search filter processing
269 configuration file processing
272 access control list processing
275 stats log connections/operations/results
278 stats log entries sent
281 print communication with shell backends
289 .B objectclass ( <oid> [NAME <name>] [DESC <description] [OBSOLETE]\
290 [SUP <oids>] [{ ABSTRACT | STRUCTURAL | AUXILIARY }] [MUST <oids>]\
293 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
294 The slapd parser extends the RFC 2252 definition by allowing string
295 forms as well as numeric OIDs to be used for the object class OID.
299 description.) Object classes are "STRUCTURAL" by default.
302 .B objectidentifier <name> { <oid> | <name>[:<suffix>] }
303 Define a string name that equates to the given OID. The string can be used
304 in place of the numeric OID in objectclass and attribute definitions. The
305 name can also be used with a suffix of the form ":xx" in which case the
306 value "oid.xx" will be used.
308 .B password-hash <hash>
309 The <hash> to use for userPassword generation. One of
322 .B password-crypt-salt-format <format>
323 Specify the format of the salt passed to
325 when generating {CRYPT} passwords.
326 This string needs to be in
328 format and may include one (and only one) %s conversion.
329 This conversion will be substituted with a string random
330 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
331 provides a two character salt and "$1$%.8s" tells some
332 versions of crypt(3) to use an MD5 algorithm and provides
333 8 random characters of salt. The default is "%s", which
334 provides 31 characters of salt.
336 .B pidfile <filename>
337 The ( absolute ) name of a file that will hold the
339 server's process ID ( see
341 ) if started without the debugging command line option.
344 Specify the referral to pass back when
346 cannot find a local database to handle a request.
347 If specified multiple times, each url is provided.
349 .B require <conditions>
350 Specify a set of conditions (separated by white space) to
351 require (default none).
352 The directive may be specified globally and/or per-database.
354 requires bind operation prior to directory operations.
356 requires session to be using LDAP version 3.
358 requires authentication prior to directory operations.
360 requires SASL authentication prior to directory operations.
362 requires strong authentication prior to directory operations.
367 conditions are currently same.
369 may be used to require no conditions (useful for clearly globally
370 set conditions within a particular database).
373 Used to specify the fully qualified domain name used for SASL processing.
375 .B sasl-realm <realm>
376 Specify SASL realm. Default is empty.
378 .B sasl-regexp <match> <replace>
379 Used by the SASL authorization mechanism to convert a SASL authenticated
380 username to an LDAP DN. When an authorization request is received, the SASL
384 are taken, when available, and combined into a SASL name of the
389 .B uid=<UID>[,cn=<REALM>][,cn=<MECH>],cn=AUTHZ
392 This SASL name is then compared against the
394 regular expression, and if the match is successful, the SASL name is
397 string. If there are wildcard strings in the
399 regular expression that are enclosed in parenthesis, e.g.
403 .B uid=(.*)\\\\+realm=.*
407 then the portion of the SASL name that matched the wildcard will be stored
408 in the numbered placeholder variable $1. If there are other wildcard strings
409 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
410 placeholders can then be used in the
416 .B cn=$1,ou=Accounts,dc=$2,dc=$4.
420 The replaced SASL name can be either a DN or an LDAP URI. If the latter, the slapd
421 server will use the URI to search its own database, and if the search returns
422 exactly one entry, the SASL name is replaced by the DN of that entry.
425 options can be given in the configuration file to allow for multiple matching
426 and replacement patterns. The matching patterns are checked in the order they
427 appear in the file, stopping at the first successful match.
430 Because the plus sign + is a character recognized by the regular expression engine,
431 and it will appear in SASL names that include a REALM, be careful to escape the
432 plus sign with a backslash \\+ to remove the character's special meaning.
435 .B sasl-secprops <properties>
436 Used to specify Cyrus SASL security properties.
439 flag (without any other properities) causes the flag properites
440 default, "noanonymous,noplain", to be cleared.
443 flag disables mechanisms susceptible to simple passive attacks.
446 flag disables mechanisms susceptible to active attacks.
449 flag disables mechanisms susceptible to passive dictionary attacks.
452 flag disables mechanisms which support anonymous login.
455 flag require forward secrecy between sessions.
458 require mechanisms which pass client credentials (and allow
459 mechanisms which can pass credentials to do so).
462 property specifies the minimum acceptable
463 .I security strength factor
464 as an integer approximate to effective key length used for
465 encryption. 0 (zero) implies no protection, 1 implies integrity
466 protection only, 56 allows DES or other weak ciphers, 112
467 allows triple DES and other strong ciphers, 128 allows RC4,
468 Blowfish and other modern strong ciphers. The default is 0.
471 property specifies the maximum acceptable
472 .I security strength factor
473 as an integer (see minssf description). The default is INT_MAX.
476 property specifies the maximum security layer receive buffer
477 size allowed. 0 disables security layers. The default is 65536.
479 .B schemacheck { on | off }
480 Turn schema checking on or off. The default is on.
482 .B security <factors>
483 Specify a set of factors (separated by white space) to require.
484 An integer value is associated with each factor and is roughly
485 equivalent of the encryption key length to require. A value
486 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
487 The directive may be specified globally and/or per-database.
489 specifies the overall security strength factor.
491 specifies the transport security strength factor.
493 specifies the TLS security strength factor.
495 specifies the SASL security strength factor.
497 specifies the overall security strength factor to require for
499 .B update_transport=<n>
500 specifies the transport security strength factor to require for
503 specifies the TLS security strength factor to require for
506 specifies the SASL security strength factor to require for
510 factor is measure of security provided by the underlying transport,
511 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
513 .B sizelimit <integer>
515 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
516 Specify the maximum number of entries to return from a search operation.
517 The default size limit is 500.
518 The second format allows a fine grain setting of the size limits.
519 Extra args can be added on the same line.
522 for an explanation of the different flags.
524 .B sockbuf_max_incoming <integer>
525 Specify the maximum incoming LDAP PDU size for anonymous sessions.
526 The default is 262143.
528 .B sockbuf_max_incoming_auth <integer>
529 Specify the maximum incoming LDAP PDU size for authenticated sessions.
530 The default is 4194303.
533 Specify the srvtab file in which the kerberos keys necessary for
534 authenticating clients using kerberos can be found. This option is only
535 meaningful if you are using Kerberos authentication.
538 Specify the maximum size of the primary thread pool.
541 .B timelimit <integer>
543 .B timelimit time[.{soft|hard}]=<integer> [...]
544 Specify the maximum number of seconds (in real time)
546 will spend answering a search request. The default time limit is 3600.
547 The second format allows a fine grain setting of the time limits.
548 Extra args can be added on the same line.
551 for an explanation of the different flags.
555 is build with support for Transport Layer Security, there are more options
558 .B TLSCipherSuite <cipher-suite-spec>
559 Permits configuring what ciphers will be accepted and the preference order.
560 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
562 TLSCipherSuite HIGH:MEDIUM:+SSLv2
564 To check what ciphers a given spec selects, use:
566 openssl ciphers -v <cipher-suite-spec>
568 .B TLSCertificateFile <filename>
569 Specifies the file that contains the
573 .B TLSCertificateKeyFile <filename>
574 Specifies the file that contains the
576 server private key that matches the certificate stored in the
577 .B TLSCertificateFile
578 file. Currently, the private key must not be protected with a password, so
579 it is of critical importance that it is protected carefully.
581 .B TLSRandFile <filename>
582 Specifies the file to obtain random bits from when /dev/[u]random
583 is not available. Generally set to the name of the EGD/PRNGD socket.
584 The environment variable RANDFILE can also be used to specify the filename.
585 .SH GENERAL BACKEND OPTIONS
586 Options in this section only apply to the configuration file section
587 for the specified backend. They are supported by every
590 .B backend <databasetype>
591 Mark the beginning of a backend definition. <databasetype>
597 depending on which backend will serve the database.
599 .SH GENERAL DATABASE OPTIONS
600 Options in this section only apply to the configuration file section
601 for the database in which they are defined. They are supported by every
604 .B database <databasetype>
605 Mark the beginning of a new database instance definition. <databasetype>
611 depending on which backend will serve the database.
616 will automatically maintain the
617 modifiersName, modifyTimestamp, creatorsName, and
618 createTimestamp attributes for entries. By default, lastmod is on.
621 This option puts the database into "read-only" mode. Any attempts to
622 modify the database will return an "unwilling to perform" error. By
623 default, readonly is off.
625 .B replica host=<hostname>[:port] [tls=yes|critical]
626 .B [suffix=<suffix> [...]]
627 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
628 .B [saslmech=<SASL mech>] [secopts=<options>] [realm=<realm>]
629 .B [authcId=<authentication ID>] [authcId=<authentication ID>]
631 Specify a replication site for this database. Refer to the "OpenLDAP
632 Administrator's Guide" for detailed information on setting up a replicated
634 directory service. Zero or more
636 instances can be used to select the subtrees that will be replicated
637 (defaults to all the database). A
645 and should only be used when adequate security services
646 (e.g TLS or IPSEC) are in place. A
654 will use Kerberos, a kerberos instance should be given in
658 .B replogfile <filename>
659 Specify the name of the replication log file to log changes to.
660 The replication log is typically written by
666 for more information. The specified file should be located
667 in a directory with limited read/write/execute access as the replication
668 logs may contain sensitive information.
671 Specify the distinguished name that is not subject to access control
672 or administrative limit restrictions for operations on this database.
673 This DN may or may not be associated with an entry. An empty root
674 DN (the default) specifies no root access is to be granted. It is
675 recommended that the rootdn only be specified when needed (such as
676 when initially populating a database). If the rootdn is within
677 a namingContext (suffix) of the database, a simple bind password
678 may also be provided using the
683 Specify a password (or hash of the password) for the rootdn. If
684 the rootdn is not within the namingContext of the database, the
685 provided password is ignored.
686 This option accepts all RFC 2307 userPassword formats known to
689 desription) as well as cleartext.
691 may be used to generate a hash of a password. Cleartext
692 and \fB{CRYPT}\fP passwords are not recommended. If empty
693 (the default), authentication of the root DN is by other means
694 (e.g. SASL). Use of SASL is encouraged.
696 .B suffix <dn suffix>
697 Specify the DN suffix of queries that will be passed to this
698 backend database. Multiple suffix lines can be given and at least one is
699 required for each database definition.
702 This option is only applicable in a slave
704 It specifies the DN allowed to make changes to the replica (typically,
707 binds as when making changes to the replica).
710 Specify the referral to pass back when
712 is asked to modify a replicated local database.
713 If specified multiple times, each url is provided.
714 .\" .SH LDBM BACKEND-SPECIFIC OPTIONS
715 .\" Options in this category only apply to the LDBM backend. That is,
716 .\" they must follow "backend ldbm" line and come before any subsequent
717 .\" "backend" or "database" lines. The LDBM backend is a high-performance
718 .\" database that makes extensive use of indexing and caching to speed
720 .SH LDBM DATABASE-SPECIFIC OPTIONS
721 Options in this category only apply to the LDBM databases. That is,
722 they must follow "database ldbm" line and come before any subsequent
723 "backend" or "database" lines.
725 .B cachesize <integer>
726 Specify the size in entries of the in-memory cache maintained
727 by the LDBM backend database instance. The default is 1000 entries.
729 .B dbcachesize <integer>
730 Specify the size in bytes of the in-memory cache associated
731 with each open index file. If not supported by the underlying database
732 method, this option is ignored without comment. The default is 100000 bytes.
735 Specify that no database locking should be performed.
736 Enabling this option may improve performance at the expense of data security.
737 Do NOT run any slap tools while slapd is running.
740 Specify that on-disk database contents should not be immediately
741 synchronized with in memory changes. Enabling this option may improve
742 performance at the expense of data security.
744 .B dbsync <frequency> <maxdelays> <delayinterval>
745 Flush dirty database buffers to disk every
749 (ie. indvidual updates are no longer written to disk). It attempts to avoid
750 syncs during periods of peak activity by waiting
752 seconds if the server is busy, repeating this delay up to
754 times before proceeding.
755 It is an attempt to provide higher write performance with some amount of data
756 security. Note that it may still be possible to get an inconsistent
757 database if the underlying engine fills its cache and writes out individual
758 pages and slapd crashes or is killed before the next sync.
762 are optional and default to
766 respectively, giving a total elapsed delay of 60 seconds before a sync
771 must be 1 or greater.
773 .B directory <directory>
774 Specify the directory where the LDBM files containing this database and
775 associated indexes live. A separate directory must be specified for
776 each database. The default is
777 .BR LOCALSTATEDIR/openldap-ldbm .
780 index {<attrlist>|default} [pres,eq,approx,sub,<special>]
781 Specify the indexes to maintain for the given attribute. If only
782 an <attr> is given, the indices specified for \fBdefault\fR
783 are maintained. A number of special index parameters may be
787 can be decomposed into
794 may be specified to allow use of this index by language subtypes.
797 may be specified to automatically maintain separate indices for each
801 may be specified to allow use of this index by named subtypes.
804 may be specified to automatically maintain separate indices for each
808 Specify the file protection mode that newly created database
809 index files should have. The default is 0600.
810 .SH SHELL DATABASE-SPECIFIC OPTIONS
811 Options in this category only apply to the SHELL backend database. That is,
812 they must follow a "database shell" line and come before any subsequent
813 "backend" or "database" lines. The Shell backend executes external programs to
814 implement operations, and is designed to make it easy to tie an existing
825 .B compare <pathname>
835 .B abandon <pathname>
836 These options specify the pathname of the command to execute in response
837 to the given LDAP operation.
839 Note that you need only supply configuration lines for those commands you
840 want the backend to handle. Operations for which a command is not
841 supplied will be refused with an "unwilling to perform" error.
842 .SH PASSWORD DATABASE-SPECIFIC OPTIONS
843 Options in this category only apply to the PASSWD backend database.
844 That is, they must follow a "database passwd" line and come before any
845 subsequent "backend" or "database" lines. The PASSWD database serves up the user
846 account information listed in the system
851 Specifies an alternate passwd file to use. The default is
854 "OpenLDAP Administrator's Guide" contains an annotated
855 example of a configuration file.
860 .BR slapd.replog (5),
867 .BR slappassword (8),
870 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
873 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
875 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob