1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2006 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
16 replication daemon and by the SLAPD tools
28 file consists of a series of global configuration options that apply to
30 as a whole (including all backends), followed by zero or more database
31 backend definitions that contain information specific to a backend
33 The configuration options are case-insensitive;
34 their value, on a case by case basis, may be case-sensitive.
41 # comment - these options apply to every database
42 <global configuration options>
43 # first database definition & configuration options
44 database <backend 1 type>
45 <configuration options specific to backend 1>
46 # subsequent database definitions & configuration options
50 As many backend-specific sections as desired may be included. Global
51 options can be overridden in a backend (for options that appear more
52 than once, the last appearance in the
56 If a line begins with white space, it is considered a continuation
57 of the previous line. Blank lines and comment lines beginning with
58 a `#' character are ignored. Note: continuation lines are unwrapped
59 before comment processing is applied.
61 Arguments on configuration lines are separated by white space. If an
62 argument contains white space, the argument should be enclosed in
63 double quotes. If an argument contains a double quote (`"') or a
64 backslash character (`\\'), the character should be preceded by a
67 The specific configuration options available are discussed below in the
68 Global Configuration Options, General Backend Options, and General Database
69 Options. Backend-specific options are discussed in the
71 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
72 details on the slapd configuration file.
73 .SH GLOBAL CONFIGURATION OPTIONS
74 Options described in this section apply to all backends, unless specifically
75 overridden in a backend definition. Arguments that should be replaced by
76 actual text are shown in brackets <>.
78 .B access to <what> "[ by <who> <access> <control> ]+"
79 Grant access (specified by <access>) to a set of entries and/or
80 attributes (specified by <what>) by one or more requestors (specified
82 If no access controls are present, the default policy
83 allows anyone and everyone to read anything but restricts
84 updates to rootdn. (e.g., "access to * by * read").
85 The rootdn can always read and write EVERYTHING!
88 and the "OpenLDAP's Administrator's Guide" for details.
91 Specify a set of features (separated by white space) to
94 allows acceptance of LDAPv2 bind requests. Note that
96 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
98 allows anonymous bind when credentials are not empty (e.g.
101 allows unauthenticated (anonymous) bind when DN is not empty.
103 allows unauthenticated (anonymous) update operations to be processed
104 (subject to access controls and other administrative limits).
106 allows unauthenticated (anonymous) proxy authorization control to be processed
107 (subject to access controls, authorization and other administrative limits).
109 .B argsfile <filename>
110 The ( absolute ) name of a file that will hold the
112 server's command line options
113 if started without the debugging command line option.
115 .B attributeoptions [option-name]...
116 Define tagging attribute options or option tag/range prefixes.
117 Options must not end with `-', prefixes must end with `-'.
118 The `lang-' prefix is predefined.
121 directive, `lang-' will no longer be defined and you must specify it
122 explicitly if you want it defined.
124 An attribute description with a tagging option is a subtype of that
125 attribute description without the option.
126 Except for that, options defined this way have no special semantics.
127 Prefixes defined this way work like the `lang-' options:
128 They define a prefix for tagging options starting with the prefix.
129 That is, if you define the prefix `x-foo-', you can use the option
131 Furthermore, in a search or compare, a prefix or range name (with
132 a trailing `-') matches all options starting with that name, as well
133 as the option with the range name sans the trailing `-'.
134 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
136 RFC 4520 reserves options beginning with `x-' for private experiments.
137 Other options should be registered with IANA, see RFC 4520 section 3.5.
138 OpenLDAP also has the `binary' option built in, but this is a transfer
139 option, not a tagging option.
142 .B attributetype "(\ <oid>\
144 [DESC\ <description>]\
153 [NO\-USER\-MODIFICATION]\
154 [USAGE\ <attributeUsage>]\ )"
156 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
157 The slapd parser extends the RFC 4512 definition by allowing string
158 forms as well as numeric OIDs to be used for the attribute OID and
159 attribute syntax OID.
165 .B authz-policy <policy>
166 Used to specify which rules to use for Proxy Authorization. Proxy
167 authorization allows a client to authenticate to the server using one
168 user's credentials, but specify a different identity to use for authorization
169 and access control purposes. It essentially allows user A to login as user
170 B, using user A's password.
173 flag disables proxy authorization. This is the default setting.
176 flag will use rules in the
178 attribute of the authorization DN.
181 flag will use rules in the
183 attribute of the authentication DN.
186 flag, an alias for the deprecated value of
188 will allow any of the above, whatever succeeds first (checked in
194 flag requires both authorizations to succeed.
197 The rules are mechanisms to specify which identities are allowed
198 to perform proxy authorization.
201 attribute in an entry specifies which other users
202 are allowed to proxy login to this entry. The
205 an entry specifies which other users this user can authorize as. Use of
208 abused if users are allowed to write arbitrary values to this attribute.
211 attribute must be protected with ACLs such that
212 only privileged users can modify it.
219 or a set of identities; it can take three forms:
222 .B ldap:///<base>??[<scope>]?<filter>
225 .B dn[.<dnstyle>]:<pattern>
228 .B u[<mech>[<realm>]]:<pattern>
231 .B group[/objectClass[/attributeType]]:<pattern>
238 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
241 The first form is a valid LDAP
249 portions must be absent, so that the search occurs locally on either
255 with the optional style modifiers
261 for exact, onelevel, children and subtree matches, which cause
263 to be normalized according to the DN normalization rules, or the special
265 style, which causes the
267 to be treated as a POSIX (''extended'') regular expression, as
274 means any non-anonymous DN.
275 The third form is a SASL
277 with the optional fields
281 that allow to specify a SASL
283 and eventually a SASL
285 for those mechanisms that support one.
286 The need to allow the specification of a mechanism is still debated,
287 and users are strongly discouraged to rely on this possibility.
288 The fourth form is a group specification, consisting of the keyword
290 optionally followed by the specification of the group
296 is searched with base scope, and in case of match, the values of the
299 are searched for the asserted DN.
300 For backwards compatibility, if no identity type is provided, i.e. only
304 is assumed; as a consequence,
306 is subjected to DN normalization.
307 Since the interpretation of
311 can impact security, users are strongly encouraged
312 to explicitly set the type of identity specification that is being used.
313 A subset of these rules can be used as third arg in the
315 statement (see below); significantly, the
322 .B authz-regexp <match> <replace>
323 Used by the authentication framework to convert simple user names,
324 such as provided by SASL subsystem, to an LDAP DN used for
325 authorization purposes. Note that the resultant DN need not refer
326 to an existing entry to be considered valid. When an authorization
327 request is received from the SASL subsystem, the SASL
332 are taken, when available, and combined into a name of the form
336 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
339 This name is then compared against the
341 POSIX (''extended'') regular expression, and if the match is successful,
342 the name is replaced with the
344 string. If there are wildcard strings in the
346 regular expression that are enclosed in parenthesis, e.g.
352 then the portion of the name that matched the wildcard will be stored
353 in the numbered placeholder variable $1. If there are other wildcard strings
354 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
355 placeholders can then be used in the
360 .B UID=$1,OU=Accounts,DC=example,DC=com
363 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
365 If the latter, the server will use the URI to search its own database(s)
366 and, if the search returns exactly one entry, the name is
367 replaced by the DN of that entry. The LDAP URI must have no
368 hostport, attrs, or extensions components, but the filter is mandatory,
372 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
375 The protocol portion of the URI must be strictly
377 Note that this search is subject to access controls. Specifically,
378 the authentication identity must have "auth" access in the subject.
382 options can be given in the configuration file to allow for multiple matching
383 and replacement patterns. The matching patterns are checked in the order they
384 appear in the file, stopping at the first successful match.
387 .\"Because the plus sign + is a character recognized by the regular expression engine,
388 .\"and it will appear in names that include a REALM, be careful to escape the
389 .\"plus sign with a backslash \\+ to remove the character's special meaning.
392 .B concurrency <integer>
393 Specify a desired level of concurrency. Provided to the underlying
394 thread system as a hint. The default is not to provide any hint.
396 .B conn_max_pending <integer>
397 Specify the maximum number of pending requests for an anonymous session.
398 If requests are submitted faster than the server can process them, they
399 will be queued up to this limit. If the limit is exceeded, the session
400 is closed. The default is 100.
402 .B conn_max_pending_auth <integer>
403 Specify the maximum number of pending requests for an authenticated session.
406 .B defaultsearchbase <dn>
407 Specify a default search base to use when client submits a
408 non-base search request with an empty base DN.
409 Base scoped search requests with an empty base DN are not affected.
411 .B disallow <features>
412 Specify a set of features (separated by white space) to
413 disallow (default none).
415 disables acceptance of anonymous bind requests. Note that this setting
416 does not prohibit anonymous directory access (See "require authc").
418 disables simple (bind) authentication.
420 disables forcing session to anonymous status (see also
422 upon StartTLS operation receipt.
424 disallows the StartTLS operation if authenticated (see also
428 .B ditcontentrule "(\ <oid>\
430 [DESC\ <description>]\
437 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
438 The slapd parser extends the RFC 4512 definition by allowing string
439 forms as well as numeric OIDs to be used for the attribute OID and
440 attribute syntax OID.
446 .B gentlehup { on | off }
447 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
449 will stop listening for new connections, but will not close the
450 connections to the current clients. Future write operations return
451 unwilling-to-perform, though. Slapd terminates when all clients
452 have closed their connections (if they ever do), or \- as before \-
453 if it receives a SIGTERM signal. This can be useful if you wish to
454 terminate the server and start a new
457 .B with another database,
458 without disrupting the currently active clients.
459 The default is off. You may wish to use
461 along with this option.
463 .B idletimeout <integer>
464 Specify the number of seconds to wait before forcibly closing
465 an idle client connection. A idletimeout of 0 disables this
466 feature. The default is 0.
468 .B include <filename>
469 Read additional configuration information from the given file before
470 continuing with the next line of the current file.
472 .B index_substr_if_minlen <integer>
473 Specify the minimum length for subinitial and subfinal indices. An
474 attribute value must have at least this many characters in order to be
475 processed by the indexing functions. The default is 2.
477 .B index_substr_if_maxlen <integer>
478 Specify the maximum length for subinitial and subfinal indices. Only
479 this many characters of an attribute value will be processed by the
480 indexing functions; any excess characters are ignored. The default is 4.
482 .B index_substr_any_len <integer>
483 Specify the length used for subany indices. An attribute value must have
484 at least this many characters in order to be processed. Attribute values
485 longer than this length will be processed in segments of this length. The
486 default is 4. The subany index will also be used in subinitial and
487 subfinal index lookups when the filter string is longer than the
488 .I index_substr_if_maxlen
491 .B index_substr_any_step <integer>
492 Specify the steps used in subany index lookups. This value sets the offset
493 for the segments of a filter string that are processed for a subany index
494 lookup. The default is 2. For example, with the default values, a search
495 using this filter "cn=*abcdefgh*" would generate index lookups for
496 "abcd", "cdef", and "efgh".
498 .\"-- NEW_LOGGING option --
500 .\".B logfile <filename>
501 .\"Specify a file for recording debug log messages. By default these messages
502 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
503 .\"copies messages to both stderr and the logfile.
506 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
507 such as those to the ldapi:// listener. For a description of SSF values,
511 option description. The default is 71.
513 .B loglevel <integer> [...]
514 Specify the level at which debugging statements and operation
515 statistics should be syslogged (currently logged to the
517 LOG_LOCAL4 facility).
518 They must be considered subsystems rather than increasingly verbose
520 Some messages with higher priority are logged regardless
521 of the configured loglevel as soon as some logging is configured,
522 otherwise anything is logged at all.
523 Log levels are additive, and available levels are:
534 debug packet handling
538 heavy trace debugging (function args)
542 connection management
546 print out packets sent and received
550 search filter processing
554 configuration file processing
558 access control list processing
562 stats log connections/operations/results
566 stats log entries sent
570 print communication with shell backends
582 \"data indexing (unused)
590 only messages that get logged whatever log level is set
593 The desired log level can be input as a single integer that combines
594 the (ORed) desired levels, both in decimal or in hexadecimal notation,
595 as a list of integers (that are ORed internally),
596 or as a list of the names that are shown between brackets, such that
609 can be used as a shortcut to enable logging at all levels (equivalent to -1).
612 or the equivalent integer representation, causes those messages
613 that are logged regardless of the configured loglevel to be logged.
614 In fact, if no loglevel (or a 0 level) is defined, no logging occurs,
617 level is required to have high priority messages logged.
620 .B moduleload <filename>
621 Specify the name of a dynamically loadable module to load. The filename
622 may be an absolute path name or a simple filename. Non-absolute names
623 are searched for in the directories specified by the
625 option. This option and the
627 option are only usable if slapd was compiled with --enable-modules.
629 .B modulepath <pathspec>
630 Specify a list of directories to search for loadable modules. Typically
631 the path is colon-separated but this depends on the operating system.
634 .B objectclass "(\ <oid>\
636 [DESC\ <description>]\
639 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
640 [MUST\ <oids>] [MAY\ <oids>] )"
642 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
643 The slapd parser extends the RFC 4512 definition by allowing string
644 forms as well as numeric OIDs to be used for the object class OID.
648 description.) Object classes are "STRUCTURAL" by default.
651 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
652 Define a string name that equates to the given OID. The string can be used
653 in place of the numeric OID in objectclass and attribute definitions. The
654 name can also be used with a suffix of the form ":xx" in which case the
655 value "oid.xx" will be used.
657 .B password-hash <hash> [<hash>...]
658 This option configures one or more hashes to be used in generation of user
659 passwords stored in the userPassword attribute during processing of
660 LDAP Password Modify Extended Operations (RFC 3062).
661 The <hash> must be one of
675 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
680 use the MD5 algorithm (RFC 1321), the latter with a seed.
687 indicates that the new password should be
688 added to userPassword as clear text.
690 Note that this option does not alter the normal user applications
691 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
693 .B password\-crypt\-salt\-format <format>
694 Specify the format of the salt passed to
696 when generating {CRYPT} passwords (see
698 during processing of LDAP Password Modify Extended Operations (RFC 3062).
700 This string needs to be in
702 format and may include one (and only one) %s conversion.
703 This conversion will be substituted with a string of random
704 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
705 provides a two character salt and "$1$%.8s" tells some
706 versions of crypt(3) to use an MD5 algorithm and provides
707 8 random characters of salt. The default is "%s", which
708 provides 31 characters of salt.
710 .B pidfile <filename>
711 The ( absolute ) name of a file that will hold the
713 server's process ID ( see
715 ) if started without the debugging command line option.
718 Specify the referral to pass back when
720 cannot find a local database to handle a request.
721 If specified multiple times, each url is provided.
724 The ( absolute ) name of a file that will hold the
726 server's command line options
727 if started without the debugging command line option.
728 If it appears after a
730 directive, the args file is specific to the
732 instance that handles that replication log.
735 The ( absolute ) name of a file that will hold the
737 server's process ID ( see
739 ) if started without the debugging command line option.
740 If it appears after a
742 directive, the pid file is specific to the
744 instance that handles that replication log.
746 .B replicationinterval
747 The number of seconds
749 waits before checking the replogfile for changes.
750 If it appears after a
752 directive, the replication interval is specific to the
754 instance that handles that replication log.
756 .B require <conditions>
757 Specify a set of conditions (separated by white space) to
758 require (default none).
759 The directive may be specified globally and/or per-database;
760 databases inherit global conditions, so per-database specifications
763 requires bind operation prior to directory operations.
765 requires session to be using LDAP version 3.
767 requires authentication prior to directory operations.
769 requires SASL authentication prior to directory operations.
771 requires strong authentication prior to directory operations.
772 The strong keyword allows protected "simple" authentication
773 as well as SASL authentication.
775 may be used to require no conditions (useful to clear out globally
776 set conditions within a particular database); it must occur first
777 in the list of conditions.
779 .B reverse-lookup on | off
780 Enable/disable client name unverified reverse lookup (default is
782 if compiled with --enable-rlookups).
785 Specify the name of an LDIF(5) file containing user defined attributes
786 for the root DSE. These attributes are returned in addition to the
787 attributes normally produced by slapd.
790 Used to specify the fully qualified domain name used for SASL processing.
792 .B sasl-realm <realm>
793 Specify SASL realm. Default is empty.
795 .B sasl-secprops <properties>
796 Used to specify Cyrus SASL security properties.
799 flag (without any other properties) causes the flag properties
800 default, "noanonymous,noplain", to be cleared.
803 flag disables mechanisms susceptible to simple passive attacks.
806 flag disables mechanisms susceptible to active attacks.
809 flag disables mechanisms susceptible to passive dictionary attacks.
812 flag disables mechanisms which support anonymous login.
815 flag require forward secrecy between sessions.
818 require mechanisms which pass client credentials (and allow
819 mechanisms which can pass credentials to do so).
822 property specifies the minimum acceptable
823 .I security strength factor
824 as an integer approximate to effective key length used for
825 encryption. 0 (zero) implies no protection, 1 implies integrity
826 protection only, 56 allows DES or other weak ciphers, 112
827 allows triple DES and other strong ciphers, 128 allows RC4,
828 Blowfish and other modern strong ciphers. The default is 0.
831 property specifies the maximum acceptable
832 .I security strength factor
833 as an integer (see minssf description). The default is INT_MAX.
836 property specifies the maximum security layer receive buffer
837 size allowed. 0 disables security layers. The default is 65536.
840 Specify the distinguished name for the subschema subentry that
841 controls the entries on this server. The default is "cn=Subschema".
843 .B security <factors>
844 Specify a set of security strength factors (separated by white space)
848 option for a description of security strength factors).
849 The directive may be specified globally and/or per-database.
851 specifies the overall security strength factor.
853 specifies the transport security strength factor.
855 specifies the TLS security strength factor.
857 specifies the SASL security strength factor.
859 specifies the overall security strength factor to require for
861 .B update_transport=<n>
862 specifies the transport security strength factor to require for
865 specifies the TLS security strength factor to require for
868 specifies the SASL security strength factor to require for
871 specifies the security strength factor required for
873 username/password authentication.
876 factor is measure of security provided by the underlying transport,
877 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
879 .B sizelimit {<integer>|unlimited}
881 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
882 Specify the maximum number of entries to return from a search operation.
883 The default size limit is 500.
886 to specify no limits.
887 The second format allows a fine grain setting of the size limits.
888 Extra args can be added on the same line.
891 for an explanation of the different flags.
893 .B sockbuf_max_incoming <integer>
894 Specify the maximum incoming LDAP PDU size for anonymous sessions.
895 The default is 262143.
897 .B sockbuf_max_incoming_auth <integer>
898 Specify the maximum incoming LDAP PDU size for authenticated sessions.
899 The default is 4194303.
902 Specify the maximum size of the primary thread pool.
903 The default is 16; the minimum value is 2.
905 .B timelimit {<integer>|unlimited}
907 .B timelimit time[.{soft|hard}]=<integer> [...]
908 Specify the maximum number of seconds (in real time)
910 will spend answering a search request. The default time limit is 3600.
913 to specify no limits.
914 The second format allows a fine grain setting of the time limits.
915 Extra args can be added on the same line.
918 for an explanation of the different flags.
920 .B tool-threads <integer>
921 Specify the maximum number of threads to use in tool mode.
922 This should not be greater than the number of CPUs in the system.
924 .\"ucdata-path is obsolete / ignored...
926 .\".B ucdata-path <path>
927 .\"Specify the path to the directory containing the Unicode character
928 .\"tables. The default path is DATADIR/ucdata.
932 is built with support for Transport Layer Security, there are more options
935 .B TLSCipherSuite <cipher-suite-spec>
936 Permits configuring what ciphers will be accepted and the preference order.
937 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
939 TLSCipherSuite HIGH:MEDIUM:+SSLv2
941 To check what ciphers a given spec selects, use:
943 openssl ciphers -v <cipher-suite-spec>
945 .B TLSCACertificateFile <filename>
946 Specifies the file that contains certificates for all of the Certificate
951 .B TLSCACertificatePath <path>
952 Specifies the path of a directory that contains Certificate Authority
953 certificates in separate individual files. Usually only one of this
954 or the TLSCACertificateFile is used.
956 .B TLSCertificateFile <filename>
957 Specifies the file that contains the
961 .B TLSCertificateKeyFile <filename>
962 Specifies the file that contains the
964 server private key that matches the certificate stored in the
965 .B TLSCertificateFile
966 file. Currently, the private key must not be protected with a password, so
967 it is of critical importance that it is protected carefully.
969 .B TLSDHParamFile <filename>
970 This directive specifies the file that contains parameters for Diffie-Hellman
971 ephemeral key exchange. This is required in order to use a DSA certificate on
972 the server. If multiple sets of parameters are present in the file, all of
973 them will be processed. Note that setting this option may also enable
974 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
975 You should append "!ADH" to your cipher suites if you have changed them
976 from the default, otherwise no certificate exchanges or verification will
979 .B TLSRandFile <filename>
980 Specifies the file to obtain random bits from when /dev/[u]random
981 is not available. Generally set to the name of the EGD/PRNGD socket.
982 The environment variable RANDFILE can also be used to specify the filename.
984 .B TLSVerifyClient <level>
985 Specifies what checks to perform on client certificates in an
986 incoming TLS session, if any.
989 can be specified as one of the following keywords:
995 will not ask the client for a certificate.
998 The client certificate is requested. If no certificate is provided,
999 the session proceeds normally. If a bad certificate is provided,
1000 it will be ignored and the session proceeds normally.
1003 The client certificate is requested. If no certificate is provided,
1004 the session proceeds normally. If a bad certificate is provided,
1005 the session is immediately terminated.
1007 .B demand | hard | true
1008 These keywords are all equivalent, for compatibility reasons.
1009 The client certificate is requested. If no certificate is provided,
1010 or a bad certificate is provided, the session is immediately terminated.
1012 Note that a valid client certificate is required in order to use the
1013 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1016 setting must be chosen to enable SASL EXTERNAL authentication.
1019 .B TLSCRLCheck <level>
1020 Specifies if the Certificate Revocation List (CRL) of the CA should be
1021 used to verify if the client certificates have not been revoked. This
1023 .B TLSCACertificatePath
1024 parameter to be set.
1026 can be specified as one of the following keywords:
1030 No CRL checks are performed
1033 Check the CRL of the peer certificate
1036 Check the CRL for a whole certificate chain
1038 .SH GENERAL BACKEND OPTIONS
1039 Options in this section only apply to the configuration file section
1040 for the specified backend. They are supported by every
1043 .B backend <databasetype>
1044 Mark the beginning of a backend definition. <databasetype>
1062 depending on which backend will serve the database.
1064 .SH GENERAL DATABASE OPTIONS
1065 Options in this section only apply to the configuration file section
1066 for the database in which they are defined. They are supported by every
1067 type of backend. Note that the
1071 option are mandatory for each database.
1073 .B database <databasetype>
1074 Mark the beginning of a new database instance definition. <databasetype>
1092 depending on which backend will serve the database.
1097 will automatically maintain the
1098 modifiersName, modifyTimestamp, creatorsName, and
1099 createTimestamp attributes for entries. It also controls
1100 the entryCSN and entryUUID attributes, which are needed
1101 by the syncrepl provider. By default, lastmod is on.
1103 .B limits <who> <limit> [<limit> [...]]
1104 Specify time and size limits based on who initiated an operation.
1111 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1117 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1122 matches all unauthenticated clients.
1125 matches all authenticated clients;
1128 dn pattern is assumed unless otherwise specified by qualifying
1129 the (optional) key string
1135 (which are synonyms), to require an exact match; with
1137 to require exactly one level of depth match; with
1139 to allow any level of depth match, including the exact match; with
1141 to allow any level of depth match, not including the exact match;
1143 explicitly requires the (default) match based on POSIX (''extended'')
1144 regular expression pattern.
1147 matches unbound operations; the
1150 The same behavior is obtained by using the
1157 with the optional objectClass
1163 sets the limits for any DN listed in the values of the
1169 group objectClass (default
1171 whose DN exactly matches
1174 The currently supported limits are
1179 The syntax for time limits is
1180 .BR time[.{soft|hard}]=<integer> ,
1183 is the number of seconds slapd will spend answering a search request.
1184 If no time limit is explicitly requested by the client, the
1186 limit is used; if the requested time limit exceeds the
1189 .\".I "Administrative limit exceeded"
1190 .\"error is returned.
1191 limit, the value of the limit is used instead.
1194 limit is set to the keyword
1196 the soft limit is used in either case; if it is set to the keyword
1198 no hard limit is enforced.
1199 Explicit requests for time limits smaller or equal to the
1202 If no limit specifier is set, the value is assigned to the
1208 to preserve the original behavior.
1210 The syntax for size limits is
1211 .BR size[.{soft|hard|unchecked}]=<integer> ,
1214 is the maximum number of entries slapd will return answering a search
1216 If no size limit is explicitly requested by the client, the
1218 limit is used; if the requested size limit exceeds the
1221 .\".I "Administrative limit exceeded"
1222 .\"error is returned.
1223 limit, the value of the limit is used instead.
1226 limit is set to the keyword
1228 the soft limit is used in either case; if it is set to the keyword
1230 no hard limit is enforced.
1231 Explicit requests for size limits smaller or equal to the
1236 specifier sets a limit on the number of candidates a search request is allowed
1238 The rationale behind it is that searches for non-properly indexed
1239 attributes may result in large sets of candidates, which must be
1242 to determine whether they match the search filter or not.
1245 limit provides a means to drop such operations before they are even
1247 If the selected candidates exceed the
1249 limit, the search will abort with
1250 .IR "Unwilling to perform" .
1251 If it is set to the keyword
1253 no limit is applied (the default).
1256 the search is not even performed; this can be used to disallow searches
1257 for a specific set of users.
1258 If no limit specifier is set, the value is assigned to the
1264 to preserve the original behavior.
1266 In case of no match, the global limits are used.
1267 The default values are the same of
1276 control is requested, the
1278 size limit is used by default, because the request of a specific page size
1279 is considered an explicit request for a limitation on the number
1280 of entries to be returned.
1281 However, the size limit applies to the total count of entries returned within
1282 the search, and not to a single page.
1283 Additional size limits may be enforced; the syntax is
1284 .BR size.pr={<integer>|noEstimate|unlimited} ,
1287 is the max page size if no explicit limit is set; the keyword
1289 inhibits the server from returning an estimate of the total number
1290 of entries that might be returned
1291 (note: the current implementation does not return any estimate).
1294 indicates that no limit is applied to the pagedResults control page size.
1296 .B size.prtotal={<integer>|unlimited|disabled}
1297 allows to set a limit on the total number of entries that a pagedResults
1298 control allows to return.
1299 By default it is set to the
1304 is the max number of entries that the whole search with pagedResults control
1308 to allow unlimited number of entries to be returned, e.g. to allow
1309 the use of the pagedResults control as a means to circumvent size
1310 limitations on regular searches; the keyword
1312 disables the control, i.e. no paged results can be returned.
1313 Note that the total number of entries returned when the pagedResults control
1314 is requested cannot exceed the
1316 size limit of regular searches unless extended by the
1321 .B maxderefdepth <depth>
1322 Specifies the maximum number of aliases to dereference when trying to
1323 resolve an entry, used to avoid infinite alias loops. The default is 1.
1325 .B mirrormode on | off
1326 This option puts a replica database into "mirror" mode. Update
1327 operations will be accepted from any user, not just the updatedn. The
1328 database must already be configured as a slurpd or syncrepl consumer
1329 before this keyword may be set. This mode must be used with extreme
1330 care, as it does not offer any consistency guarantees.
1331 By default, mirrormode is off.
1333 .B overlay <overlay-name>
1334 Add the specified overlay to this database. An overlay is a piece of
1335 code that intercepts database operations in order to extend or change
1336 them. Overlays are pushed onto
1337 a stack over the database, and so they will execute in the reverse
1338 of the order in which they were configured and the database itself
1339 will receive control last of all.
1341 .B readonly on | off
1342 This option puts the database into "read-only" mode. Any attempts to
1343 modify the database will return an "unwilling to perform" error. By
1344 default, readonly is off.
1347 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1348 .B [starttls=yes|critical]
1349 .B [suffix=<suffix> [...]]
1350 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1351 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1352 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1353 .B [attrs[!]=<attr list>]
1355 Specify a replication site for this database. Refer to the "OpenLDAP
1356 Administrator's Guide" for detailed information on setting up a replicated
1358 directory service. Zero or more
1360 instances can be used to select the subtrees that will be replicated
1361 (defaults to all the database).
1363 is deprecated in favor of the
1367 allows the replica LDAP server to be specified as an LDAP URI.
1372 requires the options
1376 and should only be used when adequate security services
1377 (e.g TLS or IPSEC) are in place. A
1383 Specific security properties (as with the
1385 keyword above) for a SASL bind can be set with the
1387 option. A non-default SASL realm can be set with the
1392 will use Kerberos, a kerberos instance should be given in
1396 can be given after the
1398 keyword to allow the selective replication of the listed attributes only;
1401 mark is used, the list is considered exclusive, i.e. the listed attributes
1403 If an objectClass is listed, all the related attributes
1404 are (are not) replicated.
1407 .B replogfile <filename>
1408 Specify the name of the replication log file to log changes to.
1409 The replication log is typically written by
1414 .BR slapd.replog (5)
1415 for more information. The specified file should be located
1416 in a directory with limited read/write/execute access as the replication
1417 logs may contain sensitive information.
1419 .B restrict <oplist>
1420 Specify a whitespace separated list of operations that are restricted.
1421 If defined inside a database specification, restrictions apply only
1422 to that database, otherwise they are global.
1423 Operations can be any of
1428 .BR extended[=<OID>] ,
1432 or the special pseudo-operations
1436 which respectively summarize read and write operations.
1444 keyword allows to indicate the OID of the specific operation
1448 Specify the distinguished name that is not subject to access control
1449 or administrative limit restrictions for operations on this database.
1450 This DN may or may not be associated with an entry. An empty root
1451 DN (the default) specifies no root access is to be granted. It is
1452 recommended that the rootdn only be specified when needed (such as
1453 when initially populating a database). If the rootdn is within
1454 a namingContext (suffix) of the database, a simple bind password
1455 may also be provided using the
1457 directive. Note that the rootdn is always needed when using syncrepl.
1459 .B rootpw <password>
1460 Specify a password (or hash of the password) for the rootdn. The
1461 password can only be set if the rootdn is within the namingContext
1462 (suffix) of the database.
1463 This option accepts all RFC 2307 userPassword formats known to
1466 description) as well as cleartext.
1468 may be used to generate a hash of a password. Cleartext
1469 and \fB{CRYPT}\fP passwords are not recommended. If empty
1470 (the default), authentication of the root DN is by other means
1471 (e.g. SASL). Use of SASL is encouraged.
1473 .B suffix <dn suffix>
1474 Specify the DN suffix of queries that will be passed to this
1475 backend database. Multiple suffix lines can be given and at least one is
1476 required for each database definition.
1477 If the suffix of one database is "inside" that of another, the database
1478 with the inner suffix must come first in the configuration file.
1480 .B subordinate [advertise]
1481 Specify that the current backend database is a subordinate of another
1482 backend database. A subordinate database may have only one suffix. This
1483 option may be used to glue multiple databases into a single namingContext.
1484 If the suffix of the current database is within the namingContext of a
1485 superior database, searches against the superior database will be
1486 propagated to the subordinate as well. All of the databases
1487 associated with a single namingContext should have identical rootdns.
1488 Behavior of other LDAP operations is unaffected by this setting. In
1489 particular, it is not possible to use moddn to move an entry from
1490 one subordinate to another subordinate within the namingContext.
1492 If the optional \fBadvertise\fP flag is supplied, the naming context of
1493 this database is advertised in the root DSE. The default is to hide this
1494 database context, so that only the superior context is visible.
1501 are used on the superior database, any glued subordinates that support
1502 these tools are opened as well.
1504 Databases that are glued together should usually be configured with the
1505 same indices (assuming they support indexing), even for attributes that
1506 only exist in some of these databases. In general, all of the glued
1507 databases should be configured as similarly as possible, since the intent
1508 is to provide the appearance of a single directory.
1510 Note that the \fIsubordinate\fP functionality is implemented internally
1511 by the \fIglue\fP overlay and as such its behavior will interact with other
1512 overlays in use. By default, the glue overlay is automatically configured as
1513 the last overlay on the superior backend. Its position on the backend
1514 can be explicitly configured by setting an \fBoverlay glue\fP directive
1515 at the desired position. This explicit configuration is necessary e.g.
1516 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1517 in order to work over all of the glued databases. E.g.
1521 suffix dc=example,dc=com
1529 .B syncrepl rid=<replica ID>
1530 .B provider=ldap[s]://<hostname>[:port]
1531 .B searchbase=<base DN>
1532 .B [type=refreshOnly|refreshAndPersist]
1533 .B [interval=dd:hh:mm:ss]
1534 .B [retry=[<retry interval> <# of retries>]+]
1535 .B [filter=<filter str>]
1536 .B [scope=sub|one|base|subord]
1537 .B [attrs=<attr list>]
1539 .B [sizelimit=<limit>]
1540 .B [timelimit=<limit>]
1541 .B [schemachecking=on|off]
1542 .B [bindmethod=simple|sasl]
1544 .B [saslmech=<mech>]
1545 .B [authcid=<identity>]
1546 .B [authzid=<identity>]
1547 .B [credentials=<passwd>]
1549 .B [secprops=<properties>]
1550 .B [starttls=yes|critical]
1551 .B [tls_cert=<file>]
1553 .B [tls_cacert=<file>]
1554 .B [tls_cacertdir=<path>]
1555 .B [tls_reqcert=never|allow|try|demand]
1556 .B [tls_ciphersuite=<ciphers>]
1557 .B [tls_crlcheck=none|peer|all]
1558 .B [logbase=<base DN>]
1559 .B [logfilter=<filter str>]
1560 .B [syncdata=default|accesslog|changelog]
1562 Specify the current database as a replica which is kept up-to-date with the
1563 master content by establishing the current
1565 as a replication consumer site running a
1568 The replica content is kept synchronized to the master content using
1569 the LDAP Content Synchronization protocol. Refer to the
1570 "OpenLDAP Administrator's Guide" for detailed information on
1571 setting up a replicated
1573 directory service using the
1577 identifies the current
1579 directive within the replication consumer site.
1580 It is a non-negative integer having no more than three digits.
1582 specifies the replication provider site containing the master content
1583 as an LDAP URI. If <port> is not given, the standard LDAP port number
1584 (389 or 636) is used. The content of the
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 The LDAP Content Synchronization protocol has two operation types.
1605 operation, the next synchronization search operation
1606 is periodically rescheduled at an interval time (specified by
1608 parameter; 1 day by default)
1609 after each synchronization operation finishes.
1611 .B refreshAndPersist
1612 operation, a synchronization search remains persistent in the provider slapd.
1613 Further updates to the master replica will generate
1614 .B searchResultEntry
1615 to the consumer slapd as the search responses to the persistent
1616 synchronization search.
1617 If an error occurs during replication, the consumer will attempt to
1618 reconnect according to the
1620 parameter which is a list of the <retry interval> and <# of retries> pairs.
1621 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1622 for the first 10 times and then retry every 300 seconds for the next 3
1623 times before stop retrying. The `+' in <# of retries> means indefinite
1624 number of retries until success.
1625 The schema checking can be enforced at the LDAP Sync
1626 consumer site by turning on the
1628 parameter. The default is off.
1633 requires the options
1637 and should only be used when adequate security services
1638 (e.g. TLS or IPSEC) are in place.
1645 Depending on the mechanism, an authentication identity and/or
1646 credentials can be specified using
1652 parameter may be used to specify an authorization identity.
1653 Specific security properties (as with the
1655 keyword above) for a SASL bind can be set with the
1657 option. A non default SASL realm can be set with the
1663 parameter specifies use of the StartTLS extended operation
1664 to establish a TLS session before Binding to the provider. If the
1666 argument is supplied, the session will be aborted if the StartTLS request
1667 fails. Otherwise the syncrepl session continues without TLS. Note that the
1668 main slapd TLS settings are not used by the syncrepl engine;
1669 by default the TLS parameters from ETCDIR/ldap.conf will be used.
1670 TLS settings may be specified here, in which case the ldap.conf settings
1671 will be completely ignored.
1673 Rather than replicating whole entries, the consumer can query logs of
1674 data modifications. This mode of operation is referred to as \fIdelta
1675 syncrepl\fP. In addition to the above parameters, the
1679 parameters must be set appropriately for the log that will be used. The
1681 parameter must be set to either "accesslog" if the log conforms to the
1682 .BR slapo-accesslog (5)
1683 log format, or "changelog" if the log conforms
1684 to the obsolete \fIchangelog\fP format. If the
1686 parameter is omitted or set to "default" then the log parameters are
1691 This option is only applicable in a slave
1692 database updated using
1694 It specifies the DN permitted to update (subject to access controls)
1695 the replica (typically, this is the DN
1697 binds to update the replica). Generally, this DN
1704 Specify the referral to pass back when
1706 is asked to modify a replicated local database.
1707 If specified multiple times, each url is provided.
1709 .SH DATABASE-SPECIFIC OPTIONS
1710 Each database may allow specific configuration options; they are
1711 documented separately in the backends' manual pages.
1713 The following backends can be compiled into slapd.
1714 They are documented in the
1715 .BR slapd-<backend> (5)
1719 This is the recommended primary backend for a normal slapd database.
1720 It takes care to configure it properly.
1721 It uses the transactional database interface of the Sleepycat Berkeley
1722 DB (BDB) package to store data.
1725 This backend is used to manage the configuration of slapd run-time.
1728 This backend is experimental.
1729 It serves up referrals based upon SRV resource records held in the
1733 This is a variant of the BDB backend that uses a hierarchical database
1734 layout which supports subtree renames.
1737 This backend acts as a proxy to forward incoming requests to another
1741 This is an easy-to-configure but obsolete database backend. It
1742 does not offer the data durability features of the BDB and HDB
1743 backends and hence is deprecated in favor of these robust backends.
1744 LDBM uses lightweight non-transactional DB interfaces,
1745 such as those providing by GDBM or Berkeley DB, to store data.
1748 This database uses the filesystem to build the tree structure
1749 of the database, using plain ascii files to store data.
1750 Its usage should be limited to very simple databases, where performance
1751 is not a requirement.
1754 This backend performs basic LDAP proxying with respect to a set of
1755 remote LDAP servers. It is an enhancement of the ldap backend.
1758 This backend provides information about the running status of the slapd
1762 Operations in this backend succeed but do nothing.
1765 This backend is provided for demonstration purposes only.
1766 It serves up user account information from the system
1771 This backend embeds a
1773 interpreter into slapd.
1774 It runs Perl subroutines to implement LDAP operations.
1777 This backend is experimental.
1778 It redirects LDAP operations to another database
1779 in the same server, based on the naming context of the request.
1780 Its use requires the
1784 for details) to rewrite the naming context of the request.
1785 It is primarily intended to implement virtual views on databases
1786 that actually store data.
1789 This backend executes external programs to implement LDAP operations.
1790 It is primarily intended to be used in prototypes.
1793 This backend is experimental.
1794 It services LDAP requests from an SQL database.
1796 The following overlays can be compiled into slapd.
1797 They are documented in the
1798 .BR slapo-<overlay> (5)
1803 This overlay can record accesses to a given backend database on another
1808 This overlay records changes on a given backend database to an LDIF log
1810 By default it is not built.
1814 This overlay allows automatic referral chasing when a referral would
1815 have been returned, either when configured by the server or when
1816 requested by the client.
1820 This overlay allows selected operations to be denied, similar to the
1821 \fBrestrict\fP option.
1825 This is a demo overlay which extends the Compare operation to detect
1826 members of a dynamic group.
1827 It has no effect on any other operations.
1831 This overlay allows expansion of dynamic groups and more.
1835 This overlay maintains a service entry in the database with the DN,
1836 modification type, modifiersName and modifyTimestamp of the last write
1837 operation performed on that database.
1841 This overlay allows caching of LDAP search requests in a local database.
1842 It is most often used with the ldap or meta backends.
1846 This overlay provides a variety of password control mechanisms,
1847 e.g. password aging, password reuse and duplication control, mandatory
1848 password resets, etc.
1851 Referential Integrity.
1852 This overlay can be used with a backend database such as
1854 to maintain the cohesiveness of a schema which utilizes reference
1859 This overlay is useful to test the behavior of clients when
1860 server-generated erroneous and/or unusual responses occur.
1864 This overlay is experimental.
1865 It performs basic DN/data rewrite and
1866 objectClass/attributeType mapping.
1870 This overlay implements the provider-side support for
1872 replication, including persistent search functionality.
1876 This overlay can be used with a backend database such as
1878 to create a "translucent proxy".
1879 Content of entries retrieved from a remote LDAP server can be partially
1880 overridden by the database.
1883 Attribute Uniqueness.
1884 This overlay can be used with a backend database such as
1886 to enforce the uniqueness of some or all attributes within a subtree.
1889 Here is a short example of a configuration file:
1893 include SYSCONFDIR/schema/core.schema
1894 pidfile LOCALSTATEDIR/slapd.pid
1896 # Subtypes of "name" (e.g. "cn" and "ou") with the
1897 # option ";x-hidden" can be searched for/compared,
1898 # but are not shown. See \fBslapd.access\fP(5).
1899 attributeoptions x-hidden lang-
1900 access to attrs=name;x-hidden by * =cs
1902 # Protect passwords. See \fBslapd.access\fP(5).
1903 access to attrs=userPassword by * auth
1904 # Read access to other attributes and entries.
1905 access to * by * read
1908 suffix "dc=our-domain,dc=com"
1909 # The database directory MUST exist prior to
1910 # running slapd AND should only be accessible
1911 # by the slapd/tools. Mode 0700 recommended.
1912 directory LOCALSTATEDIR/openldap-data
1913 # Indices to maintain
1914 index objectClass eq
1915 index cn,sn,mail pres,eq,approx,sub
1917 # We serve small clients that do not handle referrals,
1918 # so handle remote lookups on their behalf.
1921 uri ldap://ldap.some-server.com/
1926 "OpenLDAP Administrator's Guide" contains a longer annotated
1927 example of a configuration file.
1928 The original ETCDIR/slapd.conf is another example.
1932 default slapd configuration file
1936 .BR slapd\-dnssrv (5),
1938 .BR slapd\-ldap (5),
1939 .BR slapd\-ldbm (5),
1940 .BR slapd\-ldif (5),
1941 .BR slapd\-meta (5),
1942 .BR slapd\-monitor (5),
1943 .BR slapd\-null (5),
1944 .BR slapd\-passwd (5),
1945 .BR slapd\-perl (5),
1946 .BR slapd\-relay (5),
1947 .BR slapd\-shell (5),
1949 .BR slapd.access (5),
1950 .BR slapd.plugin (5),
1951 .BR slapd.replog (5),
1963 Known overlays are documented in
1964 .BR slapo\-accesslog (5),
1965 .BR slapo\-auditlog (5),
1966 .BR slapo\-chain (5),
1967 .BR slapo\-dynlist (5),
1968 .BR slapo\-lastmod (5),
1969 .BR slapo\-pcache (5),
1970 .BR slapo\-ppolicy (5),
1971 .BR slapo\-refint (5),
1972 .BR slapo\-retcode (5),
1974 .BR slapo\-syncprov (5),
1975 .BR slapo\-translucent (5),
1976 .BR slapo\-unique (5).
1978 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1979 .SH ACKNOWLEDGEMENTS
1981 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1983 is derived from University of Michigan LDAP 3.3 Release.