1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2009 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
12 contains configuration information for the
14 daemon. This configuration file is also used by the SLAPD tools
26 file consists of a series of global configuration options that apply to
28 as a whole (including all backends), followed by zero or more database
29 backend definitions that contain information specific to a backend
31 The configuration options are case-insensitive;
32 their value, on a case by case basis, may be case-sensitive.
39 # comment - these options apply to every database
40 <global configuration options>
41 # first database definition & configuration options
42 database <backend 1 type>
43 <configuration options specific to backend 1>
44 # subsequent database definitions & configuration options
48 As many backend-specific sections as desired may be included. Global
49 options can be overridden in a backend (for options that appear more
50 than once, the last appearance in the
54 If a line begins with white space, it is considered a continuation
55 of the previous line. No physical line should be over 2000 bytes
58 Blank lines and comment lines beginning with
59 a `#' character are ignored. Note: continuation lines are unwrapped
60 before comment processing is applied.
62 Arguments on configuration lines are separated by white space. If an
63 argument contains white space, the argument should be enclosed in
64 double quotes. If an argument contains a double quote (`"') or a
65 backslash character (`\\'), the character should be preceded by a
68 The specific configuration options available are discussed below in the
69 Global Configuration Options, General Backend Options, and General Database
70 Options. Backend-specific options are discussed in the
72 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
73 details on the slapd configuration file.
74 .SH GLOBAL CONFIGURATION OPTIONS
75 Options described in this section apply to all backends, unless specifically
76 overridden in a backend definition. Arguments that should be replaced by
77 actual text are shown in brackets <>.
79 .B access to <what> "[ by <who> <access> <control> ]+"
80 Grant access (specified by <access>) to a set of entries and/or
81 attributes (specified by <what>) by one or more requestors (specified
83 If no access controls are present, the default policy
84 allows anyone and everyone to read anything but restricts
85 updates to rootdn. (e.g., "access to * by * read").
86 The rootdn can always read and write EVERYTHING!
89 and the "OpenLDAP's Administrator's Guide" for details.
92 Specify a set of features (separated by white space) to
95 allows acceptance of LDAPv2 bind requests. Note that
97 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
99 allows anonymous bind when credentials are not empty (e.g.
102 allows unauthenticated (anonymous) bind when DN is not empty.
104 allows unauthenticated (anonymous) update operations to be processed
105 (subject to access controls and other administrative limits).
107 allows unauthenticated (anonymous) proxy authorization control to be processed
108 (subject to access controls, authorization and other administrative limits).
110 .B argsfile <filename>
111 The (absolute) name of a file that will hold the
113 server's command line (program name and options).
115 .B attributeoptions [option-name]...
116 Define tagging attribute options or option tag/range prefixes.
117 Options must not end with `-', prefixes must end with `-'.
118 The `lang-' prefix is predefined.
121 directive, `lang-' will no longer be defined and you must specify it
122 explicitly if you want it defined.
124 An attribute description with a tagging option is a subtype of that
125 attribute description without the option.
126 Except for that, options defined this way have no special semantics.
127 Prefixes defined this way work like the `lang-' options:
128 They define a prefix for tagging options starting with the prefix.
129 That is, if you define the prefix `x-foo-', you can use the option
131 Furthermore, in a search or compare, a prefix or range name (with
132 a trailing `-') matches all options starting with that name, as well
133 as the option with the range name sans the trailing `-'.
134 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
136 RFC 4520 reserves options beginning with `x-' for private experiments.
137 Other options should be registered with IANA, see RFC 4520 section 3.5.
138 OpenLDAP also has the `binary' option built in, but this is a transfer
139 option, not a tagging option.
142 .B attributetype "(\ <oid>\
144 [DESC\ <description>]\
153 [NO\-USER\-MODIFICATION]\
154 [USAGE\ <attributeUsage>]\ )"
156 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
157 The slapd parser extends the RFC 4512 definition by allowing string
158 forms as well as numeric OIDs to be used for the attribute OID and
159 attribute syntax OID.
165 .B authz-policy <policy>
166 Used to specify which rules to use for Proxy Authorization. Proxy
167 authorization allows a client to authenticate to the server using one
168 user's credentials, but specify a different identity to use for authorization
169 and access control purposes. It essentially allows user A to login as user
170 B, using user A's password.
173 flag disables proxy authorization. This is the default setting.
176 flag will use rules in the
178 attribute of the authorization DN.
181 flag will use rules in the
183 attribute of the authentication DN.
186 flag, an alias for the deprecated value of
188 will allow any of the above, whatever succeeds first (checked in
194 flag requires both authorizations to succeed.
197 The rules are mechanisms to specify which identities are allowed
198 to perform proxy authorization.
201 attribute in an entry specifies which other users
202 are allowed to proxy login to this entry. The
205 an entry specifies which other users this user can authorize as. Use of
208 abused if users are allowed to write arbitrary values to this attribute.
211 attribute must be protected with ACLs such that
212 only privileged users can modify it.
219 or a set of identities; it can take five forms:
222 .B ldap:///<base>??[<scope>]?<filter>
225 .B dn[.<dnstyle>]:<pattern>
228 .B u[.<mech>[/<realm>]]:<pattern>
231 .B group[/objectClass[/attributeType]]:<pattern>
238 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
241 The first form is a valid LDAP
249 portions must be absent, so that the search occurs locally on either
255 with the optional style modifiers
261 for exact, onelevel, children and subtree matches, which cause
263 to be normalized according to the DN normalization rules, or the special
265 style, which causes the
267 to be treated as a POSIX (''extended'') regular expression, as
274 means any non-anonymous DN.
275 The third form is a SASL
277 with the optional fields
281 that allow to specify a SASL
283 and eventually a SASL
285 for those mechanisms that support one.
286 The need to allow the specification of a mechanism is still debated,
287 and users are strongly discouraged to rely on this possibility.
288 The fourth form is a group specification, consisting of the keyword
290 optionally followed by the specification of the group
296 is searched with base scope, and in case of match, the values of the
299 are searched for the asserted DN.
300 For backwards compatibility, if no identity type is provided, i.e. only
304 is assumed; as a consequence,
306 is subjected to DN normalization.
307 Since the interpretation of
311 can impact security, users are strongly encouraged
312 to explicitly set the type of identity specification that is being used.
313 A subset of these rules can be used as third arg in the
315 statement (see below); significantly, the
317 provided it results in exactly one entry,
323 .B authz-regexp <match> <replace>
324 Used by the authentication framework to convert simple user names,
325 such as provided by SASL subsystem, or extracted from certificates
326 in case of cert-based SASL EXTERNAL, or provided within the RFC 4370
327 "proxied authorization" control, to an LDAP DN used for
328 authorization purposes. Note that the resulting DN need not refer
329 to an existing entry to be considered valid. When an authorization
330 request is received from the SASL subsystem, the SASL
335 are taken, when available, and combined into a name of the form
339 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
342 This name is then compared against the
344 POSIX (''extended'') regular expression, and if the match is successful,
345 the name is replaced with the
347 string. If there are wildcard strings in the
349 regular expression that are enclosed in parenthesis, e.g.
355 then the portion of the name that matched the wildcard will be stored
356 in the numbered placeholder variable $1. If there are other wildcard strings
357 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
358 placeholders can then be used in the
363 .B UID=$1,OU=Accounts,DC=example,DC=com
366 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
368 If the latter, the server will use the URI to search its own database(s)
369 and, if the search returns exactly one entry, the name is
370 replaced by the DN of that entry. The LDAP URI must have no
371 hostport, attrs, or extensions components, but the filter is mandatory,
375 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
378 The protocol portion of the URI must be strictly
380 Note that this search is subject to access controls. Specifically,
381 the authentication identity must have "auth" access in the subject.
385 options can be given in the configuration file to allow for multiple matching
386 and replacement patterns. The matching patterns are checked in the order they
387 appear in the file, stopping at the first successful match.
390 .\"Because the plus sign + is a character recognized by the regular expression engine,
391 .\"and it will appear in names that include a REALM, be careful to escape the
392 .\"plus sign with a backslash \\+ to remove the character's special meaning.
395 .B concurrency <integer>
396 Specify a desired level of concurrency. Provided to the underlying
397 thread system as a hint. The default is not to provide any hint.
399 .B conn_max_pending <integer>
400 Specify the maximum number of pending requests for an anonymous session.
401 If requests are submitted faster than the server can process them, they
402 will be queued up to this limit. If the limit is exceeded, the session
403 is closed. The default is 100.
405 .B conn_max_pending_auth <integer>
406 Specify the maximum number of pending requests for an authenticated session.
409 .B defaultsearchbase <dn>
410 Specify a default search base to use when client submits a
411 non-base search request with an empty base DN.
412 Base scoped search requests with an empty base DN are not affected.
414 .B disallow <features>
415 Specify a set of features (separated by white space) to
416 disallow (default none).
418 disables acceptance of anonymous bind requests. Note that this setting
419 does not prohibit anonymous directory access (See "require authc").
421 disables simple (bind) authentication.
423 disables forcing session to anonymous status (see also
425 upon StartTLS operation receipt.
427 disallows the StartTLS operation if authenticated (see also
429 .B proxy_authz_non_critical
430 disables acceptance of the proxied authorization control (RFC4370)
431 when criticality is FALSE.
432 .B dontusecopy_non_critical
433 disables acceptance of the dontUseCopy control (a work in progress)
434 when criticality is FALSE.
437 .B ditcontentrule "(\ <oid>\
439 [DESC\ <description>]\
446 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
447 The slapd parser extends the RFC 4512 definition by allowing string
448 forms as well as numeric OIDs to be used for the attribute OID and
449 attribute syntax OID.
455 .B gentlehup { on | off }
456 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
458 will stop listening for new connections, but will not close the
459 connections to the current clients. Future write operations return
460 unwilling-to-perform, though. Slapd terminates when all clients
461 have closed their connections (if they ever do), or \- as before \-
462 if it receives a SIGTERM signal. This can be useful if you wish to
463 terminate the server and start a new
466 .B with another database,
467 without disrupting the currently active clients.
468 The default is off. You may wish to use
470 along with this option.
472 .B idletimeout <integer>
473 Specify the number of seconds to wait before forcibly closing
474 an idle client connection. A idletimeout of 0 disables this
475 feature. The default is 0.
477 .B include <filename>
478 Read additional configuration information from the given file before
479 continuing with the next line of the current file.
481 .B index_intlen <integer>
482 Specify the key length for ordered integer indices. The most significant
483 bytes of the binary integer will be used for index keys. The default
484 value is 4, which provides exact indexing for 31 bit values.
485 A floating point representation is used to index too large values.
487 .B index_substr_if_minlen <integer>
488 Specify the minimum length for subinitial and subfinal indices. An
489 attribute value must have at least this many characters in order to be
490 processed by the indexing functions. The default is 2.
492 .B index_substr_if_maxlen <integer>
493 Specify the maximum length for subinitial and subfinal indices. Only
494 this many characters of an attribute value will be processed by the
495 indexing functions; any excess characters are ignored. The default is 4.
497 .B index_substr_any_len <integer>
498 Specify the length used for subany indices. An attribute value must have
499 at least this many characters in order to be processed. Attribute values
500 longer than this length will be processed in segments of this length. The
501 default is 4. The subany index will also be used in subinitial and
502 subfinal index lookups when the filter string is longer than the
503 .I index_substr_if_maxlen
506 .B index_substr_any_step <integer>
507 Specify the steps used in subany index lookups. This value sets the offset
508 for the segments of a filter string that are processed for a subany index
509 lookup. The default is 2. For example, with the default values, a search
510 using this filter "cn=*abcdefgh*" would generate index lookups for
511 "abcd", "cdef", and "efgh".
514 Note: Indexing support depends on the particular backend in use. Also,
515 changing these settings will generally require deleting any indices that
516 depend on these parameters and recreating them with
521 .B ldapsyntax "(\ <oid>\
522 [DESC\ <description>]\
523 [X-SUBST <substitute\-syntax>]\ )"
525 Specify an LDAP syntax using the LDAPv3 syntax defined in RFC 4512.
526 The slapd parser extends the RFC 4512 definition by allowing string
527 forms as well as numeric OIDs to be used for the syntax OID.
531 The slapd parser also honors the
533 extension (an OpenLDAP-specific extension), which allows to use the
535 statement to define a non-implemented syntax along with another syntax,
537 .IR substitute\-syntax ,
538 as its temporary replacement.
540 .I substitute\-syntax
542 This allows to define attribute types that make use of non-implemented syntaxes
543 using the correct syntax OID.
546 is used, this configuration statement would result in an error,
547 since no handlers would be associated to the resulting syntax structure.
552 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
553 such as those to the ldapi:// listener. For a description of SSF values,
557 option description. The default is 71.
559 .B logfile <filename>
560 Specify a file for recording debug log messages. By default these messages
561 only go to stderr and are not recorded anywhere else. Specifying a logfile
562 copies messages to both stderr and the logfile.
564 .B loglevel <integer> [...]
565 Specify the level at which debugging statements and operation
566 statistics should be syslogged (currently logged to the
568 LOG_LOCAL4 facility).
569 They must be considered subsystems rather than increasingly verbose
571 Some messages with higher priority are logged regardless
572 of the configured loglevel as soon as any logging is configured.
573 Log levels are additive, and available levels are:
584 debug packet handling
588 heavy trace debugging (function args)
592 connection management
596 print out packets sent and received
600 search filter processing
604 configuration file processing
608 access control list processing
612 connections, LDAP operations, results (recommended)
616 stats log entries sent
620 print communication with shell backends
632 \"data indexing (unused)
640 only messages that get logged whatever log level is set
643 The desired log level can be input as a single integer that combines
644 the (ORed) desired levels, both in decimal or in hexadecimal notation,
645 as a list of integers (that are ORed internally),
646 or as a list of the names that are shown between brackets, such that
659 can be used as a shortcut to enable logging at all levels (equivalent to -1).
662 or the equivalent integer representation, causes those messages
663 that are logged regardless of the configured loglevel to be logged.
664 In fact, if loglevel is set to 0, no logging occurs,
667 level is required to have high priority messages logged.
669 The loglevel defaults to \fBstats\fP.
670 This level should usually also be included when using other loglevels, to
671 help analyze the logs.
674 .B moduleload <filename>
675 Specify the name of a dynamically loadable module to load. The filename
676 may be an absolute path name or a simple filename. Non-absolute names
677 are searched for in the directories specified by the
679 option. This option and the
681 option are only usable if slapd was compiled with --enable-modules.
683 .B modulepath <pathspec>
684 Specify a list of directories to search for loadable modules. Typically
685 the path is colon-separated but this depends on the operating system.
688 .B objectclass "(\ <oid>\
690 [DESC\ <description>]\
693 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
694 [MUST\ <oids>] [MAY\ <oids>] )"
696 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
697 The slapd parser extends the RFC 4512 definition by allowing string
698 forms as well as numeric OIDs to be used for the object class OID.
702 description.) Object classes are "STRUCTURAL" by default.
705 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
706 Define a string name that equates to the given OID. The string can be used
707 in place of the numeric OID in objectclass and attribute definitions. The
708 name can also be used with a suffix of the form ":xx" in which case the
709 value "oid.xx" will be used.
711 .B password-hash <hash> [<hash>...]
712 This option configures one or more hashes to be used in generation of user
713 passwords stored in the userPassword attribute during processing of
714 LDAP Password Modify Extended Operations (RFC 3062).
715 The <hash> must be one of
729 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
734 use the MD5 algorithm (RFC 1321), the latter with a seed.
741 indicates that the new password should be
742 added to userPassword as clear text.
744 Note that this option does not alter the normal user applications
745 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
747 .B password\-crypt\-salt\-format <format>
748 Specify the format of the salt passed to
750 when generating {CRYPT} passwords (see
752 during processing of LDAP Password Modify Extended Operations (RFC 3062).
754 This string needs to be in
756 format and may include one (and only one) %s conversion.
757 This conversion will be substituted with a string of random
758 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
759 provides a two character salt and "$1$%.8s" tells some
760 versions of crypt(3) to use an MD5 algorithm and provides
761 8 random characters of salt. The default is "%s", which
762 provides 31 characters of salt.
764 .B pidfile <filename>
765 The (absolute) name of a file that will hold the
767 server's process ID (see
771 Specify the referral to pass back when
773 cannot find a local database to handle a request.
774 If specified multiple times, each url is provided.
776 .B require <conditions>
777 Specify a set of conditions (separated by white space) to
778 require (default none).
779 The directive may be specified globally and/or per-database;
780 databases inherit global conditions, so per-database specifications
783 requires bind operation prior to directory operations.
785 requires session to be using LDAP version 3.
787 requires authentication prior to directory operations.
789 requires SASL authentication prior to directory operations.
791 requires strong authentication prior to directory operations.
792 The strong keyword allows protected "simple" authentication
793 as well as SASL authentication.
795 may be used to require no conditions (useful to clear out globally
796 set conditions within a particular database); it must occur first
797 in the list of conditions.
799 .B reverse-lookup on | off
800 Enable/disable client name unverified reverse lookup (default is
802 if compiled with --enable-rlookups).
805 Specify the name of an LDIF(5) file containing user defined attributes
806 for the root DSE. These attributes are returned in addition to the
807 attributes normally produced by slapd.
809 The root DSE is an entry with information about the server and its
810 capabilities, in operational attributes.
811 It has the empty DN, and can be read with e.g.:
813 ldapsearch -x -b "" -s base "+"
815 See RFC 4512 section 5.1 for details.
818 Used to specify the fully qualified domain name used for SASL processing.
820 .B sasl-realm <realm>
821 Specify SASL realm. Default is empty.
823 .B sasl-secprops <properties>
824 Used to specify Cyrus SASL security properties.
827 flag (without any other properties) causes the flag properties
828 default, "noanonymous,noplain", to be cleared.
831 flag disables mechanisms susceptible to simple passive attacks.
834 flag disables mechanisms susceptible to active attacks.
837 flag disables mechanisms susceptible to passive dictionary attacks.
840 flag disables mechanisms which support anonymous login.
843 flag require forward secrecy between sessions.
846 require mechanisms which pass client credentials (and allow
847 mechanisms which can pass credentials to do so).
850 property specifies the minimum acceptable
851 .I security strength factor
852 as an integer approximate to effective key length used for
853 encryption. 0 (zero) implies no protection, 1 implies integrity
854 protection only, 56 allows DES or other weak ciphers, 112
855 allows triple DES and other strong ciphers, 128 allows RC4,
856 Blowfish and other modern strong ciphers. The default is 0.
859 property specifies the maximum acceptable
860 .I security strength factor
861 as an integer (see minssf description). The default is INT_MAX.
864 property specifies the maximum security layer receive buffer
865 size allowed. 0 disables security layers. The default is 65536.
868 Specify the distinguished name for the subschema subentry that
869 controls the entries on this server. The default is "cn=Subschema".
871 .B security <factors>
872 Specify a set of security strength factors (separated by white space)
876 option for a description of security strength factors).
877 The directive may be specified globally and/or per-database.
879 specifies the overall security strength factor.
881 specifies the transport security strength factor.
883 specifies the TLS security strength factor.
885 specifies the SASL security strength factor.
887 specifies the overall security strength factor to require for
889 .B update_transport=<n>
890 specifies the transport security strength factor to require for
893 specifies the TLS security strength factor to require for
896 specifies the SASL security strength factor to require for
899 specifies the security strength factor required for
901 username/password authentication.
904 factor is measure of security provided by the underlying transport,
905 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
907 .B serverID <integer> [<URL>]
908 Specify an integer ID from 0 to 4095 for this server (limited
909 to 3 hexadecimal digits).
911 required when using multimaster replication and each master must have a
912 unique ID. Note that this requirement also applies to separate masters
913 contributing to a glued set of databases.
914 If the URL is provided, this directive may be specified
915 multiple times, providing a complete list of participating servers
916 and their IDs. The fully qualified hostname of each server should be
917 used in the supplied URLs. The IDs are used in the "replica id" field
918 of all CSNs generated by the specified server. The default value is zero.
925 .B sizelimit {<integer>|unlimited}
927 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
928 Specify the maximum number of entries to return from a search operation.
929 The default size limit is 500.
932 to specify no limits.
933 The second format allows a fine grain setting of the size limits.
934 Extra args can be added on the same line.
937 for an explanation of the different flags.
939 .B sockbuf_max_incoming <integer>
940 Specify the maximum incoming LDAP PDU size for anonymous sessions.
941 The default is 262143.
943 .B sockbuf_max_incoming_auth <integer>
944 Specify the maximum incoming LDAP PDU size for authenticated sessions.
945 The default is 4194303.
947 .B sortvals <attr> [...]
948 Specify a list of multi-valued attributes whose values will always
949 be maintained in sorted order. Using this option will allow Modify,
950 Compare, and filter evaluations on these attributes to be performed
951 more efficiently. The resulting sort order depends on the
952 attributes' syntax and matching rules and may not correspond to
953 lexical order or any other recognizable order.
956 Specify the maximum size of the primary thread pool.
957 The default is 16; the minimum value is 2.
959 .B timelimit {<integer>|unlimited}
961 .B timelimit time[.{soft|hard}]=<integer> [...]
962 Specify the maximum number of seconds (in real time)
964 will spend answering a search request. The default time limit is 3600.
967 to specify no limits.
968 The second format allows a fine grain setting of the time limits.
969 Extra args can be added on the same line.
972 for an explanation of the different flags.
974 .B tool-threads <integer>
975 Specify the maximum number of threads to use in tool mode.
976 This should not be greater than the number of CPUs in the system.
978 .\"ucdata-path is obsolete / ignored...
980 .\".B ucdata-path <path>
981 .\"Specify the path to the directory containing the Unicode character
982 .\"tables. The default path is DATADIR/ucdata.
986 is built with support for Transport Layer Security, there are more options
989 .B TLSCipherSuite <cipher-suite-spec>
990 Permits configuring what ciphers will be accepted and the preference order.
991 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
993 TLSCipherSuite HIGH:MEDIUM:+SSLv2
995 To check what ciphers a given spec selects, use:
998 openssl ciphers -v <cipher-suite-spec>
1001 To obtain the list of ciphers in GNUtls use:
1008 .B TLSCACertificateFile <filename>
1009 Specifies the file that contains certificates for all of the Certificate
1014 .B TLSCACertificatePath <path>
1015 Specifies the path of a directory that contains Certificate Authority
1016 certificates in separate individual files. Usually only one of this
1017 or the TLSCACertificateFile is used. This directive is not supported
1020 .B TLSCertificateFile <filename>
1021 Specifies the file that contains the
1025 .B TLSCertificateKeyFile <filename>
1026 Specifies the file that contains the
1028 server private key that matches the certificate stored in the
1029 .B TLSCertificateFile
1030 file. Currently, the private key must not be protected with a password, so
1031 it is of critical importance that it is protected carefully.
1033 .B TLSDHParamFile <filename>
1034 This directive specifies the file that contains parameters for Diffie-Hellman
1035 ephemeral key exchange. This is required in order to use a DSA certificate on
1036 the server. If multiple sets of parameters are present in the file, all of
1037 them will be processed. Note that setting this option may also enable
1038 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
1039 You should append "!ADH" to your cipher suites if you have changed them
1040 from the default, otherwise no certificate exchanges or verification will
1041 be done. When using GNUtls these parameters are always generated randomly so
1042 this directive is ignored.
1044 .B TLSRandFile <filename>
1045 Specifies the file to obtain random bits from when /dev/[u]random
1046 is not available. Generally set to the name of the EGD/PRNGD socket.
1047 The environment variable RANDFILE can also be used to specify the filename.
1048 This directive is ignored with GNUtls.
1050 .B TLSVerifyClient <level>
1051 Specifies what checks to perform on client certificates in an
1052 incoming TLS session, if any.
1055 can be specified as one of the following keywords:
1059 This is the default.
1061 will not ask the client for a certificate.
1064 The client certificate is requested. If no certificate is provided,
1065 the session proceeds normally. If a bad certificate is provided,
1066 it will be ignored and the session proceeds normally.
1069 The client certificate is requested. If no certificate is provided,
1070 the session proceeds normally. If a bad certificate is provided,
1071 the session is immediately terminated.
1073 .B demand | hard | true
1074 These keywords are all equivalent, for compatibility reasons.
1075 The client certificate is requested. If no certificate is provided,
1076 or a bad certificate is provided, the session is immediately terminated.
1078 Note that a valid client certificate is required in order to use the
1079 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1082 setting must be chosen to enable SASL EXTERNAL authentication.
1085 .B TLSCRLCheck <level>
1086 Specifies if the Certificate Revocation List (CRL) of the CA should be
1087 used to verify if the client certificates have not been revoked. This
1089 .B TLSCACertificatePath
1090 parameter to be set. This directive is ignored with GNUtls.
1092 can be specified as one of the following keywords:
1096 No CRL checks are performed
1099 Check the CRL of the peer certificate
1102 Check the CRL for a whole certificate chain
1105 .B TLSCRLFile <filename>
1106 Specifies a file containing a Certificate Revocation List to be used
1107 for verifying that certificates have not been revoked. This directive is
1108 only valid when using GNUtls.
1109 .SH GENERAL BACKEND OPTIONS
1110 Options in this section only apply to the configuration file section
1111 for the specified backend. They are supported by every
1114 .B backend <databasetype>
1115 Mark the beginning of a backend definition. <databasetype>
1132 depending on which backend will serve the database.
1134 .SH GENERAL DATABASE OPTIONS
1135 Options in this section only apply to the configuration file section
1136 for the database in which they are defined. They are supported by every
1137 type of backend. Note that the
1141 option are mandatory for each database.
1143 .B database <databasetype>
1144 Mark the beginning of a new database instance definition. <databasetype>
1161 depending on which backend will serve the database.
1163 LDAP operations, even subtree searches, normally access only one
1165 That can be changed by gluing databases together with the
1168 Access controls and some overlays can also involve multiple databases.
1170 .B add_content_acl on | off
1171 Controls whether Add operations will perform ACL checks on
1172 the content of the entry being added. This check is off
1174 .BR slapd.access (5)
1175 manual page for more details on ACL requirements for
1179 Controls whether the database will be used to answer
1180 queries. A database that is hidden will never be
1181 selected to answer any queries, and any suffix configured
1182 on the database will be ignored in checks for conflicts
1183 with other databases. By default, hidden is off.
1188 will automatically maintain the
1189 modifiersName, modifyTimestamp, creatorsName, and
1190 createTimestamp attributes for entries. It also controls
1191 the entryCSN and entryUUID attributes, which are needed
1192 by the syncrepl provider. By default, lastmod is on.
1194 .B limits <selector> <limit> [<limit> [...]]
1195 Specify time and size limits based on the operation's initiator or
1203 anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>
1209 <dnspec> ::= dn[.<type>][.<style>]
1211 <type> ::= self | this
1213 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1218 is the default and means the bound user, while
1220 means the base DN of the operation.
1223 matches all unauthenticated clients.
1226 matches all authenticated clients;
1229 dn pattern is assumed unless otherwise specified by qualifying
1230 the (optional) key string
1236 (which are synonyms), to require an exact match; with
1238 to require exactly one level of depth match; with
1240 to allow any level of depth match, including the exact match; with
1242 to allow any level of depth match, not including the exact match;
1244 explicitly requires the (default) match based on POSIX (''extended'')
1245 regular expression pattern.
1248 matches unbound operations; the
1251 The same behavior is obtained by using the
1258 with the optional objectClass
1264 sets the limits for any DN listed in the values of the
1270 group objectClass (default
1272 whose DN exactly matches
1275 The currently supported limits are
1280 The syntax for time limits is
1281 .BR time[.{soft|hard}]=<integer> ,
1284 is the number of seconds slapd will spend answering a search request.
1285 If no time limit is explicitly requested by the client, the
1287 limit is used; if the requested time limit exceeds the
1290 .\".I "Administrative limit exceeded"
1291 .\"error is returned.
1292 limit, the value of the limit is used instead.
1295 limit is set to the keyword
1297 the soft limit is used in either case; if it is set to the keyword
1299 no hard limit is enforced.
1300 Explicit requests for time limits smaller or equal to the
1303 If no limit specifier is set, the value is assigned to the
1309 to preserve the original behavior.
1311 The syntax for size limits is
1312 .BR size[.{soft|hard|unchecked}]=<integer> ,
1315 is the maximum number of entries slapd will return answering a search
1317 If no size limit is explicitly requested by the client, the
1319 limit is used; if the requested size limit exceeds the
1322 .\".I "Administrative limit exceeded"
1323 .\"error is returned.
1324 limit, the value of the limit is used instead.
1327 limit is set to the keyword
1329 the soft limit is used in either case; if it is set to the keyword
1331 no hard limit is enforced.
1332 Explicit requests for size limits smaller or equal to the
1337 specifier sets a limit on the number of candidates a search request is allowed
1339 The rationale behind it is that searches for non-properly indexed
1340 attributes may result in large sets of candidates, which must be
1343 to determine whether they match the search filter or not.
1346 limit provides a means to drop such operations before they are even
1348 If the selected candidates exceed the
1350 limit, the search will abort with
1351 .IR "Unwilling to perform" .
1352 If it is set to the keyword
1354 no limit is applied (the default).
1357 the search is not even performed; this can be used to disallow searches
1358 for a specific set of users.
1359 If no limit specifier is set, the value is assigned to the
1365 to preserve the original behavior.
1367 In case of no match, the global limits are used.
1368 The default values are the same as for
1377 control is requested, the
1379 size limit is used by default, because the request of a specific page size
1380 is considered an explicit request for a limitation on the number
1381 of entries to be returned.
1382 However, the size limit applies to the total count of entries returned within
1383 the search, and not to a single page.
1384 Additional size limits may be enforced; the syntax is
1385 .BR size.pr={<integer>|noEstimate|unlimited} ,
1388 is the max page size if no explicit limit is set; the keyword
1390 inhibits the server from returning an estimate of the total number
1391 of entries that might be returned
1392 (note: the current implementation does not return any estimate).
1395 indicates that no limit is applied to the pagedResults control page size.
1397 .B size.prtotal={<integer>|unlimited|disabled}
1398 allows to set a limit on the total number of entries that a pagedResults
1399 control allows to return.
1400 By default it is set to the
1405 is the max number of entries that the whole search with pagedResults control
1409 to allow unlimited number of entries to be returned, e.g. to allow
1410 the use of the pagedResults control as a means to circumvent size
1411 limitations on regular searches; the keyword
1413 disables the control, i.e. no paged results can be returned.
1414 Note that the total number of entries returned when the pagedResults control
1415 is requested cannot exceed the
1417 size limit of regular searches unless extended by the
1421 The \fBlimits\fP statement is typically used to let an unlimited
1422 number of entries be returned by searches performed
1423 with the identity used by the consumer for synchronization purposes
1424 by means of the RFC 4533 LDAP Content Synchronization protocol
1425 (see \fBsyncrepl\fP for details).
1428 .B maxderefdepth <depth>
1429 Specifies the maximum number of aliases to dereference when trying to
1430 resolve an entry, used to avoid infinite alias loops. The default is 15.
1432 .B mirrormode on | off
1433 This option puts a replica database into "mirror" mode. Update
1434 operations will be accepted from any user, not just the updatedn. The
1435 database must already be configured as a syncrepl consumer
1436 before this keyword may be set. This mode also requires a
1438 (see above) to be configured.
1439 By default, mirrormode is off.
1441 .B monitoring on | off
1442 This option enables database-specific monitoring in the entry related
1443 to the current database in the "cn=Databases,cn=Monitor" subtree
1444 of the monitor database, if the monitor database is enabled.
1445 Currently, only the BDB and the HDB databases provide database-specific
1447 The default depends on the backend type.
1449 .B overlay <overlay-name>
1450 Add the specified overlay to this database. An overlay is a piece of
1451 code that intercepts database operations in order to extend or change
1452 them. Overlays are pushed onto
1453 a stack over the database, and so they will execute in the reverse
1454 of the order in which they were configured and the database itself
1455 will receive control last of all. See the
1456 .BR slapd.overlays (5)
1457 manual page for an overview of the available overlays.
1458 Note that all of the database's
1459 regular settings should be configured before any overlay settings.
1461 .B readonly on | off
1462 This option puts the database into "read-only" mode. Any attempts to
1463 modify the database will return an "unwilling to perform" error. By
1464 default, readonly is off.
1466 .B restrict <oplist>
1467 Specify a whitespace separated list of operations that are restricted.
1468 If defined inside a database specification, restrictions apply only
1469 to that database, otherwise they are global.
1470 Operations can be any of
1475 .BR extended[=<OID>] ,
1479 or the special pseudo-operations
1483 which respectively summarize read and write operations.
1491 keyword allows to indicate the OID of the specific operation
1495 Specify the distinguished name that is not subject to access control
1496 or administrative limit restrictions for operations on this database.
1497 This DN may or may not be associated with an entry. An empty root
1498 DN (the default) specifies no root access is to be granted. It is
1499 recommended that the rootdn only be specified when needed (such as
1500 when initially populating a database). If the rootdn is within
1501 a namingContext (suffix) of the database, a simple bind password
1502 may also be provided using the
1504 directive. Many optional features, including syncrepl, require the
1505 rootdn to be defined for the database.
1507 .B rootpw <password>
1508 Specify a password (or hash of the password) for the rootdn. The
1509 password can only be set if the rootdn is within the namingContext
1510 (suffix) of the database.
1511 This option accepts all RFC 2307 userPassword formats known to
1514 description) as well as cleartext.
1516 may be used to generate a hash of a password. Cleartext
1517 and \fB{CRYPT}\fP passwords are not recommended. If empty
1518 (the default), authentication of the root DN is by other means
1519 (e.g. SASL). Use of SASL is encouraged.
1521 .B suffix <dn suffix>
1522 Specify the DN suffix of queries that will be passed to this
1523 backend database. Multiple suffix lines can be given and at least one is
1524 required for each database definition.
1526 If the suffix of one database is "inside" that of another, the database
1527 with the inner suffix must come first in the configuration file.
1528 You may also want to glue such databases together with the
1532 .B subordinate [advertise]
1533 Specify that the current backend database is a subordinate of another
1534 backend database. A subordinate database may have only one suffix. This
1535 option may be used to glue multiple databases into a single namingContext.
1536 If the suffix of the current database is within the namingContext of a
1537 superior database, searches against the superior database will be
1538 propagated to the subordinate as well. All of the databases
1539 associated with a single namingContext should have identical rootdns.
1540 Behavior of other LDAP operations is unaffected by this setting. In
1541 particular, it is not possible to use moddn to move an entry from
1542 one subordinate to another subordinate within the namingContext.
1544 If the optional \fBadvertise\fP flag is supplied, the naming context of
1545 this database is advertised in the root DSE. The default is to hide this
1546 database context, so that only the superior context is visible.
1553 are used on the superior database, any glued subordinates that support
1554 these tools are opened as well.
1556 Databases that are glued together should usually be configured with the
1557 same indices (assuming they support indexing), even for attributes that
1558 only exist in some of these databases. In general, all of the glued
1559 databases should be configured as similarly as possible, since the intent
1560 is to provide the appearance of a single directory.
1562 Note that the \fIsubordinate\fP functionality is implemented internally
1563 by the \fIglue\fP overlay and as such its behavior will interact with other
1564 overlays in use. By default, the glue overlay is automatically configured as
1565 the last overlay on the superior backend. Its position on the backend
1566 can be explicitly configured by setting an \fBoverlay glue\fP directive
1567 at the desired position. This explicit configuration is necessary e.g.
1568 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1569 in order to work over all of the glued databases. E.g.
1573 suffix dc=example,dc=com
1581 .B syncrepl rid=<replica ID>
1582 .B provider=ldap[s]://<hostname>[:port]
1583 .B searchbase=<base DN>
1584 .B [type=refreshOnly|refreshAndPersist]
1585 .B [interval=dd:hh:mm:ss]
1586 .B [retry=[<retry interval> <# of retries>]+]
1587 .B [filter=<filter str>]
1588 .B [scope=sub|one|base|subord]
1589 .B [attrs=<attr list>]
1591 .B [sizelimit=<limit>]
1592 .B [timelimit=<limit>]
1593 .B [schemachecking=on|off]
1594 .B [network-timeout=<seconds>]
1595 .B [timeout=<seconds>]
1596 .B [bindmethod=simple|sasl]
1598 .B [saslmech=<mech>]
1599 .B [authcid=<identity>]
1600 .B [authzid=<identity>]
1601 .B [credentials=<passwd>]
1603 .B [secprops=<properties>]
1604 .B [starttls=yes|critical]
1605 .B [tls_cert=<file>]
1607 .B [tls_cacert=<file>]
1608 .B [tls_cacertdir=<path>]
1609 .B [tls_reqcert=never|allow|try|demand]
1610 .B [tls_ciphersuite=<ciphers>]
1611 .B [tls_crlcheck=none|peer|all]
1612 .B [logbase=<base DN>]
1613 .B [logfilter=<filter str>]
1614 .B [syncdata=default|accesslog|changelog]
1616 Specify the current database as a replica which is kept up-to-date with the
1617 master content by establishing the current
1619 as a replication consumer site running a
1622 The replica content is kept synchronized to the master content using
1623 the LDAP Content Synchronization protocol. Refer to the
1624 "OpenLDAP Administrator's Guide" for detailed information on
1625 setting up a replicated
1627 directory service using the
1632 identifies the current
1634 directive within the replication consumer site.
1635 It is a non-negative integer not greater than 4095 (limited
1636 to three hexadecimal digits).
1639 specifies the replication provider site containing the master content
1640 as an LDAP URI. If <port> is not given, the standard LDAP port number
1641 (389 or 636) is used.
1645 replica is defined using a search
1646 specification as its result set. The consumer
1648 will send search requests to the provider
1650 according to the search specification. The search specification includes
1651 .BR searchbase ", " scope ", " filter ", " attrs ", " attrsonly ", " sizelimit ", "
1654 parameters as in the normal search specification.
1655 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1656 \fB(objectclass=*)\fP, while there is no default \fBsearchbase\fP. The
1657 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1658 attributes, and \fBattrsonly\fP is unset by default.
1659 The \fBsizelimit\fP and \fBtimelimit\fP only
1660 accept "unlimited" and positive integers, and both default to "unlimited".
1661 The \fBsizelimit\fP and \fBtimelimit\fP parameters define
1662 a consumer requested limitation on the number of entries that can be returned
1663 by the LDAP Content Synchronization operation; as such, it is intended
1664 to implement partial replication based on the size of the replicated database
1665 and on the time required by the synchronization.
1666 Note, however, that any provider-side limits for the replication identity
1667 will be enforced by the provider regardless of the limits requested
1668 by the LDAP Content Synchronization operation, much like for any other
1671 The LDAP Content Synchronization protocol has two operation types.
1674 operation, the next synchronization search operation
1675 is periodically rescheduled at an interval time (specified by
1677 parameter; 1 day by default)
1678 after each synchronization operation finishes.
1680 .B refreshAndPersist
1681 operation, a synchronization search remains persistent in the provider slapd.
1682 Further updates to the master replica will generate
1683 .B searchResultEntry
1684 to the consumer slapd as the search responses to the persistent
1685 synchronization search.
1687 If an error occurs during replication, the consumer will attempt to
1688 reconnect according to the
1690 parameter which is a list of the <retry interval> and <# of retries> pairs.
1691 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1692 for the first 10 times and then retry every 300 seconds for the next 3
1693 times before stop retrying. The `+' in <# of retries> means indefinite
1694 number of retries until success.
1697 was specified, by default syncrepl retries every hour forever.
1699 The schema checking can be enforced at the LDAP Sync
1700 consumer site by turning on the
1702 parameter. The default is \fBoff\fP.
1703 Schema checking \fBon\fP means that replicated entries must have
1704 a structural objectClass, must obey to objectClass requirements
1705 in terms of required/allowed attributes, and that naming attributes
1706 and distinguished values must be present.
1707 As a consequence, schema checking should be \fBoff\fP when partial
1708 replication is used.
1712 parameter sets how long the consumer will wait to establish a
1713 network connection to the provider. Once a connection is
1716 parameter determines how long the consumer will wait for the initial
1717 Bind request to complete. The defaults for these parameters come
1725 requires the options
1729 and should only be used when adequate security services
1730 (e.g. TLS or IPSEC) are in place.
1731 .B REMEMBER: simple bind credentials must be in cleartext!
1738 Depending on the mechanism, an authentication identity and/or
1739 credentials can be specified using
1745 parameter may be used to specify an authorization identity.
1746 Specific security properties (as with the
1748 keyword above) for a SASL bind can be set with the
1750 option. A non default SASL realm can be set with the
1753 The identity used for synchronization by the consumer should be allowed
1754 to receive an unlimited number of entries in response to a search request.
1755 The provider, other than allow authentication of the syncrepl identity,
1756 should grant that identity appropriate access privileges to the data
1757 that is being replicated (\fBaccess\fP directive), and appropriate time
1759 This can be accomplished by either allowing unlimited \fBsizelimit\fP
1760 and \fBtimelimit\fP, or by setting an appropriate \fBlimits\fP statement
1761 in the consumer's configuration (see \fBsizelimit\fP and \fBlimits\fP
1766 parameter specifies use of the StartTLS extended operation
1767 to establish a TLS session before Binding to the provider. If the
1769 argument is supplied, the session will be aborted if the StartTLS request
1770 fails. Otherwise the syncrepl session continues without TLS. The
1771 tls_reqcert setting defaults to "demand" and the other TLS settings
1772 default to the same as the main slapd TLS settings.
1774 Rather than replicating whole entries, the consumer can query logs of
1775 data modifications. This mode of operation is referred to as \fIdelta
1776 syncrepl\fP. In addition to the above parameters, the
1780 parameters must be set appropriately for the log that will be used. The
1782 parameter must be set to either "accesslog" if the log conforms to the
1783 .BR slapo-accesslog (5)
1784 log format, or "changelog" if the log conforms
1785 to the obsolete \fIchangelog\fP format. If the
1787 parameter is omitted or set to "default" then the log parameters are
1792 This option is only applicable in a slave
1794 It specifies the DN permitted to update (subject to access controls)
1795 the replica. It is only needed in certain push-mode
1796 replication scenarios. Generally, this DN
1803 Specify the referral to pass back when
1805 is asked to modify a replicated local database.
1806 If specified multiple times, each url is provided.
1808 .SH DATABASE-SPECIFIC OPTIONS
1809 Each database may allow specific configuration options; they are
1810 documented separately in the backends' manual pages. See the
1811 .BR slapd.backends (5)
1812 manual page for an overview of available backends.
1815 Here is a short example of a configuration file:
1819 include SYSCONFDIR/schema/core.schema
1820 pidfile LOCALSTATEDIR/run/slapd.pid
1822 # Subtypes of "name" (e.g. "cn" and "ou") with the
1823 # option ";x-hidden" can be searched for/compared,
1824 # but are not shown. See \fBslapd.access\fP(5).
1825 attributeoptions x-hidden lang-
1826 access to attrs=name;x-hidden by * =cs
1828 # Protect passwords. See \fBslapd.access\fP(5).
1829 access to attrs=userPassword by * auth
1830 # Read access to other attributes and entries.
1831 access to * by * read
1834 suffix "dc=our-domain,dc=com"
1835 # The database directory MUST exist prior to
1836 # running slapd AND should only be accessible
1837 # by the slapd/tools. Mode 0700 recommended.
1838 directory LOCALSTATEDIR/openldap-data
1839 # Indices to maintain
1840 index objectClass eq
1841 index cn,sn,mail pres,eq,approx,sub
1843 # We serve small clients that do not handle referrals,
1844 # so handle remote lookups on their behalf.
1847 uri ldap://ldap.some-server.com/
1852 "OpenLDAP Administrator's Guide" contains a longer annotated
1853 example of a configuration file.
1854 The original ETCDIR/slapd.conf is another example.
1858 default slapd configuration file
1861 .BR slapd\-config (5),
1862 .BR slapd.access (5),
1863 .BR slapd.backends (5),
1864 .BR slapd.overlays (5),
1865 .BR slapd.plugin (5),
1866 .BR slapd.replog (5),
1877 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1878 .SH ACKNOWLEDGEMENTS
projects / openldap / blob