1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2009 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 SLAPD tools
26 file consists of a series of global configuration options that apply to
28 as a whole (including all backends), followed by zero or more database
29 backend definitions that contain information specific to a backend
31 The configuration options are case-insensitive;
32 their value, on a case by case basis, may be case-sensitive.
39 # comment - these options apply to every database
40 <global configuration options>
41 # first database definition & configuration options
42 database <backend 1 type>
43 <configuration options specific to backend 1>
44 # subsequent database definitions & configuration options
48 As many backend-specific sections as desired may be included. Global
49 options can be overridden in a backend (for options that appear more
50 than once, the last appearance in the
54 If a line begins with white space, it is considered a continuation
55 of the previous line. No physical line should be over 2000 bytes
58 Blank lines and comment lines beginning with
59 a `#' character are ignored. Note: continuation lines are unwrapped
60 before comment processing is applied.
62 Arguments on configuration lines are separated by white space. If an
63 argument contains white space, the argument should be enclosed in
64 double quotes. If an argument contains a double quote (`"') or a
65 backslash character (`\\'), the character should be preceded by a
68 The specific configuration options available are discussed below in the
69 Global Configuration Options, General Backend Options, and General Database
70 Options. Backend-specific options are discussed in the
71 .B slapd\-<backend>(5)
72 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
73 details on the slapd configuration file.
74 .SH GLOBAL CONFIGURATION OPTIONS
75 Options described in this section apply to all backends, unless specifically
76 overridden in a backend definition. Arguments that should be replaced by
77 actual text are shown in brackets <>.
79 .B access to <what> "[ by <who> <access> <control> ]+"
80 Grant access (specified by <access>) to a set of entries and/or
81 attributes (specified by <what>) by one or more requestors (specified
83 If no access controls are present, the default policy
84 allows anyone and everyone to read anything but restricts
85 updates to rootdn. (e.g., "access to * by * read").
86 The rootdn can always read and write EVERYTHING!
89 and the "OpenLDAP's Administrator's Guide" for details.
92 Specify a set of features (separated by white space) to
95 allows acceptance of LDAPv2 bind requests. Note that
97 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
99 allows anonymous bind when credentials are not empty (e.g.
102 allows unauthenticated (anonymous) bind when DN is not empty.
104 allows unauthenticated (anonymous) update operations to be processed
105 (subject to access controls and other administrative limits).
107 allows unauthenticated (anonymous) proxy authorization control to be processed
108 (subject to access controls, authorization and other administrative limits).
110 .B argsfile <filename>
111 The (absolute) name of a file that will hold the
113 server's command line (program name and options).
115 .B attributeoptions [option-name]...
116 Define tagging attribute options or option tag/range prefixes.
117 Options must not end with `\-', prefixes must end with `\-'.
118 The `lang\-' prefix is predefined.
121 directive, `lang\-' will no longer be defined and you must specify it
122 explicitly if you want it defined.
124 An attribute description with a tagging option is a subtype of that
125 attribute description without the option.
126 Except for that, options defined this way have no special semantics.
127 Prefixes defined this way work like the `lang\-' options:
128 They define a prefix for tagging options starting with the prefix.
129 That is, if you define the prefix `x\-foo\-', you can use the option
131 Furthermore, in a search or compare, a prefix or range name (with
132 a trailing `\-') matches all options starting with that name, as well
133 as the option with the range name sans the trailing `\-'.
134 That is, `x\-foo\-bar\-' matches `x\-foo\-bar' and `x\-foo\-bar\-baz'.
136 RFC 4520 reserves options beginning with `x\-' for private experiments.
137 Other options should be registered with IANA, see RFC 4520 section 3.5.
138 OpenLDAP also has the `binary' option built in, but this is a transfer
139 option, not a tagging option.
142 .B attributetype "(\ <oid>\
144 [DESC\ <description>]\
153 [NO\-USER\-MODIFICATION]\
154 [USAGE\ <attributeUsage>]\ )"
156 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
157 The slapd parser extends the RFC 4512 definition by allowing string
158 forms as well as numeric OIDs to be used for the attribute OID and
159 attribute syntax OID.
165 .B authz\-policy <policy>
166 Used to specify which rules to use for Proxy Authorization. Proxy
167 authorization allows a client to authenticate to the server using one
168 user's credentials, but specify a different identity to use for authorization
169 and access control purposes. It essentially allows user A to login as user
170 B, using user A's password.
173 flag disables proxy authorization. This is the default setting.
176 flag will use rules in the
178 attribute of the authorization DN.
181 flag will use rules in the
183 attribute of the authentication DN.
186 flag, an alias for the deprecated value of
188 will allow any of the above, whatever succeeds first (checked in
194 flag requires both authorizations to succeed.
197 The rules are mechanisms to specify which identities are allowed
198 to perform proxy authorization.
201 attribute in an entry specifies which other users
202 are allowed to proxy login to this entry. The
205 an entry specifies which other users this user can authorize as. Use of
208 abused if users are allowed to write arbitrary values to this attribute.
211 attribute must be protected with ACLs such that
212 only privileged users can modify it.
219 or a set of identities; it can take five forms:
222 .B ldap:///<base>??[<scope>]?<filter>
225 .B dn[.<dnstyle>]:<pattern>
228 .B u[.<mech>[/<realm>]]:<pattern>
231 .B group[/objectClass[/attributeType]]:<pattern>
238 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
241 The first form is a valid LDAP
249 portions must be absent, so that the search occurs locally on either
255 with the optional style modifiers
261 for exact, onelevel, children and subtree matches, which cause
263 to be normalized according to the DN normalization rules, or the special
265 style, which causes the
267 to be treated as a POSIX (''extended'') regular expression, as
274 means any non-anonymous DN.
275 The third form is a SASL
277 with the optional fields
281 that allow to specify a SASL
283 and eventually a SASL
285 for those mechanisms that support one.
286 The need to allow the specification of a mechanism is still debated,
287 and users are strongly discouraged to rely on this possibility.
288 The fourth form is a group specification, consisting of the keyword
290 optionally followed by the specification of the group
296 is searched with base scope, and in case of match, the values of the
299 are searched for the asserted DN.
300 For backwards compatibility, if no identity type is provided, i.e. only
304 is assumed; as a consequence,
306 is subjected to DN normalization.
307 Since the interpretation of
311 can impact security, users are strongly encouraged
312 to explicitly set the type of identity specification that is being used.
313 A subset of these rules can be used as third arg in the
315 statement (see below); significantly, the
317 provided it results in exactly one entry,
323 .B authz\-regexp <match> <replace>
324 Used by the authentication framework to convert simple user names,
325 such as provided by SASL subsystem, or extracted from certificates
326 in case of cert-based SASL EXTERNAL, or provided within the RFC 4370
327 "proxied authorization" control, to an LDAP DN used for
328 authorization purposes. Note that the resulting DN need not refer
329 to an existing entry to be considered valid. When an authorization
330 request is received from the SASL subsystem, the SASL
335 are taken, when available, and combined into a name of the form
339 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
342 This name is then compared against the
344 POSIX (''extended'') regular expression, and if the match is successful,
345 the name is replaced with the
347 string. If there are wildcard strings in the
349 regular expression that are enclosed in parenthesis, e.g.
355 then the portion of the name that matched the wildcard will be stored
356 in the numbered placeholder variable $1. If there are other wildcard strings
357 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
358 placeholders can then be used in the
363 .B UID=$1,OU=Accounts,DC=example,DC=com
366 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
368 If the latter, the server will use the URI to search its own database(s)
369 and, if the search returns exactly one entry, the name is
370 replaced by the DN of that entry. The LDAP URI must have no
371 hostport, attrs, or extensions components, but the filter is mandatory,
375 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
378 The protocol portion of the URI must be strictly
380 Note that this search is subject to access controls. Specifically,
381 the authentication identity must have "auth" access in the subject.
385 options can be given in the configuration file to allow for multiple matching
386 and replacement patterns. The matching patterns are checked in the order they
387 appear in the file, stopping at the first successful match.
390 .\"Because the plus sign + is a character recognized by the regular expression engine,
391 .\"and it will appear in names that include a REALM, be careful to escape the
392 .\"plus sign with a backslash \\+ to remove the character's special meaning.
395 .B concurrency <integer>
396 Specify a desired level of concurrency. Provided to the underlying
397 thread system as a hint. The default is not to provide any hint.
399 .B conn_max_pending <integer>
400 Specify the maximum number of pending requests for an anonymous session.
401 If requests are submitted faster than the server can process them, they
402 will be queued up to this limit. If the limit is exceeded, the session
403 is closed. The default is 100.
405 .B conn_max_pending_auth <integer>
406 Specify the maximum number of pending requests for an authenticated session.
409 .B defaultsearchbase <dn>
410 Specify a default search base to use when client submits a
411 non-base search request with an empty base DN.
412 Base scoped search requests with an empty base DN are not affected.
414 .B disallow <features>
415 Specify a set of features (separated by white space) to
416 disallow (default none).
418 disables acceptance of anonymous bind requests. Note that this setting
419 does not prohibit anonymous directory access (See "require authc").
421 disables simple (bind) authentication.
423 disables forcing session to anonymous status (see also
425 upon StartTLS operation receipt.
427 disallows the StartTLS operation if authenticated (see also
429 .B proxy_authz_non_critical
430 disables acceptance of the proxied authorization control (RFC4370)
431 when criticality is FALSE.
432 .B dontusecopy_non_critical
433 disables acceptance of the dontUseCopy control (a work in progress)
434 when criticality is FALSE.
437 .B ditcontentrule "(\ <oid>\
439 [DESC\ <description>]\
446 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
447 The slapd parser extends the RFC 4512 definition by allowing string
448 forms as well as numeric OIDs to be used for the attribute OID and
449 attribute syntax OID.
455 .B gentlehup { on | off }
456 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
458 will stop listening for new connections, but will not close the
459 connections to the current clients. Future write operations return
460 unwilling-to-perform, though. Slapd terminates when all clients
461 have closed their connections (if they ever do), or - as before -
462 if it receives a SIGTERM signal. This can be useful if you wish to
463 terminate the server and start a new
466 .B with another database,
467 without disrupting the currently active clients.
468 The default is off. You may wish to use
470 along with this option.
472 .B idletimeout <integer>
473 Specify the number of seconds to wait before forcibly closing
474 an idle client connection. A idletimeout of 0 disables this
475 feature. The default is 0. You may also want to set the
479 .B include <filename>
480 Read additional configuration information from the given file before
481 continuing with the next line of the current file.
483 .B index_intlen <integer>
484 Specify the key length for ordered integer indices. The most significant
485 bytes of the binary integer will be used for index keys. The default
486 value is 4, which provides exact indexing for 31 bit values.
487 A floating point representation is used to index too large values.
489 .B index_substr_if_minlen <integer>
490 Specify the minimum length for subinitial and subfinal indices. An
491 attribute value must have at least this many characters in order to be
492 processed by the indexing functions. The default is 2.
494 .B index_substr_if_maxlen <integer>
495 Specify the maximum length for subinitial and subfinal indices. Only
496 this many characters of an attribute value will be processed by the
497 indexing functions; any excess characters are ignored. The default is 4.
499 .B index_substr_any_len <integer>
500 Specify the length used for subany indices. An attribute value must have
501 at least this many characters in order to be processed. Attribute values
502 longer than this length will be processed in segments of this length. The
503 default is 4. The subany index will also be used in subinitial and
504 subfinal index lookups when the filter string is longer than the
505 .I index_substr_if_maxlen
508 .B index_substr_any_step <integer>
509 Specify the steps used in subany index lookups. This value sets the offset
510 for the segments of a filter string that are processed for a subany index
511 lookup. The default is 2. For example, with the default values, a search
512 using this filter "cn=*abcdefgh*" would generate index lookups for
513 "abcd", "cdef", and "efgh".
516 Note: Indexing support depends on the particular backend in use. Also,
517 changing these settings will generally require deleting any indices that
518 depend on these parameters and recreating them with
523 .B ldapsyntax "(\ <oid>\
524 [DESC\ <description>]\
525 [X\-SUBST <substitute-syntax>]\ )"
527 Specify an LDAP syntax using the LDAPv3 syntax defined in RFC 4512.
528 The slapd parser extends the RFC 4512 definition by allowing string
529 forms as well as numeric OIDs to be used for the syntax OID.
533 The slapd parser also honors the
535 extension (an OpenLDAP-specific extension), which allows to use the
537 statement to define a non-implemented syntax along with another syntax,
539 .IR substitute-syntax ,
540 as its temporary replacement.
544 This allows to define attribute types that make use of non-implemented syntaxes
545 using the correct syntax OID.
548 is used, this configuration statement would result in an error,
549 since no handlers would be associated to the resulting syntax structure.
554 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
555 such as those to the ldapi:// listener. For a description of SSF values,
559 option description. The default is 71.
561 .B logfile <filename>
562 Specify a file for recording debug log messages. By default these messages
563 only go to stderr and are not recorded anywhere else. Specifying a logfile
564 copies messages to both stderr and the logfile.
566 .B loglevel <integer> [...]
567 Specify the level at which debugging statements and operation
568 statistics should be syslogged (currently logged to the
570 LOG_LOCAL4 facility).
571 They must be considered subsystems rather than increasingly verbose
573 Some messages with higher priority are logged regardless
574 of the configured loglevel as soon as any logging is configured.
575 Log levels are additive, and available levels are:
586 debug packet handling
590 heavy trace debugging (function args)
594 connection management
598 print out packets sent and received
602 search filter processing
606 configuration file processing
610 access control list processing
614 connections, LDAP operations, results (recommended)
618 stats log entries sent
622 print communication with shell backends
634 \"data indexing (unused)
642 only messages that get logged whatever log level is set
645 The desired log level can be input as a single integer that combines
646 the (ORed) desired levels, both in decimal or in hexadecimal notation,
647 as a list of integers (that are ORed internally),
648 or as a list of the names that are shown between brackets, such that
661 can be used as a shortcut to enable logging at all levels (equivalent to \-1).
664 or the equivalent integer representation, causes those messages
665 that are logged regardless of the configured loglevel to be logged.
666 In fact, if loglevel is set to 0, no logging occurs,
669 level is required to have high priority messages logged.
671 The loglevel defaults to \fBstats\fP.
672 This level should usually also be included when using other loglevels, to
673 help analyze the logs.
676 .B moduleload <filename>
677 Specify the name of a dynamically loadable module to load. The filename
678 may be an absolute path name or a simple filename. Non-absolute names
679 are searched for in the directories specified by the
681 option. This option and the
683 option are only usable if slapd was compiled with \-\-enable\-modules.
685 .B modulepath <pathspec>
686 Specify a list of directories to search for loadable modules. Typically
687 the path is colon-separated but this depends on the operating system.
688 The default is MODULEDIR, which is where the standard OpenLDAP install
689 will place its modules.
692 .B objectclass "(\ <oid>\
694 [DESC\ <description>]\
697 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
698 [MUST\ <oids>] [MAY\ <oids>] )"
700 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
701 The slapd parser extends the RFC 4512 definition by allowing string
702 forms as well as numeric OIDs to be used for the object class OID.
706 description.) Object classes are "STRUCTURAL" by default.
709 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
710 Define a string name that equates to the given OID. The string can be used
711 in place of the numeric OID in objectclass and attribute definitions. The
712 name can also be used with a suffix of the form ":xx" in which case the
713 value "oid.xx" will be used.
715 .B password\-hash <hash> [<hash>...]
716 This option configures one or more hashes to be used in generation of user
717 passwords stored in the userPassword attribute during processing of
718 LDAP Password Modify Extended Operations (RFC 3062).
719 The <hash> must be one of
733 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
738 use the MD5 algorithm (RFC 1321), the latter with a seed.
745 indicates that the new password should be
746 added to userPassword as clear text.
748 Note that this option does not alter the normal user applications
749 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
751 .B password\-crypt\-salt\-format <format>
752 Specify the format of the salt passed to
754 when generating {CRYPT} passwords (see
756 during processing of LDAP Password Modify Extended Operations (RFC 3062).
758 This string needs to be in
760 format and may include one (and only one) %s conversion.
761 This conversion will be substituted with a string of random
762 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
763 provides a two character salt and "$1$%.8s" tells some
764 versions of crypt(3) to use an MD5 algorithm and provides
765 8 random characters of salt. The default is "%s", which
766 provides 31 characters of salt.
768 .B pidfile <filename>
769 The (absolute) name of a file that will hold the
771 server's process ID (see
775 Specify the referral to pass back when
777 cannot find a local database to handle a request.
778 If specified multiple times, each url is provided.
780 .B require <conditions>
781 Specify a set of conditions (separated by white space) to
782 require (default none).
783 The directive may be specified globally and/or per-database;
784 databases inherit global conditions, so per-database specifications
787 requires bind operation prior to directory operations.
789 requires session to be using LDAP version 3.
791 requires authentication prior to directory operations.
793 requires SASL authentication prior to directory operations.
795 requires strong authentication prior to directory operations.
796 The strong keyword allows protected "simple" authentication
797 as well as SASL authentication.
799 may be used to require no conditions (useful to clear out globally
800 set conditions within a particular database); it must occur first
801 in the list of conditions.
803 .B reverse\-lookup on | off
804 Enable/disable client name unverified reverse lookup (default is
806 if compiled with \-\-enable\-rlookups).
809 Specify the name of an LDIF(5) file containing user defined attributes
810 for the root DSE. These attributes are returned in addition to the
811 attributes normally produced by slapd.
813 The root DSE is an entry with information about the server and its
814 capabilities, in operational attributes.
815 It has the empty DN, and can be read with e.g.:
817 ldapsearch \-x \-b "" \-s base "+"
819 See RFC 4512 section 5.1 for details.
821 .B sasl\-auxprops <plugin> [...]
822 Specify which auxprop plugins to use for authentication lookups. The
823 default is empty, which just uses slapd's internal support. Usually
824 no other auxprop plugins are needed.
827 Used to specify the fully qualified domain name used for SASL processing.
829 .B sasl\-realm <realm>
830 Specify SASL realm. Default is empty.
832 .B sasl\-secprops <properties>
833 Used to specify Cyrus SASL security properties.
836 flag (without any other properties) causes the flag properties
837 default, "noanonymous,noplain", to be cleared.
840 flag disables mechanisms susceptible to simple passive attacks.
843 flag disables mechanisms susceptible to active attacks.
846 flag disables mechanisms susceptible to passive dictionary attacks.
849 flag disables mechanisms which support anonymous login.
852 flag require forward secrecy between sessions.
855 require mechanisms which pass client credentials (and allow
856 mechanisms which can pass credentials to do so).
859 property specifies the minimum acceptable
860 .I security strength factor
861 as an integer approximate to effective key length used for
862 encryption. 0 (zero) implies no protection, 1 implies integrity
863 protection only, 56 allows DES or other weak ciphers, 112
864 allows triple DES and other strong ciphers, 128 allows RC4,
865 Blowfish and other modern strong ciphers. The default is 0.
868 property specifies the maximum acceptable
869 .I security strength factor
870 as an integer (see minssf description). The default is INT_MAX.
873 property specifies the maximum security layer receive buffer
874 size allowed. 0 disables security layers. The default is 65536.
877 Specify the distinguished name for the subschema subentry that
878 controls the entries on this server. The default is "cn=Subschema".
880 .B security <factors>
881 Specify a set of security strength factors (separated by white space)
883 .BR sasl\-secprops 's
885 option for a description of security strength factors).
886 The directive may be specified globally and/or per-database.
888 specifies the overall security strength factor.
890 specifies the transport security strength factor.
892 specifies the TLS security strength factor.
894 specifies the SASL security strength factor.
896 specifies the overall security strength factor to require for
898 .B update_transport=<n>
899 specifies the transport security strength factor to require for
902 specifies the TLS security strength factor to require for
905 specifies the SASL security strength factor to require for
908 specifies the security strength factor required for
910 username/password authentication.
913 factor is measure of security provided by the underlying transport,
914 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
916 .B serverID <integer> [<URL>]
917 Specify an integer ID from 0 to 4095 for this server (limited
918 to 3 hexadecimal digits).
920 required when using multimaster replication and each master must have a
921 unique ID. Note that this requirement also applies to separate masters
922 contributing to a glued set of databases.
923 If the URL is provided, this directive may be specified
924 multiple times, providing a complete list of participating servers
925 and their IDs. The fully qualified hostname of each server should be
926 used in the supplied URLs. The IDs are used in the "replica id" field
927 of all CSNs generated by the specified server. The default value is zero.
934 .B sizelimit {<integer>|unlimited}
936 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
937 Specify the maximum number of entries to return from a search operation.
938 The default size limit is 500.
941 to specify no limits.
942 The second format allows a fine grain setting of the size limits.
943 Extra args can be added on the same line.
946 for an explanation of the different flags.
948 .B sockbuf_max_incoming <integer>
949 Specify the maximum incoming LDAP PDU size for anonymous sessions.
950 The default is 262143.
952 .B sockbuf_max_incoming_auth <integer>
953 Specify the maximum incoming LDAP PDU size for authenticated sessions.
954 The default is 4194303.
956 .B sortvals <attr> [...]
957 Specify a list of multi-valued attributes whose values will always
958 be maintained in sorted order. Using this option will allow Modify,
959 Compare, and filter evaluations on these attributes to be performed
960 more efficiently. The resulting sort order depends on the
961 attributes' syntax and matching rules and may not correspond to
962 lexical order or any other recognizable order.
965 Specify the maximum size of the primary thread pool.
966 The default is 16; the minimum value is 2.
968 .B timelimit {<integer>|unlimited}
970 .B timelimit time[.{soft|hard}]=<integer> [...]
971 Specify the maximum number of seconds (in real time)
973 will spend answering a search request. The default time limit is 3600.
976 to specify no limits.
977 The second format allows a fine grain setting of the time limits.
978 Extra args can be added on the same line.
981 for an explanation of the different flags.
983 .B tool\-threads <integer>
984 Specify the maximum number of threads to use in tool mode.
985 This should not be greater than the number of CPUs in the system.
987 .\"ucdata-path is obsolete / ignored...
989 .\".B ucdata-path <path>
990 .\"Specify the path to the directory containing the Unicode character
991 .\"tables. The default path is DATADIR/ucdata.
993 .B writetimeout <integer>
994 Specify the number of seconds to wait before forcibly closing
995 a connection with an outstanding write. This allows recovery from
996 various network hang conditions. A writetimeout of 0 disables this
997 feature. The default is 0.
1001 is built with support for Transport Layer Security, there are more options
1004 .B TLSCipherSuite <cipher-suite-spec>
1005 Permits configuring what ciphers will be accepted and the preference order.
1006 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
1008 TLSCipherSuite HIGH:MEDIUM:+SSLv2
1010 To check what ciphers a given spec selects, use:
1013 openssl ciphers \-v <cipher-suite-spec>
1016 To obtain the list of ciphers in GNUtls use:
1023 .B TLSCACertificateFile <filename>
1024 Specifies the file that contains certificates for all of the Certificate
1029 .B TLSCACertificatePath <path>
1030 Specifies the path of a directory that contains Certificate Authority
1031 certificates in separate individual files. Usually only one of this
1032 or the TLSCACertificateFile is used. This directive is not supported
1035 .B TLSCertificateFile <filename>
1036 Specifies the file that contains the
1040 .B TLSCertificateKeyFile <filename>
1041 Specifies the file that contains the
1043 server private key that matches the certificate stored in the
1044 .B TLSCertificateFile
1045 file. Currently, the private key must not be protected with a password, so
1046 it is of critical importance that it is protected carefully.
1048 .B TLSDHParamFile <filename>
1049 This directive specifies the file that contains parameters for Diffie-Hellman
1050 ephemeral key exchange. This is required in order to use a DSA certificate on
1051 the server. If multiple sets of parameters are present in the file, all of
1052 them will be processed. Note that setting this option may also enable
1053 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
1054 You should append "!ADH" to your cipher suites if you have changed them
1055 from the default, otherwise no certificate exchanges or verification will
1056 be done. When using GNUtls these parameters are always generated randomly so
1057 this directive is ignored.
1059 .B TLSRandFile <filename>
1060 Specifies the file to obtain random bits from when /dev/[u]random
1061 is not available. Generally set to the name of the EGD/PRNGD socket.
1062 The environment variable RANDFILE can also be used to specify the filename.
1063 This directive is ignored with GNUtls.
1065 .B TLSVerifyClient <level>
1066 Specifies what checks to perform on client certificates in an
1067 incoming TLS session, if any.
1070 can be specified as one of the following keywords:
1074 This is the default.
1076 will not ask the client for a certificate.
1079 The client certificate is requested. If no certificate is provided,
1080 the session proceeds normally. If a bad certificate is provided,
1081 it will be ignored and the session proceeds normally.
1084 The client certificate is requested. If no certificate is provided,
1085 the session proceeds normally. If a bad certificate is provided,
1086 the session is immediately terminated.
1088 .B demand | hard | true
1089 These keywords are all equivalent, for compatibility reasons.
1090 The client certificate is requested. If no certificate is provided,
1091 or a bad certificate is provided, the session is immediately terminated.
1093 Note that a valid client certificate is required in order to use the
1094 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1097 setting must be chosen to enable SASL EXTERNAL authentication.
1100 .B TLSCRLCheck <level>
1101 Specifies if the Certificate Revocation List (CRL) of the CA should be
1102 used to verify if the client certificates have not been revoked. This
1104 .B TLSCACertificatePath
1105 parameter to be set. This directive is ignored with GNUtls.
1107 can be specified as one of the following keywords:
1111 No CRL checks are performed
1114 Check the CRL of the peer certificate
1117 Check the CRL for a whole certificate chain
1120 .B TLSCRLFile <filename>
1121 Specifies a file containing a Certificate Revocation List to be used
1122 for verifying that certificates have not been revoked. This directive is
1123 only valid when using GNUtls.
1124 .SH GENERAL BACKEND OPTIONS
1125 Options in this section only apply to the configuration file section
1126 for the specified backend. They are supported by every
1129 .B backend <databasetype>
1130 Mark the beginning of a backend definition. <databasetype>
1147 depending on which backend will serve the database.
1149 .SH GENERAL DATABASE OPTIONS
1150 Options in this section only apply to the configuration file section
1151 for the database in which they are defined. They are supported by every
1152 type of backend. Note that the
1156 option are mandatory for each database.
1158 .B database <databasetype>
1159 Mark the beginning of a new database instance definition. <databasetype>
1176 depending on which backend will serve the database.
1178 LDAP operations, even subtree searches, normally access only one
1180 That can be changed by gluing databases together with the
1183 Access controls and some overlays can also involve multiple databases.
1185 .B add_content_acl on | off
1186 Controls whether Add operations will perform ACL checks on
1187 the content of the entry being added. This check is off
1189 .BR slapd.access (5)
1190 manual page for more details on ACL requirements for
1194 Controls whether the database will be used to answer
1195 queries. A database that is hidden will never be
1196 selected to answer any queries, and any suffix configured
1197 on the database will be ignored in checks for conflicts
1198 with other databases. By default, hidden is off.
1203 will automatically maintain the
1204 modifiersName, modifyTimestamp, creatorsName, and
1205 createTimestamp attributes for entries. It also controls
1206 the entryCSN and entryUUID attributes, which are needed
1207 by the syncrepl provider. By default, lastmod is on.
1209 .B limits <selector> <limit> [<limit> [...]]
1210 Specify time and size limits based on the operation's initiator or
1218 anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>
1224 <dnspec> ::= dn[.<type>][.<style>]
1226 <type> ::= self | this
1228 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1233 is the default and means the bound user, while
1235 means the base DN of the operation.
1238 matches all unauthenticated clients.
1241 matches all authenticated clients;
1244 dn pattern is assumed unless otherwise specified by qualifying
1245 the (optional) key string
1251 (which are synonyms), to require an exact match; with
1253 to require exactly one level of depth match; with
1255 to allow any level of depth match, including the exact match; with
1257 to allow any level of depth match, not including the exact match;
1259 explicitly requires the (default) match based on POSIX (''extended'')
1260 regular expression pattern.
1263 matches unbound operations; the
1266 The same behavior is obtained by using the
1273 with the optional objectClass
1279 sets the limits for any DN listed in the values of the
1285 group objectClass (default
1287 whose DN exactly matches
1290 The currently supported limits are
1295 The syntax for time limits is
1296 .BR time[.{soft|hard}]=<integer> ,
1299 is the number of seconds slapd will spend answering a search request.
1300 If no time limit is explicitly requested by the client, the
1302 limit is used; if the requested time limit exceeds the
1305 .\".I "Administrative limit exceeded"
1306 .\"error is returned.
1307 limit, the value of the limit is used instead.
1310 limit is set to the keyword
1312 the soft limit is used in either case; if it is set to the keyword
1314 no hard limit is enforced.
1315 Explicit requests for time limits smaller or equal to the
1318 If no limit specifier is set, the value is assigned to the
1324 to preserve the original behavior.
1326 The syntax for size limits is
1327 .BR size[.{soft|hard|unchecked}]=<integer> ,
1330 is the maximum number of entries slapd will return answering a search
1332 If no size limit is explicitly requested by the client, the
1334 limit is used; if the requested size limit exceeds the
1337 .\".I "Administrative limit exceeded"
1338 .\"error is returned.
1339 limit, the value of the limit is used instead.
1342 limit is set to the keyword
1344 the soft limit is used in either case; if it is set to the keyword
1346 no hard limit is enforced.
1347 Explicit requests for size limits smaller or equal to the
1352 specifier sets a limit on the number of candidates a search request is allowed
1354 The rationale behind it is that searches for non-properly indexed
1355 attributes may result in large sets of candidates, which must be
1358 to determine whether they match the search filter or not.
1361 limit provides a means to drop such operations before they are even
1363 If the selected candidates exceed the
1365 limit, the search will abort with
1366 .IR "Unwilling to perform" .
1367 If it is set to the keyword
1369 no limit is applied (the default).
1372 the search is not even performed; this can be used to disallow searches
1373 for a specific set of users.
1374 If no limit specifier is set, the value is assigned to the
1380 to preserve the original behavior.
1382 In case of no match, the global limits are used.
1383 The default values are the same as for
1392 control is requested, the
1394 size limit is used by default, because the request of a specific page size
1395 is considered an explicit request for a limitation on the number
1396 of entries to be returned.
1397 However, the size limit applies to the total count of entries returned within
1398 the search, and not to a single page.
1399 Additional size limits may be enforced; the syntax is
1400 .BR size.pr={<integer>|noEstimate|unlimited} ,
1403 is the max page size if no explicit limit is set; the keyword
1405 inhibits the server from returning an estimate of the total number
1406 of entries that might be returned
1407 (note: the current implementation does not return any estimate).
1410 indicates that no limit is applied to the pagedResults control page size.
1412 .B size.prtotal={<integer>|unlimited|disabled}
1413 allows to set a limit on the total number of entries that a pagedResults
1414 control allows to return.
1415 By default it is set to the
1420 is the max number of entries that the whole search with pagedResults control
1424 to allow unlimited number of entries to be returned, e.g. to allow
1425 the use of the pagedResults control as a means to circumvent size
1426 limitations on regular searches; the keyword
1428 disables the control, i.e. no paged results can be returned.
1429 Note that the total number of entries returned when the pagedResults control
1430 is requested cannot exceed the
1432 size limit of regular searches unless extended by the
1436 The \fBlimits\fP statement is typically used to let an unlimited
1437 number of entries be returned by searches performed
1438 with the identity used by the consumer for synchronization purposes
1439 by means of the RFC 4533 LDAP Content Synchronization protocol
1440 (see \fBsyncrepl\fP for details).
1443 .B maxderefdepth <depth>
1444 Specifies the maximum number of aliases to dereference when trying to
1445 resolve an entry, used to avoid infinite alias loops. The default is 15.
1447 .B mirrormode on | off
1448 This option puts a replica database into "mirror" mode. Update
1449 operations will be accepted from any user, not just the updatedn. The
1450 database must already be configured as a syncrepl consumer
1451 before this keyword may be set. This mode also requires a
1453 (see above) to be configured.
1454 By default, mirrormode is off.
1456 .B monitoring on | off
1457 This option enables database-specific monitoring in the entry related
1458 to the current database in the "cn=Databases,cn=Monitor" subtree
1459 of the monitor database, if the monitor database is enabled.
1460 Currently, only the BDB and the HDB databases provide database-specific
1462 The default depends on the backend type.
1464 .B overlay <overlay-name>
1465 Add the specified overlay to this database. An overlay is a piece of
1466 code that intercepts database operations in order to extend or change
1467 them. Overlays are pushed onto
1468 a stack over the database, and so they will execute in the reverse
1469 of the order in which they were configured and the database itself
1470 will receive control last of all. See the
1471 .BR slapd.overlays (5)
1472 manual page for an overview of the available overlays.
1473 Note that all of the database's
1474 regular settings should be configured before any overlay settings.
1476 .B readonly on | off
1477 This option puts the database into "read-only" mode. Any attempts to
1478 modify the database will return an "unwilling to perform" error. By
1479 default, readonly is off.
1481 .B restrict <oplist>
1482 Specify a whitespace separated list of operations that are restricted.
1483 If defined inside a database specification, restrictions apply only
1484 to that database, otherwise they are global.
1485 Operations can be any of
1490 .BR extended[=<OID>] ,
1494 or the special pseudo-operations
1498 which respectively summarize read and write operations.
1506 keyword allows to indicate the OID of the specific operation
1510 Specify the distinguished name that is not subject to access control
1511 or administrative limit restrictions for operations on this database.
1512 This DN may or may not be associated with an entry. An empty root
1513 DN (the default) specifies no root access is to be granted. It is
1514 recommended that the rootdn only be specified when needed (such as
1515 when initially populating a database). If the rootdn is within
1516 a namingContext (suffix) of the database, a simple bind password
1517 may also be provided using the
1519 directive. Many optional features, including syncrepl, require the
1520 rootdn to be defined for the database.
1522 .B rootpw <password>
1523 Specify a password (or hash of the password) for the rootdn. The
1524 password can only be set if the rootdn is within the namingContext
1525 (suffix) of the database.
1526 This option accepts all RFC 2307 userPassword formats known to
1529 description) as well as cleartext.
1531 may be used to generate a hash of a password. Cleartext
1532 and \fB{CRYPT}\fP passwords are not recommended. If empty
1533 (the default), authentication of the root DN is by other means
1534 (e.g. SASL). Use of SASL is encouraged.
1536 .B suffix <dn suffix>
1537 Specify the DN suffix of queries that will be passed to this
1538 backend database. Multiple suffix lines can be given and at least one is
1539 required for each database definition.
1541 If the suffix of one database is "inside" that of another, the database
1542 with the inner suffix must come first in the configuration file.
1543 You may also want to glue such databases together with the
1547 .B subordinate [advertise]
1548 Specify that the current backend database is a subordinate of another
1549 backend database. A subordinate database may have only one suffix. This
1550 option may be used to glue multiple databases into a single namingContext.
1551 If the suffix of the current database is within the namingContext of a
1552 superior database, searches against the superior database will be
1553 propagated to the subordinate as well. All of the databases
1554 associated with a single namingContext should have identical rootdns.
1555 Behavior of other LDAP operations is unaffected by this setting. In
1556 particular, it is not possible to use moddn to move an entry from
1557 one subordinate to another subordinate within the namingContext.
1559 If the optional \fBadvertise\fP flag is supplied, the naming context of
1560 this database is advertised in the root DSE. The default is to hide this
1561 database context, so that only the superior context is visible.
1568 are used on the superior database, any glued subordinates that support
1569 these tools are opened as well.
1571 Databases that are glued together should usually be configured with the
1572 same indices (assuming they support indexing), even for attributes that
1573 only exist in some of these databases. In general, all of the glued
1574 databases should be configured as similarly as possible, since the intent
1575 is to provide the appearance of a single directory.
1577 Note that the \fIsubordinate\fP functionality is implemented internally
1578 by the \fIglue\fP overlay and as such its behavior will interact with other
1579 overlays in use. By default, the glue overlay is automatically configured as
1580 the last overlay on the superior backend. Its position on the backend
1581 can be explicitly configured by setting an \fBoverlay glue\fP directive
1582 at the desired position. This explicit configuration is necessary e.g.
1583 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1584 in order to work over all of the glued databases. E.g.
1588 suffix dc=example,dc=com
1596 .B syncrepl rid=<replica ID>
1597 .B provider=ldap[s]://<hostname>[:port]
1598 .B searchbase=<base DN>
1599 .B [type=refreshOnly|refreshAndPersist]
1600 .B [interval=dd:hh:mm:ss]
1601 .B [retry=[<retry interval> <# of retries>]+]
1602 .B [filter=<filter str>]
1603 .B [scope=sub|one|base|subord]
1604 .B [attrs=<attr list>]
1606 .B [sizelimit=<limit>]
1607 .B [timelimit=<limit>]
1608 .B [schemachecking=on|off]
1609 .B [network\-timeout=<seconds>]
1610 .B [timeout=<seconds>]
1611 .B [bindmethod=simple|sasl]
1613 .B [saslmech=<mech>]
1614 .B [authcid=<identity>]
1615 .B [authzid=<identity>]
1616 .B [credentials=<passwd>]
1618 .B [secprops=<properties>]
1619 .B [starttls=yes|critical]
1620 .B [tls_cert=<file>]
1622 .B [tls_cacert=<file>]
1623 .B [tls_cacertdir=<path>]
1624 .B [tls_reqcert=never|allow|try|demand]
1625 .B [tls_ciphersuite=<ciphers>]
1626 .B [tls_crlcheck=none|peer|all]
1627 .B [logbase=<base DN>]
1628 .B [logfilter=<filter str>]
1629 .B [syncdata=default|accesslog|changelog]
1631 Specify the current database as a replica which is kept up-to-date with the
1632 master content by establishing the current
1634 as a replication consumer site running a
1637 The replica content is kept synchronized to the master content using
1638 the LDAP Content Synchronization protocol. Refer to the
1639 "OpenLDAP Administrator's Guide" for detailed information on
1640 setting up a replicated
1642 directory service using the
1647 identifies the current
1649 directive within the replication consumer site.
1650 It is a non-negative integer not greater than 4095 (limited
1651 to three hexadecimal digits).
1654 specifies the replication provider site containing the master content
1655 as an LDAP URI. If <port> is not given, the standard LDAP port number
1656 (389 or 636) is used.
1660 replica is defined using a search
1661 specification as its result set. The consumer
1663 will send search requests to the provider
1665 according to the search specification. The search specification includes
1666 .BR searchbase ", " scope ", " filter ", " attrs ", " attrsonly ", " sizelimit ", "
1669 parameters as in the normal search specification.
1670 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1671 \fB(objectclass=*)\fP, while there is no default \fBsearchbase\fP. The
1672 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1673 attributes, and \fBattrsonly\fP is unset by default.
1674 The \fBsizelimit\fP and \fBtimelimit\fP only
1675 accept "unlimited" and positive integers, and both default to "unlimited".
1676 The \fBsizelimit\fP and \fBtimelimit\fP parameters define
1677 a consumer requested limitation on the number of entries that can be returned
1678 by the LDAP Content Synchronization operation; as such, it is intended
1679 to implement partial replication based on the size of the replicated database
1680 and on the time required by the synchronization.
1681 Note, however, that any provider-side limits for the replication identity
1682 will be enforced by the provider regardless of the limits requested
1683 by the LDAP Content Synchronization operation, much like for any other
1686 The LDAP Content Synchronization protocol has two operation types.
1689 operation, the next synchronization search operation
1690 is periodically rescheduled at an interval time (specified by
1692 parameter; 1 day by default)
1693 after each synchronization operation finishes.
1695 .B refreshAndPersist
1696 operation, a synchronization search remains persistent in the provider slapd.
1697 Further updates to the master replica will generate
1698 .B searchResultEntry
1699 to the consumer slapd as the search responses to the persistent
1700 synchronization search.
1702 If an error occurs during replication, the consumer will attempt to
1703 reconnect according to the
1705 parameter which is a list of the <retry interval> and <# of retries> pairs.
1706 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1707 for the first 10 times and then retry every 300 seconds for the next 3
1708 times before stop retrying. The `+' in <# of retries> means indefinite
1709 number of retries until success.
1712 was specified, by default syncrepl retries every hour forever.
1714 The schema checking can be enforced at the LDAP Sync
1715 consumer site by turning on the
1717 parameter. The default is \fBoff\fP.
1718 Schema checking \fBon\fP means that replicated entries must have
1719 a structural objectClass, must obey to objectClass requirements
1720 in terms of required/allowed attributes, and that naming attributes
1721 and distinguished values must be present.
1722 As a consequence, schema checking should be \fBoff\fP when partial
1723 replication is used.
1727 parameter sets how long the consumer will wait to establish a
1728 network connection to the provider. Once a connection is
1731 parameter determines how long the consumer will wait for the initial
1732 Bind request to complete. The defaults for these parameters come
1740 requires the options
1744 and should only be used when adequate security services
1745 (e.g. TLS or IPSEC) are in place.
1746 .B REMEMBER: simple bind credentials must be in cleartext!
1753 Depending on the mechanism, an authentication identity and/or
1754 credentials can be specified using
1760 parameter may be used to specify an authorization identity.
1761 Specific security properties (as with the
1763 keyword above) for a SASL bind can be set with the
1765 option. A non default SASL realm can be set with the
1768 The identity used for synchronization by the consumer should be allowed
1769 to receive an unlimited number of entries in response to a search request.
1770 The provider, other than allow authentication of the syncrepl identity,
1771 should grant that identity appropriate access privileges to the data
1772 that is being replicated (\fBaccess\fP directive), and appropriate time
1774 This can be accomplished by either allowing unlimited \fBsizelimit\fP
1775 and \fBtimelimit\fP, or by setting an appropriate \fBlimits\fP statement
1776 in the consumer's configuration (see \fBsizelimit\fP and \fBlimits\fP
1781 parameter specifies use of the StartTLS extended operation
1782 to establish a TLS session before Binding to the provider. If the
1784 argument is supplied, the session will be aborted if the StartTLS request
1785 fails. Otherwise the syncrepl session continues without TLS. The
1786 tls_reqcert setting defaults to "demand" and the other TLS settings
1787 default to the same as the main slapd TLS settings.
1789 Rather than replicating whole entries, the consumer can query logs of
1790 data modifications. This mode of operation is referred to as \fIdelta
1791 syncrepl\fP. In addition to the above parameters, the
1795 parameters must be set appropriately for the log that will be used. The
1797 parameter must be set to either "accesslog" if the log conforms to the
1798 .BR slapo\-accesslog (5)
1799 log format, or "changelog" if the log conforms
1800 to the obsolete \fIchangelog\fP format. If the
1802 parameter is omitted or set to "default" then the log parameters are
1807 This option is only applicable in a slave
1809 It specifies the DN permitted to update (subject to access controls)
1810 the replica. It is only needed in certain push-mode
1811 replication scenarios. Generally, this DN
1818 Specify the referral to pass back when
1820 is asked to modify a replicated local database.
1821 If specified multiple times, each url is provided.
1823 .SH DATABASE-SPECIFIC OPTIONS
1824 Each database may allow specific configuration options; they are
1825 documented separately in the backends' manual pages. See the
1826 .BR slapd.backends (5)
1827 manual page for an overview of available backends.
1830 Here is a short example of a configuration file:
1834 include SYSCONFDIR/schema/core.schema
1835 pidfile LOCALSTATEDIR/run/slapd.pid
1837 # Subtypes of "name" (e.g. "cn" and "ou") with the
1838 # option ";x\-hidden" can be searched for/compared,
1839 # but are not shown. See \fBslapd.access\fP(5).
1840 attributeoptions x\-hidden lang\-
1841 access to attrs=name;x\-hidden by * =cs
1843 # Protect passwords. See \fBslapd.access\fP(5).
1844 access to attrs=userPassword by * auth
1845 # Read access to other attributes and entries.
1846 access to * by * read
1849 suffix "dc=our\-domain,dc=com"
1850 # The database directory MUST exist prior to
1851 # running slapd AND should only be accessible
1852 # by the slapd/tools. Mode 0700 recommended.
1853 directory LOCALSTATEDIR/openldap\-data
1854 # Indices to maintain
1855 index objectClass eq
1856 index cn,sn,mail pres,eq,approx,sub
1858 # We serve small clients that do not handle referrals,
1859 # so handle remote lookups on their behalf.
1862 uri ldap://ldap.some\-server.com/
1867 "OpenLDAP Administrator's Guide" contains a longer annotated
1868 example of a configuration file.
1869 The original ETCDIR/slapd.conf is another example.
1873 default slapd configuration file
1876 .BR slapd\-config (5),
1877 .BR slapd.access (5),
1878 .BR slapd.backends (5),
1879 .BR slapd.overlays (5),
1880 .BR slapd.plugin (5),
1881 .BR slapd.replog (5),
1892 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1893 .SH ACKNOWLEDGEMENTS