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 2251 reserves options beginning with `x-' for private experiments.
137 Other options should be registered with IANA, see RFC 3383 section 3.4.
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 2252.
157 The slapd parser extends the RFC 2252 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
380 options can be given in the configuration file to allow for multiple matching
381 and replacement patterns. The matching patterns are checked in the order they
382 appear in the file, stopping at the first successful match.
385 .\"Because the plus sign + is a character recognized by the regular expression engine,
386 .\"and it will appear in names that include a REALM, be careful to escape the
387 .\"plus sign with a backslash \\+ to remove the character's special meaning.
390 .B concurrency <integer>
391 Specify a desired level of concurrency. Provided to the underlying
392 thread system as a hint. The default is not to provide any hint.
394 .B conn_max_pending <integer>
395 Specify the maximum number of pending requests for an anonymous session.
396 If requests are submitted faster than the server can process them, they
397 will be queued up to this limit. If the limit is exceeded, the session
398 is closed. The default is 100.
400 .B conn_max_pending_auth <integer>
401 Specify the maximum number of pending requests for an authenticated session.
404 .B defaultsearchbase <dn>
405 Specify a default search base to use when client submits a
406 non-base search request with an empty base DN.
407 Base scoped search requests with an empty base DN are not affected.
409 .B disallow <features>
410 Specify a set of features (separated by white space) to
411 disallow (default none).
413 disables acceptance of anonymous bind requests.
415 disables simple (bind) authentication.
417 disables forcing session to anonymous status (see also
419 upon StartTLS operation receipt.
421 disallows the StartTLS operation if authenticated (see also
425 .B ditcontentrule "(\ <oid>\
427 [DESC\ <description>]\
434 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
435 The slapd parser extends the RFC 2252 definition by allowing string
436 forms as well as numeric OIDs to be used for the attribute OID and
437 attribute syntax OID.
443 .B gentlehup { on | off }
444 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
446 will stop listening for new connections, but will not close the
447 connections to the current clients. Future write operations return
448 unwilling-to-perform, though. Slapd terminates when all clients
449 have closed their connections (if they ever do), or \- as before \-
450 if it receives a SIGTERM signal. This can be useful if you wish to
451 terminate the server and start a new
454 .B with another database,
455 without disrupting the currently active clients.
456 The default is off. You may wish to use
458 along with this option.
460 .B idletimeout <integer>
461 Specify the number of seconds to wait before forcibly closing
462 an idle client connection. A idletimeout of 0 disables this
463 feature. The default is 0.
465 .B include <filename>
466 Read additional configuration information from the given file before
467 continuing with the next line of the current file.
469 .B index_substr_if_minlen <integer>
470 Specify the minimum length for subinitial and subfinal indices. An
471 attribute value must have at least this many characters in order to be
472 processed by the indexing functions. The default is 2.
474 .B index_substr_if_maxlen <integer>
475 Specify the maximum length for subinitial and subfinal indices. Only
476 this many characters of an attribute value will be processed by the
477 indexing functions; any excess characters are ignored. The default is 4.
479 .B index_substr_any_len <integer>
480 Specify the length used for subany indices. An attribute value must have
481 at least this many characters in order to be processed. Attribute values
482 longer than this length will be processed in segments of this length. The
483 default is 4. The subany index will also be used in subinitial and
484 subfinal index lookups when the filter string is longer than the
485 .I index_substr_if_maxlen
488 .B index_substr_any_step <integer>
489 Specify the steps used in subany index lookups. This value sets the offset
490 for the segments of a filter string that are processed for a subany index
491 lookup. The default is 2. For example, with the default values, a search
492 using this filter "cn=*abcdefgh*" would generate index lookups for
493 "abcd", "cdef", and "efgh".
495 .\"-- NEW_LOGGING option --
497 .\".B logfile <filename>
498 .\"Specify a file for recording debug log messages. By default these messages
499 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
500 .\"copies messages to both stderr and the logfile.
503 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
504 such as those to the ldapi:// listener. For a description of SSF values,
508 option description. The default is 71.
510 .B loglevel <integer> [...]
511 Specify the level at which debugging statements and operation
512 statistics should be syslogged (currently logged to the
514 LOG_LOCAL4 facility).
515 They must be considered subsystems rather than increasingly verbose
517 Some messages with higher priority are logged regardless
518 of the configured loglevel as soon as some logging is configured,
519 otherwise anything is logged at all.
520 Log levels are additive, and available levels are:
531 debug packet handling
535 heavy trace debugging (function args)
539 connection management
543 print out packets sent and received
547 search filter processing
551 configuration file processing
555 access control list processing
559 stats log connections/operations/results
563 stats log entries sent
567 print communication with shell backends
579 \"data indexing (unused)
587 only messages that get logged whatever log level is set
590 The desired log level can be input as a single integer that combines
591 the (ORed) desired levels, both in decimal or in hexadecimal notation,
592 as a list of integers (that are ORed internally),
593 or as a list of the names that are shown between brackets, such that
606 can be used as a shortcut to enable logging at all levels (equivalent to -1).
609 or the equivalent integer representation, causes those messages
610 that are logged regardless of the configured loglevel to be logged.
611 In fact, if no loglevel (or a 0 level) is defined, no logging occurs,
614 level is required to have high priority messages logged.
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 2252.
640 The slapd parser extends the RFC 2252 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.
725 If it appears after a
727 directive, the args file is specific to the
729 instance that handles that replication log.
732 The ( absolute ) name of a file that will hold the
734 server's process ID ( see
736 ) if started without the debugging command line option.
737 If it appears after a
739 directive, the pid file is specific to the
741 instance that handles that replication log.
743 .B replicationinterval
744 The number of seconds
746 waits before checking the replogfile for changes.
747 If it appears after a
749 directive, the replication interval is specific to the
751 instance that handles that replication log.
753 .B require <conditions>
754 Specify a set of conditions (separated by white space) to
755 require (default none).
756 The directive may be specified globally and/or per-database.
758 requires bind operation prior to directory operations.
760 requires session to be using LDAP version 3.
762 requires authentication prior to directory operations.
764 requires SASL authentication prior to directory operations.
766 requires strong authentication prior to directory operations.
767 The strong keyword allows protected "simple" authentication
768 as well as SASL authentication.
770 may be used to require no conditions (useful for clearly globally
771 set conditions within a particular database).
773 .B reverse-lookup on | off
774 Enable/disable client name unverified reverse lookup (default is
776 if compiled with --enable-rlookups).
779 Specify the name of an LDIF(5) file containing user defined attributes
780 for the root DSE. These attributes are returned in addition to the
781 attributes normally produced by slapd.
784 Used to specify the fully qualified domain name used for SASL processing.
786 .B sasl-realm <realm>
787 Specify SASL realm. Default is empty.
789 .B sasl-secprops <properties>
790 Used to specify Cyrus SASL security properties.
793 flag (without any other properties) causes the flag properties
794 default, "noanonymous,noplain", to be cleared.
797 flag disables mechanisms susceptible to simple passive attacks.
800 flag disables mechanisms susceptible to active attacks.
803 flag disables mechanisms susceptible to passive dictionary attacks.
806 flag disables mechanisms which support anonymous login.
809 flag require forward secrecy between sessions.
812 require mechanisms which pass client credentials (and allow
813 mechanisms which can pass credentials to do so).
816 property specifies the minimum acceptable
817 .I security strength factor
818 as an integer approximate to effective key length used for
819 encryption. 0 (zero) implies no protection, 1 implies integrity
820 protection only, 56 allows DES or other weak ciphers, 112
821 allows triple DES and other strong ciphers, 128 allows RC4,
822 Blowfish and other modern strong ciphers. The default is 0.
825 property specifies the maximum acceptable
826 .I security strength factor
827 as an integer (see minssf description). The default is INT_MAX.
830 property specifies the maximum security layer receive buffer
831 size allowed. 0 disables security layers. The default is 65536.
834 Specify the distinguished name for the subschema subentry that
835 controls the entries on this server. The default is "cn=Subschema".
837 .B security <factors>
838 Specify a set of security strength factors (separated by white space)
842 option for a description of security strength factors).
843 The directive may be specified globally and/or per-database.
845 specifies the overall security strength factor.
847 specifies the transport security strength factor.
849 specifies the TLS security strength factor.
851 specifies the SASL security strength factor.
853 specifies the overall security strength factor to require for
855 .B update_transport=<n>
856 specifies the transport security strength factor to require for
859 specifies the TLS security strength factor to require for
862 specifies the SASL security strength factor to require for
865 specifies the security strength factor required for
867 username/password authentication.
870 factor is measure of security provided by the underlying transport,
871 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
873 .B sizelimit {<integer>|unlimited}
875 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
876 Specify the maximum number of entries to return from a search operation.
877 The default size limit is 500.
880 to specify no limits.
881 The second format allows a fine grain setting of the size limits.
882 Extra args can be added on the same line.
885 for an explanation of the different flags.
887 .B sockbuf_max_incoming <integer>
888 Specify the maximum incoming LDAP PDU size for anonymous sessions.
889 The default is 262143.
891 .B sockbuf_max_incoming_auth <integer>
892 Specify the maximum incoming LDAP PDU size for authenticated sessions.
893 The default is 4194303.
896 Specify the maximum size of the primary thread pool.
897 The default is 16; the minimum value is 2.
899 .B timelimit {<integer>|unlimited}
901 .B timelimit time[.{soft|hard}]=<integer> [...]
902 Specify the maximum number of seconds (in real time)
904 will spend answering a search request. The default time limit is 3600.
907 to specify no limits.
908 The second format allows a fine grain setting of the time limits.
909 Extra args can be added on the same line.
912 for an explanation of the different flags.
914 .B tool-threads <integer>
915 Specify the maximum number of threads to use in tool mode.
916 This should not be greater than the number of CPUs in the system.
918 .\"ucdata-path is obsolete / ignored...
920 .\".B ucdata-path <path>
921 .\"Specify the path to the directory containing the Unicode character
922 .\"tables. The default path is DATADIR/ucdata.
926 is built with support for Transport Layer Security, there are more options
929 .B TLSCipherSuite <cipher-suite-spec>
930 Permits configuring what ciphers will be accepted and the preference order.
931 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
933 TLSCipherSuite HIGH:MEDIUM:+SSLv2
935 To check what ciphers a given spec selects, use:
937 openssl ciphers -v <cipher-suite-spec>
939 .B TLSCACertificateFile <filename>
940 Specifies the file that contains certificates for all of the Certificate
945 .B TLSCACertificatePath <path>
946 Specifies the path of a directory that contains Certificate Authority
947 certificates in separate individual files. Usually only one of this
948 or the TLSCACertificateFile is used.
950 .B TLSCertificateFile <filename>
951 Specifies the file that contains the
955 .B TLSCertificateKeyFile <filename>
956 Specifies the file that contains the
958 server private key that matches the certificate stored in the
959 .B TLSCertificateFile
960 file. Currently, the private key must not be protected with a password, so
961 it is of critical importance that it is protected carefully.
963 .B TLSDHParamFile <filename>
964 This directive specifies the file that contains parameters for Diffie-Hellman
965 ephemeral key exchange. This is required in order to use a DSA certificate on
966 the server. If multiple sets of parameters are present in the file, all of
967 them will be processed. Note that setting this option may also enable
968 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
969 You should append "!ADH" to your cipher suites if you have changed them
970 from the default, otherwise no certificate exchanges or verification will
973 .B TLSRandFile <filename>
974 Specifies the file to obtain random bits from when /dev/[u]random
975 is not available. Generally set to the name of the EGD/PRNGD socket.
976 The environment variable RANDFILE can also be used to specify the filename.
978 .B TLSVerifyClient <level>
979 Specifies what checks to perform on client certificates in an
980 incoming TLS session, if any.
983 can be specified as one of the following keywords:
989 will not ask the client for a certificate.
992 The client certificate is requested. If no certificate is provided,
993 the session proceeds normally. If a bad certificate is provided,
994 it will be ignored and the session proceeds normally.
997 The client certificate is requested. If no certificate is provided,
998 the session proceeds normally. If a bad certificate is provided,
999 the session is immediately terminated.
1001 .B demand | hard | true
1002 These keywords are all equivalent, for compatibility reasons.
1003 The client certificate is requested. If no certificate is provided,
1004 or a bad certificate is provided, the session is immediately terminated.
1006 Note that a valid client certificate is required in order to use the
1007 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1010 setting must be chosen to enable SASL EXTERNAL authentication.
1013 .B TLSCRLCheck <level>
1014 Specifies if the Certificate Revocation List (CRL) of the CA should be
1015 used to verify if the client certificates have not been revoked. This
1017 .B TLSCACertificatePath
1018 parameter to be set.
1020 can be specified as one of the following keywords:
1024 No CRL checks are performed
1027 Check the CRL of the peer certificate
1030 Check the CRL for a whole certificate chain
1032 .SH GENERAL BACKEND OPTIONS
1033 Options in this section only apply to the configuration file section
1034 for the specified backend. They are supported by every
1037 .B backend <databasetype>
1038 Mark the beginning of a backend definition. <databasetype>
1056 depending on which backend will serve the database.
1058 .SH GENERAL DATABASE OPTIONS
1059 Options in this section only apply to the configuration file section
1060 for the database in which they are defined. They are supported by every
1061 type of backend. Note that the
1065 option are mandatory for each database.
1067 .B database <databasetype>
1068 Mark the beginning of a new database instance definition. <databasetype>
1086 depending on which backend will serve the database.
1091 will automatically maintain the
1092 modifiersName, modifyTimestamp, creatorsName, and
1093 createTimestamp attributes for entries. By default, lastmod is on.
1095 .B limits <who> <limit> [<limit> [...]]
1096 Specify time and size limits based on who initiated an operation.
1103 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1109 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1114 matches all unauthenticated clients.
1117 matches all authenticated clients;
1120 dn pattern is assumed unless otherwise specified by qualifying
1121 the (optional) key string
1127 (which are synonyms), to require an exact match; with
1129 to require exactly one level of depth match; with
1131 to allow any level of depth match, including the exact match; with
1133 to allow any level of depth match, not including the exact match;
1135 explicitly requires the (default) match based on POSIX (''extended'')
1136 regular expression pattern.
1139 matches unbound operations; the
1142 The same behavior is obtained by using the
1149 with the optional objectClass
1155 sets the limits for any DN listed in the values of the
1161 group objectClass (default
1163 whose DN exactly matches
1166 The currently supported limits are
1171 The syntax for time limits is
1172 .BR time[.{soft|hard}]=<integer> ,
1175 is the number of seconds slapd will spend answering a search request.
1176 If no time limit is explicitly requested by the client, the
1178 limit is used; if the requested time limit exceeds the
1181 .\".I "Administrative limit exceeded"
1182 .\"error is returned.
1183 limit, the value of the limit is used instead.
1186 limit is set to the keyword
1188 the soft limit is used in either case; if it is set to the keyword
1190 no hard limit is enforced.
1191 Explicit requests for time limits smaller or equal to the
1194 If no limit specifier is set, the value is assigned to the
1200 to preserve the original behavior.
1202 The syntax for size limits is
1203 .BR size[.{soft|hard|unchecked}]=<integer> ,
1206 is the maximum number of entries slapd will return answering a search
1208 If no size limit is explicitly requested by the client, the
1210 limit is used; if the requested size limit exceeds the
1213 .\".I "Administrative limit exceeded"
1214 .\"error is returned.
1215 limit, the value of the limit is used instead.
1218 limit is set to the keyword
1220 the soft limit is used in either case; if it is set to the keyword
1222 no hard limit is enforced.
1223 Explicit requests for size limits smaller or equal to the
1228 specifier sets a limit on the number of candidates a search request is allowed
1230 The rationale behind it is that searches for non-properly indexed
1231 attributes may result in large sets of candidates, which must be
1234 to determine whether they match the search filter or not.
1237 limit provides a means to drop such operations before they are even
1239 If the selected candidates exceed the
1241 limit, the search will abort with
1242 .IR "Unwilling to perform" .
1243 If it is set to the keyword
1245 no limit is applied (the default).
1248 the search is not even performed; this can be used to disallow searches
1249 for a specific set of users.
1250 If no limit specifier is set, the value is assigned to the
1256 to preserve the original behavior.
1258 In case of no match, the global limits are used.
1259 The default values are the same of
1268 control is requested, the
1270 size limit is used by default, because the request of a specific page size
1271 is considered an explicit request for a limitation on the number
1272 of entries to be returned.
1273 However, the size limit applies to the total count of entries returned within
1274 the search, and not to a single page.
1275 Additional size limits may be enforced; the syntax is
1276 .BR size.pr={<integer>|noEstimate|unlimited} ,
1279 is the max page size if no explicit limit is set; the keyword
1281 inhibits the server from returning an estimate of the total number
1282 of entries that might be returned
1283 (note: the current implementation does not return any estimate).
1286 indicates that no limit is applied to the pagedResults control page size.
1288 .B size.prtotal={<integer>|unlimited|disabled}
1289 allows to set a limit on the total number of entries that a pagedResults
1290 control allows to return.
1291 By default it is set to the
1296 is the max number of entries that the whole search with pagedResults control
1300 to allow unlimited number of entries to be returned, e.g. to allow
1301 the use of the pagedResults control as a means to circumvent size
1302 limitations on regular searches; the keyword
1304 disables the control, i.e. no paged results can be returned.
1305 Note that the total number of entries returned when the pagedResults control
1306 is requested cannot exceed the
1308 size limit of regular searches unless extended by the
1313 .B maxderefdepth <depth>
1314 Specifies the maximum number of aliases to dereference when trying to
1315 resolve an entry, used to avoid infinite alias loops. The default is 1.
1317 .B mirrormode on | off
1318 This option puts a replica database into "mirror" mode. Update
1319 operations will be accepted from any user, not just the updatedn. The
1320 database must already be configured as a slurpd or syncrepl consumer
1321 before this keyword may be set. This mode must be used with extreme
1322 care, as it does not offer any consistency guarantees.
1323 By default, mirrormode is off.
1325 .B overlay <overlay-name>
1326 Add the specified overlay to this database. An overlay is a piece of
1327 code that intercepts database operations in order to extend or change
1328 them. Overlays are pushed onto
1329 a stack over the database, and so they will execute in the reverse
1330 of the order in which they were configured and the database itself
1331 will receive control last of all.
1333 .B readonly on | off
1334 This option puts the database into "read-only" mode. Any attempts to
1335 modify the database will return an "unwilling to perform" error. By
1336 default, readonly is off.
1339 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1340 .B [starttls=yes|critical]
1341 .B [suffix=<suffix> [...]]
1342 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1343 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1344 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1345 .B [attrs[!]=<attr list>]
1347 Specify a replication site for this database. Refer to the "OpenLDAP
1348 Administrator's Guide" for detailed information on setting up a replicated
1350 directory service. Zero or more
1352 instances can be used to select the subtrees that will be replicated
1353 (defaults to all the database).
1355 is deprecated in favor of the
1359 allows the replica LDAP server to be specified as an LDAP URI.
1364 requires the options
1368 and should only be used when adequate security services
1369 (e.g TLS or IPSEC) are in place. A
1375 Specific security properties (as with the
1377 keyword above) for a SASL bind can be set with the
1379 option. A non-default SASL realm can be set with the
1384 will use Kerberos, a kerberos instance should be given in
1388 can be given after the
1390 keyword to allow the selective replication of the listed attributes only;
1393 mark is used, the list is considered exclusive, i.e. the listed attributes
1395 If an objectClass is listed, all the related attributes
1396 are (are not) replicated.
1399 .B replogfile <filename>
1400 Specify the name of the replication log file to log changes to.
1401 The replication log is typically written by
1406 .BR slapd.replog (5)
1407 for more information. The specified file should be located
1408 in a directory with limited read/write/execute access as the replication
1409 logs may contain sensitive information.
1411 .B restrict <oplist>
1412 Specify a whitespace separated list of operations that are restricted.
1413 If defined inside a database specification, restrictions apply only
1414 to that database, otherwise they are global.
1415 Operations can be any of
1420 .BR extended[=<OID>] ,
1424 or the special pseudo-operations
1428 which respectively summarize read and write operations.
1436 keyword allows to indicate the OID of the specific operation
1440 Specify the distinguished name that is not subject to access control
1441 or administrative limit restrictions for operations on this database.
1442 This DN may or may not be associated with an entry. An empty root
1443 DN (the default) specifies no root access is to be granted. It is
1444 recommended that the rootdn only be specified when needed (such as
1445 when initially populating a database). If the rootdn is within
1446 a namingContext (suffix) of the database, a simple bind password
1447 may also be provided using the
1449 directive. Note that the rootdn is always needed when using syncrepl.
1451 .B rootpw <password>
1452 Specify a password (or hash of the password) for the rootdn. The
1453 password can only be set if the rootdn is within the namingContext
1454 (suffix) of the database.
1455 This option accepts all RFC 2307 userPassword formats known to
1458 description) as well as cleartext.
1460 may be used to generate a hash of a password. Cleartext
1461 and \fB{CRYPT}\fP passwords are not recommended. If empty
1462 (the default), authentication of the root DN is by other means
1463 (e.g. SASL). Use of SASL is encouraged.
1465 .B suffix <dn suffix>
1466 Specify the DN suffix of queries that will be passed to this
1467 backend database. Multiple suffix lines can be given and at least one is
1468 required for each database definition.
1469 If the suffix of one database is "inside" that of another, the database
1470 with the inner suffix must come first in the configuration file.
1472 .B subordinate [advertise]
1473 Specify that the current backend database is a subordinate of another
1474 backend database. A subordinate database may have only one suffix. This
1475 option may be used to glue multiple databases into a single namingContext.
1476 If the suffix of the current database is within the namingContext of a
1477 superior database, searches against the superior database will be
1478 propagated to the subordinate as well. All of the databases
1479 associated with a single namingContext should have identical rootdns.
1480 Behavior of other LDAP operations is unaffected by this setting. In
1481 particular, it is not possible to use moddn to move an entry from
1482 one subordinate to another subordinate within the namingContext.
1484 If the optional \fBadvertise\fP flag is supplied, the naming context of
1485 this database is advertised in the root DSE. The default is to hide this
1486 database context, so that only the superior context is visible.
1493 are used on the superior database, any glued subordinates that support
1494 these tools are opened as well.
1496 Databases that are glued together should usually be configured with the
1497 same indices (assuming they support indexing), even for attributes that
1498 only exist in some of these databases. In general, all of the glued
1499 databases should be configured as similarly as possible, since the intent
1500 is to provide the appearance of a single directory.
1502 Note that the \fIsubordinate\fP functionality is implemented internally
1503 by the \fIglue\fP overlay and as such its behavior will interact with other
1504 overlays in use. By default, the glue overlay is automatically configured as
1505 the last overlay on the superior backend. Its position on the backend
1506 can be explicitly configured by setting an \fBoverlay glue\fP directive
1507 at the desired position. This explicit configuration is necessary e.g.
1508 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1509 in order to work over all of the glued databases. E.g.
1513 suffix dc=example,dc=com
1521 .B syncrepl rid=<replica ID>
1522 .B provider=ldap[s]://<hostname>[:port]
1523 .B searchbase=<base DN>
1524 .B [type=refreshOnly|refreshAndPersist]
1525 .B [interval=dd:hh:mm:ss]
1526 .B [retry=[<retry interval> <# of retries>]+]
1527 .B [filter=<filter str>]
1528 .B [scope=sub|one|base|subord]
1529 .B [attrs=<attr list>]
1531 .B [sizelimit=<limit>]
1532 .B [timelimit=<limit>]
1533 .B [schemachecking=on|off]
1534 .B [bindmethod=simple|sasl]
1536 .B [saslmech=<mech>]
1537 .B [authcid=<identity>]
1538 .B [authzid=<identity>]
1539 .B [credentials=<passwd>]
1541 .B [secprops=<properties>]
1542 .B [starttls=yes|critical]
1543 .B [tls_cert=<file>]
1545 .B [tls_cacert=<file>]
1546 .B [tls_cacertdir=<path>]
1547 .B [tls_reqcert=never|allow|try|demand]
1548 .B [tls_ciphersuite=<ciphers>]
1549 .B [tls_crlcheck=none|peer|all]
1550 .B [logbase=<base DN>]
1551 .B [logfilter=<filter str>]
1552 .B [syncdata=default|accesslog|changelog]
1554 Specify the current database as a replica which is kept up-to-date with the
1555 master content by establishing the current
1557 as a replication consumer site running a
1560 The replica content is kept synchronized to the master content using
1561 the LDAP Content Synchronization protocol. Refer to the
1562 "OpenLDAP Administrator's Guide" for detailed information on
1563 setting up a replicated
1565 directory service using the
1569 identifies the current
1571 directive within the replication consumer site.
1572 It is a non-negative integer having no more than three digits.
1574 specifies the replication provider site containing the master content
1575 as an LDAP URI. If <port> is not given, the standard LDAP port number
1576 (389 or 636) is used. The content of the
1578 replica is defined using a search
1579 specification as its result set. The consumer
1581 will send search requests to the provider
1583 according to the search specification. The search specification includes
1584 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1587 parameters as in the normal search specification.
1588 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1589 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1590 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1591 attributes, and \fBattrsonly\fP is unset by default.
1592 The \fBsizelimit\fP and \fBtimelimit\fP only
1593 accept "unlimited" and positive integers, and both default to "unlimited".
1594 The LDAP Content Synchronization protocol has two operation types.
1597 operation, the next synchronization search operation
1598 is periodically rescheduled at an interval time (specified by
1600 parameter; 1 day by default)
1601 after each synchronization operation finishes.
1603 .B refreshAndPersist
1604 operation, a synchronization search remains persistent in the provider slapd.
1605 Further updates to the master replica will generate
1606 .B searchResultEntry
1607 to the consumer slapd as the search responses to the persistent
1608 synchronization search.
1609 If an error occurs during replication, the consumer will attempt to
1610 reconnect according to the
1612 parameter which is a list of the <retry interval> and <# of retries> pairs.
1613 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1614 for the first 10 times and then retry every 300 seconds for the next 3
1615 times before stop retrying. The `+' in <# of retries> means indefinite
1616 number of retries until success.
1617 The schema checking can be enforced at the LDAP Sync
1618 consumer site by turning on the
1620 parameter. The default is off.
1625 requires the options
1629 and should only be used when adequate security services
1630 (e.g. TLS or IPSEC) are in place.
1637 Depending on the mechanism, an authentication identity and/or
1638 credentials can be specified using
1644 parameter may be used to specify an authorization identity.
1645 Specific security properties (as with the
1647 keyword above) for a SASL bind can be set with the
1649 option. A non default SASL realm can be set with the
1655 parameter specifies use of the StartTLS extended operation
1656 to establish a TLS session before Binding to the provider. If the
1658 argument is supplied, the session will be aborted if the StartTLS request
1659 fails. Otherwise the syncrepl session continues without TLS. Note that the
1660 main slapd TLS settings are not used by the syncrepl engine;
1661 by default the TLS parameters from ETCDIR/ldap.conf will be used.
1662 TLS settings may be specified here, in which case the ldap.conf settings
1663 will be completely ignored.
1665 Rather than replicating whole entries, the consumer can query logs of
1666 data modifications. This mode of operation is referred to as \fIdelta
1667 syncrepl\fP. In addition to the above parameters, the
1671 parameters must be set appropriately for the log that will be used. The
1673 parameter must be set to either "accesslog" if the log conforms to the
1674 .BR slapo-accesslog (5)
1675 log format, or "changelog" if the log conforms
1676 to the obsolete \fIchangelog\fP format. If the
1678 parameter is omitted or set to "default" then the log parameters are
1683 This option is only applicable in a slave
1684 database updated using
1686 It specifies the DN permitted to update (subject to access controls)
1687 the replica (typically, this is the DN
1689 binds to update the replica). Generally, this DN
1696 Specify the referral to pass back when
1698 is asked to modify a replicated local database.
1699 If specified multiple times, each url is provided.
1701 .SH DATABASE-SPECIFIC OPTIONS
1702 Each database may allow specific configuration options; they are
1703 documented separately in the backends' manual pages.
1705 The following backends can be compiled into slapd.
1706 They are documented in the
1707 .BR slapd-<backend> (5)
1711 This is the recommended primary backend for a normal slapd database.
1712 It takes care to configure it properly.
1713 It uses the transactional database interface of the Sleepycat Berkeley
1714 DB (BDB) package to store data.
1717 This backend is used to manage the configuration of slapd run-time.
1720 This backend is experimental.
1721 It serves up referrals based upon SRV resource records held in the
1725 This is a variant of the BDB backend that uses a hierarchical database
1726 layout which supports subtree renames.
1729 This backend acts as a proxy to forward incoming requests to another
1733 This is an easy-to-configure but obsolete database backend. It
1734 does not offer the data durability features of the BDB and HDB
1735 backends and hence is deprecated in favor of these robust backends.
1736 LDBM uses lightweight non-transactional DB interfaces,
1737 such as those providing by GDBM or Berkeley DB, to store data.
1740 This database uses the filesystem to build the tree structure
1741 of the database, using plain ascii files to store data.
1742 Its usage should be limited to very simple databases, where performance
1743 is not a requirement.
1746 This backend performs basic LDAP proxying with respect to a set of
1747 remote LDAP servers. It is an enhancement of the ldap backend.
1750 This backend provides information about the running status of the slapd
1754 Operations in this backend succeed but do nothing.
1757 This backend is provided for demonstration purposes only.
1758 It serves up user account information from the system
1763 This backend embeds a
1765 interpreter into slapd.
1766 It runs Perl subroutines to implement LDAP operations.
1769 This backend is experimental.
1770 It redirects LDAP operations to another database
1771 in the same server, based on the naming context of the request.
1772 Its use requires the
1776 for details) to rewrite the naming context of the request.
1777 It is primarily intended to implement virtual views on databases
1778 that actually store data.
1781 This backend executes external programs to implement LDAP operations.
1782 It is primarily intended to be used in prototypes.
1785 This backend is experimental.
1786 It services LDAP requests from an SQL database.
1788 The following overlays can be compiled into slapd.
1789 They are documented in the
1790 .BR slapo-<overlay> (5)
1795 This overlay can record accesses to a given backend database on another
1800 This overlay records changes on a given backend database to an LDIF log
1802 By default it is not built.
1806 This overlay allows automatic referral chasing when a referral would
1807 have been returned, either when configured by the server or when
1808 requested by the client.
1812 This overlay allows selected operations to be denied, similar to the
1813 \fBrestrict\fP option.
1817 This is a demo overlay which extends the Compare operation to detect
1818 members of a dynamic group.
1819 It has no effect on any other operations.
1823 This overlay allows expansion of dynamic groups and more.
1827 This overlay maintains a service entry in the database with the DN,
1828 modification type, modifiersName and modifyTimestamp of the last write
1829 operation performed on that database.
1833 This overlay allows caching of LDAP search requests in a local database.
1834 It is most often used with the ldap or meta backends.
1838 This overlay provides a variety of password control mechanisms,
1839 e.g. password aging, password reuse and duplication control, mandatory
1840 password resets, etc.
1843 Referential Integrity.
1844 This overlay can be used with a backend database such as
1846 to maintain the cohesiveness of a schema which utilizes reference
1851 This overlay is useful to test the behavior of clients when
1852 server-generated erroneous and/or unusual responses occur.
1856 This overlay is experimental.
1857 It performs basic DN/data rewrite and
1858 objectClass/attributeType mapping.
1862 This overlay implements the provider-side support for
1864 replication, including persistent search functionality.
1868 This overlay can be used with a backend database such as
1870 to create a "translucent proxy".
1871 Content of entries retrieved from a remote LDAP server can be partially
1872 overridden by the database.
1875 Attribute Uniqueness.
1876 This overlay can be used with a backend database such as
1878 to enforce the uniqueness of some or all attributes within a subtree.
1881 Here is a short example of a configuration file:
1885 include SYSCONFDIR/schema/core.schema
1886 pidfile LOCALSTATEDIR/slapd.pid
1888 # Subtypes of "name" (e.g. "cn" and "ou") with the
1889 # option ";x-hidden" can be searched for/compared,
1890 # but are not shown. See \fBslapd.access\fP(5).
1891 attributeoptions x-hidden lang-
1892 access to attrs=name;x-hidden by * =cs
1894 # Protect passwords. See \fBslapd.access\fP(5).
1895 access to attrs=userPassword by * auth
1896 # Read access to other attributes and entries.
1897 access to * by * read
1900 suffix "dc=our-domain,dc=com"
1901 # The database directory MUST exist prior to
1902 # running slapd AND should only be accessible
1903 # by the slapd/tools. Mode 0700 recommended.
1904 directory LOCALSTATEDIR/openldap-data
1905 # Indices to maintain
1906 index objectClass eq
1907 index cn,sn,mail pres,eq,approx,sub
1909 # We serve small clients that do not handle referrals,
1910 # so handle remote lookups on their behalf.
1913 uri ldap://ldap.some-server.com/
1918 "OpenLDAP Administrator's Guide" contains a longer annotated
1919 example of a configuration file.
1920 The original ETCDIR/slapd.conf is another example.
1924 default slapd configuration file
1928 .BR slapd\-dnssrv (5),
1930 .BR slapd\-ldap (5),
1931 .BR slapd\-ldbm (5),
1932 .BR slapd\-ldif (5),
1933 .BR slapd\-meta (5),
1934 .BR slapd\-monitor (5),
1935 .BR slapd\-null (5),
1936 .BR slapd\-passwd (5),
1937 .BR slapd\-perl (5),
1938 .BR slapd\-relay (5),
1939 .BR slapd\-shell (5),
1941 .BR slapd.access (5),
1942 .BR slapd.plugin (5),
1943 .BR slapd.replog (5),
1955 Known overlays are documented in
1956 .BR slapo\-accesslog (5),
1957 .BR slapo\-auditlog (5),
1958 .BR slapo\-chain (5),
1959 .BR slapo\-dynlist (5),
1960 .BR slapo\-lastmod (5),
1961 .BR slapo\-pcache (5),
1962 .BR slapo\-ppolicy (5),
1963 .BR slapo\-refint (5),
1964 .BR slapo\-retcode (5),
1966 .BR slapo\-syncprov (5),
1967 .BR slapo\-translucent (5),
1968 .BR slapo\-unique (5).
1970 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1971 .SH ACKNOWLEDGEMENTS
1973 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1975 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob