1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2011 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 authid\-rewrite<cmd> <args>
166 Used by the authentication framework to convert simple user names
167 to an LDAP DN used for authorization purposes.
168 Its purpose is analogous to that of
171 The prefix \fIauthid\-\fP is followed by a set of rules analogous
172 to those described in
174 for data rewriting (replace the \fIrwm\-\fP prefix with \fIauthid\-\fP).
175 .B authid\-rewrite<cmd>
178 rules should not be intermixed.
180 .B authz\-policy <policy>
181 Used to specify which rules to use for Proxy Authorization. Proxy
182 authorization allows a client to authenticate to the server using one
183 user's credentials, but specify a different identity to use for authorization
184 and access control purposes. It essentially allows user A to login as user
185 B, using user A's password.
188 flag disables proxy authorization. This is the default setting.
191 flag will use rules in the
193 attribute of the authorization DN.
196 flag will use rules in the
198 attribute of the authentication DN.
201 flag, an alias for the deprecated value of
203 will allow any of the above, whatever succeeds first (checked in
209 flag requires both authorizations to succeed.
212 The rules are mechanisms to specify which identities are allowed
213 to perform proxy authorization.
216 attribute in an entry specifies which other users
217 are allowed to proxy login to this entry. The
220 an entry specifies which other users this user can authorize as. Use of
223 abused if users are allowed to write arbitrary values to this attribute.
226 attribute must be protected with ACLs such that
227 only privileged users can modify it.
234 or a set of identities; it can take five forms:
237 .B ldap:///<base>??[<scope>]?<filter>
240 .B dn[.<dnstyle>]:<pattern>
243 .B u[.<mech>[/<realm>]]:<pattern>
246 .B group[/objectClass[/attributeType]]:<pattern>
253 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
256 The first form is a valid LDAP
264 portions must be absent, so that the search occurs locally on either
270 with the optional style modifiers
276 for exact, onelevel, children and subtree matches, which cause
278 to be normalized according to the DN normalization rules, or the special
280 style, which causes the
282 to be treated as a POSIX (''extended'') regular expression, as
289 means any non-anonymous DN.
290 The third form is a SASL
292 with the optional fields
296 that allow to specify a SASL
298 and eventually a SASL
300 for those mechanisms that support one.
301 The need to allow the specification of a mechanism is still debated,
302 and users are strongly discouraged to rely on this possibility.
303 The fourth form is a group specification, consisting of the keyword
305 optionally followed by the specification of the group
311 is searched with base scope, and in case of match, the values of the
314 are searched for the asserted DN.
315 For backwards compatibility, if no identity type is provided, i.e. only
319 is assumed; as a consequence,
321 is subjected to DN normalization.
322 Since the interpretation of
326 can impact security, users are strongly encouraged
327 to explicitly set the type of identity specification that is being used.
328 A subset of these rules can be used as third arg in the
330 statement (see below); significantly, the
332 provided it results in exactly one entry,
338 .B authz\-regexp <match> <replace>
339 Used by the authentication framework to convert simple user names,
340 such as provided by SASL subsystem, or extracted from certificates
341 in case of cert-based SASL EXTERNAL, or provided within the RFC 4370
342 "proxied authorization" control, to an LDAP DN used for
343 authorization purposes. Note that the resulting DN need not refer
344 to an existing entry to be considered valid. When an authorization
345 request is received from the SASL subsystem, the SASL
350 are taken, when available, and combined into a name of the form
354 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
357 This name is then compared against the
359 POSIX (''extended'') regular expression, and if the match is successful,
360 the name is replaced with the
362 string. If there are wildcard strings in the
364 regular expression that are enclosed in parenthesis, e.g.
370 then the portion of the name that matched the wildcard will be stored
371 in the numbered placeholder variable $1. If there are other wildcard strings
372 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
373 placeholders can then be used in the
378 .B UID=$1,OU=Accounts,DC=example,DC=com
381 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
383 If the latter, the server will use the URI to search its own database(s)
384 and, if the search returns exactly one entry, the name is
385 replaced by the DN of that entry. The LDAP URI must have no
386 hostport, attrs, or extensions components, but the filter is mandatory,
390 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
393 The protocol portion of the URI must be strictly
395 Note that this search is subject to access controls. Specifically,
396 the authentication identity must have "auth" access in the subject.
400 options can be given in the configuration file to allow for multiple matching
401 and replacement patterns. The matching patterns are checked in the order they
402 appear in the file, stopping at the first successful match.
405 .\"Because the plus sign + is a character recognized by the regular expression engine,
406 .\"and it will appear in names that include a REALM, be careful to escape the
407 .\"plus sign with a backslash \\+ to remove the character's special meaning.
410 .B concurrency <integer>
411 Specify a desired level of concurrency. Provided to the underlying
412 thread system as a hint. The default is not to provide any hint.
414 .B conn_max_pending <integer>
415 Specify the maximum number of pending requests for an anonymous session.
416 If requests are submitted faster than the server can process them, they
417 will be queued up to this limit. If the limit is exceeded, the session
418 is closed. The default is 100.
420 .B conn_max_pending_auth <integer>
421 Specify the maximum number of pending requests for an authenticated session.
424 .B defaultsearchbase <dn>
425 Specify a default search base to use when client submits a
426 non-base search request with an empty base DN.
427 Base scoped search requests with an empty base DN are not affected.
429 .B disallow <features>
430 Specify a set of features (separated by white space) to
431 disallow (default none).
433 disables acceptance of anonymous bind requests. Note that this setting
434 does not prohibit anonymous directory access (See "require authc").
436 disables simple (bind) authentication.
438 disables forcing session to anonymous status (see also
440 upon StartTLS operation receipt.
442 disallows the StartTLS operation if authenticated (see also
444 .B proxy_authz_non_critical
445 disables acceptance of the proxied authorization control (RFC4370)
446 when criticality is FALSE.
447 .B dontusecopy_non_critical
448 disables acceptance of the dontUseCopy control (a work in progress)
449 when criticality is FALSE.
452 .B ditcontentrule "(\ <oid>\
454 [DESC\ <description>]\
461 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
462 The slapd parser extends the RFC 4512 definition by allowing string
463 forms as well as numeric OIDs to be used for the attribute OID and
464 attribute syntax OID.
470 .B gentlehup { on | off }
471 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
473 will stop listening for new connections, but will not close the
474 connections to the current clients. Future write operations return
475 unwilling-to-perform, though. Slapd terminates when all clients
476 have closed their connections (if they ever do), or - as before -
477 if it receives a SIGTERM signal. This can be useful if you wish to
478 terminate the server and start a new
481 .B with another database,
482 without disrupting the currently active clients.
483 The default is off. You may wish to use
485 along with this option.
487 .B idletimeout <integer>
488 Specify the number of seconds to wait before forcibly closing
489 an idle client connection. A idletimeout of 0 disables this
490 feature. The default is 0. You may also want to set the
494 .B include <filename>
495 Read additional configuration information from the given file before
496 continuing with the next line of the current file.
498 .B index_intlen <integer>
499 Specify the key length for ordered integer indices. The most significant
500 bytes of the binary integer will be used for index keys. The default
501 value is 4, which provides exact indexing for 31 bit values.
502 A floating point representation is used to index too large values.
504 .B index_substr_if_minlen <integer>
505 Specify the minimum length for subinitial and subfinal indices. An
506 attribute value must have at least this many characters in order to be
507 processed by the indexing functions. The default is 2.
509 .B index_substr_if_maxlen <integer>
510 Specify the maximum length for subinitial and subfinal indices. Only
511 this many characters of an attribute value will be processed by the
512 indexing functions; any excess characters are ignored. The default is 4.
514 .B index_substr_any_len <integer>
515 Specify the length used for subany indices. An attribute value must have
516 at least this many characters in order to be processed. Attribute values
517 longer than this length will be processed in segments of this length. The
518 default is 4. The subany index will also be used in subinitial and
519 subfinal index lookups when the filter string is longer than the
520 .I index_substr_if_maxlen
523 .B index_substr_any_step <integer>
524 Specify the steps used in subany index lookups. This value sets the offset
525 for the segments of a filter string that are processed for a subany index
526 lookup. The default is 2. For example, with the default values, a search
527 using this filter "cn=*abcdefgh*" would generate index lookups for
528 "abcd", "cdef", and "efgh".
531 Note: Indexing support depends on the particular backend in use. Also,
532 changing these settings will generally require deleting any indices that
533 depend on these parameters and recreating them with
538 .B ldapsyntax "(\ <oid>\
539 [DESC\ <description>]\
540 [X\-SUBST <substitute-syntax>]\ )"
542 Specify an LDAP syntax using the LDAPv3 syntax defined in RFC 4512.
543 The slapd parser extends the RFC 4512 definition by allowing string
544 forms as well as numeric OIDs to be used for the syntax OID.
548 The slapd parser also honors the
550 extension (an OpenLDAP-specific extension), which allows to use the
552 statement to define a non-implemented syntax along with another syntax,
554 .IR substitute-syntax ,
555 as its temporary replacement.
559 This allows to define attribute types that make use of non-implemented syntaxes
560 using the correct syntax OID.
563 is used, this configuration statement would result in an error,
564 since no handlers would be associated to the resulting syntax structure.
569 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
570 such as those to the ldapi:// listener. For a description of SSF values,
574 option description. The default is 71.
576 .B logfile <filename>
577 Specify a file for recording debug log messages. By default these messages
578 only go to stderr and are not recorded anywhere else. Specifying a logfile
579 copies messages to both stderr and the logfile.
581 .B loglevel <integer> [...]
582 Specify the level at which debugging statements and operation
583 statistics should be syslogged (currently logged to the
585 LOG_LOCAL4 facility).
586 They must be considered subsystems rather than increasingly verbose
588 Some messages with higher priority are logged regardless
589 of the configured loglevel as soon as any logging is configured.
590 Log levels are additive, and available levels are:
601 debug packet handling
605 heavy trace debugging (function args)
609 connection management
613 print out packets sent and received
617 search filter processing
621 configuration file processing
625 access control list processing
629 connections, LDAP operations, results (recommended)
633 stats log entries sent
637 print communication with shell backends
649 \"data indexing (unused)
657 only messages that get logged whatever log level is set
660 The desired log level can be input as a single integer that combines
661 the (ORed) desired levels, both in decimal or in hexadecimal notation,
662 as a list of integers (that are ORed internally),
663 or as a list of the names that are shown between brackets, such that
676 can be used as a shortcut to enable logging at all levels (equivalent to \-1).
679 or the equivalent integer representation, causes those messages
680 that are logged regardless of the configured loglevel to be logged.
681 In fact, if loglevel is set to 0, no logging occurs,
684 level is required to have high priority messages logged.
686 The loglevel defaults to \fBstats\fP.
687 This level should usually also be included when using other loglevels, to
688 help analyze the logs.
691 .B moduleload <filename>
692 Specify the name of a dynamically loadable module to load. The filename
693 may be an absolute path name or a simple filename. Non-absolute names
694 are searched for in the directories specified by the
696 option. This option and the
698 option are only usable if slapd was compiled with \-\-enable\-modules.
700 .B modulepath <pathspec>
701 Specify a list of directories to search for loadable modules. Typically
702 the path is colon-separated but this depends on the operating system.
703 The default is MODULEDIR, which is where the standard OpenLDAP install
704 will place its modules.
707 .B objectclass "(\ <oid>\
709 [DESC\ <description>]\
712 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
713 [MUST\ <oids>] [MAY\ <oids>] )"
715 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
716 The slapd parser extends the RFC 4512 definition by allowing string
717 forms as well as numeric OIDs to be used for the object class OID.
721 description.) Object classes are "STRUCTURAL" by default.
724 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
725 Define a string name that equates to the given OID. The string can be used
726 in place of the numeric OID in objectclass and attribute definitions. The
727 name can also be used with a suffix of the form ":xx" in which case the
728 value "oid.xx" will be used.
730 .B password\-hash <hash> [<hash>...]
731 This option configures one or more hashes to be used in generation of user
732 passwords stored in the userPassword attribute during processing of
733 LDAP Password Modify Extended Operations (RFC 3062).
734 The <hash> must be one of
748 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
753 use the MD5 algorithm (RFC 1321), the latter with a seed.
760 indicates that the new password should be
761 added to userPassword as clear text.
763 Note that this option does not alter the normal user applications
764 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
766 .B password\-crypt\-salt\-format <format>
767 Specify the format of the salt passed to
769 when generating {CRYPT} passwords (see
771 during processing of LDAP Password Modify Extended Operations (RFC 3062).
773 This string needs to be in
775 format and may include one (and only one) %s conversion.
776 This conversion will be substituted with a string of random
777 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
778 provides a two character salt and "$1$%.8s" tells some
779 versions of crypt(3) to use an MD5 algorithm and provides
780 8 random characters of salt. The default is "%s", which
781 provides 31 characters of salt.
783 .B pidfile <filename>
784 The (absolute) name of a file that will hold the
786 server's process ID (see
790 Specify the referral to pass back when
792 cannot find a local database to handle a request.
793 If specified multiple times, each url is provided.
795 .B require <conditions>
796 Specify a set of conditions (separated by white space) to
797 require (default none).
798 The directive may be specified globally and/or per-database;
799 databases inherit global conditions, so per-database specifications
802 requires bind operation prior to directory operations.
804 requires session to be using LDAP version 3.
806 requires authentication prior to directory operations.
808 requires SASL authentication prior to directory operations.
810 requires strong authentication prior to directory operations.
811 The strong keyword allows protected "simple" authentication
812 as well as SASL authentication.
814 may be used to require no conditions (useful to clear out globally
815 set conditions within a particular database); it must occur first
816 in the list of conditions.
818 .B reverse\-lookup on | off
819 Enable/disable client name unverified reverse lookup (default is
821 if compiled with \-\-enable\-rlookups).
824 Specify the name of an LDIF(5) file containing user defined attributes
825 for the root DSE. These attributes are returned in addition to the
826 attributes normally produced by slapd.
828 The root DSE is an entry with information about the server and its
829 capabilities, in operational attributes.
830 It has the empty DN, and can be read with e.g.:
832 ldapsearch \-x \-b "" \-s base "+"
834 See RFC 4512 section 5.1 for details.
836 .B sasl\-auxprops <plugin> [...]
837 Specify which auxprop plugins to use for authentication lookups. The
838 default is empty, which just uses slapd's internal support. Usually
839 no other auxprop plugins are needed.
842 Used to specify the fully qualified domain name used for SASL processing.
844 .B sasl\-realm <realm>
845 Specify SASL realm. Default is empty.
847 .B sasl\-secprops <properties>
848 Used to specify Cyrus SASL security properties.
851 flag (without any other properties) causes the flag properties
852 default, "noanonymous,noplain", to be cleared.
855 flag disables mechanisms susceptible to simple passive attacks.
858 flag disables mechanisms susceptible to active attacks.
861 flag disables mechanisms susceptible to passive dictionary attacks.
864 flag disables mechanisms which support anonymous login.
867 flag require forward secrecy between sessions.
870 require mechanisms which pass client credentials (and allow
871 mechanisms which can pass credentials to do so).
874 property specifies the minimum acceptable
875 .I security strength factor
876 as an integer approximate to effective key length used for
877 encryption. 0 (zero) implies no protection, 1 implies integrity
878 protection only, 56 allows DES or other weak ciphers, 112
879 allows triple DES and other strong ciphers, 128 allows RC4,
880 Blowfish and other modern strong ciphers. The default is 0.
883 property specifies the maximum acceptable
884 .I security strength factor
885 as an integer (see minssf description). The default is INT_MAX.
888 property specifies the maximum security layer receive buffer
889 size allowed. 0 disables security layers. The default is 65536.
892 Specify the distinguished name for the subschema subentry that
893 controls the entries on this server. The default is "cn=Subschema".
895 .B security <factors>
896 Specify a set of security strength factors (separated by white space)
898 .BR sasl\-secprops 's
900 option for a description of security strength factors).
901 The directive may be specified globally and/or per-database.
903 specifies the overall security strength factor.
905 specifies the transport security strength factor.
907 specifies the TLS security strength factor.
909 specifies the SASL security strength factor.
911 specifies the overall security strength factor to require for
913 .B update_transport=<n>
914 specifies the transport security strength factor to require for
917 specifies the TLS security strength factor to require for
920 specifies the SASL security strength factor to require for
923 specifies the security strength factor required for
925 username/password authentication.
928 factor is measure of security provided by the underlying transport,
929 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
931 .B serverID <integer> [<URL>]
932 Specify an integer ID from 0 to 4095 for this server (limited
933 to 3 hexadecimal digits). The ID may also be specified as a
934 hexadecimal ID by prefixing the value with "0x".
936 required when using multimaster replication and each master must have a
937 unique ID. Note that this requirement also applies to separate masters
938 contributing to a glued set of databases.
939 If the URL is provided, this directive may be specified
940 multiple times, providing a complete list of participating servers
941 and their IDs. The fully qualified hostname of each server should be
942 used in the supplied URLs. The IDs are used in the "replica id" field
943 of all CSNs generated by the specified server. The default value is zero.
950 .B sizelimit {<integer>|unlimited}
952 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
953 Specify the maximum number of entries to return from a search operation.
954 The default size limit is 500.
957 to specify no limits.
958 The second format allows a fine grain setting of the size limits.
959 Extra args can be added on the same line.
962 for an explanation of the different flags.
964 .B sockbuf_max_incoming <integer>
965 Specify the maximum incoming LDAP PDU size for anonymous sessions.
966 The default is 262143.
968 .B sockbuf_max_incoming_auth <integer>
969 Specify the maximum incoming LDAP PDU size for authenticated sessions.
970 The default is 4194303.
972 .B sortvals <attr> [...]
973 Specify a list of multi-valued attributes whose values will always
974 be maintained in sorted order. Using this option will allow Modify,
975 Compare, and filter evaluations on these attributes to be performed
976 more efficiently. The resulting sort order depends on the
977 attributes' syntax and matching rules and may not correspond to
978 lexical order or any other recognizable order.
980 .B tcp-buffer [listener=<URL>] [{read|write}=]<size>
981 Specify the size of the TCP buffer.
982 A global value for both read and write TCP buffers related to any listener
983 is defined, unless the listener is explicitly specified,
984 or either the read or write qualifiers are used.
988 Note that some OS-es implement automatic TCP buffer tuning.
991 Specify the maximum size of the primary thread pool.
992 The default is 16; the minimum value is 2.
994 .B timelimit {<integer>|unlimited}
996 .B timelimit time[.{soft|hard}]=<integer> [...]
997 Specify the maximum number of seconds (in real time)
999 will spend answering a search request. The default time limit is 3600.
1002 to specify no limits.
1003 The second format allows a fine grain setting of the time limits.
1004 Extra args can be added on the same line.
1007 for an explanation of the different flags.
1009 .B tool\-threads <integer>
1010 Specify the maximum number of threads to use in tool mode.
1011 This should not be greater than the number of CPUs in the system.
1013 .\"ucdata-path is obsolete / ignored...
1015 .\".B ucdata-path <path>
1016 .\"Specify the path to the directory containing the Unicode character
1017 .\"tables. The default path is DATADIR/ucdata.
1019 .B writetimeout <integer>
1020 Specify the number of seconds to wait before forcibly closing
1021 a connection with an outstanding write. This allows recovery from
1022 various network hang conditions. A writetimeout of 0 disables this
1023 feature. The default is 0.
1027 is built with support for Transport Layer Security, there are more options
1030 .B TLSCipherSuite <cipher-suite-spec>
1031 Permits configuring what ciphers will be accepted and the preference order.
1032 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
1034 TLSCipherSuite HIGH:MEDIUM:+SSLv2
1036 To check what ciphers a given spec selects, use:
1039 openssl ciphers \-v <cipher-suite-spec>
1042 To obtain the list of ciphers in GNUtls use:
1049 .B TLSCACertificateFile <filename>
1050 Specifies the file that contains certificates for all of the Certificate
1055 .B TLSCACertificatePath <path>
1056 Specifies the path of a directory that contains Certificate Authority
1057 certificates in separate individual files. Usually only one of this
1058 or the TLSCACertificateFile is used. This directive is not supported
1061 .B TLSCertificateFile <filename>
1062 Specifies the file that contains the
1066 .B TLSCertificateKeyFile <filename>
1067 Specifies the file that contains the
1069 server private key that matches the certificate stored in the
1070 .B TLSCertificateFile
1071 file. Currently, the private key must not be protected with a password, so
1072 it is of critical importance that it is protected carefully.
1074 .B TLSDHParamFile <filename>
1075 This directive specifies the file that contains parameters for Diffie-Hellman
1076 ephemeral key exchange. This is required in order to use a DSA certificate on
1077 the server. If multiple sets of parameters are present in the file, all of
1078 them will be processed. Note that setting this option may also enable
1079 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
1080 You should append "!ADH" to your cipher suites if you have changed them
1081 from the default, otherwise no certificate exchanges or verification will
1082 be done. When using GNUtls these parameters are always generated randomly so
1083 this directive is ignored.
1085 .B TLSRandFile <filename>
1086 Specifies the file to obtain random bits from when /dev/[u]random
1087 is not available. Generally set to the name of the EGD/PRNGD socket.
1088 The environment variable RANDFILE can also be used to specify the filename.
1089 This directive is ignored with GNUtls.
1091 .B TLSVerifyClient <level>
1092 Specifies what checks to perform on client certificates in an
1093 incoming TLS session, if any.
1096 can be specified as one of the following keywords:
1100 This is the default.
1102 will not ask the client for a certificate.
1105 The client certificate is requested. If no certificate is provided,
1106 the session proceeds normally. If a bad certificate is provided,
1107 it will be ignored and the session proceeds normally.
1110 The client certificate is requested. If no certificate is provided,
1111 the session proceeds normally. If a bad certificate is provided,
1112 the session is immediately terminated.
1114 .B demand | hard | true
1115 These keywords are all equivalent, for compatibility reasons.
1116 The client certificate is requested. If no certificate is provided,
1117 or a bad certificate is provided, the session is immediately terminated.
1119 Note that a valid client certificate is required in order to use the
1120 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1123 setting must be chosen to enable SASL EXTERNAL authentication.
1126 .B TLSCRLCheck <level>
1127 Specifies if the Certificate Revocation List (CRL) of the CA should be
1128 used to verify if the client certificates have not been revoked. This
1130 .B TLSCACertificatePath
1131 parameter to be set. This directive is ignored with GNUtls.
1133 can be specified as one of the following keywords:
1137 No CRL checks are performed
1140 Check the CRL of the peer certificate
1143 Check the CRL for a whole certificate chain
1146 .B TLSCRLFile <filename>
1147 Specifies a file containing a Certificate Revocation List to be used
1148 for verifying that certificates have not been revoked. This directive is
1149 only valid when using GNUtls.
1150 .SH GENERAL BACKEND OPTIONS
1151 Options in this section only apply to the configuration file section
1152 for the specified backend. They are supported by every
1155 .B backend <databasetype>
1156 Mark the beginning of a backend definition. <databasetype>
1173 depending on which backend will serve the database.
1175 .SH GENERAL DATABASE OPTIONS
1176 Options in this section only apply to the configuration file section
1177 for the database in which they are defined. They are supported by every
1178 type of backend. Note that the
1182 option are mandatory for each database.
1184 .B database <databasetype>
1185 Mark the beginning of a new database instance definition. <databasetype>
1202 depending on which backend will serve the database.
1204 LDAP operations, even subtree searches, normally access only one
1206 That can be changed by gluing databases together with the
1209 Access controls and some overlays can also involve multiple databases.
1211 .B add_content_acl on | off
1212 Controls whether Add operations will perform ACL checks on
1213 the content of the entry being added. This check is off
1215 .BR slapd.access (5)
1216 manual page for more details on ACL requirements for
1220 Controls whether the database will be used to answer
1221 queries. A database that is hidden will never be
1222 selected to answer any queries, and any suffix configured
1223 on the database will be ignored in checks for conflicts
1224 with other databases. By default, hidden is off.
1229 will automatically maintain the
1230 modifiersName, modifyTimestamp, creatorsName, and
1231 createTimestamp attributes for entries. It also controls
1232 the entryCSN and entryUUID attributes, which are needed
1233 by the syncrepl provider. By default, lastmod is on.
1235 .B limits <selector> <limit> [<limit> [...]]
1236 Specify time and size limits based on the operation's initiator or
1244 anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>
1250 <dnspec> ::= dn[.<type>][.<style>]
1252 <type> ::= self | this
1254 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1259 is the default and means the bound user, while
1261 means the base DN of the operation.
1264 matches all unauthenticated clients.
1267 matches all authenticated clients;
1270 dn pattern is assumed unless otherwise specified by qualifying
1271 the (optional) key string
1277 (which are synonyms), to require an exact match; with
1279 to require exactly one level of depth match; with
1281 to allow any level of depth match, including the exact match; with
1283 to allow any level of depth match, not including the exact match;
1285 explicitly requires the (default) match based on POSIX (''extended'')
1286 regular expression pattern.
1289 matches unbound operations; the
1292 The same behavior is obtained by using the
1299 with the optional objectClass
1305 sets the limits for any DN listed in the values of the
1311 group objectClass (default
1313 whose DN exactly matches
1316 The currently supported limits are
1321 The syntax for time limits is
1322 .BR time[.{soft|hard}]=<integer> ,
1325 is the number of seconds slapd will spend answering a search request.
1326 If no time limit is explicitly requested by the client, the
1328 limit is used; if the requested time limit exceeds the
1331 .\".I "Administrative limit exceeded"
1332 .\"error is returned.
1333 limit, the value of the limit is used instead.
1336 limit is set to the keyword
1338 the soft limit is used in either case; if it is set to the keyword
1340 no hard limit is enforced.
1341 Explicit requests for time limits smaller or equal to the
1344 If no limit specifier is set, the value is assigned to the
1350 to preserve the original behavior.
1352 The syntax for size limits is
1353 .BR size[.{soft|hard|unchecked}]=<integer> ,
1356 is the maximum number of entries slapd will return answering a search
1358 If no size limit is explicitly requested by the client, the
1360 limit is used; if the requested size limit exceeds the
1363 .\".I "Administrative limit exceeded"
1364 .\"error is returned.
1365 limit, the value of the limit is used instead.
1368 limit is set to the keyword
1370 the soft limit is used in either case; if it is set to the keyword
1372 no hard limit is enforced.
1373 Explicit requests for size limits smaller or equal to the
1378 specifier sets a limit on the number of candidates a search request is allowed
1380 The rationale behind it is that searches for non-properly indexed
1381 attributes may result in large sets of candidates, which must be
1384 to determine whether they match the search filter or not.
1387 limit provides a means to drop such operations before they are even
1389 If the selected candidates exceed the
1391 limit, the search will abort with
1392 .IR "Unwilling to perform" .
1393 If it is set to the keyword
1395 no limit is applied (the default).
1398 the search is not even performed; this can be used to disallow searches
1399 for a specific set of users.
1400 If no limit specifier is set, the value is assigned to the
1406 to preserve the original behavior.
1408 In case of no match, the global limits are used.
1409 The default values are the same as for
1418 control is requested, the
1420 size limit is used by default, because the request of a specific page size
1421 is considered an explicit request for a limitation on the number
1422 of entries to be returned.
1423 However, the size limit applies to the total count of entries returned within
1424 the search, and not to a single page.
1425 Additional size limits may be enforced; the syntax is
1426 .BR size.pr={<integer>|noEstimate|unlimited} ,
1429 is the max page size if no explicit limit is set; the keyword
1431 inhibits the server from returning an estimate of the total number
1432 of entries that might be returned
1433 (note: the current implementation does not return any estimate).
1436 indicates that no limit is applied to the pagedResults control page size.
1438 .B size.prtotal={<integer>|unlimited|disabled}
1439 allows to set a limit on the total number of entries that a pagedResults
1440 control allows to return.
1441 By default it is set to the
1446 is the max number of entries that the whole search with pagedResults control
1450 to allow unlimited number of entries to be returned, e.g. to allow
1451 the use of the pagedResults control as a means to circumvent size
1452 limitations on regular searches; the keyword
1454 disables the control, i.e. no paged results can be returned.
1455 Note that the total number of entries returned when the pagedResults control
1456 is requested cannot exceed the
1458 size limit of regular searches unless extended by the
1462 The \fBlimits\fP statement is typically used to let an unlimited
1463 number of entries be returned by searches performed
1464 with the identity used by the consumer for synchronization purposes
1465 by means of the RFC 4533 LDAP Content Synchronization protocol
1466 (see \fBsyncrepl\fP for details).
1469 .B maxderefdepth <depth>
1470 Specifies the maximum number of aliases to dereference when trying to
1471 resolve an entry, used to avoid infinite alias loops. The default is 15.
1473 .B mirrormode on | off
1474 This option puts a replica database into "mirror" mode. Update
1475 operations will be accepted from any user, not just the updatedn. The
1476 database must already be configured as a syncrepl consumer
1477 before this keyword may be set. This mode also requires a
1479 (see above) to be configured.
1480 By default, mirrormode is off.
1482 .B monitoring on | off
1483 This option enables database-specific monitoring in the entry related
1484 to the current database in the "cn=Databases,cn=Monitor" subtree
1485 of the monitor database, if the monitor database is enabled.
1486 Currently, only the BDB and the HDB databases provide database-specific
1488 The default depends on the backend type.
1490 .B overlay <overlay-name>
1491 Add the specified overlay to this database. An overlay is a piece of
1492 code that intercepts database operations in order to extend or change
1493 them. Overlays are pushed onto
1494 a stack over the database, and so they will execute in the reverse
1495 of the order in which they were configured and the database itself
1496 will receive control last of all. See the
1497 .BR slapd.overlays (5)
1498 manual page for an overview of the available overlays.
1499 Note that all of the database's
1500 regular settings should be configured before any overlay settings.
1502 .B readonly on | off
1503 This option puts the database into "read-only" mode. Any attempts to
1504 modify the database will return an "unwilling to perform" error. By
1505 default, readonly is off.
1507 .B restrict <oplist>
1508 Specify a whitespace separated list of operations that are restricted.
1509 If defined inside a database specification, restrictions apply only
1510 to that database, otherwise they are global.
1511 Operations can be any of
1516 .BR extended[=<OID>] ,
1520 or the special pseudo-operations
1524 which respectively summarize read and write operations.
1532 keyword allows to indicate the OID of the specific operation
1536 Specify the distinguished name that is not subject to access control
1537 or administrative limit restrictions for operations on this database.
1538 This DN may or may not be associated with an entry. An empty root
1539 DN (the default) specifies no root access is to be granted. It is
1540 recommended that the rootdn only be specified when needed (such as
1541 when initially populating a database). If the rootdn is within
1542 a namingContext (suffix) of the database, a simple bind password
1543 may also be provided using the
1545 directive. Many optional features, including syncrepl, require the
1546 rootdn to be defined for the database.
1548 .B rootpw <password>
1549 Specify a password (or hash of the password) for the rootdn. The
1550 password can only be set if the rootdn is within the namingContext
1551 (suffix) of the database.
1552 This option accepts all RFC 2307 userPassword formats known to
1555 description) as well as cleartext.
1557 may be used to generate a hash of a password. Cleartext
1558 and \fB{CRYPT}\fP passwords are not recommended. If empty
1559 (the default), authentication of the root DN is by other means
1560 (e.g. SASL). Use of SASL is encouraged.
1562 .B suffix <dn suffix>
1563 Specify the DN suffix of queries that will be passed to this
1564 backend database. Multiple suffix lines can be given and at least one is
1565 required for each database definition.
1567 If the suffix of one database is "inside" that of another, the database
1568 with the inner suffix must come first in the configuration file.
1569 You may also want to glue such databases together with the
1573 .B subordinate [advertise]
1574 Specify that the current backend database is a subordinate of another
1575 backend database. A subordinate database may have only one suffix. This
1576 option may be used to glue multiple databases into a single namingContext.
1577 If the suffix of the current database is within the namingContext of a
1578 superior database, searches against the superior database will be
1579 propagated to the subordinate as well. All of the databases
1580 associated with a single namingContext should have identical rootdns.
1581 Behavior of other LDAP operations is unaffected by this setting. In
1582 particular, it is not possible to use moddn to move an entry from
1583 one subordinate to another subordinate within the namingContext.
1585 If the optional \fBadvertise\fP flag is supplied, the naming context of
1586 this database is advertised in the root DSE. The default is to hide this
1587 database context, so that only the superior context is visible.
1594 are used on the superior database, any glued subordinates that support
1595 these tools are opened as well.
1597 Databases that are glued together should usually be configured with the
1598 same indices (assuming they support indexing), even for attributes that
1599 only exist in some of these databases. In general, all of the glued
1600 databases should be configured as similarly as possible, since the intent
1601 is to provide the appearance of a single directory.
1603 Note that the \fIsubordinate\fP functionality is implemented internally
1604 by the \fIglue\fP overlay and as such its behavior will interact with other
1605 overlays in use. By default, the glue overlay is automatically configured as
1606 the last overlay on the superior backend. Its position on the backend
1607 can be explicitly configured by setting an \fBoverlay glue\fP directive
1608 at the desired position. This explicit configuration is necessary e.g.
1609 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1610 in order to work over all of the glued databases. E.g.
1614 suffix dc=example,dc=com
1621 .B sync_use_subentry
1622 Store the syncrepl contextCSN in a subentry instead of the context entry
1623 of the database. The subentry's RDN will be "cn=ldapsync". By default
1624 the contextCSN is stored in the context entry.
1627 .B syncrepl rid=<replica ID>
1628 .B provider=ldap[s]://<hostname>[:port]
1629 .B searchbase=<base DN>
1630 .B [type=refreshOnly|refreshAndPersist]
1631 .B [interval=dd:hh:mm:ss]
1632 .B [retry=[<retry interval> <# of retries>]+]
1633 .B [filter=<filter str>]
1634 .B [scope=sub|one|base|subord]
1635 .B [attrs=<attr list>]
1637 .B [sizelimit=<limit>]
1638 .B [timelimit=<limit>]
1639 .B [schemachecking=on|off]
1640 .B [network\-timeout=<seconds>]
1641 .B [timeout=<seconds>]
1642 .B [bindmethod=simple|sasl]
1644 .B [saslmech=<mech>]
1645 .B [authcid=<identity>]
1646 .B [authzid=<identity>]
1647 .B [credentials=<passwd>]
1649 .B [secprops=<properties>]
1650 .B [keepalive=<idle>:<probes>:<interval>]
1651 .B [starttls=yes|critical]
1652 .B [tls_cert=<file>]
1654 .B [tls_cacert=<file>]
1655 .B [tls_cacertdir=<path>]
1656 .B [tls_reqcert=never|allow|try|demand]
1657 .B [tls_ciphersuite=<ciphers>]
1658 .B [tls_crlcheck=none|peer|all]
1659 .B [logbase=<base DN>]
1660 .B [logfilter=<filter str>]
1661 .B [syncdata=default|accesslog|changelog]
1663 Specify the current database as a replica which is kept up-to-date with the
1664 master content by establishing the current
1666 as a replication consumer site running a
1669 The replica content is kept synchronized to the master content using
1670 the LDAP Content Synchronization protocol. Refer to the
1671 "OpenLDAP Administrator's Guide" for detailed information on
1672 setting up a replicated
1674 directory service using the
1679 identifies the current
1681 directive within the replication consumer site.
1682 It is a non-negative integer not greater than 999 (limited
1683 to three decimal digits).
1686 specifies the replication provider site containing the master content
1687 as an LDAP URI. If <port> is not given, the standard LDAP port number
1688 (389 or 636) is used.
1692 replica is defined using a search
1693 specification as its result set. The consumer
1695 will send search requests to the provider
1697 according to the search specification. The search specification includes
1698 .BR searchbase ", " scope ", " filter ", " attrs ", " attrsonly ", " sizelimit ", "
1701 parameters as in the normal search specification.
1702 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1703 \fB(objectclass=*)\fP, while there is no default \fBsearchbase\fP. The
1704 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1705 attributes, and \fBattrsonly\fP is unset by default.
1706 The \fBsizelimit\fP and \fBtimelimit\fP only
1707 accept "unlimited" and positive integers, and both default to "unlimited".
1708 The \fBsizelimit\fP and \fBtimelimit\fP parameters define
1709 a consumer requested limitation on the number of entries that can be returned
1710 by the LDAP Content Synchronization operation; as such, it is intended
1711 to implement partial replication based on the size of the replicated database
1712 and on the time required by the synchronization.
1713 Note, however, that any provider-side limits for the replication identity
1714 will be enforced by the provider regardless of the limits requested
1715 by the LDAP Content Synchronization operation, much like for any other
1718 The LDAP Content Synchronization protocol has two operation types.
1721 operation, the next synchronization search operation
1722 is periodically rescheduled at an interval time (specified by
1724 parameter; 1 day by default)
1725 after each synchronization operation finishes.
1727 .B refreshAndPersist
1728 operation, a synchronization search remains persistent in the provider slapd.
1729 Further updates to the master replica will generate
1730 .B searchResultEntry
1731 to the consumer slapd as the search responses to the persistent
1732 synchronization search.
1734 If an error occurs during replication, the consumer will attempt to
1735 reconnect according to the
1737 parameter which is a list of the <retry interval> and <# of retries> pairs.
1738 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1739 for the first 10 times and then retry every 300 seconds for the next 3
1740 times before stop retrying. The `+' in <# of retries> means indefinite
1741 number of retries until success.
1744 was specified, by default syncrepl retries every hour forever.
1746 The schema checking can be enforced at the LDAP Sync
1747 consumer site by turning on the
1749 parameter. The default is \fBoff\fP.
1750 Schema checking \fBon\fP means that replicated entries must have
1751 a structural objectClass, must obey to objectClass requirements
1752 in terms of required/allowed attributes, and that naming attributes
1753 and distinguished values must be present.
1754 As a consequence, schema checking should be \fBoff\fP when partial
1755 replication is used.
1759 parameter sets how long the consumer will wait to establish a
1760 network connection to the provider. Once a connection is
1763 parameter determines how long the consumer will wait for the initial
1764 Bind request to complete. The defaults for these parameters come
1772 requires the options
1776 and should only be used when adequate security services
1777 (e.g. TLS or IPSEC) are in place.
1778 .B REMEMBER: simple bind credentials must be in cleartext!
1785 Depending on the mechanism, an authentication identity and/or
1786 credentials can be specified using
1792 parameter may be used to specify an authorization identity.
1793 Specific security properties (as with the
1795 keyword above) for a SASL bind can be set with the
1797 option. A non default SASL realm can be set with the
1800 The identity used for synchronization by the consumer should be allowed
1801 to receive an unlimited number of entries in response to a search request.
1802 The provider, other than allow authentication of the syncrepl identity,
1803 should grant that identity appropriate access privileges to the data
1804 that is being replicated (\fBaccess\fP directive), and appropriate time
1806 This can be accomplished by either allowing unlimited \fBsizelimit\fP
1807 and \fBtimelimit\fP, or by setting an appropriate \fBlimits\fP statement
1808 in the consumer's configuration (see \fBsizelimit\fP and \fBlimits\fP
1813 parameter sets the values of \fIidle\fP, \fIprobes\fP, and \fIinterval\fP
1814 used to check whether a socket is alive;
1816 is the number of seconds a connection needs to remain idle before TCP
1817 starts sending keepalive probes;
1819 is the maximum number of keepalive probes TCP should send before dropping
1822 is interval in seconds between individual keepalive probes.
1823 Only some systems support the customization of these values;
1826 parameter is ignored otherwise, and system-wide settings are used.
1830 parameter specifies use of the StartTLS extended operation
1831 to establish a TLS session before Binding to the provider. If the
1833 argument is supplied, the session will be aborted if the StartTLS request
1834 fails. Otherwise the syncrepl session continues without TLS. The
1835 tls_reqcert setting defaults to "demand" and the other TLS settings
1836 default to the same as the main slapd TLS settings.
1838 Rather than replicating whole entries, the consumer can query logs of
1839 data modifications. This mode of operation is referred to as \fIdelta
1840 syncrepl\fP. In addition to the above parameters, the
1844 parameters must be set appropriately for the log that will be used. The
1846 parameter must be set to either "accesslog" if the log conforms to the
1847 .BR slapo\-accesslog (5)
1848 log format, or "changelog" if the log conforms
1849 to the obsolete \fIchangelog\fP format. If the
1851 parameter is omitted or set to "default" then the log parameters are
1856 This option is only applicable in a slave
1858 It specifies the DN permitted to update (subject to access controls)
1859 the replica. It is only needed in certain push-mode
1860 replication scenarios. Generally, this DN
1867 Specify the referral to pass back when
1869 is asked to modify a replicated local database.
1870 If specified multiple times, each url is provided.
1872 .SH DATABASE-SPECIFIC OPTIONS
1873 Each database may allow specific configuration options; they are
1874 documented separately in the backends' manual pages. See the
1875 .BR slapd.backends (5)
1876 manual page for an overview of available backends.
1879 Here is a short example of a configuration file:
1883 include SYSCONFDIR/schema/core.schema
1884 pidfile LOCALSTATEDIR/run/slapd.pid
1886 # Subtypes of "name" (e.g. "cn" and "ou") with the
1887 # option ";x\-hidden" can be searched for/compared,
1888 # but are not shown. See \fBslapd.access\fP(5).
1889 attributeoptions x\-hidden lang\-
1890 access to attrs=name;x\-hidden by * =cs
1892 # Protect passwords. See \fBslapd.access\fP(5).
1893 access to attrs=userPassword by * auth
1894 # Read access to other attributes and entries.
1895 access to * by * read
1898 suffix "dc=our\-domain,dc=com"
1899 # The database directory MUST exist prior to
1900 # running slapd AND should only be accessible
1901 # by the slapd/tools. Mode 0700 recommended.
1902 directory LOCALSTATEDIR/openldap\-data
1903 # Indices to maintain
1904 index objectClass eq
1905 index cn,sn,mail pres,eq,approx,sub
1907 # We serve small clients that do not handle referrals,
1908 # so handle remote lookups on their behalf.
1911 uri ldap://ldap.some\-server.com/
1916 "OpenLDAP Administrator's Guide" contains a longer annotated
1917 example of a configuration file.
1918 The original ETCDIR/slapd.conf is another example.
1922 default slapd configuration file
1925 .BR slapd\-config (5),
1926 .BR slapd.access (5),
1927 .BR slapd.backends (5),
1928 .BR slapd.overlays (5),
1929 .BR slapd.plugin (5),
1930 .BR slapd.replog (5),
1941 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1942 .SH ACKNOWLEDGEMENTS