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.
754 The root DSE is an entry with information about the server and its
755 capabilities, in operational attributes.
756 It has the empty DN, and can be read with e.g.:
758 ldapsearch -x -b "" -s base "+"
760 See RFC 4512 section 5.1 for details.
763 Used to specify the fully qualified domain name used for SASL processing.
765 .B sasl-realm <realm>
766 Specify SASL realm. Default is empty.
768 .B sasl-secprops <properties>
769 Used to specify Cyrus SASL security properties.
772 flag (without any other properties) causes the flag properties
773 default, "noanonymous,noplain", to be cleared.
776 flag disables mechanisms susceptible to simple passive attacks.
779 flag disables mechanisms susceptible to active attacks.
782 flag disables mechanisms susceptible to passive dictionary attacks.
785 flag disables mechanisms which support anonymous login.
788 flag require forward secrecy between sessions.
791 require mechanisms which pass client credentials (and allow
792 mechanisms which can pass credentials to do so).
795 property specifies the minimum acceptable
796 .I security strength factor
797 as an integer approximate to effective key length used for
798 encryption. 0 (zero) implies no protection, 1 implies integrity
799 protection only, 56 allows DES or other weak ciphers, 112
800 allows triple DES and other strong ciphers, 128 allows RC4,
801 Blowfish and other modern strong ciphers. The default is 0.
804 property specifies the maximum acceptable
805 .I security strength factor
806 as an integer (see minssf description). The default is INT_MAX.
809 property specifies the maximum security layer receive buffer
810 size allowed. 0 disables security layers. The default is 65536.
813 Specify the distinguished name for the subschema subentry that
814 controls the entries on this server. The default is "cn=Subschema".
816 .B security <factors>
817 Specify a set of security strength factors (separated by white space)
821 option for a description of security strength factors).
822 The directive may be specified globally and/or per-database.
824 specifies the overall security strength factor.
826 specifies the transport security strength factor.
828 specifies the TLS security strength factor.
830 specifies the SASL security strength factor.
832 specifies the overall security strength factor to require for
834 .B update_transport=<n>
835 specifies the transport security strength factor to require for
838 specifies the TLS security strength factor to require for
841 specifies the SASL security strength factor to require for
844 specifies the security strength factor required for
846 username/password authentication.
849 factor is measure of security provided by the underlying transport,
850 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
852 .B serverID <integer> [<URL>]
853 Specify an integer ID from 0 to 4095 for this server. These IDs are
854 required when using multimaster replication and each master must have a
855 unique ID. If the URL is provided, this directive may be specified
856 multiple times, providing a complete list of participating servers
857 and their IDs. The fully qualified hostname of each server should be
858 used in the supplied URLs. The IDs are used in the "replica id" field
859 of all CSNs generated by the specified server. The default value is zero.
866 .B sizelimit {<integer>|unlimited}
868 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
869 Specify the maximum number of entries to return from a search operation.
870 The default size limit is 500.
873 to specify no limits.
874 The second format allows a fine grain setting of the size limits.
875 Extra args can be added on the same line.
878 for an explanation of the different flags.
880 .B sockbuf_max_incoming <integer>
881 Specify the maximum incoming LDAP PDU size for anonymous sessions.
882 The default is 262143.
884 .B sockbuf_max_incoming_auth <integer>
885 Specify the maximum incoming LDAP PDU size for authenticated sessions.
886 The default is 4194303.
889 Specify the maximum size of the primary thread pool.
890 The default is 16; the minimum value is 2.
892 .B timelimit {<integer>|unlimited}
894 .B timelimit time[.{soft|hard}]=<integer> [...]
895 Specify the maximum number of seconds (in real time)
897 will spend answering a search request. The default time limit is 3600.
900 to specify no limits.
901 The second format allows a fine grain setting of the time limits.
902 Extra args can be added on the same line.
905 for an explanation of the different flags.
907 .B tool-threads <integer>
908 Specify the maximum number of threads to use in tool mode.
909 This should not be greater than the number of CPUs in the system.
911 .\"ucdata-path is obsolete / ignored...
913 .\".B ucdata-path <path>
914 .\"Specify the path to the directory containing the Unicode character
915 .\"tables. The default path is DATADIR/ucdata.
919 is built with support for Transport Layer Security, there are more options
922 .B TLSCipherSuite <cipher-suite-spec>
923 Permits configuring what ciphers will be accepted and the preference order.
924 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
926 TLSCipherSuite HIGH:MEDIUM:+SSLv2
928 To check what ciphers a given spec selects, use:
931 openssl ciphers -v <cipher-suite-spec>
934 To obtain the list of ciphers in GNUtls use:
941 .B TLSCACertificateFile <filename>
942 Specifies the file that contains certificates for all of the Certificate
947 .B TLSCACertificatePath <path>
948 Specifies the path of a directory that contains Certificate Authority
949 certificates in separate individual files. Usually only one of this
950 or the TLSCACertificateFile is used. This directive is not supported
953 .B TLSCertificateFile <filename>
954 Specifies the file that contains the
958 .B TLSCertificateKeyFile <filename>
959 Specifies the file that contains the
961 server private key that matches the certificate stored in the
962 .B TLSCertificateFile
963 file. Currently, the private key must not be protected with a password, so
964 it is of critical importance that it is protected carefully.
966 .B TLSDHParamFile <filename>
967 This directive specifies the file that contains parameters for Diffie-Hellman
968 ephemeral key exchange. This is required in order to use a DSA certificate on
969 the server. If multiple sets of parameters are present in the file, all of
970 them will be processed. Note that setting this option may also enable
971 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
972 You should append "!ADH" to your cipher suites if you have changed them
973 from the default, otherwise no certificate exchanges or verification will
974 be done. When using GNUtls these parameters are always generated randomly so
975 this directive is ignored.
977 .B TLSRandFile <filename>
978 Specifies the file to obtain random bits from when /dev/[u]random
979 is not available. Generally set to the name of the EGD/PRNGD socket.
980 The environment variable RANDFILE can also be used to specify the filename.
981 This directive is ignored with GNUtls.
983 .B TLSVerifyClient <level>
984 Specifies what checks to perform on client certificates in an
985 incoming TLS session, if any.
988 can be specified as one of the following keywords:
994 will not ask the client for a certificate.
997 The client certificate is requested. If no certificate is provided,
998 the session proceeds normally. If a bad certificate is provided,
999 it will be ignored and the session proceeds normally.
1002 The client certificate is requested. If no certificate is provided,
1003 the session proceeds normally. If a bad certificate is provided,
1004 the session is immediately terminated.
1006 .B demand | hard | true
1007 These keywords are all equivalent, for compatibility reasons.
1008 The client certificate is requested. If no certificate is provided,
1009 or a bad certificate is provided, the session is immediately terminated.
1011 Note that a valid client certificate is required in order to use the
1012 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1015 setting must be chosen to enable SASL EXTERNAL authentication.
1018 .B TLSCRLCheck <level>
1019 Specifies if the Certificate Revocation List (CRL) of the CA should be
1020 used to verify if the client certificates have not been revoked. This
1022 .B TLSCACertificatePath
1023 parameter to be set. This directive is ignored with GNUtls.
1025 can be specified as one of the following keywords:
1029 No CRL checks are performed
1032 Check the CRL of the peer certificate
1035 Check the CRL for a whole certificate chain
1038 .B TLSCRLFile <filename>
1039 Specifies a file containing a Certificate Revocation List to be used
1040 for verifying that certificates have not been revoked. This directive is
1041 only valid when using GNUtls.
1042 .SH GENERAL BACKEND OPTIONS
1043 Options in this section only apply to the configuration file section
1044 for the specified backend. They are supported by every
1047 .B backend <databasetype>
1048 Mark the beginning of a backend definition. <databasetype>
1066 depending on which backend will serve the database.
1068 .SH GENERAL DATABASE OPTIONS
1069 Options in this section only apply to the configuration file section
1070 for the database in which they are defined. They are supported by every
1071 type of backend. Note that the
1075 option are mandatory for each database.
1077 .B database <databasetype>
1078 Mark the beginning of a new database instance definition. <databasetype>
1096 depending on which backend will serve the database.
1099 Controls whether the database will be used to answer
1100 queries. A database that is hidden will never be
1101 selected to answer any queries, and any suffix configured
1102 on the database will be ignored in checks for conflicts
1103 with other databases. By default, hidden is off.
1108 will automatically maintain the
1109 modifiersName, modifyTimestamp, creatorsName, and
1110 createTimestamp attributes for entries. It also controls
1111 the entryCSN and entryUUID attributes, which are needed
1112 by the syncrepl provider. By default, lastmod is on.
1114 .B limits <who> <limit> [<limit> [...]]
1115 Specify time and size limits based on who initiated an operation.
1122 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1128 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1133 matches all unauthenticated clients.
1136 matches all authenticated clients;
1139 dn pattern is assumed unless otherwise specified by qualifying
1140 the (optional) key string
1146 (which are synonyms), to require an exact match; with
1148 to require exactly one level of depth match; with
1150 to allow any level of depth match, including the exact match; with
1152 to allow any level of depth match, not including the exact match;
1154 explicitly requires the (default) match based on POSIX (''extended'')
1155 regular expression pattern.
1158 matches unbound operations; the
1161 The same behavior is obtained by using the
1168 with the optional objectClass
1174 sets the limits for any DN listed in the values of the
1180 group objectClass (default
1182 whose DN exactly matches
1185 The currently supported limits are
1190 The syntax for time limits is
1191 .BR time[.{soft|hard}]=<integer> ,
1194 is the number of seconds slapd will spend answering a search request.
1195 If no time limit is explicitly requested by the client, the
1197 limit is used; if the requested time limit exceeds the
1200 .\".I "Administrative limit exceeded"
1201 .\"error is returned.
1202 limit, the value of the limit is used instead.
1205 limit is set to the keyword
1207 the soft limit is used in either case; if it is set to the keyword
1209 no hard limit is enforced.
1210 Explicit requests for time limits smaller or equal to the
1213 If no limit specifier is set, the value is assigned to the
1219 to preserve the original behavior.
1221 The syntax for size limits is
1222 .BR size[.{soft|hard|unchecked}]=<integer> ,
1225 is the maximum number of entries slapd will return answering a search
1227 If no size limit is explicitly requested by the client, the
1229 limit is used; if the requested size limit exceeds the
1232 .\".I "Administrative limit exceeded"
1233 .\"error is returned.
1234 limit, the value of the limit is used instead.
1237 limit is set to the keyword
1239 the soft limit is used in either case; if it is set to the keyword
1241 no hard limit is enforced.
1242 Explicit requests for size limits smaller or equal to the
1247 specifier sets a limit on the number of candidates a search request is allowed
1249 The rationale behind it is that searches for non-properly indexed
1250 attributes may result in large sets of candidates, which must be
1253 to determine whether they match the search filter or not.
1256 limit provides a means to drop such operations before they are even
1258 If the selected candidates exceed the
1260 limit, the search will abort with
1261 .IR "Unwilling to perform" .
1262 If it is set to the keyword
1264 no limit is applied (the default).
1267 the search is not even performed; this can be used to disallow searches
1268 for a specific set of users.
1269 If no limit specifier is set, the value is assigned to the
1275 to preserve the original behavior.
1277 In case of no match, the global limits are used.
1278 The default values are the same of
1287 control is requested, the
1289 size limit is used by default, because the request of a specific page size
1290 is considered an explicit request for a limitation on the number
1291 of entries to be returned.
1292 However, the size limit applies to the total count of entries returned within
1293 the search, and not to a single page.
1294 Additional size limits may be enforced; the syntax is
1295 .BR size.pr={<integer>|noEstimate|unlimited} ,
1298 is the max page size if no explicit limit is set; the keyword
1300 inhibits the server from returning an estimate of the total number
1301 of entries that might be returned
1302 (note: the current implementation does not return any estimate).
1305 indicates that no limit is applied to the pagedResults control page size.
1307 .B size.prtotal={<integer>|unlimited|disabled}
1308 allows to set a limit on the total number of entries that a pagedResults
1309 control allows to return.
1310 By default it is set to the
1315 is the max number of entries that the whole search with pagedResults control
1319 to allow unlimited number of entries to be returned, e.g. to allow
1320 the use of the pagedResults control as a means to circumvent size
1321 limitations on regular searches; the keyword
1323 disables the control, i.e. no paged results can be returned.
1324 Note that the total number of entries returned when the pagedResults control
1325 is requested cannot exceed the
1327 size limit of regular searches unless extended by the
1332 .B maxderefdepth <depth>
1333 Specifies the maximum number of aliases to dereference when trying to
1334 resolve an entry, used to avoid infinite alias loops. The default is 1.
1336 .B mirrormode on | off
1337 This option puts a replica database into "mirror" mode. Update
1338 operations will be accepted from any user, not just the updatedn. The
1339 database must already be configured as a syncrepl consumer
1340 before this keyword may be set. This mode also requires a
1342 (see above) to be configured.
1343 By default, mirrormode is off.
1345 .B overlay <overlay-name>
1346 Add the specified overlay to this database. An overlay is a piece of
1347 code that intercepts database operations in order to extend or change
1348 them. Overlays are pushed onto
1349 a stack over the database, and so they will execute in the reverse
1350 of the order in which they were configured and the database itself
1351 will receive control last of all. See the
1352 .BR slapd.overlays (5)
1353 manual page for an overview of the available overlays.
1354 Note that all of the database's
1355 regular settings should be configured before any overlay settings.
1357 .B readonly on | off
1358 This option puts the database into "read-only" mode. Any attempts to
1359 modify the database will return an "unwilling to perform" error. By
1360 default, readonly is off.
1363 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1364 .B [starttls=yes|critical]
1365 .B [suffix=<suffix> [...]]
1366 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1367 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1368 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1369 .B [attrs[!]=<attr list>]
1371 Specify a replication site for this database. Refer to the "OpenLDAP
1372 Administrator's Guide" for detailed information on setting up a replicated
1374 directory service. Zero or more
1376 instances can be used to select the subtrees that will be replicated
1377 (defaults to all the database).
1379 is deprecated in favor of the
1383 allows the replica LDAP server to be specified as an LDAP URI.
1388 requires the options
1392 and should only be used when adequate security services
1393 (e.g TLS or IPSEC) are in place. A
1399 Specific security properties (as with the
1401 keyword above) for a SASL bind can be set with the
1403 option. A non-default SASL realm can be set with the
1408 will use Kerberos, a kerberos instance should be given in
1412 can be given after the
1414 keyword to allow the selective replication of the listed attributes only;
1417 mark is used, the list is considered exclusive, i.e. the listed attributes
1419 If an objectClass is listed, all the related attributes
1420 are (are not) replicated.
1423 .B restrict <oplist>
1424 Specify a whitespace separated list of operations that are restricted.
1425 If defined inside a database specification, restrictions apply only
1426 to that database, otherwise they are global.
1427 Operations can be any of
1432 .BR extended[=<OID>] ,
1436 or the special pseudo-operations
1440 which respectively summarize read and write operations.
1448 keyword allows to indicate the OID of the specific operation
1452 Specify the distinguished name that is not subject to access control
1453 or administrative limit restrictions for operations on this database.
1454 This DN may or may not be associated with an entry. An empty root
1455 DN (the default) specifies no root access is to be granted. It is
1456 recommended that the rootdn only be specified when needed (such as
1457 when initially populating a database). If the rootdn is within
1458 a namingContext (suffix) of the database, a simple bind password
1459 may also be provided using the
1461 directive. Note that the rootdn is always needed when using syncrepl.
1463 .B rootpw <password>
1464 Specify a password (or hash of the password) for the rootdn. The
1465 password can only be set if the rootdn is within the namingContext
1466 (suffix) of the database.
1467 This option accepts all RFC 2307 userPassword formats known to
1470 description) as well as cleartext.
1472 may be used to generate a hash of a password. Cleartext
1473 and \fB{CRYPT}\fP passwords are not recommended. If empty
1474 (the default), authentication of the root DN is by other means
1475 (e.g. SASL). Use of SASL is encouraged.
1477 .B suffix <dn suffix>
1478 Specify the DN suffix of queries that will be passed to this
1479 backend database. Multiple suffix lines can be given and at least one is
1480 required for each database definition.
1481 If the suffix of one database is "inside" that of another, the database
1482 with the inner suffix must come first in the configuration file.
1484 .B subordinate [advertise]
1485 Specify that the current backend database is a subordinate of another
1486 backend database. A subordinate database may have only one suffix. This
1487 option may be used to glue multiple databases into a single namingContext.
1488 If the suffix of the current database is within the namingContext of a
1489 superior database, searches against the superior database will be
1490 propagated to the subordinate as well. All of the databases
1491 associated with a single namingContext should have identical rootdns.
1492 Behavior of other LDAP operations is unaffected by this setting. In
1493 particular, it is not possible to use moddn to move an entry from
1494 one subordinate to another subordinate within the namingContext.
1496 If the optional \fBadvertise\fP flag is supplied, the naming context of
1497 this database is advertised in the root DSE. The default is to hide this
1498 database context, so that only the superior context is visible.
1505 are used on the superior database, any glued subordinates that support
1506 these tools are opened as well.
1508 Databases that are glued together should usually be configured with the
1509 same indices (assuming they support indexing), even for attributes that
1510 only exist in some of these databases. In general, all of the glued
1511 databases should be configured as similarly as possible, since the intent
1512 is to provide the appearance of a single directory.
1514 Note that the \fIsubordinate\fP functionality is implemented internally
1515 by the \fIglue\fP overlay and as such its behavior will interact with other
1516 overlays in use. By default, the glue overlay is automatically configured as
1517 the last overlay on the superior backend. Its position on the backend
1518 can be explicitly configured by setting an \fBoverlay glue\fP directive
1519 at the desired position. This explicit configuration is necessary e.g.
1520 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1521 in order to work over all of the glued databases. E.g.
1525 suffix dc=example,dc=com
1533 .B syncrepl rid=<replica ID>
1534 .B provider=ldap[s]://<hostname>[:port]
1535 .B searchbase=<base DN>
1536 .B [type=refreshOnly|refreshAndPersist]
1537 .B [interval=dd:hh:mm:ss]
1538 .B [retry=[<retry interval> <# of retries>]+]
1539 .B [filter=<filter str>]
1540 .B [scope=sub|one|base|subord]
1541 .B [attrs=<attr list>]
1543 .B [sizelimit=<limit>]
1544 .B [timelimit=<limit>]
1545 .B [schemachecking=on|off]
1546 .B [bindmethod=simple|sasl]
1548 .B [saslmech=<mech>]
1549 .B [authcid=<identity>]
1550 .B [authzid=<identity>]
1551 .B [credentials=<passwd>]
1553 .B [secprops=<properties>]
1554 .B [starttls=yes|critical]
1555 .B [tls_cert=<file>]
1557 .B [tls_cacert=<file>]
1558 .B [tls_cacertdir=<path>]
1559 .B [tls_reqcert=never|allow|try|demand]
1560 .B [tls_ciphersuite=<ciphers>]
1561 .B [tls_crlcheck=none|peer|all]
1562 .B [logbase=<base DN>]
1563 .B [logfilter=<filter str>]
1564 .B [syncdata=default|accesslog|changelog]
1566 Specify the current database as a replica which is kept up-to-date with the
1567 master content by establishing the current
1569 as a replication consumer site running a
1572 The replica content is kept synchronized to the master content using
1573 the LDAP Content Synchronization protocol. Refer to the
1574 "OpenLDAP Administrator's Guide" for detailed information on
1575 setting up a replicated
1577 directory service using the
1582 identifies the current
1584 directive within the replication consumer site.
1585 It is a non-negative integer having no more than three digits.
1588 specifies the replication provider site containing the master content
1589 as an LDAP URI. If <port> is not given, the standard LDAP port number
1590 (389 or 636) is used.
1594 replica is defined using a search
1595 specification as its result set. The consumer
1597 will send search requests to the provider
1599 according to the search specification. The search specification includes
1600 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1603 parameters as in the normal search specification.
1604 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1605 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1606 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1607 attributes, and \fBattrsonly\fP is unset by default.
1608 The \fBsizelimit\fP and \fBtimelimit\fP only
1609 accept "unlimited" and positive integers, and both default to "unlimited".
1610 Note, however, that any provider-side limits for the replication identity
1611 will be enforced by the provider regardless of the limits requested
1612 by the LDAP Content Synchronization operation, much like for any other
1615 The LDAP Content Synchronization protocol has two operation types.
1618 operation, the next synchronization search operation
1619 is periodically rescheduled at an interval time (specified by
1621 parameter; 1 day by default)
1622 after each synchronization operation finishes.
1624 .B refreshAndPersist
1625 operation, a synchronization search remains persistent in the provider slapd.
1626 Further updates to the master replica will generate
1627 .B searchResultEntry
1628 to the consumer slapd as the search responses to the persistent
1629 synchronization search.
1631 If an error occurs during replication, the consumer will attempt to
1632 reconnect according to the
1634 parameter which is a list of the <retry interval> and <# of retries> pairs.
1635 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1636 for the first 10 times and then retry every 300 seconds for the next 3
1637 times before stop retrying. The `+' in <# of retries> means indefinite
1638 number of retries until success.
1640 The schema checking can be enforced at the LDAP Sync
1641 consumer site by turning on the
1643 parameter. The default is off.
1649 requires the options
1653 and should only be used when adequate security services
1654 (e.g. TLS or IPSEC) are in place.
1655 .B REMEMBER: simple bind credentials must be in cleartext!
1662 Depending on the mechanism, an authentication identity and/or
1663 credentials can be specified using
1669 parameter may be used to specify an authorization identity.
1670 Specific security properties (as with the
1672 keyword above) for a SASL bind can be set with the
1674 option. A non default SASL realm can be set with the
1677 The provider, other than allow authentication of the syncrepl identity,
1678 should grant that identity appropriate access privileges to the data
1679 that is being replicated (\fBaccess\fP directive), and appropriate time
1680 and size limits (\fBlimits\fP directive).
1685 parameter specifies use of the StartTLS extended operation
1686 to establish a TLS session before Binding to the provider. If the
1688 argument is supplied, the session will be aborted if the StartTLS request
1689 fails. Otherwise the syncrepl session continues without TLS. The
1690 tls_reqcert setting defaults to "demand" and the other TLS settings
1691 default to the same as the main slapd TLS settings.
1693 Rather than replicating whole entries, the consumer can query logs of
1694 data modifications. This mode of operation is referred to as \fIdelta
1695 syncrepl\fP. In addition to the above parameters, the
1699 parameters must be set appropriately for the log that will be used. The
1701 parameter must be set to either "accesslog" if the log conforms to the
1702 .BR slapo-accesslog (5)
1703 log format, or "changelog" if the log conforms
1704 to the obsolete \fIchangelog\fP format. If the
1706 parameter is omitted or set to "default" then the log parameters are
1711 This option is only applicable in a slave
1713 It specifies the DN permitted to update (subject to access controls)
1714 the replica. It is only needed in certain push-mode
1715 replication scenarios. Generally, this DN
1722 Specify the referral to pass back when
1724 is asked to modify a replicated local database.
1725 If specified multiple times, each url is provided.
1727 .SH DATABASE-SPECIFIC OPTIONS
1728 Each database may allow specific configuration options; they are
1729 documented separately in the backends' manual pages. See the
1730 .BR slapd.backends (5)
1731 manual page for an overview of available backends.
1734 Here is a short example of a configuration file:
1738 include SYSCONFDIR/schema/core.schema
1739 pidfile LOCALSTATEDIR/run/slapd.pid
1741 # Subtypes of "name" (e.g. "cn" and "ou") with the
1742 # option ";x-hidden" can be searched for/compared,
1743 # but are not shown. See \fBslapd.access\fP(5).
1744 attributeoptions x-hidden lang-
1745 access to attrs=name;x-hidden by * =cs
1747 # Protect passwords. See \fBslapd.access\fP(5).
1748 access to attrs=userPassword by * auth
1749 # Read access to other attributes and entries.
1750 access to * by * read
1753 suffix "dc=our-domain,dc=com"
1754 # The database directory MUST exist prior to
1755 # running slapd AND should only be accessible
1756 # by the slapd/tools. Mode 0700 recommended.
1757 directory LOCALSTATEDIR/openldap-data
1758 # Indices to maintain
1759 index objectClass eq
1760 index cn,sn,mail pres,eq,approx,sub
1762 # We serve small clients that do not handle referrals,
1763 # so handle remote lookups on their behalf.
1766 uri ldap://ldap.some-server.com/
1771 "OpenLDAP Administrator's Guide" contains a longer annotated
1772 example of a configuration file.
1773 The original ETCDIR/slapd.conf is another example.
1777 default slapd configuration file
1780 .BR slapd\-config (5),
1781 .BR slapd.access (5),
1782 .BR slapd.backends (5),
1783 .BR slapd.overlays (5),
1784 .BR slapd.plugin (5),
1785 .BR slapd.replog (5),
1796 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1797 .SH ACKNOWLEDGEMENTS
projects / openldap / blob