1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2007 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 options
114 if started without the debugging command line option.
116 .B attributeoptions [option-name]...
117 Define tagging attribute options or option tag/range prefixes.
118 Options must not end with `-', prefixes must end with `-'.
119 The `lang-' prefix is predefined.
122 directive, `lang-' will no longer be defined and you must specify it
123 explicitly if you want it defined.
125 An attribute description with a tagging option is a subtype of that
126 attribute description without the option.
127 Except for that, options defined this way have no special semantics.
128 Prefixes defined this way work like the `lang-' options:
129 They define a prefix for tagging options starting with the prefix.
130 That is, if you define the prefix `x-foo-', you can use the option
132 Furthermore, in a search or compare, a prefix or range name (with
133 a trailing `-') matches all options starting with that name, as well
134 as the option with the range name sans the trailing `-'.
135 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
137 RFC 4520 reserves options beginning with `x-' for private experiments.
138 Other options should be registered with IANA, see RFC 4520 section 3.5.
139 OpenLDAP also has the `binary' option built in, but this is a transfer
140 option, not a tagging option.
143 .B attributetype "(\ <oid>\
145 [DESC\ <description>]\
154 [NO\-USER\-MODIFICATION]\
155 [USAGE\ <attributeUsage>]\ )"
157 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
158 The slapd parser extends the RFC 4512 definition by allowing string
159 forms as well as numeric OIDs to be used for the attribute OID and
160 attribute syntax OID.
166 .B authz-policy <policy>
167 Used to specify which rules to use for Proxy Authorization. Proxy
168 authorization allows a client to authenticate to the server using one
169 user's credentials, but specify a different identity to use for authorization
170 and access control purposes. It essentially allows user A to login as user
171 B, using user A's password.
174 flag disables proxy authorization. This is the default setting.
177 flag will use rules in the
179 attribute of the authorization DN.
182 flag will use rules in the
184 attribute of the authentication DN.
187 flag, an alias for the deprecated value of
189 will allow any of the above, whatever succeeds first (checked in
195 flag requires both authorizations to succeed.
198 The rules are mechanisms to specify which identities are allowed
199 to perform proxy authorization.
202 attribute in an entry specifies which other users
203 are allowed to proxy login to this entry. The
206 an entry specifies which other users this user can authorize as. Use of
209 abused if users are allowed to write arbitrary values to this attribute.
212 attribute must be protected with ACLs such that
213 only privileged users can modify it.
220 or a set of identities; it can take five forms:
223 .B ldap:///<base>??[<scope>]?<filter>
226 .B dn[.<dnstyle>]:<pattern>
229 .B u[<mech>[<realm>]]:<pattern>
232 .B group[/objectClass[/attributeType]]:<pattern>
239 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
242 The first form is a valid LDAP
250 portions must be absent, so that the search occurs locally on either
256 with the optional style modifiers
262 for exact, onelevel, children and subtree matches, which cause
264 to be normalized according to the DN normalization rules, or the special
266 style, which causes the
268 to be treated as a POSIX (''extended'') regular expression, as
275 means any non-anonymous DN.
276 The third form is a SASL
278 with the optional fields
282 that allow to specify a SASL
284 and eventually a SASL
286 for those mechanisms that support one.
287 The need to allow the specification of a mechanism is still debated,
288 and users are strongly discouraged to rely on this possibility.
289 The fourth form is a group specification, consisting of the keyword
291 optionally followed by the specification of the group
297 is searched with base scope, and in case of match, the values of the
300 are searched for the asserted DN.
301 For backwards compatibility, if no identity type is provided, i.e. only
305 is assumed; as a consequence,
307 is subjected to DN normalization.
308 Since the interpretation of
312 can impact security, users are strongly encouraged
313 to explicitly set the type of identity specification that is being used.
314 A subset of these rules can be used as third arg in the
316 statement (see below); significantly, the
323 .B authz-regexp <match> <replace>
324 Used by the authentication framework to convert simple user names,
325 such as provided by SASL subsystem, to an LDAP DN used for
326 authorization purposes. Note that the resultant DN need not refer
327 to an existing entry to be considered valid. When an authorization
328 request is received from the SASL subsystem, the SASL
333 are taken, when available, and combined into a name of the form
337 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
340 This name is then compared against the
342 POSIX (''extended'') regular expression, and if the match is successful,
343 the name is replaced with the
345 string. If there are wildcard strings in the
347 regular expression that are enclosed in parenthesis, e.g.
353 then the portion of the name that matched the wildcard will be stored
354 in the numbered placeholder variable $1. If there are other wildcard strings
355 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
356 placeholders can then be used in the
361 .B UID=$1,OU=Accounts,DC=example,DC=com
364 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
366 If the latter, the server will use the URI to search its own database(s)
367 and, if the search returns exactly one entry, the name is
368 replaced by the DN of that entry. The LDAP URI must have no
369 hostport, attrs, or extensions components, but the filter is mandatory,
373 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
376 The protocol portion of the URI must be strictly
378 Note that this search is subject to access controls. Specifically,
379 the authentication identity must have "auth" access in the subject.
383 options can be given in the configuration file to allow for multiple matching
384 and replacement patterns. The matching patterns are checked in the order they
385 appear in the file, stopping at the first successful match.
388 .\"Because the plus sign + is a character recognized by the regular expression engine,
389 .\"and it will appear in names that include a REALM, be careful to escape the
390 .\"plus sign with a backslash \\+ to remove the character's special meaning.
393 .B concurrency <integer>
394 Specify a desired level of concurrency. Provided to the underlying
395 thread system as a hint. The default is not to provide any hint.
397 .B conn_max_pending <integer>
398 Specify the maximum number of pending requests for an anonymous session.
399 If requests are submitted faster than the server can process them, they
400 will be queued up to this limit. If the limit is exceeded, the session
401 is closed. The default is 100.
403 .B conn_max_pending_auth <integer>
404 Specify the maximum number of pending requests for an authenticated session.
407 .B defaultsearchbase <dn>
408 Specify a default search base to use when client submits a
409 non-base search request with an empty base DN.
410 Base scoped search requests with an empty base DN are not affected.
412 .B disallow <features>
413 Specify a set of features (separated by white space) to
414 disallow (default none).
416 disables acceptance of anonymous bind requests. Note that this setting
417 does not prohibit anonymous directory access (See "require authc").
419 disables simple (bind) authentication.
421 disables forcing session to anonymous status (see also
423 upon StartTLS operation receipt.
425 disallows the StartTLS operation if authenticated (see also
429 .B ditcontentrule "(\ <oid>\
431 [DESC\ <description>]\
438 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
439 The slapd parser extends the RFC 4512 definition by allowing string
440 forms as well as numeric OIDs to be used for the attribute OID and
441 attribute syntax OID.
447 .B gentlehup { on | off }
448 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
450 will stop listening for new connections, but will not close the
451 connections to the current clients. Future write operations return
452 unwilling-to-perform, though. Slapd terminates when all clients
453 have closed their connections (if they ever do), or \- as before \-
454 if it receives a SIGTERM signal. This can be useful if you wish to
455 terminate the server and start a new
458 .B with another database,
459 without disrupting the currently active clients.
460 The default is off. You may wish to use
462 along with this option.
464 .B idletimeout <integer>
465 Specify the number of seconds to wait before forcibly closing
466 an idle client connection. A idletimeout of 0 disables this
467 feature. The default is 0.
469 .B include <filename>
470 Read additional configuration information from the given file before
471 continuing with the next line of the current file.
473 .B index_substr_if_minlen <integer>
474 Specify the minimum length for subinitial and subfinal indices. An
475 attribute value must have at least this many characters in order to be
476 processed by the indexing functions. The default is 2.
478 .B index_substr_if_maxlen <integer>
479 Specify the maximum length for subinitial and subfinal indices. Only
480 this many characters of an attribute value will be processed by the
481 indexing functions; any excess characters are ignored. The default is 4.
483 .B index_substr_any_len <integer>
484 Specify the length used for subany indices. An attribute value must have
485 at least this many characters in order to be processed. Attribute values
486 longer than this length will be processed in segments of this length. The
487 default is 4. The subany index will also be used in subinitial and
488 subfinal index lookups when the filter string is longer than the
489 .I index_substr_if_maxlen
492 .B index_substr_any_step <integer>
493 Specify the steps used in subany index lookups. This value sets the offset
494 for the segments of a filter string that are processed for a subany index
495 lookup. The default is 2. For example, with the default values, a search
496 using this filter "cn=*abcdefgh*" would generate index lookups for
497 "abcd", "cdef", and "efgh".
500 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
501 such as those to the ldapi:// listener. For a description of SSF values,
505 option description. The default is 71.
507 .B logfile <filename>
508 Specify a file for recording debug log messages. By default these messages
509 only go to stderr and are not recorded anywhere else. Specifying a logfile
510 copies messages to both stderr and the logfile.
512 .B loglevel <integer> [...]
513 Specify the level at which debugging statements and operation
514 statistics should be syslogged (currently logged to the
516 LOG_LOCAL4 facility).
517 They must be considered subsystems rather than increasingly verbose
519 Some messages with higher priority are logged regardless
520 of the configured loglevel as soon as any logging is configured.
521 Log levels are additive, and available levels are:
532 debug packet handling
536 heavy trace debugging (function args)
540 connection management
544 print out packets sent and received
548 search filter processing
552 configuration file processing
556 access control list processing
560 stats log connections/operations/results
564 stats log entries sent
568 print communication with shell backends
580 \"data indexing (unused)
588 only messages that get logged whatever log level is set
591 The desired log level can be input as a single integer that combines
592 the (ORed) desired levels, both in decimal or in hexadecimal notation,
593 as a list of integers (that are ORed internally),
594 or as a list of the names that are shown between brackets, such that
607 can be used as a shortcut to enable logging at all levels (equivalent to -1).
610 or the equivalent integer representation, causes those messages
611 that are logged regardless of the configured loglevel to be logged.
612 In fact, if no loglevel (or a 0 level) is defined, no logging occurs,
615 level is required to have high priority messages logged.
618 .B moduleload <filename>
619 Specify the name of a dynamically loadable module to load. The filename
620 may be an absolute path name or a simple filename. Non-absolute names
621 are searched for in the directories specified by the
623 option. This option and the
625 option are only usable if slapd was compiled with --enable-modules.
627 .B modulepath <pathspec>
628 Specify a list of directories to search for loadable modules. Typically
629 the path is colon-separated but this depends on the operating system.
632 .B objectclass "(\ <oid>\
634 [DESC\ <description>]\
637 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
638 [MUST\ <oids>] [MAY\ <oids>] )"
640 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
641 The slapd parser extends the RFC 4512 definition by allowing string
642 forms as well as numeric OIDs to be used for the object class OID.
646 description.) Object classes are "STRUCTURAL" by default.
649 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
650 Define a string name that equates to the given OID. The string can be used
651 in place of the numeric OID in objectclass and attribute definitions. The
652 name can also be used with a suffix of the form ":xx" in which case the
653 value "oid.xx" will be used.
655 .B password-hash <hash> [<hash>...]
656 This option configures one or more hashes to be used in generation of user
657 passwords stored in the userPassword attribute during processing of
658 LDAP Password Modify Extended Operations (RFC 3062).
659 The <hash> must be one of
673 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
678 use the MD5 algorithm (RFC 1321), the latter with a seed.
685 indicates that the new password should be
686 added to userPassword as clear text.
688 Note that this option does not alter the normal user applications
689 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
691 .B password\-crypt\-salt\-format <format>
692 Specify the format of the salt passed to
694 when generating {CRYPT} passwords (see
696 during processing of LDAP Password Modify Extended Operations (RFC 3062).
698 This string needs to be in
700 format and may include one (and only one) %s conversion.
701 This conversion will be substituted with a string of random
702 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
703 provides a two character salt and "$1$%.8s" tells some
704 versions of crypt(3) to use an MD5 algorithm and provides
705 8 random characters of salt. The default is "%s", which
706 provides 31 characters of salt.
708 .B pidfile <filename>
709 The ( absolute ) name of a file that will hold the
711 server's process ID ( see
713 ) if started without the debugging command line option.
716 Specify the referral to pass back when
718 cannot find a local database to handle a request.
719 If specified multiple times, each url is provided.
721 .B require <conditions>
722 Specify a set of conditions (separated by white space) to
723 require (default none).
724 The directive may be specified globally and/or per-database;
725 databases inherit global conditions, so per-database specifications
728 requires bind operation prior to directory operations.
730 requires session to be using LDAP version 3.
732 requires authentication prior to directory operations.
734 requires SASL authentication prior to directory operations.
736 requires strong authentication prior to directory operations.
737 The strong keyword allows protected "simple" authentication
738 as well as SASL authentication.
740 may be used to require no conditions (useful to clear out globally
741 set conditions within a particular database); it must occur first
742 in the list of conditions.
744 .B reverse-lookup on | off
745 Enable/disable client name unverified reverse lookup (default is
747 if compiled with --enable-rlookups).
750 Specify the name of an LDIF(5) file containing user defined attributes
751 for the root DSE. These attributes are returned in addition to the
752 attributes normally produced by slapd.
755 Used to specify the fully qualified domain name used for SASL processing.
757 .B sasl-realm <realm>
758 Specify SASL realm. Default is empty.
760 .B sasl-secprops <properties>
761 Used to specify Cyrus SASL security properties.
764 flag (without any other properties) causes the flag properties
765 default, "noanonymous,noplain", to be cleared.
768 flag disables mechanisms susceptible to simple passive attacks.
771 flag disables mechanisms susceptible to active attacks.
774 flag disables mechanisms susceptible to passive dictionary attacks.
777 flag disables mechanisms which support anonymous login.
780 flag require forward secrecy between sessions.
783 require mechanisms which pass client credentials (and allow
784 mechanisms which can pass credentials to do so).
787 property specifies the minimum acceptable
788 .I security strength factor
789 as an integer approximate to effective key length used for
790 encryption. 0 (zero) implies no protection, 1 implies integrity
791 protection only, 56 allows DES or other weak ciphers, 112
792 allows triple DES and other strong ciphers, 128 allows RC4,
793 Blowfish and other modern strong ciphers. The default is 0.
796 property specifies the maximum acceptable
797 .I security strength factor
798 as an integer (see minssf description). The default is INT_MAX.
801 property specifies the maximum security layer receive buffer
802 size allowed. 0 disables security layers. The default is 65536.
805 Specify the distinguished name for the subschema subentry that
806 controls the entries on this server. The default is "cn=Subschema".
808 .B security <factors>
809 Specify a set of security strength factors (separated by white space)
813 option for a description of security strength factors).
814 The directive may be specified globally and/or per-database.
816 specifies the overall security strength factor.
818 specifies the transport security strength factor.
820 specifies the TLS security strength factor.
822 specifies the SASL security strength factor.
824 specifies the overall security strength factor to require for
826 .B update_transport=<n>
827 specifies the transport security strength factor to require for
830 specifies the TLS security strength factor to require for
833 specifies the SASL security strength factor to require for
836 specifies the security strength factor required for
838 username/password authentication.
841 factor is measure of security provided by the underlying transport,
842 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
844 .B serverID <integer> [<URL>]
845 Specify an integer ID from 0 to 4095 for this server. These IDs are
846 required when using multimaster replication and each master must have a
847 unique ID. If the URL is provided, this directive may be specified
848 multiple times, providing a complete list of participating servers
849 and their IDs. The fully qualified hostname of each server should be
850 used in the supplied URLs. The IDs are used in the "replica id" field
851 of all CSNs generated by the specified server. The default value is zero.
858 .B sizelimit {<integer>|unlimited}
860 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
861 Specify the maximum number of entries to return from a search operation.
862 The default size limit is 500.
865 to specify no limits.
866 The second format allows a fine grain setting of the size limits.
867 Extra args can be added on the same line.
870 for an explanation of the different flags.
872 .B sockbuf_max_incoming <integer>
873 Specify the maximum incoming LDAP PDU size for anonymous sessions.
874 The default is 262143.
876 .B sockbuf_max_incoming_auth <integer>
877 Specify the maximum incoming LDAP PDU size for authenticated sessions.
878 The default is 4194303.
881 Specify the maximum size of the primary thread pool.
882 The default is 16; the minimum value is 2.
884 .B timelimit {<integer>|unlimited}
886 .B timelimit time[.{soft|hard}]=<integer> [...]
887 Specify the maximum number of seconds (in real time)
889 will spend answering a search request. The default time limit is 3600.
892 to specify no limits.
893 The second format allows a fine grain setting of the time limits.
894 Extra args can be added on the same line.
897 for an explanation of the different flags.
899 .B tool-threads <integer>
900 Specify the maximum number of threads to use in tool mode.
901 This should not be greater than the number of CPUs in the system.
903 .\"ucdata-path is obsolete / ignored...
905 .\".B ucdata-path <path>
906 .\"Specify the path to the directory containing the Unicode character
907 .\"tables. The default path is DATADIR/ucdata.
911 is built with support for Transport Layer Security, there are more options
914 .B TLSCipherSuite <cipher-suite-spec>
915 Permits configuring what ciphers will be accepted and the preference order.
916 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
918 TLSCipherSuite HIGH:MEDIUM:+SSLv2
920 To check what ciphers a given spec selects, use:
923 openssl ciphers -v <cipher-suite-spec>
926 To obtain the list of ciphers in GNUtls use:
933 .B TLSCACertificateFile <filename>
934 Specifies the file that contains certificates for all of the Certificate
939 .B TLSCACertificatePath <path>
940 Specifies the path of a directory that contains Certificate Authority
941 certificates in separate individual files. Usually only one of this
942 or the TLSCACertificateFile is used. This directive is not supported
945 .B TLSCertificateFile <filename>
946 Specifies the file that contains the
950 .B TLSCertificateKeyFile <filename>
951 Specifies the file that contains the
953 server private key that matches the certificate stored in the
954 .B TLSCertificateFile
955 file. Currently, the private key must not be protected with a password, so
956 it is of critical importance that it is protected carefully.
958 .B TLSDHParamFile <filename>
959 This directive specifies the file that contains parameters for Diffie-Hellman
960 ephemeral key exchange. This is required in order to use a DSA certificate on
961 the server. If multiple sets of parameters are present in the file, all of
962 them will be processed. Note that setting this option may also enable
963 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
964 You should append "!ADH" to your cipher suites if you have changed them
965 from the default, otherwise no certificate exchanges or verification will
966 be done. When using GNUtls these parameters are always generated randomly so
967 this directive is ignored.
969 .B TLSRandFile <filename>
970 Specifies the file to obtain random bits from when /dev/[u]random
971 is not available. Generally set to the name of the EGD/PRNGD socket.
972 The environment variable RANDFILE can also be used to specify the filename.
973 This directive is ignored with GNUtls.
975 .B TLSVerifyClient <level>
976 Specifies what checks to perform on client certificates in an
977 incoming TLS session, if any.
980 can be specified as one of the following keywords:
986 will not ask the client for a certificate.
989 The client certificate is requested. If no certificate is provided,
990 the session proceeds normally. If a bad certificate is provided,
991 it will be ignored and the session proceeds normally.
994 The client certificate is requested. If no certificate is provided,
995 the session proceeds normally. If a bad certificate is provided,
996 the session is immediately terminated.
998 .B demand | hard | true
999 These keywords are all equivalent, for compatibility reasons.
1000 The client certificate is requested. If no certificate is provided,
1001 or a bad certificate is provided, the session is immediately terminated.
1003 Note that a valid client certificate is required in order to use the
1004 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1007 setting must be chosen to enable SASL EXTERNAL authentication.
1010 .B TLSCRLCheck <level>
1011 Specifies if the Certificate Revocation List (CRL) of the CA should be
1012 used to verify if the client certificates have not been revoked. This
1014 .B TLSCACertificatePath
1015 parameter to be set. This directive is ignored with GNUtls.
1017 can be specified as one of the following keywords:
1021 No CRL checks are performed
1024 Check the CRL of the peer certificate
1027 Check the CRL for a whole certificate chain
1030 .B TLSCRLFile <filename>
1031 Specifies a file containing a Certificate Revocation List to be used
1032 for verifying that certificates have not been revoked. This directive is
1033 only valid when using GNUtls.
1034 .SH GENERAL BACKEND OPTIONS
1035 Options in this section only apply to the configuration file section
1036 for the specified backend. They are supported by every
1039 .B backend <databasetype>
1040 Mark the beginning of a backend definition. <databasetype>
1058 depending on which backend will serve the database.
1060 .SH GENERAL DATABASE OPTIONS
1061 Options in this section only apply to the configuration file section
1062 for the database in which they are defined. They are supported by every
1063 type of backend. Note that the
1067 option are mandatory for each database.
1069 .B database <databasetype>
1070 Mark the beginning of a new database instance definition. <databasetype>
1088 depending on which backend will serve the database.
1091 Controls whether the database will be used to answer
1092 queries. A database that is hidden will never be
1093 selected to answer any queries, and any suffix configured
1094 on the database will be ignored in checks for conflicts
1095 with other databases. By default, hidden is off.
1100 will automatically maintain the
1101 modifiersName, modifyTimestamp, creatorsName, and
1102 createTimestamp attributes for entries. It also controls
1103 the entryCSN and entryUUID attributes, which are needed
1104 by the syncrepl provider. By default, lastmod is on.
1106 .B limits <who> <limit> [<limit> [...]]
1107 Specify time and size limits based on who initiated an operation.
1114 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1120 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1125 matches all unauthenticated clients.
1128 matches all authenticated clients;
1131 dn pattern is assumed unless otherwise specified by qualifying
1132 the (optional) key string
1138 (which are synonyms), to require an exact match; with
1140 to require exactly one level of depth match; with
1142 to allow any level of depth match, including the exact match; with
1144 to allow any level of depth match, not including the exact match;
1146 explicitly requires the (default) match based on POSIX (''extended'')
1147 regular expression pattern.
1150 matches unbound operations; the
1153 The same behavior is obtained by using the
1160 with the optional objectClass
1166 sets the limits for any DN listed in the values of the
1172 group objectClass (default
1174 whose DN exactly matches
1177 The currently supported limits are
1182 The syntax for time limits is
1183 .BR time[.{soft|hard}]=<integer> ,
1186 is the number of seconds slapd will spend answering a search request.
1187 If no time limit is explicitly requested by the client, the
1189 limit is used; if the requested time limit exceeds the
1192 .\".I "Administrative limit exceeded"
1193 .\"error is returned.
1194 limit, the value of the limit is used instead.
1197 limit is set to the keyword
1199 the soft limit is used in either case; if it is set to the keyword
1201 no hard limit is enforced.
1202 Explicit requests for time limits smaller or equal to the
1205 If no limit specifier is set, the value is assigned to the
1211 to preserve the original behavior.
1213 The syntax for size limits is
1214 .BR size[.{soft|hard|unchecked}]=<integer> ,
1217 is the maximum number of entries slapd will return answering a search
1219 If no size limit is explicitly requested by the client, the
1221 limit is used; if the requested size limit exceeds the
1224 .\".I "Administrative limit exceeded"
1225 .\"error is returned.
1226 limit, the value of the limit is used instead.
1229 limit is set to the keyword
1231 the soft limit is used in either case; if it is set to the keyword
1233 no hard limit is enforced.
1234 Explicit requests for size limits smaller or equal to the
1239 specifier sets a limit on the number of candidates a search request is allowed
1241 The rationale behind it is that searches for non-properly indexed
1242 attributes may result in large sets of candidates, which must be
1245 to determine whether they match the search filter or not.
1248 limit provides a means to drop such operations before they are even
1250 If the selected candidates exceed the
1252 limit, the search will abort with
1253 .IR "Unwilling to perform" .
1254 If it is set to the keyword
1256 no limit is applied (the default).
1259 the search is not even performed; this can be used to disallow searches
1260 for a specific set of users.
1261 If no limit specifier is set, the value is assigned to the
1267 to preserve the original behavior.
1269 In case of no match, the global limits are used.
1270 The default values are the same of
1279 control is requested, the
1281 size limit is used by default, because the request of a specific page size
1282 is considered an explicit request for a limitation on the number
1283 of entries to be returned.
1284 However, the size limit applies to the total count of entries returned within
1285 the search, and not to a single page.
1286 Additional size limits may be enforced; the syntax is
1287 .BR size.pr={<integer>|noEstimate|unlimited} ,
1290 is the max page size if no explicit limit is set; the keyword
1292 inhibits the server from returning an estimate of the total number
1293 of entries that might be returned
1294 (note: the current implementation does not return any estimate).
1297 indicates that no limit is applied to the pagedResults control page size.
1299 .B size.prtotal={<integer>|unlimited|disabled}
1300 allows to set a limit on the total number of entries that a pagedResults
1301 control allows to return.
1302 By default it is set to the
1307 is the max number of entries that the whole search with pagedResults control
1311 to allow unlimited number of entries to be returned, e.g. to allow
1312 the use of the pagedResults control as a means to circumvent size
1313 limitations on regular searches; the keyword
1315 disables the control, i.e. no paged results can be returned.
1316 Note that the total number of entries returned when the pagedResults control
1317 is requested cannot exceed the
1319 size limit of regular searches unless extended by the
1324 .B maxderefdepth <depth>
1325 Specifies the maximum number of aliases to dereference when trying to
1326 resolve an entry, used to avoid infinite alias loops. The default is 1.
1328 .B mirrormode on | off
1329 This option puts a replica database into "mirror" mode. Update
1330 operations will be accepted from any user, not just the updatedn. The
1331 database must already be configured as a syncrepl consumer
1332 before this keyword may be set. This mode also requires a
1334 (see above) to be configured.
1335 By default, mirrormode is off.
1337 .B overlay <overlay-name>
1338 Add the specified overlay to this database. An overlay is a piece of
1339 code that intercepts database operations in order to extend or change
1340 them. Overlays are pushed onto
1341 a stack over the database, and so they will execute in the reverse
1342 of the order in which they were configured and the database itself
1343 will receive control last of all. See the
1344 .BR slapd.overlays (5)
1345 manual page for an overview of the available overlays.
1346 Note that all of the database's
1347 regular settings should be configured before any overlay settings.
1349 .B readonly on | off
1350 This option puts the database into "read-only" mode. Any attempts to
1351 modify the database will return an "unwilling to perform" error. By
1352 default, readonly is off.
1355 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1356 .B [starttls=yes|critical]
1357 .B [suffix=<suffix> [...]]
1358 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1359 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1360 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1361 .B [attrs[!]=<attr list>]
1363 Specify a replication site for this database. Refer to the "OpenLDAP
1364 Administrator's Guide" for detailed information on setting up a replicated
1366 directory service. Zero or more
1368 instances can be used to select the subtrees that will be replicated
1369 (defaults to all the database).
1371 is deprecated in favor of the
1375 allows the replica LDAP server to be specified as an LDAP URI.
1380 requires the options
1384 and should only be used when adequate security services
1385 (e.g TLS or IPSEC) are in place. A
1391 Specific security properties (as with the
1393 keyword above) for a SASL bind can be set with the
1395 option. A non-default SASL realm can be set with the
1400 will use Kerberos, a kerberos instance should be given in
1404 can be given after the
1406 keyword to allow the selective replication of the listed attributes only;
1409 mark is used, the list is considered exclusive, i.e. the listed attributes
1411 If an objectClass is listed, all the related attributes
1412 are (are not) replicated.
1415 .B restrict <oplist>
1416 Specify a whitespace separated list of operations that are restricted.
1417 If defined inside a database specification, restrictions apply only
1418 to that database, otherwise they are global.
1419 Operations can be any of
1424 .BR extended[=<OID>] ,
1428 or the special pseudo-operations
1432 which respectively summarize read and write operations.
1440 keyword allows to indicate the OID of the specific operation
1444 Specify the distinguished name that is not subject to access control
1445 or administrative limit restrictions for operations on this database.
1446 This DN may or may not be associated with an entry. An empty root
1447 DN (the default) specifies no root access is to be granted. It is
1448 recommended that the rootdn only be specified when needed (such as
1449 when initially populating a database). If the rootdn is within
1450 a namingContext (suffix) of the database, a simple bind password
1451 may also be provided using the
1453 directive. Note that the rootdn is always needed when using syncrepl.
1455 .B rootpw <password>
1456 Specify a password (or hash of the password) for the rootdn. The
1457 password can only be set if the rootdn is within the namingContext
1458 (suffix) of the database.
1459 This option accepts all RFC 2307 userPassword formats known to
1462 description) as well as cleartext.
1464 may be used to generate a hash of a password. Cleartext
1465 and \fB{CRYPT}\fP passwords are not recommended. If empty
1466 (the default), authentication of the root DN is by other means
1467 (e.g. SASL). Use of SASL is encouraged.
1469 .B suffix <dn suffix>
1470 Specify the DN suffix of queries that will be passed to this
1471 backend database. Multiple suffix lines can be given and at least one is
1472 required for each database definition.
1473 If the suffix of one database is "inside" that of another, the database
1474 with the inner suffix must come first in the configuration file.
1476 .B subordinate [advertise]
1477 Specify that the current backend database is a subordinate of another
1478 backend database. A subordinate database may have only one suffix. This
1479 option may be used to glue multiple databases into a single namingContext.
1480 If the suffix of the current database is within the namingContext of a
1481 superior database, searches against the superior database will be
1482 propagated to the subordinate as well. All of the databases
1483 associated with a single namingContext should have identical rootdns.
1484 Behavior of other LDAP operations is unaffected by this setting. In
1485 particular, it is not possible to use moddn to move an entry from
1486 one subordinate to another subordinate within the namingContext.
1488 If the optional \fBadvertise\fP flag is supplied, the naming context of
1489 this database is advertised in the root DSE. The default is to hide this
1490 database context, so that only the superior context is visible.
1497 are used on the superior database, any glued subordinates that support
1498 these tools are opened as well.
1500 Databases that are glued together should usually be configured with the
1501 same indices (assuming they support indexing), even for attributes that
1502 only exist in some of these databases. In general, all of the glued
1503 databases should be configured as similarly as possible, since the intent
1504 is to provide the appearance of a single directory.
1506 Note that the \fIsubordinate\fP functionality is implemented internally
1507 by the \fIglue\fP overlay and as such its behavior will interact with other
1508 overlays in use. By default, the glue overlay is automatically configured as
1509 the last overlay on the superior backend. Its position on the backend
1510 can be explicitly configured by setting an \fBoverlay glue\fP directive
1511 at the desired position. This explicit configuration is necessary e.g.
1512 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1513 in order to work over all of the glued databases. E.g.
1517 suffix dc=example,dc=com
1525 .B syncrepl rid=<replica ID>
1526 .B provider=ldap[s]://<hostname>[:port]
1527 .B searchbase=<base DN>
1528 .B [type=refreshOnly|refreshAndPersist]
1529 .B [interval=dd:hh:mm:ss]
1530 .B [retry=[<retry interval> <# of retries>]+]
1531 .B [filter=<filter str>]
1532 .B [scope=sub|one|base|subord]
1533 .B [attrs=<attr list>]
1535 .B [sizelimit=<limit>]
1536 .B [timelimit=<limit>]
1537 .B [schemachecking=on|off]
1538 .B [bindmethod=simple|sasl]
1540 .B [saslmech=<mech>]
1541 .B [authcid=<identity>]
1542 .B [authzid=<identity>]
1543 .B [credentials=<passwd>]
1545 .B [secprops=<properties>]
1546 .B [starttls=yes|critical]
1547 .B [tls_cert=<file>]
1549 .B [tls_cacert=<file>]
1550 .B [tls_cacertdir=<path>]
1551 .B [tls_reqcert=never|allow|try|demand]
1552 .B [tls_ciphersuite=<ciphers>]
1553 .B [tls_crlcheck=none|peer|all]
1554 .B [logbase=<base DN>]
1555 .B [logfilter=<filter str>]
1556 .B [syncdata=default|accesslog|changelog]
1558 Specify the current database as a replica which is kept up-to-date with the
1559 master content by establishing the current
1561 as a replication consumer site running a
1564 The replica content is kept synchronized to the master content using
1565 the LDAP Content Synchronization protocol. Refer to the
1566 "OpenLDAP Administrator's Guide" for detailed information on
1567 setting up a replicated
1569 directory service using the
1574 identifies the current
1576 directive within the replication consumer site.
1577 It is a non-negative integer having no more than three digits.
1580 specifies the replication provider site containing the master content
1581 as an LDAP URI. If <port> is not given, the standard LDAP port number
1582 (389 or 636) is used.
1586 replica is defined using a search
1587 specification as its result set. The consumer
1589 will send search requests to the provider
1591 according to the search specification. The search specification includes
1592 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1595 parameters as in the normal search specification.
1596 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1597 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1598 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1599 attributes, and \fBattrsonly\fP is unset by default.
1600 The \fBsizelimit\fP and \fBtimelimit\fP only
1601 accept "unlimited" and positive integers, and both default to "unlimited".
1602 Note, however, that any provider-side limits for the replication identity
1603 will be enforced by the provider regardless of the limits requested
1604 by the LDAP Content Synchronization operation, much like for any other
1607 The LDAP Content Synchronization protocol has two operation types.
1610 operation, the next synchronization search operation
1611 is periodically rescheduled at an interval time (specified by
1613 parameter; 1 day by default)
1614 after each synchronization operation finishes.
1616 .B refreshAndPersist
1617 operation, a synchronization search remains persistent in the provider slapd.
1618 Further updates to the master replica will generate
1619 .B searchResultEntry
1620 to the consumer slapd as the search responses to the persistent
1621 synchronization search.
1623 If an error occurs during replication, the consumer will attempt to
1624 reconnect according to the
1626 parameter which is a list of the <retry interval> and <# of retries> pairs.
1627 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1628 for the first 10 times and then retry every 300 seconds for the next 3
1629 times before stop retrying. The `+' in <# of retries> means indefinite
1630 number of retries until success.
1632 The schema checking can be enforced at the LDAP Sync
1633 consumer site by turning on the
1635 parameter. The default is off.
1641 requires the options
1645 and should only be used when adequate security services
1646 (e.g. TLS or IPSEC) are in place.
1647 .B REMEMBER: simple bind credentials must be in cleartext!
1654 Depending on the mechanism, an authentication identity and/or
1655 credentials can be specified using
1661 parameter may be used to specify an authorization identity.
1662 Specific security properties (as with the
1664 keyword above) for a SASL bind can be set with the
1666 option. A non default SASL realm can be set with the
1669 The provider, other than allow authentication of the syncrepl identity,
1670 should grant that identity appropriate access privileges to the data
1671 that is being replicated (\fBaccess\fP directive), and appropriate time
1672 and size limits (\fBlimits\fP directive).
1677 parameter specifies use of the StartTLS extended operation
1678 to establish a TLS session before Binding to the provider. If the
1680 argument is supplied, the session will be aborted if the StartTLS request
1681 fails. Otherwise the syncrepl session continues without TLS. The
1682 tls_reqcert setting defaults to "demand" and the other TLS settings
1683 default to the same as the main slapd TLS settings.
1685 Rather than replicating whole entries, the consumer can query logs of
1686 data modifications. This mode of operation is referred to as \fIdelta
1687 syncrepl\fP. In addition to the above parameters, the
1691 parameters must be set appropriately for the log that will be used. The
1693 parameter must be set to either "accesslog" if the log conforms to the
1694 .BR slapo-accesslog (5)
1695 log format, or "changelog" if the log conforms
1696 to the obsolete \fIchangelog\fP format. If the
1698 parameter is omitted or set to "default" then the log parameters are
1703 This option is only applicable in a slave
1705 It specifies the DN permitted to update (subject to access controls)
1706 the replica. It is only needed in certain push-mode
1707 replication scenarios. Generally, this DN
1714 Specify the referral to pass back when
1716 is asked to modify a replicated local database.
1717 If specified multiple times, each url is provided.
1719 .SH DATABASE-SPECIFIC OPTIONS
1720 Each database may allow specific configuration options; they are
1721 documented separately in the backends' manual pages. See the
1722 .BR slapd.backends (5)
1723 manual page for an overview of available backends.
1726 Here is a short example of a configuration file:
1730 include SYSCONFDIR/schema/core.schema
1731 pidfile LOCALSTATEDIR/run/slapd.pid
1733 # Subtypes of "name" (e.g. "cn" and "ou") with the
1734 # option ";x-hidden" can be searched for/compared,
1735 # but are not shown. See \fBslapd.access\fP(5).
1736 attributeoptions x-hidden lang-
1737 access to attrs=name;x-hidden by * =cs
1739 # Protect passwords. See \fBslapd.access\fP(5).
1740 access to attrs=userPassword by * auth
1741 # Read access to other attributes and entries.
1742 access to * by * read
1745 suffix "dc=our-domain,dc=com"
1746 # The database directory MUST exist prior to
1747 # running slapd AND should only be accessible
1748 # by the slapd/tools. Mode 0700 recommended.
1749 directory LOCALSTATEDIR/openldap-data
1750 # Indices to maintain
1751 index objectClass eq
1752 index cn,sn,mail pres,eq,approx,sub
1754 # We serve small clients that do not handle referrals,
1755 # so handle remote lookups on their behalf.
1758 uri ldap://ldap.some-server.com/
1763 "OpenLDAP Administrator's Guide" contains a longer annotated
1764 example of a configuration file.
1765 The original ETCDIR/slapd.conf is another example.
1769 default slapd configuration file
1772 .BR slapd\-config (5),
1773 .BR slapd.access (5),
1774 .BR slapd.backends (5),
1775 .BR slapd.overlays (5),
1776 .BR slapd.plugin (5),
1777 .BR slapd.replog (5),
1788 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1789 .SH ACKNOWLEDGEMENTS
projects / openldap / blob