1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2008 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 .B argsfile <filename>
107 The ( absolute ) name of a file that will hold the
109 server's command line options
110 if started without the debugging command line option.
112 .B attributeoptions [option-name]...
113 Define tagging attribute options or option tag/range prefixes.
114 Options must not end with `-', prefixes must end with `-'.
115 The `lang-' prefix is predefined.
118 directive, `lang-' will no longer be defined and you must specify it
119 explicitly if you want it defined.
121 An attribute description with a tagging option is a subtype of that
122 attribute description without the option.
123 Except for that, options defined this way have no special semantics.
124 Prefixes defined this way work like the `lang-' options:
125 They define a prefix for tagging options starting with the prefix.
126 That is, if you define the prefix `x-foo-', you can use the option
128 Furthermore, in a search or compare, a prefix or range name (with
129 a trailing `-') matches all options starting with that name, as well
130 as the option with the range name sans the trailing `-'.
131 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
133 RFC 4520 reserves options beginning with `x-' for private experiments.
134 Other options should be registered with IANA, see RFC 4520 section 3.5.
135 OpenLDAP also has the `binary' option built in, but this is a transfer
136 option, not a tagging option.
139 .B attributetype "(\ <oid>\
141 [DESC\ <description>]\
150 [NO\-USER\-MODIFICATION]\
151 [USAGE\ <attributeUsage>]\ )"
153 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
154 The slapd parser extends the RFC 4512 definition by allowing string
155 forms as well as numeric OIDs to be used for the attribute OID and
156 attribute syntax OID.
162 .B authz-policy <policy>
163 Used to specify which rules to use for Proxy Authorization. Proxy
164 authorization allows a client to authenticate to the server using one
165 user's credentials, but specify a different identity to use for authorization
166 and access control purposes. It essentially allows user A to login as user
167 B, using user A's password.
170 flag disables proxy authorization. This is the default setting.
173 flag will use rules in the
175 attribute of the authorization DN.
178 flag will use rules in the
180 attribute of the authentication DN.
183 flag, an alias for the deprecated value of
185 will allow any of the above, whatever succeeds first (checked in
191 flag requires both authorizations to succeed.
194 The rules are mechanisms to specify which identities are allowed
195 to perform proxy authorization.
198 attribute in an entry specifies which other users
199 are allowed to proxy login to this entry. The
202 an entry specifies which other users this user can authorize as. Use of
205 abused if users are allowed to write arbitrary values to this attribute.
208 attribute must be protected with ACLs such that
209 only privileged users can modify it.
216 or a set of identities; it can take five forms:
219 .B ldap:///<base>??[<scope>]?<filter>
222 .B dn[.<dnstyle>]:<pattern>
225 .B u[<mech>[<realm>]]:<pattern>
228 .B group[/objectClass[/attributeType]]:<pattern>
235 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
238 The first form is a valid LDAP
246 portions must be absent, so that the search occurs locally on either
252 with the optional style modifiers
258 for exact, onelevel, children and subtree matches, which cause
260 to be normalized according to the DN normalization rules, or the special
262 style, which causes the
264 to be treated as a POSIX (''extended'') regular expression, as
271 means any non-anonymous DN.
272 The third form is a SASL
274 with the optional fields
278 that allow to specify a SASL
280 and eventually a SASL
282 for those mechanisms that support one.
283 The need to allow the specification of a mechanism is still debated,
284 and users are strongly discouraged to rely on this possibility.
285 The fourth form is a group specification, consisting of the keyword
287 optionally followed by the specification of the group
293 is searched with base scope, and in case of match, the values of the
296 are searched for the asserted DN.
297 For backwards compatibility, if no identity type is provided, i.e. only
301 is assumed; as a consequence,
303 is subjected to DN normalization.
304 Since the interpretation of
308 can impact security, users are strongly encouraged
309 to explicitly set the type of identity specification that is being used.
310 A subset of these rules can be used as third arg in the
312 statement (see below); significantly, the
319 .B authz-regexp <match> <replace>
320 Used by the authentication framework to convert simple user names,
321 such as provided by SASL subsystem, to an LDAP DN used for
322 authorization purposes. Note that the resultant DN need not refer
323 to an existing entry to be considered valid. When an authorization
324 request is received from the SASL subsystem, the SASL
329 are taken, when available, and combined into a name of the form
333 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
336 This name is then compared against the
338 POSIX (''extended'') regular expression, and if the match is successful,
339 the name is replaced with the
341 string. If there are wildcard strings in the
343 regular expression that are enclosed in parenthesis, e.g.
349 then the portion of the name that matched the wildcard will be stored
350 in the numbered placeholder variable $1. If there are other wildcard strings
351 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
352 placeholders can then be used in the
357 .B UID=$1,OU=Accounts,DC=example,DC=com
360 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
362 If the latter, the server will use the URI to search its own database(s)
363 and, if the search returns exactly one entry, the name is
364 replaced by the DN of that entry. The LDAP URI must have no
365 hostport, attrs, or extensions components, but the filter is mandatory,
369 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
372 The protocol portion of the URI must be strictly
374 Note that this search is subject to access controls. Specifically,
375 the authentication identity must have "auth" access in the subject.
379 options can be given in the configuration file to allow for multiple matching
380 and replacement patterns. The matching patterns are checked in the order they
381 appear in the file, stopping at the first successful match.
384 .\"Because the plus sign + is a character recognized by the regular expression engine,
385 .\"and it will appear in names that include a REALM, be careful to escape the
386 .\"plus sign with a backslash \\+ to remove the character's special meaning.
389 .B concurrency <integer>
390 Specify a desired level of concurrency. Provided to the underlying
391 thread system as a hint. The default is not to provide any hint.
393 .B conn_max_pending <integer>
394 Specify the maximum number of pending requests for an anonymous session.
395 If requests are submitted faster than the server can process them, they
396 will be queued up to this limit. If the limit is exceeded, the session
397 is closed. The default is 100.
399 .B conn_max_pending_auth <integer>
400 Specify the maximum number of pending requests for an authenticated session.
403 .B defaultsearchbase <dn>
404 Specify a default search base to use when client submits a
405 non-base search request with an empty base DN.
406 Base scoped search requests with an empty base DN are not affected.
408 .B disallow <features>
409 Specify a set of features (separated by white space) to
410 disallow (default none).
412 disables acceptance of anonymous bind requests. Note that this setting
413 does not prohibit anonymous directory access (See "require authc").
415 disables simple (bind) authentication.
417 disables forcing session to anonymous status (see also
418 .BR tls_authc ) upon StartTLS operation receipt.
420 disallow the StartTLS operation if authenticated (see also
424 .B ditcontentrule "(\ <oid>\
426 [DESC\ <description>]\
433 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
434 The slapd parser extends the RFC 4512 definition by allowing string
435 forms as well as numeric OIDs to be used for the attribute OID and
436 attribute syntax OID.
442 .B gentlehup { on | off }
443 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
445 will stop listening for new connections, but will not close the
446 connections to the current clients. Future write operations return
447 unwilling-to-perform, though. Slapd terminates when all clients
448 have closed their connections (if they ever do), or \- as before \-
449 if it receives a SIGTERM signal. This can be useful if you wish to
450 terminate the server and start a new
453 .B with another database,
454 without disrupting the currently active clients.
455 The default is off. You may wish to use
457 along with this option.
459 .B idletimeout <integer>
460 Specify the number of seconds to wait before forcibly closing
461 an idle client connection. A idletimeout of 0 disables this
462 feature. The default is 0.
464 .B include <filename>
465 Read additional configuration information from the given file before
466 continuing with the next line of the current file.
468 .B index_substr_if_minlen <integer>
469 Specify the minimum length for subinitial and subfinal indices. An
470 attribute value must have at least this many characters in order to be
471 processed by the indexing functions. The default is 2.
473 .B index_substr_if_maxlen <integer>
474 Specify the maximum length for subinitial and subfinal indices. Only
475 this many characters of an attribute value will be processed by the
476 indexing functions; any excess characters are ignored. The default is 4.
478 .B index_substr_any_len <integer>
479 Specify the length used for subany indices. An attribute value must have
480 at least this many characters in order to be processed. Attribute values
481 longer than this length will be processed in segments of this length. The
482 default is 4. The subany index will also be used in subinitial and
483 subfinal index lookups when the filter string is longer than the
484 .I index_substr_if_maxlen
487 .B index_substr_any_step <integer>
488 Specify the steps used in subany index lookups. This value sets the offset
489 for the segments of a filter string that are processed for a subany index
490 lookup. The default is 2. For example, with the default values, a search
491 using this filter "cn=*abcdefgh*" would generate index lookups for
492 "abcd", "cdef", and "efgh".
494 .\"-- NEW_LOGGING option --
496 .\".B logfile <filename>
497 .\"Specify a file for recording debug log messages. By default these messages
498 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
499 .\"copies messages to both stderr and the logfile.
502 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
503 such as those to the ldapi:// listener. For a description of SSF values,
507 option description. The default is 71.
509 .B loglevel <integer> [...]
510 Specify the level at which debugging statements and operation
511 statistics should be syslogged (currently logged to the
513 LOG_LOCAL4 facility).
514 They must be considered subsystems rather than increasingly verbose
516 Some messages with higher priority are logged regardless
517 of the configured loglevel as soon as some logging is configured,
518 otherwise anything is logged at all.
519 Log levels are additive, and available levels are:
530 debug packet handling
534 heavy trace debugging (function args)
538 connection management
542 print out packets sent and received
546 search filter processing
550 configuration file processing
554 access control list processing
558 stats log connections/operations/results
562 stats log entries sent
566 print communication with shell backends
578 data indexing (unused)
586 only messages that get logged whatever log level is set
589 The desired log level can be input as a single integer that combines
590 the (ORed) desired levels, both in decimal or in hexadecimal notation,
591 as a list of integers (that are ORed internally),
592 or as a list of the names that are shown between brackets, such that
605 can be used as a shortcut to enable logging at all levels (equivalent to -1).
608 or the equivalent integer representation, causes those messages
609 that are logged regardless of the configured loglevel to be logged.
610 In fact, if loglevel is set to 0, no logging occurs,
613 level is required to have high priority messages logged.
614 The loglevel defaults to \fBstats\fP.
617 .B moduleload <filename>
618 Specify the name of a dynamically loadable module to load. The filename
619 may be an absolute path name or a simple filename. Non-absolute names
620 are searched for in the directories specified by the
622 option. This option and the
624 option are only usable if slapd was compiled with --enable-modules.
626 .B modulepath <pathspec>
627 Specify a list of directories to search for loadable modules. Typically
628 the path is colon-separated but this depends on the operating system.
631 .B objectclass "(\ <oid>\
633 [DESC\ <description>]\
636 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
637 [MUST\ <oids>] [MAY\ <oids>] )"
639 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
640 The slapd parser extends the RFC 4512 definition by allowing string
641 forms as well as numeric OIDs to be used for the object class OID.
645 description.) Object classes are "STRUCTURAL" by default.
648 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
649 Define a string name that equates to the given OID. The string can be used
650 in place of the numeric OID in objectclass and attribute definitions. The
651 name can also be used with a suffix of the form ":xx" in which case the
652 value "oid.xx" will be used.
654 .B password-hash <hash> [<hash>...]
655 This option configures one or more hashes to be used in generation of user
656 passwords stored in the userPassword attribute during processing of
657 LDAP Password Modify Extended Operations (RFC 3062).
658 The <hash> must be one of
672 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
677 use the MD5 algorithm (RFC 1321), the latter with a seed.
684 indicates that the new password should be
685 added to userPassword as clear text.
687 Note that this option does not alter the normal user applications
688 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
690 .B password\-crypt\-salt\-format <format>
691 Specify the format of the salt passed to
693 when generating {CRYPT} passwords (see
695 during processing of LDAP Password Modify Extended Operations (RFC 3062).
697 This string needs to be in
699 format and may include one (and only one) %s conversion.
700 This conversion will be substituted with a string of random
701 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
702 provides a two character salt and "$1$%.8s" tells some
703 versions of crypt(3) to use an MD5 algorithm and provides
704 8 random characters of salt. The default is "%s", which
705 provides 31 characters of salt.
707 .B pidfile <filename>
708 The ( absolute ) name of a file that will hold the
710 server's process ID ( see
712 ) if started without the debugging command line option.
715 Specify the referral to pass back when
717 cannot find a local database to handle a request.
718 If specified multiple times, each url is provided.
721 The ( absolute ) name of a file that will hold the
723 server's command line options
724 if started without the debugging command line option.
727 The ( absolute ) name of a file that will hold the
729 server's process ID ( see
731 ) if started without the debugging command line option.
733 .B replicationinterval
734 The number of seconds
736 waits before checking the replogfile for changes.
738 .B require <conditions>
739 Specify a set of conditions (separated by white space) to
740 require (default none).
741 The directive may be specified globally and/or per-database;
742 databases inherit global conditions, so per-database specifications
745 requires bind operation prior to directory operations.
747 requires session to be using LDAP version 3.
749 requires authentication prior to directory operations.
751 requires SASL authentication prior to directory operations.
753 requires strong authentication prior to directory operations.
754 The strong keyword allows protected "simple" authentication
755 as well as SASL authentication.
757 may be used to require no conditions (useful to clear out globally
758 set conditions within a particular database); it must occur first
759 in the list of conditions.
761 .B reverse-lookup on | off
762 Enable/disable client name unverified reverse lookup (default is
764 if compiled with --enable-rlookups).
767 Specify the name of an LDIF(5) file containing user defined attributes
768 for the root DSE. These attributes are returned in addition to the
769 attributes normally produced by slapd.
772 Used to specify the fully qualified domain name used for SASL processing.
774 .B sasl-realm <realm>
775 Specify SASL realm. Default is empty.
777 .B sasl-secprops <properties>
778 Used to specify Cyrus SASL security properties.
781 flag (without any other properties) causes the flag properties
782 default, "noanonymous,noplain", to be cleared.
785 flag disables mechanisms susceptible to simple passive attacks.
788 flag disables mechanisms susceptible to active attacks.
791 flag disables mechanisms susceptible to passive dictionary attacks.
794 flag disables mechanisms which support anonymous login.
797 flag require forward secrecy between sessions.
800 require mechanisms which pass client credentials (and allow
801 mechanisms which can pass credentials to do so).
804 property specifies the minimum acceptable
805 .I security strength factor
806 as an integer approximate to effective key length used for
807 encryption. 0 (zero) implies no protection, 1 implies integrity
808 protection only, 56 allows DES or other weak ciphers, 112
809 allows triple DES and other strong ciphers, 128 allows RC4,
810 Blowfish and other modern strong ciphers. The default is 0.
813 property specifies the maximum acceptable
814 .I security strength factor
815 as an integer (see minssf description). The default is INT_MAX.
818 property specifies the maximum security layer receive buffer
819 size allowed. 0 disables security layers. The default is 65536.
822 Specify the distinguished name for the subschema subentry that
823 controls the entries on this server. The default is "cn=Subschema".
825 .B security <factors>
826 Specify a set of security strength factors (separated by white space)
830 option for a description of security strength factors).
831 The directive may be specified globally and/or per-database.
833 specifies the overall security strength factor.
835 specifies the transport security strength factor.
837 specifies the TLS security strength factor.
839 specifies the SASL security strength factor.
841 specifies the overall security strength factor to require for
843 .B update_transport=<n>
844 specifies the transport security strength factor to require for
847 specifies the TLS security strength factor to require for
850 specifies the SASL security strength factor to require for
853 specifies the security strength factor required for
855 username/password authentication.
858 factor is measure of security provided by the underlying transport,
859 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
861 .B sizelimit {<integer>|unlimited}
863 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
864 Specify the maximum number of entries to return from a search operation.
865 The default size limit is 500.
868 to specify no limits.
869 The second format allows a fine grain setting of the size limits.
870 Extra args can be added on the same line.
873 for an explanation of the different flags.
875 .B sockbuf_max_incoming <integer>
876 Specify the maximum incoming LDAP PDU size for anonymous sessions.
877 The default is 262143.
879 .B sockbuf_max_incoming_auth <integer>
880 Specify the maximum incoming LDAP PDU size for authenticated sessions.
881 The default is 4194303.
884 Specify the maximum size of the primary thread pool.
885 The default is 16; the minimum value is 2.
887 .B timelimit {<integer>|unlimited}
889 .B timelimit time[.{soft|hard}]=<integer> [...]
890 Specify the maximum number of seconds (in real time)
892 will spend answering a search request. The default time limit is 3600.
895 to specify no limits.
896 The second format allows a fine grain setting of the time limits.
897 Extra args can be added on the same line.
900 for an explanation of the different flags.
902 .B tool-threads <integer>
903 Specify the maximum number of threads to use in tool mode.
904 This should not be greater than the number of CPUs in the system.
906 .\"ucdata-path is obsolete / ignored...
908 .\".B ucdata-path <path>
909 .\"Specify the path to the directory containing the Unicode character
910 .\"tables. The default path is DATADIR/ucdata.
914 is built with support for Transport Layer Security, there are more options
917 .B TLSCipherSuite <cipher-suite-spec>
918 Permits configuring what ciphers will be accepted and the preference order.
919 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
921 TLSCipherSuite HIGH:MEDIUM:+SSLv2
923 To check what ciphers a given spec selects, use:
925 openssl ciphers -v <cipher-suite-spec>
927 .B TLSCACertificateFile <filename>
928 Specifies the file that contains certificates for all of the Certificate
933 .B TLSCACertificatePath <path>
934 Specifies the path of a directory that contains Certificate Authority
935 certificates in separate individual files. Usually only one of this
936 or the TLSCACertificateFile is used.
938 .B TLSCertificateFile <filename>
939 Specifies the file that contains the
943 .B TLSCertificateKeyFile <filename>
944 Specifies the file that contains the
946 server private key that matches the certificate stored in the
947 .B TLSCertificateFile
948 file. Currently, the private key must not be protected with a password, so
949 it is of critical importance that it is protected carefully.
951 .B TLSDHParamFile <filename>
952 This directive specifies the file that contains parameters for Diffie-Hellman
953 ephemeral key exchange. This is required in order to use a DSA certificate on
954 the server. If multiple sets of parameters are present in the file, all of
955 them will be processed. Note that setting this option may also enable
956 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
957 You should append "!ADH" to your cipher suites if you have changed them
958 from the default, otherwise no certificate exchanges or verification will
961 .B TLSRandFile <filename>
962 Specifies the file to obtain random bits from when /dev/[u]random
963 is not available. Generally set to the name of the EGD/PRNGD socket.
964 The environment variable RANDFILE can also be used to specify the filename.
966 .B TLSVerifyClient <level>
967 Specifies what checks to perform on client certificates in an
968 incoming TLS session, if any.
971 can be specified as one of the following keywords:
977 will not ask the client for a certificate.
980 The client certificate is requested. If no certificate is provided,
981 the session proceeds normally. If a bad certificate is provided,
982 it will be ignored and the session proceeds normally.
985 The client certificate is requested. If no certificate is provided,
986 the session proceeds normally. If a bad certificate is provided,
987 the session is immediately terminated.
989 .B demand | hard | true
990 These keywords are all equivalent, for compatibility reasons.
991 The client certificate is requested. If no certificate is provided,
992 or a bad certificate is provided, the session is immediately terminated.
994 Note that a valid client certificate is required in order to use the
995 SASL EXTERNAL authentication mechanism with a TLS session. As such,
998 setting must be chosen to enable SASL EXTERNAL authentication.
1001 .B TLSCRLCheck <level>
1002 Specifies if the Certificate Revocation List (CRL) of the CA should be
1003 used to verify if the client certificates have not been revoked. This
1005 .B TLSCACertificatePath
1006 parameter to be set.
1008 can be specified as one of the following keywords:
1012 No CRL checks are performed
1015 Check the CRL of the peer certificate
1018 Check the CRL for a whole certificate chain
1020 .SH GENERAL BACKEND OPTIONS
1021 Options in this section only apply to the configuration file section
1022 for the specified backend. They are supported by every
1025 .B backend <databasetype>
1026 Mark the beginning of a backend definition. <databasetype>
1044 depending on which backend will serve the database.
1046 .SH GENERAL DATABASE OPTIONS
1047 Options in this section only apply to the configuration file section
1048 for the database in which they are defined. They are supported by every
1049 type of backend. Note that the
1053 option are mandatory for each database.
1055 .B database <databasetype>
1056 Mark the beginning of a new database instance definition. <databasetype>
1074 depending on which backend will serve the database.
1079 will automatically maintain the
1080 modifiersName, modifyTimestamp, creatorsName, and
1081 createTimestamp attributes for entries. It also controls
1082 the entryCSN and entryUUID attributes, which are needed
1083 by the syncrepl provider. By default, lastmod is on.
1085 .B limits <who> <limit> [<limit> [...]]
1086 Specify time and size limits based on who initiated an operation.
1093 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1099 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1104 matches all unauthenticated clients.
1107 matches all authenticated clients;
1110 dn pattern is assumed unless otherwise specified by qualifying
1111 the (optional) key string
1117 (which are synonyms), to require an exact match; with
1119 to require exactly one level of depth match; with
1121 to allow any level of depth match, including the exact match; with
1123 to allow any level of depth match, not including the exact match;
1125 explicitly requires the (default) match based on POSIX (''extended'')
1126 regular expression pattern.
1129 matches unbound operations; the
1132 The same behavior is obtained by using the
1139 with the optional objectClass
1145 sets the limits for any DN listed in the values of the
1151 group objectClass (default
1153 whose DN exactly matches
1156 The currently supported limits are
1161 The syntax for time limits is
1162 .BR time[.{soft|hard}]=<integer> ,
1165 is the number of seconds slapd will spend answering a search request.
1166 If no time limit is explicitly requested by the client, the
1168 limit is used; if the requested time limit exceeds the
1171 .\".I "Administrative limit exceeded"
1172 .\"error is returned.
1173 limit, the value of the limit is used instead.
1176 limit is set to the keyword
1178 the soft limit is used in either case; if it is set to the keyword
1180 no hard limit is enforced.
1181 Explicit requests for time limits smaller or equal to the
1184 If no limit specifier is set, the value is assigned to the
1190 to preserve the original behavior.
1192 The syntax for size limits is
1193 .BR size[.{soft|hard|unchecked}]=<integer> ,
1196 is the maximum number of entries slapd will return answering a search
1198 If no size limit is explicitly requested by the client, the
1200 limit is used; if the requested size limit exceeds the
1203 .\".I "Administrative limit exceeded"
1204 .\"error is returned.
1205 limit, the value of the limit is used instead.
1208 limit is set to the keyword
1210 the soft limit is used in either case; if it is set to the keyword
1212 no hard limit is enforced.
1213 Explicit requests for size limits smaller or equal to the
1218 specifier sets a limit on the number of candidates a search request is allowed
1220 The rationale behind it is that searches for non-properly indexed
1221 attributes may result in large sets of candidates, which must be
1224 to determine whether they match the search filter or not.
1227 limit provides a means to drop such operations before they are even
1229 If the selected candidates exceed the
1231 limit, the search will abort with
1232 .IR "Unwilling to perform" .
1233 If it is set to the keyword
1235 no limit is applied (the default).
1238 the search is not even performed; this can be used to disallow searches
1239 for a specific set of users.
1240 If no limit specifier is set, the value is assigned to the
1246 to preserve the original behavior.
1248 In case of no match, the global limits are used.
1249 The default values are the same of
1258 control is requested, the
1260 size limit is used by default, because the request of a specific page size
1261 is considered an explicit request for a limitation on the number
1262 of entries to be returned.
1263 However, the size limit applies to the total count of entries returned within
1264 the search, and not to a single page.
1265 Additional size limits may be enforced; the syntax is
1266 .BR size.pr={<integer>|noEstimate|unlimited} ,
1269 is the max page size if no explicit limit is set; the keyword
1271 inhibits the server from returning an estimate of the total number
1272 of entries that might be returned
1273 (note: the current implementation does not return any estimate).
1276 indicates that no limit is applied to the pagedResults control page size.
1278 .B size.prtotal={<integer>|unlimited|disabled}
1279 allows to set a limit on the total number of entries that a pagedResults
1280 control allows to return.
1281 By default it is set to the
1286 is the max number of entries that the whole search with pagedResults control
1290 to allow unlimited number of entries to be returned, e.g. to allow
1291 the use of the pagedResults control as a means to circumvent size
1292 limitations on regular searches; the keyword
1294 disables the control, i.e. no paged results can be returned.
1295 Note that the total number of entries returned when the pagedResults control
1296 is requested cannot exceed the
1298 size limit of regular searches unless extended by the
1302 The \fBlimits\fP statement is typically used to let an unlimited
1303 number of entries to be returned by searches performed
1304 with the identity used by the consumer for synchronization purposes
1305 by means of the RFC 4533 LDAP Content Synchronization protocol
1306 (see \fBsyncrepl\fP for details).
1309 .B maxderefdepth <depth>
1310 Specifies the maximum number of aliases to dereference when trying to
1311 resolve an entry, used to avoid infinite alias loops. The default is 15.
1313 .B overlay <overlay-name>
1314 Add the specified overlay to this database. An overlay is a piece of
1315 code that intercepts database operations in order to extend or change
1316 them. Overlays are pushed onto
1317 a stack over the database, and so they will execute in the reverse
1318 of the order in which they were configured and the database itself
1319 will receive control last of all. Note that all of the database's
1320 regular settings should be configured before any overlay settings.
1322 .B readonly on | off
1323 This option puts the database into "read-only" mode. Any attempts to
1324 modify the database will return an "unwilling to perform" error. By
1325 default, readonly is off.
1328 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1329 .B [starttls=yes|critical]
1330 .B [suffix=<suffix> [...]]
1331 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1332 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1333 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1334 .B [attr[!]=<attr list>]
1336 Specify a replication site for this database. Refer to the "OpenLDAP
1337 Administrator's Guide" for detailed information on setting up a replicated
1339 directory service. Zero or more
1341 instances can be used to select the subtrees that will be replicated
1342 (defaults to all the database).
1344 is deprecated in favor of the
1348 allows the replica LDAP server to be specified as an LDAP URI.
1353 requires the options
1357 and should only be used when adequate security services
1358 (e.g TLS or IPSEC) are in place. A
1364 Specific security properties (as with the
1366 keyword above) for a SASL bind can be set with the
1368 option. A non-default SASL realm can be set with the
1373 will use Kerberos, a kerberos instance should be given in
1377 can be given after the
1379 keyword to allow the selective replication of the listed attributes only;
1382 mark is used, the list is considered exclusive, i.e. the listed attributes
1384 If an objectClass is listed, all the related attributes
1385 are (are not) replicated.
1388 .B replogfile <filename>
1389 Specify the name of the replication log file to log changes to.
1390 The replication log is typically written by
1395 .BR slapd.replog (5)
1396 for more information. The specified file should be located
1397 in a directory with limited read/write/execute access as the replication
1398 logs may contain sensitive information.
1400 .B restrict <oplist>
1401 Specify a whitespace separated list of operations that are restricted.
1402 If defined inside a database specification, restrictions apply only
1403 to that database, otherwise they are global.
1404 Operations can be any of
1409 .BR extended[=<OID>] ,
1413 or the special pseudo-operations
1417 which respectively summarize read and write operations.
1425 keyword allows to indicate the OID of the specific operation
1429 Specify the distinguished name that is not subject to access control
1430 or administrative limit restrictions for operations on this database.
1431 This DN may or may not be associated with an entry. An empty root
1432 DN (the default) specifies no root access is to be granted. It is
1433 recommended that the rootdn only be specified when needed (such as
1434 when initially populating a database). If the rootdn is within
1435 a namingContext (suffix) of the database, a simple bind password
1436 may also be provided using the
1438 directive. Many optional features, including syncrepl, require the
1439 rootdn to be defined for the database.
1441 .B rootpw <password>
1442 Specify a password (or hash of the password) for the rootdn. The
1443 password can only be set if the rootdn is within the namingContext
1444 (suffix) of the database.
1445 This option accepts all RFC 2307 userPassword formats known to
1448 description) as well as cleartext.
1450 may be used to generate a hash of a password. Cleartext
1451 and \fB{CRYPT}\fP passwords are not recommended. If empty
1452 (the default), authentication of the root DN is by other means
1453 (e.g. SASL). Use of SASL is encouraged.
1455 .B suffix <dn suffix>
1456 Specify the DN suffix of queries that will be passed to this
1457 backend database. Multiple suffix lines can be given and at least one is
1458 required for each database definition.
1459 If the suffix of one database is "inside" that of another, the database
1460 with the inner suffix must come first in the configuration file.
1462 .B subordinate [advertise]
1463 Specify that the current backend database is a subordinate of another
1464 backend database. A subordinate database may have only one suffix. This
1465 option may be used to glue multiple databases into a single namingContext.
1466 If the suffix of the current database is within the namingContext of a
1467 superior database, searches against the superior database will be
1468 propagated to the subordinate as well. All of the databases
1469 associated with a single namingContext should have identical rootdns.
1470 Behavior of other LDAP operations is unaffected by this setting. In
1471 particular, it is not possible to use moddn to move an entry from
1472 one subordinate to another subordinate within the namingContext.
1474 If the optional \fBadvertise\fP flag is supplied, the naming context of
1475 this database is advertised in the root DSE. The default is to hide this
1476 database context, so that only the superior context is visible.
1483 are used on the superior database, any glued subordinates that support
1484 these tools are opened as well.
1486 Databases that are glued together should usually be configured with the
1487 same indices (assuming they support indexing), even for attributes that
1488 only exist in some of these databases. In general, all of the glued
1489 databases should be configured as similarly as possible, since the intent
1490 is to provide the appearance of a single directory.
1492 Note that the \fIsubordinate\fP functionality is implemented internally
1493 by the \fIglue\fP overlay and as such its behavior will interact with other
1494 overlays in use. By default, the glue overlay is automatically configured as
1495 the last overlay on the superior backend. Its position on the backend
1496 can be explicitly configured by setting an \fBoverlay glue\fP directive
1497 at the desired position. This explicit configuration is necessary e.g.
1498 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1499 in order to work over all of the glued databases. E.g.
1503 suffix dc=example,dc=com
1511 .B syncrepl rid=<replica ID>
1512 .B provider=ldap[s]://<hostname>[:port]
1513 .B [type=refreshOnly|refreshAndPersist]
1514 .B [interval=dd:hh:mm:ss]
1515 .B [retry=[<retry interval> <# of retries>]+]
1516 .B searchbase=<base DN>
1517 .B [filter=<filter str>]
1518 .B [scope=sub|one|base]
1519 .B [attrs=<attr list>]
1521 .B [sizelimit=<limit>]
1522 .B [timelimit=<limit>]
1523 .B [schemachecking=on|off]
1524 .B [starttls=yes|critical]
1525 .B [bindmethod=simple|sasl]
1527 .B [saslmech=<mech>]
1528 .B [authcid=<identity>]
1529 .B [authzid=<identity>]
1530 .B [credentials=<passwd>]
1532 .B [secprops=<properties>]
1533 .B [logbase=<base DN>]
1534 .B [logfilter=<filter str>]
1535 .B [syncdata=default|accesslog|changelog]
1537 Specify the current database as a replica which is kept up-to-date with the
1538 master content by establishing the current
1540 as a replication consumer site running a
1543 The replica content is kept synchronized to the master content using
1544 the LDAP Content Synchronization protocol. Refer to the
1545 "OpenLDAP Administrator's Guide" for detailed information on
1546 setting up a replicated
1548 directory service using the
1552 identifies the current
1554 directive within the replication consumer site.
1555 It is a non-negative integer having no more than three digits.
1557 specifies the replication provider site containing the master content
1558 as an LDAP URI. If <port> is not given, the standard LDAP port number
1559 (389 or 636) is used.
1563 replica is defined using a search
1564 specification as its result set. The consumer
1566 will send search requests to the provider
1568 according to the search specification. The search specification includes
1569 .BR searchbase ", " scope ", " filter ", " attrs ", " attrsonly ", " sizelimit ", "
1572 parameters as in the normal search specification.
1573 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1574 \fB(objectclass=*)\fP, while there is no default \fBsearchbase\fP. The
1575 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1576 attributes, and \fBattrsonly\fP is unset by default.
1577 The \fBsizelimit\fP and \fBtimelimit\fP only
1578 accept "unlimited" and positive integers, and both default to "unlimited".
1579 The \fBsizelimit\fP parameter defines a consumer requested limitation
1580 on the number of entries that can be returned by the search; as such,
1581 it is intended to implement partial replication based on the size
1582 of the replicated database.
1584 The LDAP Content Synchronization protocol has two operation types.
1587 operation, the next synchronization search operation
1588 is periodically rescheduled at an interval time (specified by
1590 parameter; 1 day by default)
1591 after each synchronization operation finishes.
1593 .B refreshAndPersist
1594 operation, a synchronization search remains persistent in the provider slapd.
1595 Further updates to the master replica will generate
1596 .B searchResultEntry
1597 to the consumer slapd as the search responses to the persistent
1598 synchronization search.
1599 If an error occurs during replication, the consumer will attempt to
1600 reconnect according to the
1602 parameter which is a list of the <retry interval> and <# of retries> pairs.
1603 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1604 for the first 10 times and then retry every 300 seconds for the next 3
1605 times before stop retrying. The `+' in <# of retries> means indefinite
1606 number of retries until success.
1608 The schema checking can be enforced at the LDAP Sync
1609 consumer site by turning on the
1611 parameter. The default is \fBoff\fP.
1612 Schema checking \fBon\fP means that replicated entries must have
1613 a structural objectClass, must obey to objectClass requirements
1614 in terms of required/allowed attributes, and that naming attributes
1615 and distinguished values must be present.
1616 As a consequence, schema checking should be \fBoff\fP when partial
1617 replication is used.
1621 parameter specifies use of the StartTLS extended operation
1622 to establish a TLS session before Binding to the provider. If the
1623 StartTLS request fails and the
1625 argument was used, the session will be aborted. Otherwise the syncrepl
1626 session continues without TLS.
1632 requires the options
1636 and should only be used when adequate security services
1637 (e.g. TLS or IPSEC) are in place.
1638 .B REMEMBER: simple bind credentials must be in cleartext!
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
1660 The identity used for synchronization by the consumer should be allowed
1661 to receive an unlimited number of entries in response to a search request;
1662 this can be accomplished by either allowing unlimited \fBsizelimit\fP
1663 or by setting an appropriate \fBlimits\fP statement in the consumer's
1664 configuration (see \fBsizelimit\fP and \fBlimits\fP for details).
1666 Rather than replicating whole entries, the consumer can query logs of
1667 data modifications. This mode of operation is referred to as \fIdelta
1668 syncrepl\fP. In addition to the above parameters, the
1672 parameters must be set appropriately for the log that will be used. The
1674 parameter must be set to either "accesslog" if the log conforms to the
1675 .BR slapo-accesslog (5)
1676 log format, or "changelog" if the log conforms
1677 to the obsolete \fIchangelog\fP format. If the
1679 parameter is omitted or set to "default" then the log parameters are
1684 This option is only applicable in a slave
1685 database updated using
1687 It specifies the DN permitted to update (subject to access controls)
1688 the replica (typically, this is the DN
1690 binds to update the replica). Generally, this DN
1697 Specify the referral to pass back when
1699 is asked to modify a replicated local database.
1700 If specified multiple times, each url is provided.
1702 .SH DATABASE-SPECIFIC OPTIONS
1703 Each database may allow specific configuration options; they are
1704 documented separately in the backends' manual pages.
1706 The following backends can be compiled into slapd.
1707 They are documented in the
1708 .BR slapd-<backend> (5)
1712 This is the recommended primary backend for a normal slapd database.
1713 It takes care to configure it properly.
1714 It uses the transactional database interface of the Oracle Berkeley
1715 DB (BDB) package to store data.
1718 This backend is used to manage the configuration of slapd run-time.
1721 This backend is experimental.
1722 It serves up referrals based upon SRV resource records held in the
1726 This is a variant of the BDB backend that uses a hierarchical database
1727 layout which supports subtree renames.
1730 This backend acts as a proxy to forward incoming requests to another
1734 This is an easy-to-configure but obsolete database backend. It
1735 does not offer the data durability features of the BDB and HDB
1736 backends and hence is deprecated in favor of these robust backends.
1737 LDBM uses lightweight non-transactional DB interfaces,
1738 such as those providing by GDBM or Berkeley DB, to store data.
1741 This database uses the filesystem to build the tree structure
1742 of the database, using plain ascii files to store data.
1743 Its usage should be limited to very simple databases, where performance
1744 is not a requirement.
1747 This backend performs basic LDAP proxying with respect to a set of
1748 remote LDAP servers. It is an enhancement of the ldap backend.
1751 This backend provides information about the running status of the slapd
1755 Operations in this backend succeed but do nothing.
1758 This backend is provided for demonstration purposes only.
1759 It serves up user account information from the system
1764 This backend embeds a
1766 interpreter into slapd.
1767 It runs Perl subroutines to implement LDAP operations.
1770 This backend is experimental.
1771 It redirects LDAP operations to another database
1772 in the same server, based on the naming context of the request.
1773 Its use requires the
1777 for details) to rewrite the naming context of the request.
1778 It is primarily intended to implement virtual views on databases
1779 that actually store data.
1782 This backend executes external programs to implement LDAP operations.
1783 It is primarily intended to be used in prototypes.
1786 This backend is experimental.
1787 It services LDAP requests from an SQL database.
1789 The following overlays can be compiled into slapd.
1790 They are documented in the
1791 .BR slapo-<overlay> (5)
1796 This overlay can record accesses to a given backend database on another
1801 This overlay records changes on a given backend database to an LDIF log
1803 By default it is not built.
1807 This overlay allows automatic referral chasing when a referral would
1808 have been returned, either when configured by the server or when
1809 requested by the client.
1813 This overlay allows selected operations to be denied, similar to the
1814 \fBrestrict\fP option.
1818 This is a demo overlay which extends the Compare operation to detect
1819 members of a dynamic group.
1820 It has no effect on any other operations.
1824 This overlay allows expansion of dynamic groups and more.
1828 This overlay maintains a service entry in the database with the DN,
1829 modification type, modifiersName and modifyTimestamp of the last write
1830 operation performed on that database.
1834 This overlay allows caching of LDAP search requests in a local database.
1835 It is most often used with the ldap or meta backends.
1839 This overlay provides a variety of password control mechanisms,
1840 e.g. password aging, password reuse and duplication control, mandatory
1841 password resets, etc.
1844 Referential Integrity.
1845 This overlay can be used with a backend database such as
1847 to maintain the cohesiveness of a schema which utilizes reference
1852 This overlay is useful to test the behavior of clients when
1853 server-generated erroneous and/or unusual responses occur.
1857 This overlay is experimental.
1858 It performs basic DN/data rewrite and
1859 objectClass/attributeType mapping.
1863 This overlay implements the provider-side support for
1865 replication, including persistent search functionality.
1869 This overlay can be used with a backend database such as
1871 to create a "translucent proxy".
1872 Content of entries retrieved from a remote LDAP server can be partially
1873 overridden by the database.
1876 Attribute Uniqueness.
1877 This overlay can be used with a backend database such as
1879 to enforce the uniqueness of some or all attributes within a subtree.
1882 Here is a short example of a configuration file:
1886 include SYSCONFDIR/schema/core.schema
1887 pidfile LOCALSTATEDIR/slapd.pid
1889 # Subtypes of "name" (e.g. "cn" and "ou") with the
1890 # option ";x-hidden" can be searched for/compared,
1891 # but are not shown. See \fBslapd.access\fP(5).
1892 attributeoptions x-hidden lang-
1893 access to attr=name;x-hidden by * =cs
1895 # Protect passwords. See \fBslapd.access\fP(5).
1896 access to attrs=userPassword by * auth
1897 # Read access to other attributes and entries.
1898 access to * by * read
1901 suffix "dc=our-domain,dc=com"
1902 # The database directory MUST exist prior to
1903 # running slapd AND should only be accessible
1904 # by the slapd/tools. Mode 0700 recommended.
1905 directory LOCALSTATEDIR/openldap-data
1906 # Indices to maintain
1907 index objectClass eq
1908 index cn,sn,mail pres,eq,approx,sub
1910 # We serve small clients that do not handle referrals,
1911 # so handle remote lookups on their behalf.
1914 uri ldap://ldap.some-server.com/
1919 "OpenLDAP Administrator's Guide" contains a longer annotated
1920 example of a configuration file.
1921 The original ETCDIR/slapd.conf is another example.
1925 default slapd configuration file
1929 .BR slapd\-dnssrv (5),
1931 .BR slapd\-ldap (5),
1932 .BR slapd\-ldbm (5),
1933 .BR slapd\-ldif (5),
1934 .BR slapd\-meta (5),
1935 .BR slapd\-monitor (5),
1936 .BR slapd\-null (5),
1937 .BR slapd\-passwd (5),
1938 .BR slapd\-perl (5),
1939 .BR slapd\-relay (5),
1940 .BR slapd\-shell (5),
1942 .BR slapd.access (5),
1943 .BR slapd.plugin (5),
1944 .BR slapd.replog (5),
1956 Known overlays are documented in
1957 .BR slapo\-accesslog (5),
1958 .BR slapo\-auditlog (5),
1959 .BR slapo\-chain (5),
1960 .BR slapo\-dynlist (5),
1961 .BR slapo\-lastmod (5),
1962 .BR slapo\-pcache (5),
1963 .BR slapo\-ppolicy (5),
1964 .BR slapo\-refint (5),
1965 .BR slapo\-retcode (5),
1967 .BR slapo\-syncprov (5),
1968 .BR slapo\-translucent (5),
1969 .BR slapo\-unique (5).
1971 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1972 .SH ACKNOWLEDGEMENTS
1974 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1976 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob