1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2017 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_hash64 { on | off }
499 Use a 64 bit hash for indexing. The default is to use 32 bit hashes.
500 These hashes are used for equality and substring indexing. The 64 bit
501 version may be needed to avoid index collisions when the number of
502 indexed values exceeds ~64 million. (Note that substring indexing
503 generates multiple index values per actual attribute value.)
504 Indices generated with 32 bit hashes are incompatible with the 64 bit
505 version, and vice versa. Any existing databases must be fully reloaded
506 when changing this setting. This directive is only supported on 64 bit CPUs.
508 .B index_intlen <integer>
509 Specify the key length for ordered integer indices. The most significant
510 bytes of the binary integer will be used for index keys. The default
511 value is 4, which provides exact indexing for 31 bit values.
512 A floating point representation is used to index too large values.
514 .B index_substr_if_minlen <integer>
515 Specify the minimum length for subinitial and subfinal indices. An
516 attribute value must have at least this many characters in order to be
517 processed by the indexing functions. The default is 2.
519 .B index_substr_if_maxlen <integer>
520 Specify the maximum length for subinitial and subfinal indices. Only
521 this many characters of an attribute value will be processed by the
522 indexing functions; any excess characters are ignored. The default is 4.
524 .B index_substr_any_len <integer>
525 Specify the length used for subany indices. An attribute value must have
526 at least this many characters in order to be processed. Attribute values
527 longer than this length will be processed in segments of this length. The
528 default is 4. The subany index will also be used in subinitial and
529 subfinal index lookups when the filter string is longer than the
530 .I index_substr_if_maxlen
533 .B index_substr_any_step <integer>
534 Specify the steps used in subany index lookups. This value sets the offset
535 for the segments of a filter string that are processed for a subany index
536 lookup. The default is 2. For example, with the default values, a search
537 using this filter "cn=*abcdefgh*" would generate index lookups for
538 "abcd", "cdef", and "efgh".
541 Note: Indexing support depends on the particular backend in use. Also,
542 changing these settings will generally require deleting any indices that
543 depend on these parameters and recreating them with
548 .B ldapsyntax "(\ <oid>\
549 [DESC\ <description>]\
550 [X\-SUBST <substitute-syntax>]\ )"
552 Specify an LDAP syntax using the LDAPv3 syntax defined in RFC 4512.
553 The slapd parser extends the RFC 4512 definition by allowing string
554 forms as well as numeric OIDs to be used for the syntax OID.
558 The slapd parser also honors the
560 extension (an OpenLDAP-specific extension), which allows one to use the
562 statement to define a non-implemented syntax along with another syntax,
564 .IR substitute-syntax ,
565 as its temporary replacement.
569 This allows one to define attribute types that make use of non-implemented syntaxes
570 using the correct syntax OID.
573 is used, this configuration statement would result in an error,
574 since no handlers would be associated to the resulting syntax structure.
578 .B listener-threads <integer>
579 Specify the number of threads to use for the connection manager.
580 The default is 1 and this is typically adequate for up to 16 CPU cores.
581 The value should be set to a power of 2.
584 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
585 such as those to the ldapi:// listener. For a description of SSF values,
589 option description. The default is 71.
591 .B logfile <filename>
592 Specify a file for recording debug log messages. By default these messages
593 only go to stderr and are not recorded anywhere else. Specifying a logfile
594 copies messages to both stderr and the logfile.
596 .B loglevel <integer> [...]
597 Specify the level at which debugging statements and operation
598 statistics should be syslogged (currently logged to the
600 LOG_LOCAL4 facility).
601 They must be considered subsystems rather than increasingly verbose
603 Some messages with higher priority are logged regardless
604 of the configured loglevel as soon as any logging is configured.
605 Log levels are additive, and available levels are:
616 debug packet handling
620 heavy trace debugging (function args)
624 connection management
628 print out packets sent and received
632 search filter processing
636 configuration file processing
640 access control list processing
644 connections, LDAP operations, results (recommended)
648 stats log entries sent
652 print communication with shell backends
664 \"data indexing (unused)
672 only messages that get logged whatever log level is set
675 The desired log level can be input as a single integer that combines
676 the (ORed) desired levels, both in decimal or in hexadecimal notation,
677 as a list of integers (that are ORed internally),
678 or as a list of the names that are shown between parentheses, such that
691 can be used as a shortcut to enable logging at all levels (equivalent to \-1).
694 or the equivalent integer representation, causes those messages
695 that are logged regardless of the configured loglevel to be logged.
696 In fact, if loglevel is set to 0, no logging occurs,
699 level is required to have high priority messages logged.
701 The loglevel defaults to \fBstats\fP.
702 This level should usually also be included when using other loglevels, to
703 help analyze the logs.
706 .B moduleload <filename>
707 Specify the name of a dynamically loadable module to load. The filename
708 may be an absolute path name or a simple filename. Non-absolute names
709 are searched for in the directories specified by the
711 option. This option and the
713 option are only usable if slapd was compiled with \-\-enable\-modules.
715 .B modulepath <pathspec>
716 Specify a list of directories to search for loadable modules. Typically
717 the path is colon-separated but this depends on the operating system.
718 The default is MODULEDIR, which is where the standard OpenLDAP install
719 will place its modules.
722 .B objectclass "(\ <oid>\
724 [DESC\ <description>]\
727 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
728 [MUST\ <oids>] [MAY\ <oids>] )"
730 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
731 The slapd parser extends the RFC 4512 definition by allowing string
732 forms as well as numeric OIDs to be used for the object class OID.
736 description.) Object classes are "STRUCTURAL" by default.
739 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
740 Define a string name that equates to the given OID. The string can be used
741 in place of the numeric OID in objectclass and attribute definitions. The
742 name can also be used with a suffix of the form ":xx" in which case the
743 value "oid.xx" will be used.
745 .B password\-hash <hash> [<hash>...]
746 This option configures one or more hashes to be used in generation of user
747 passwords stored in the userPassword attribute during processing of
748 LDAP Password Modify Extended Operations (RFC 3062).
749 The <hash> must be one of
763 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
768 use the MD5 algorithm (RFC 1321), the latter with a seed.
775 indicates that the new password should be
776 added to userPassword as clear text.
778 Note that this option does not alter the normal user applications
779 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
781 .B password\-crypt\-salt\-format <format>
782 Specify the format of the salt passed to
784 when generating {CRYPT} passwords (see
786 during processing of LDAP Password Modify Extended Operations (RFC 3062).
788 This string needs to be in
790 format and may include one (and only one) %s conversion.
791 This conversion will be substituted with a string of random
792 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
793 provides a two character salt and "$1$%.8s" tells some
794 versions of crypt(3) to use an MD5 algorithm and provides
795 8 random characters of salt. The default is "%s", which
796 provides 31 characters of salt.
798 .B pidfile <filename>
799 The (absolute) name of a file that will hold the
801 server's process ID (see
805 Specify the referral to pass back when
807 cannot find a local database to handle a request.
808 If specified multiple times, each url is provided.
810 .B require <conditions>
811 Specify a set of conditions (separated by white space) to
812 require (default none).
813 The directive may be specified globally and/or per-database;
814 databases inherit global conditions, so per-database specifications
817 requires bind operation prior to directory operations.
819 requires session to be using LDAP version 3.
821 requires authentication prior to directory operations.
823 requires SASL authentication prior to directory operations.
825 requires strong authentication prior to directory operations.
826 The strong keyword allows protected "simple" authentication
827 as well as SASL authentication.
829 may be used to require no conditions (useful to clear out globally
830 set conditions within a particular database); it must occur first
831 in the list of conditions.
833 .B reverse\-lookup on | off
834 Enable/disable client name unverified reverse lookup (default is
836 if compiled with \-\-enable\-rlookups).
839 Specify the name of an LDIF(5) file containing user defined attributes
840 for the root DSE. These attributes are returned in addition to the
841 attributes normally produced by slapd.
843 The root DSE is an entry with information about the server and its
844 capabilities, in operational attributes.
845 It has the empty DN, and can be read with e.g.:
847 ldapsearch \-x \-b "" \-s base "+"
849 See RFC 4512 section 5.1 for details.
851 .B sasl\-auxprops <plugin> [...]
852 Specify which auxprop plugins to use for authentication lookups. The
853 default is empty, which just uses slapd's internal support. Usually
854 no other auxprop plugins are needed.
856 .B sasl\-auxprops\-dontusecopy <attr> [...]
857 Specify which attribute(s) should be subject to the don't use copy control. This
858 is necessary for some SASL mechanisms such as OTP to work in a replicated
859 environment. The attribute "cmusaslsecretOTP" is the default value.
861 .B sasl\-auxprops\-dontusecopy\-ignore on | off
862 Used to disable replication of the attribute(s) defined by
863 sasl-auxprops-dontusecopy and instead use a local value for the attribute. This
864 allows the SASL mechanism to continue to work if the master is offline. This can
865 cause replication inconsistency. Defaults to off.
868 Used to specify the fully qualified domain name used for SASL processing.
870 .B sasl\-realm <realm>
871 Specify SASL realm. Default is empty.
873 .B sasl\-secprops <properties>
874 Used to specify Cyrus SASL security properties.
877 flag (without any other properties) causes the flag properties
878 default, "noanonymous,noplain", to be cleared.
881 flag disables mechanisms susceptible to simple passive attacks.
884 flag disables mechanisms susceptible to active attacks.
887 flag disables mechanisms susceptible to passive dictionary attacks.
890 flag disables mechanisms which support anonymous login.
893 flag require forward secrecy between sessions.
896 require mechanisms which pass client credentials (and allow
897 mechanisms which can pass credentials to do so).
900 property specifies the minimum acceptable
901 .I security strength factor
902 as an integer approximate to effective key length used for
903 encryption. 0 (zero) implies no protection, 1 implies integrity
904 protection only, 56 allows DES or other weak ciphers, 112
905 allows triple DES and other strong ciphers, 128 allows RC4,
906 Blowfish and other modern strong ciphers. The default is 0.
909 property specifies the maximum acceptable
910 .I security strength factor
911 as an integer (see minssf description). The default is INT_MAX.
914 property specifies the maximum security layer receive buffer
915 size allowed. 0 disables security layers. The default is 65536.
918 Specify the distinguished name for the subschema subentry that
919 controls the entries on this server. The default is "cn=Subschema".
921 .B security <factors>
922 Specify a set of security strength factors (separated by white space)
924 .BR sasl\-secprops 's
926 option for a description of security strength factors).
927 The directive may be specified globally and/or per-database.
929 specifies the overall security strength factor.
931 specifies the transport security strength factor.
933 specifies the TLS security strength factor.
935 specifies the SASL security strength factor.
937 specifies the overall security strength factor to require for
939 .B update_transport=<n>
940 specifies the transport security strength factor to require for
943 specifies the TLS security strength factor to require for
946 specifies the SASL security strength factor to require for
949 specifies the security strength factor required for
951 username/password authentication.
954 factor is measure of security provided by the underlying transport,
955 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
957 .B serverID <integer> [<URL>]
958 Specify an integer ID from 0 to 4095 for this server (limited
959 to 3 hexadecimal digits). The ID may also be specified as a
960 hexadecimal ID by prefixing the value with "0x".
962 required when using multimaster replication and each master must have a
963 unique non-zero ID. Note that this requirement also applies to separate masters
964 contributing to a glued set of databases.
965 If the URL is provided, this directive may be specified
966 multiple times, providing a complete list of participating servers
967 and their IDs. The fully qualified hostname of each server should be
968 used in the supplied URLs. The IDs are used in the "replica id" field
969 of all CSNs generated by the specified server. The default value is zero, which
970 is only valid for single master replication.
977 .B sizelimit {<integer>|unlimited}
979 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
980 Specify the maximum number of entries to return from a search operation.
981 The default size limit is 500.
984 to specify no limits.
985 The second format allows a fine grain setting of the size limits.
986 Extra args can be added on the same line.
989 for an explanation of the different flags.
991 .B sockbuf_max_incoming <integer>
992 Specify the maximum incoming LDAP PDU size for anonymous sessions.
993 The default is 262143.
995 .B sockbuf_max_incoming_auth <integer>
996 Specify the maximum incoming LDAP PDU size for authenticated sessions.
997 The default is 4194303.
999 .B sortvals <attr> [...]
1000 Specify a list of multi-valued attributes whose values will always
1001 be maintained in sorted order. Using this option will allow Modify,
1002 Compare, and filter evaluations on these attributes to be performed
1003 more efficiently. The resulting sort order depends on the
1004 attributes' syntax and matching rules and may not correspond to
1005 lexical order or any other recognizable order.
1007 .B tcp-buffer [listener=<URL>] [{read|write}=]<size>
1008 Specify the size of the TCP buffer.
1009 A global value for both read and write TCP buffers related to any listener
1010 is defined, unless the listener is explicitly specified,
1011 or either the read or write qualifiers are used.
1015 Note that some OS-es implement automatic TCP buffer tuning.
1017 .B threads <integer>
1018 Specify the maximum size of the primary thread pool.
1019 The default is 16; the minimum value is 2.
1021 .B threadqueues <integer>
1022 Specify the number of work queues to use for the primary thread pool.
1023 The default is 1 and this is typically adequate for up to 8 CPU cores.
1024 The value should not exceed the number of CPUs in the system.
1026 .B timelimit {<integer>|unlimited}
1028 .B timelimit time[.{soft|hard}]=<integer> [...]
1029 Specify the maximum number of seconds (in real time)
1031 will spend answering a search request. The default time limit is 3600.
1034 to specify no limits.
1035 The second format allows a fine grain setting of the time limits.
1036 Extra args can be added on the same line.
1039 for an explanation of the different flags.
1041 .B tool\-threads <integer>
1042 Specify the maximum number of threads to use in tool mode.
1043 This should not be greater than the number of CPUs in the system.
1045 .\"ucdata-path is obsolete / ignored...
1047 .\".B ucdata-path <path>
1048 .\"Specify the path to the directory containing the Unicode character
1049 .\"tables. The default path is DATADIR/ucdata.
1051 .B writetimeout <integer>
1052 Specify the number of seconds to wait before forcibly closing
1053 a connection with an outstanding write. This allows recovery from
1054 various network hang conditions. A writetimeout of 0 disables this
1055 feature. The default is 0.
1059 is built with support for Transport Layer Security, there are more options
1062 .B TLSCipherSuite <cipher-suite-spec>
1063 Permits configuring what ciphers will be accepted and the preference order.
1064 <cipher-suite-spec> should be a cipher specification for the TLS library
1065 in use (OpenSSL, GnuTLS, or Mozilla NSS).
1071 TLSCipherSuite HIGH:MEDIUM:+SSLv2
1074 TLSCiphersuite SECURE256:!AES-128-CBC
1077 To check what ciphers a given spec selects in OpenSSL, use:
1080 openssl ciphers \-v <cipher-suite-spec>
1083 With GnuTLS the available specs can be found in the manual page of
1085 (see the description of the
1089 In older versions of GnuTLS, where gnutls\-cli does not support the option
1090 \-\-priority, you can obtain the \(em more limited \(em list of ciphers by calling:
1096 When using Mozilla NSS, the OpenSSL cipher suite specifications are used and
1097 translated into the format used internally by Mozilla NSS. There isn't an easy
1098 way to list the cipher suites from the command line. The authoritative list
1099 is in the source code for Mozilla NSS in the file sslinfo.c in the structure
1101 static const SSLCipherSuiteInfo suiteInfo[]
1105 .B TLSCACertificateFile <filename>
1106 Specifies the file that contains certificates for all of the Certificate
1109 will recognize. The certificate for
1110 the CA that signed the server certificate must be included among
1111 these certificates. If the signing CA was not a top-level (root) CA,
1112 certificates for the entire sequence of CA's from the signing CA to
1113 the top-level CA should be present. Multiple certificates are simply
1114 appended to the file; the order is not significant.
1116 .B TLSCACertificatePath <path>
1117 Specifies the path of a directory that contains Certificate Authority
1118 certificates in separate individual files. Usually only one of this
1119 or the TLSCACertificateFile is used. This directive is not supported
1122 When using Mozilla NSS, <path> may contain a Mozilla NSS cert/key
1123 database. If <path> contains a Mozilla NSS cert/key database and
1124 CA cert files, OpenLDAP will use the cert/key database and will
1125 ignore the CA cert files.
1127 .B TLSCertificateFile <filename>
1128 Specifies the file that contains the
1132 When using Mozilla NSS, if using a cert/key database (specified with
1133 TLSCACertificatePath), TLSCertificateFile specifies
1134 the name of the certificate to use:
1136 TLSCertificateFile Server-Cert
1138 If using a token other than the internal built in token, specify the
1139 token name first, followed by a colon:
1141 TLSCertificateFile my hardware device:Server-Cert
1143 Use certutil \-L to list the certificates by name:
1145 certutil \-d /path/to/certdbdir \-L
1148 .B TLSCertificateKeyFile <filename>
1149 Specifies the file that contains the
1151 server private key that matches the certificate stored in the
1152 .B TLSCertificateFile
1153 file. Currently, the private key must not be protected with a password, so
1154 it is of critical importance that it is protected carefully.
1156 When using Mozilla NSS, TLSCertificateKeyFile specifies the name of
1157 a file that contains the password for the key for the certificate specified with
1158 TLSCertificateFile. The modutil command can be used to turn off password
1159 protection for the cert/key database. For example, if TLSCACertificatePath
1160 specifes /etc/openldap/certdb as the location of the cert/key database, use
1161 modutil to change the password to the empty string:
1163 modutil \-dbdir /etc/openldap/certdb \-changepw 'NSS Certificate DB'
1165 You must have the old password, if any. Ignore the WARNING about the running
1166 browser. Press 'Enter' for the new password.
1168 .B TLSDHParamFile <filename>
1169 This directive specifies the file that contains parameters for Diffie-Hellman
1170 ephemeral key exchange. This is required in order to use a DSA certificate on
1171 the server, or an RSA certificate missing the "key encipherment" key usage.
1172 Note that setting this option may also enable
1173 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
1174 Anonymous key exchanges should generally be avoided since they provide no
1175 actual client or server authentication and provide no protection against
1176 man-in-the-middle attacks.
1177 You should append "!ADH" to your cipher suites to ensure that these suites
1179 When using Mozilla NSS these parameters are always generated randomly
1180 so this directive is ignored.
1183 Specify the name of a curve to use for Elliptic curve Diffie-Hellman
1184 ephemeral key exchange. This is required to enable ECDHE algorithms in
1185 OpenSSL. This option is not used with GnuTLS; the curves may be
1186 chosen in the GnuTLS ciphersuite specification. This option is also
1187 ignored for Mozilla NSS.
1189 .B TLSProtocolMin <major>[.<minor>]
1190 Specifies minimum SSL/TLS protocol version that will be negotiated.
1191 If the server doesn't support at least that version,
1192 the SSL handshake will fail.
1193 To require TLS 1.x or higher, set this option to 3.(x+1),
1200 would require TLS 1.1.
1201 Specifying a minimum that is higher than that supported by the
1202 OpenLDAP implementation will result in it requiring the
1203 highest level that it does support.
1204 This directive is ignored with GnuTLS.
1206 .B TLSRandFile <filename>
1207 Specifies the file to obtain random bits from when /dev/[u]random
1208 is not available. Generally set to the name of the EGD/PRNGD socket.
1209 The environment variable RANDFILE can also be used to specify the filename.
1210 This directive is ignored with GnuTLS and Mozilla NSS.
1212 .B TLSVerifyClient <level>
1213 Specifies what checks to perform on client certificates in an
1214 incoming TLS session, if any.
1217 can be specified as one of the following keywords:
1221 This is the default.
1223 will not ask the client for a certificate.
1226 The client certificate is requested. If no certificate is provided,
1227 the session proceeds normally. If a bad certificate is provided,
1228 it will be ignored and the session proceeds normally.
1231 The client certificate is requested. If no certificate is provided,
1232 the session proceeds normally. If a bad certificate is provided,
1233 the session is immediately terminated.
1235 .B demand | hard | true
1236 These keywords are all equivalent, for compatibility reasons.
1237 The client certificate is requested. If no certificate is provided,
1238 or a bad certificate is provided, the session is immediately terminated.
1240 Note that a valid client certificate is required in order to use the
1241 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1244 setting must be chosen to enable SASL EXTERNAL authentication.
1247 .B TLSCRLCheck <level>
1248 Specifies if the Certificate Revocation List (CRL) of the CA should be
1249 used to verify if the client certificates have not been revoked. This
1251 .B TLSCACertificatePath
1252 parameter to be set. This directive is ignored with GnuTLS and Mozilla NSS.
1254 can be specified as one of the following keywords:
1258 No CRL checks are performed
1261 Check the CRL of the peer certificate
1264 Check the CRL for a whole certificate chain
1267 .B TLSCRLFile <filename>
1268 Specifies a file containing a Certificate Revocation List to be used
1269 for verifying that certificates have not been revoked. This directive is
1270 only valid when using GnuTLS and Mozilla NSS.
1271 .SH GENERAL BACKEND OPTIONS
1272 Options in this section only apply to the configuration file section
1273 for the specified backend. They are supported by every
1276 .B backend <databasetype>
1277 Mark the beginning of a backend definition. <databasetype>
1295 depending on which backend will serve the database.
1297 .SH GENERAL DATABASE OPTIONS
1298 Options in this section only apply to the configuration file section
1299 for the database in which they are defined. They are supported by every
1300 type of backend. Note that the
1304 option are mandatory for each database.
1306 .B database <databasetype>
1307 Mark the beginning of a new database instance definition. <databasetype>
1325 depending on which backend will serve the database.
1327 LDAP operations, even subtree searches, normally access only one
1329 That can be changed by gluing databases together with the
1332 Access controls and some overlays can also involve multiple databases.
1334 .B add_content_acl on | off
1335 Controls whether Add operations will perform ACL checks on
1336 the content of the entry being added. This check is off
1338 .BR slapd.access (5)
1339 manual page for more details on ACL requirements for
1342 .B extra_attrs <attrlist>
1343 Lists what attributes need to be added to search requests.
1344 Local storage backends return the entire entry to the frontend.
1345 The frontend takes care of only returning the requested attributes
1346 that are allowed by ACLs.
1347 However, features like access checking and so may need specific
1348 attributes that are not automatically returned by remote storage
1349 backends, like proxy backends and so on.
1351 is a list of attributes that are needed for internal purposes
1352 and thus always need to be collected, even when not explicitly
1353 requested by clients.
1356 Controls whether the database will be used to answer
1357 queries. A database that is hidden will never be
1358 selected to answer any queries, and any suffix configured
1359 on the database will be ignored in checks for conflicts
1360 with other databases. By default, hidden is off.
1365 will automatically maintain the
1366 modifiersName, modifyTimestamp, creatorsName, and
1367 createTimestamp attributes for entries. It also controls
1368 the entryCSN and entryUUID attributes, which are needed
1369 by the syncrepl provider. By default, lastmod is on.
1371 .B limits <selector> <limit> [<limit> [...]]
1372 Specify time and size limits based on the operation's initiator or
1380 anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>
1386 <dnspec> ::= dn[.<type>][.<style>]
1388 <type> ::= self | this
1390 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1395 is the default and means the bound user, while
1397 means the base DN of the operation.
1400 matches all unauthenticated clients.
1403 matches all authenticated clients;
1406 dn pattern is assumed unless otherwise specified by qualifying
1407 the (optional) key string
1413 (which are synonyms), to require an exact match; with
1415 to require exactly one level of depth match; with
1417 to allow any level of depth match, including the exact match; with
1419 to allow any level of depth match, not including the exact match;
1421 explicitly requires the (default) match based on POSIX (''extended'')
1422 regular expression pattern.
1425 matches unbound operations; the
1428 The same behavior is obtained by using the
1435 with the optional objectClass
1441 sets the limits for any DN listed in the values of the
1447 group objectClass (default
1449 whose DN exactly matches
1452 The currently supported limits are
1457 The syntax for time limits is
1458 .BR time[.{soft|hard}]=<integer> ,
1461 is the number of seconds slapd will spend answering a search request.
1462 If no time limit is explicitly requested by the client, the
1464 limit is used; if the requested time limit exceeds the
1467 .\".I "Administrative limit exceeded"
1468 .\"error is returned.
1469 limit, the value of the limit is used instead.
1472 limit is set to the keyword
1474 the soft limit is used in either case; if it is set to the keyword
1476 no hard limit is enforced.
1477 Explicit requests for time limits smaller or equal to the
1480 If no limit specifier is set, the value is assigned to the
1486 to preserve the original behavior.
1488 The syntax for size limits is
1489 .BR size[.{soft|hard|unchecked}]=<integer> ,
1492 is the maximum number of entries slapd will return answering a search
1494 If no size limit is explicitly requested by the client, the
1496 limit is used; if the requested size limit exceeds the
1499 .\".I "Administrative limit exceeded"
1500 .\"error is returned.
1501 limit, the value of the limit is used instead.
1504 limit is set to the keyword
1506 the soft limit is used in either case; if it is set to the keyword
1508 no hard limit is enforced.
1509 Explicit requests for size limits smaller or equal to the
1514 specifier sets a limit on the number of candidates a search request is allowed
1516 The rationale behind it is that searches for non-properly indexed
1517 attributes may result in large sets of candidates, which must be
1520 to determine whether they match the search filter or not.
1523 limit provides a means to drop such operations before they are even
1525 If the selected candidates exceed the
1527 limit, the search will abort with
1528 .IR "Unwilling to perform" .
1529 If it is set to the keyword
1531 no limit is applied (the default).
1534 the search is not even performed; this can be used to disallow searches
1535 for a specific set of users.
1536 If no limit specifier is set, the value is assigned to the
1542 to preserve the original behavior.
1544 In case of no match, the global limits are used.
1545 The default values are the same as for
1554 control is requested, the
1556 size limit is used by default, because the request of a specific page size
1557 is considered an explicit request for a limitation on the number
1558 of entries to be returned.
1559 However, the size limit applies to the total count of entries returned within
1560 the search, and not to a single page.
1561 Additional size limits may be enforced; the syntax is
1562 .BR size.pr={<integer>|noEstimate|unlimited} ,
1565 is the max page size if no explicit limit is set; the keyword
1567 inhibits the server from returning an estimate of the total number
1568 of entries that might be returned
1569 (note: the current implementation does not return any estimate).
1572 indicates that no limit is applied to the pagedResults control page size.
1574 .B size.prtotal={<integer>|unlimited|disabled}
1575 allows one to set a limit on the total number of entries that the pagedResults
1576 control will return.
1577 By default it is set to the
1582 is the max number of entries that the whole search with pagedResults control
1586 to allow unlimited number of entries to be returned, e.g. to allow
1587 the use of the pagedResults control as a means to circumvent size
1588 limitations on regular searches; the keyword
1590 disables the control, i.e. no paged results can be returned.
1591 Note that the total number of entries returned when the pagedResults control
1592 is requested cannot exceed the
1594 size limit of regular searches unless extended by the
1598 The \fBlimits\fP statement is typically used to let an unlimited
1599 number of entries be returned by searches performed
1600 with the identity used by the consumer for synchronization purposes
1601 by means of the RFC 4533 LDAP Content Synchronization protocol
1602 (see \fBsyncrepl\fP for details).
1605 .B maxderefdepth <depth>
1606 Specifies the maximum number of aliases to dereference when trying to
1607 resolve an entry, used to avoid infinite alias loops. The default is 15.
1609 .B mirrormode on | off
1610 This option puts a replica database into "mirror" mode. Update
1611 operations will be accepted from any user, not just the updatedn. The
1612 database must already be configured as a syncrepl consumer
1613 before this keyword may be set. This mode also requires a
1615 (see above) to be configured.
1616 By default, mirrormode is off.
1618 .B monitoring on | off
1619 This option enables database-specific monitoring in the entry related
1620 to the current database in the "cn=Databases,cn=Monitor" subtree
1621 of the monitor database, if the monitor database is enabled.
1622 Currently, only the BDB and the HDB databases provide database-specific
1624 The default depends on the backend type.
1626 .B overlay <overlay-name>
1627 Add the specified overlay to this database. An overlay is a piece of
1628 code that intercepts database operations in order to extend or change
1629 them. Overlays are pushed onto
1630 a stack over the database, and so they will execute in the reverse
1631 of the order in which they were configured and the database itself
1632 will receive control last of all. See the
1633 .BR slapd.overlays (5)
1634 manual page for an overview of the available overlays.
1635 Note that all of the database's
1636 regular settings should be configured before any overlay settings.
1638 .B readonly on | off
1639 This option puts the database into "read-only" mode. Any attempts to
1640 modify the database will return an "unwilling to perform" error. By
1641 default, readonly is off.
1643 .B restrict <oplist>
1644 Specify a whitespace separated list of operations that are restricted.
1645 If defined inside a database specification, restrictions apply only
1646 to that database, otherwise they are global.
1647 Operations can be any of
1652 .BR extended[=<OID>] ,
1656 or the special pseudo-operations
1660 which respectively summarize read and write operations.
1668 keyword allows one to indicate the OID of the specific operation
1672 Specify the distinguished name that is not subject to access control
1673 or administrative limit restrictions for operations on this database.
1674 This DN may or may not be associated with an entry. An empty root
1675 DN (the default) specifies no root access is to be granted. It is
1676 recommended that the rootdn only be specified when needed (such as
1677 when initially populating a database). If the rootdn is within
1678 a namingContext (suffix) of the database, a simple bind password
1679 may also be provided using the
1681 directive. Many optional features, including syncrepl, require the
1682 rootdn to be defined for the database.
1684 .B rootpw <password>
1685 Specify a password (or hash of the password) for the rootdn. The
1686 password can only be set if the rootdn is within the namingContext
1687 (suffix) of the database.
1688 This option accepts all RFC 2307 userPassword formats known to
1691 description) as well as cleartext.
1693 may be used to generate a hash of a password. Cleartext
1694 and \fB{CRYPT}\fP passwords are not recommended. If empty
1695 (the default), authentication of the root DN is by other means
1696 (e.g. SASL). Use of SASL is encouraged.
1698 .B suffix <dn suffix>
1699 Specify the DN suffix of queries that will be passed to this
1700 backend database. Multiple suffix lines can be given and at least one is
1701 required for each database definition.
1703 If the suffix of one database is "inside" that of another, the database
1704 with the inner suffix must come first in the configuration file.
1705 You may also want to glue such databases together with the
1709 .B subordinate [advertise]
1710 Specify that the current backend database is a subordinate of another
1711 backend database. A subordinate database may have only one suffix. This
1712 option may be used to glue multiple databases into a single namingContext.
1713 If the suffix of the current database is within the namingContext of a
1714 superior database, searches against the superior database will be
1715 propagated to the subordinate as well. All of the databases
1716 associated with a single namingContext should have identical rootdns.
1717 Behavior of other LDAP operations is unaffected by this setting. In
1718 particular, it is not possible to use moddn to move an entry from
1719 one subordinate to another subordinate within the namingContext.
1721 If the optional \fBadvertise\fP flag is supplied, the naming context of
1722 this database is advertised in the root DSE. The default is to hide this
1723 database context, so that only the superior context is visible.
1730 are used on the superior database, any glued subordinates that support
1731 these tools are opened as well.
1733 Databases that are glued together should usually be configured with the
1734 same indices (assuming they support indexing), even for attributes that
1735 only exist in some of these databases. In general, all of the glued
1736 databases should be configured as similarly as possible, since the intent
1737 is to provide the appearance of a single directory.
1739 Note that the \fIsubordinate\fP functionality is implemented internally
1740 by the \fIglue\fP overlay and as such its behavior will interact with other
1741 overlays in use. By default, the glue overlay is automatically configured as
1742 the last overlay on the superior backend. Its position on the backend
1743 can be explicitly configured by setting an \fBoverlay glue\fP directive
1744 at the desired position. This explicit configuration is necessary e.g.
1745 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1746 in order to work over all of the glued databases. E.g.
1750 suffix dc=example,dc=com
1757 .B sync_use_subentry
1758 Store the syncrepl contextCSN in a subentry instead of the context entry
1759 of the database. The subentry's RDN will be "cn=ldapsync". By default
1760 the contextCSN is stored in the context entry.
1763 .B syncrepl rid=<replica ID>
1764 .B provider=ldap[s]://<hostname>[:port]
1765 .B searchbase=<base DN>
1766 .B [type=refreshOnly|refreshAndPersist]
1767 .B [interval=dd:hh:mm:ss]
1768 .B [retry=[<retry interval> <# of retries>]+]
1769 .B [filter=<filter str>]
1770 .B [scope=sub|one|base|subord]
1771 .B [attrs=<attr list>]
1772 .B [exattrs=<attr list>]
1774 .B [sizelimit=<limit>]
1775 .B [timelimit=<limit>]
1776 .B [schemachecking=on|off]
1777 .B [network\-timeout=<seconds>]
1778 .B [timeout=<seconds>]
1779 .B [bindmethod=simple|sasl]
1781 .B [saslmech=<mech>]
1782 .B [authcid=<identity>]
1783 .B [authzid=<identity>]
1784 .B [credentials=<passwd>]
1786 .B [secprops=<properties>]
1787 .B [keepalive=<idle>:<probes>:<interval>]
1788 .B [starttls=yes|critical]
1789 .B [tls_cert=<file>]
1791 .B [tls_cacert=<file>]
1792 .B [tls_cacertdir=<path>]
1793 .B [tls_reqcert=never|allow|try|demand]
1794 .B [tls_cipher_suite=<ciphers>]
1795 .B [tls_crlcheck=none|peer|all]
1796 .B [tls_protocol_min=<major>[.<minor>]]
1797 .B [suffixmassage=<real DN>]
1798 .B [logbase=<base DN>]
1799 .B [logfilter=<filter str>]
1800 .B [syncdata=default|accesslog|changelog]
1803 Specify the current database as a replica which is kept up-to-date with the
1804 master content by establishing the current
1806 as a replication consumer site running a
1809 The replica content is kept synchronized to the master content using
1810 the LDAP Content Synchronization protocol. Refer to the
1811 "OpenLDAP Administrator's Guide" for detailed information on
1812 setting up a replicated
1814 directory service using the
1819 identifies the current
1821 directive within the replication consumer site.
1822 It is a non-negative integer not greater than 999 (limited
1823 to three decimal digits).
1826 specifies the replication provider site containing the master content
1827 as an LDAP URI. If <port> is not given, the standard LDAP port number
1828 (389 or 636) is used.
1832 replica is defined using a search
1833 specification as its result set. The consumer
1835 will send search requests to the provider
1837 according to the search specification. The search specification includes
1838 .BR searchbase ", " scope ", " filter ", " attrs ", " attrsonly ", " sizelimit ", "
1841 parameters as in the normal search specification.
1842 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1843 \fB(objectclass=*)\fP, while there is no default \fBsearchbase\fP. The
1844 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1845 attributes, and \fBattrsonly\fP is unset by default.
1846 The \fBsizelimit\fP and \fBtimelimit\fP only
1847 accept "unlimited" and positive integers, and both default to "unlimited".
1848 The \fBsizelimit\fP and \fBtimelimit\fP parameters define
1849 a consumer requested limitation on the number of entries that can be returned
1850 by the LDAP Content Synchronization operation; as such, it is intended
1851 to implement partial replication based on the size of the replicated database
1852 and on the time required by the synchronization.
1853 Note, however, that any provider-side limits for the replication identity
1854 will be enforced by the provider regardless of the limits requested
1855 by the LDAP Content Synchronization operation, much like for any other
1858 option may also be used to specify attributes that should be omitted
1859 from incoming entries.
1860 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1861 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1862 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1863 attributes, and \fBattrsonly\fP and \fBexattrs\fP are unset by default.
1864 The \fBsizelimit\fP and \fBtimelimit\fP only
1865 accept "unlimited" and positive integers, and both default to "unlimited".
1866 Note, however, that any provider-side limits for the replication identity
1867 will be enforced by the provider regardless of the limits requested
1868 by the LDAP Content Synchronization operation, much like for any other
1871 The LDAP Content Synchronization protocol has two operation types.
1874 operation, the next synchronization search operation
1875 is periodically rescheduled at an interval time (specified by
1877 parameter; 1 day by default)
1878 after each synchronization operation finishes.
1880 .B refreshAndPersist
1881 operation, a synchronization search remains persistent in the provider slapd.
1882 Further updates to the master replica will generate
1883 .B searchResultEntry
1884 to the consumer slapd as the search responses to the persistent
1885 synchronization search. If the initial search fails due to an error, the
1886 next synchronization search operation is periodically rescheduled at an
1887 interval time (specified by
1889 parameter; 1 day by default)
1891 If an error occurs during replication, the consumer will attempt to
1892 reconnect according to the
1894 parameter which is a list of the <retry interval> and <# of retries> pairs.
1895 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1896 for the first 10 times and then retry every 300 seconds for the next 3
1897 times before stop retrying. The `+' in <# of retries> means indefinite
1898 number of retries until success.
1901 was specified, by default syncrepl retries every hour forever.
1903 The schema checking can be enforced at the LDAP Sync
1904 consumer site by turning on the
1906 parameter. The default is \fBoff\fP.
1907 Schema checking \fBon\fP means that replicated entries must have
1908 a structural objectClass, must obey to objectClass requirements
1909 in terms of required/allowed attributes, and that naming attributes
1910 and distinguished values must be present.
1911 As a consequence, schema checking should be \fBoff\fP when partial
1912 replication is used.
1916 parameter sets how long the consumer will wait to establish a
1917 network connection to the provider. Once a connection is
1920 parameter determines how long the consumer will wait for the initial
1921 Bind request to complete. The defaults for these parameters come
1929 requires the options
1933 and should only be used when adequate security services
1934 (e.g. TLS or IPSEC) are in place.
1935 .B REMEMBER: simple bind credentials must be in cleartext!
1942 Depending on the mechanism, an authentication identity and/or
1943 credentials can be specified using
1949 parameter may be used to specify an authorization identity.
1950 Specific security properties (as with the
1952 keyword above) for a SASL bind can be set with the
1954 option. A non default SASL realm can be set with the
1957 The identity used for synchronization by the consumer should be allowed
1958 to receive an unlimited number of entries in response to a search request.
1959 The provider, other than allow authentication of the syncrepl identity,
1960 should grant that identity appropriate access privileges to the data
1961 that is being replicated (\fBaccess\fP directive), and appropriate time
1963 This can be accomplished by either allowing unlimited \fBsizelimit\fP
1964 and \fBtimelimit\fP, or by setting an appropriate \fBlimits\fP statement
1965 in the consumer's configuration (see \fBsizelimit\fP and \fBlimits\fP
1970 parameter sets the values of \fIidle\fP, \fIprobes\fP, and \fIinterval\fP
1971 used to check whether a socket is alive;
1973 is the number of seconds a connection needs to remain idle before TCP
1974 starts sending keepalive probes;
1976 is the maximum number of keepalive probes TCP should send before dropping
1979 is interval in seconds between individual keepalive probes.
1980 Only some systems support the customization of these values;
1983 parameter is ignored otherwise, and system-wide settings are used.
1987 parameter specifies use of the StartTLS extended operation
1988 to establish a TLS session before Binding to the provider. If the
1990 argument is supplied, the session will be aborted if the StartTLS request
1991 fails. Otherwise the syncrepl session continues without TLS. The
1992 tls_reqcert setting defaults to "demand" and the other TLS settings
1993 default to the same as the main slapd TLS settings.
1997 parameter allows the consumer to pull entries from a remote directory
1998 whose DN suffix differs from the local directory. The portion of the
1999 remote entries' DNs that matches the \fIsearchbase\fP will be replaced
2000 with the suffixmassage DN.
2002 Rather than replicating whole entries, the consumer can query logs of
2003 data modifications. This mode of operation is referred to as \fIdelta
2004 syncrepl\fP. In addition to the above parameters, the
2008 parameters must be set appropriately for the log that will be used. The
2010 parameter must be set to either "accesslog" if the log conforms to the
2011 .BR slapo\-accesslog (5)
2012 log format, or "changelog" if the log conforms
2013 to the obsolete \fIchangelog\fP format. If the
2015 parameter is omitted or set to "default" then the log parameters are
2020 parameter tells the underlying database that it can store changes without
2021 performing a full flush after each change. This may improve performance
2022 for the consumer, while sacrificing safety or durability.
2026 This option is only applicable in a slave
2028 It specifies the DN permitted to update (subject to access controls)
2029 the replica. It is only needed in certain push-mode
2030 replication scenarios. Generally, this DN
2037 Specify the referral to pass back when
2039 is asked to modify a replicated local database.
2040 If specified multiple times, each url is provided.
2042 .SH DATABASE-SPECIFIC OPTIONS
2043 Each database may allow specific configuration options; they are
2044 documented separately in the backends' manual pages. See the
2045 .BR slapd.backends (5)
2046 manual page for an overview of available backends.
2049 Here is a short example of a configuration file:
2053 include SYSCONFDIR/schema/core.schema
2054 pidfile LOCALSTATEDIR/run/slapd.pid
2056 # Subtypes of "name" (e.g. "cn" and "ou") with the
2057 # option ";x\-hidden" can be searched for/compared,
2058 # but are not shown. See \fBslapd.access\fP(5).
2059 attributeoptions x\-hidden lang\-
2060 access to attrs=name;x\-hidden by * =cs
2062 # Protect passwords. See \fBslapd.access\fP(5).
2063 access to attrs=userPassword by * auth
2064 # Read access to other attributes and entries.
2065 access to * by * read
2068 suffix "dc=our\-domain,dc=com"
2069 # The database directory MUST exist prior to
2070 # running slapd AND should only be accessible
2071 # by the slapd/tools. Mode 0700 recommended.
2072 directory LOCALSTATEDIR/openldap\-data
2073 # Indices to maintain
2074 index objectClass eq
2075 index cn,sn,mail pres,eq,approx,sub
2077 # We serve small clients that do not handle referrals,
2078 # so handle remote lookups on their behalf.
2081 uri ldap://ldap.some\-server.com/
2086 "OpenLDAP Administrator's Guide" contains a longer annotated
2087 example of a configuration file.
2088 The original ETCDIR/slapd.conf is another example.
2092 default slapd configuration file
2095 .BR gnutls\-cli (1),
2096 .BR slapd\-config (5),
2097 .BR slapd.access (5),
2098 .BR slapd.backends (5),
2099 .BR slapd.overlays (5),
2100 .BR slapd.plugin (5),
2111 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
2112 .SH ACKNOWLEDGEMENTS
projects / openldap / blob