1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2005 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 allow 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 2251 reserves options beginning with `x-' for private experiments.
134 Other options should be registered with IANA, see RFC 3383 section 3.4.
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 2252.
154 The slapd parser extends the RFC 2252 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 three 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
377 options can be given in the configuration file to allow for multiple matching
378 and replacement patterns. The matching patterns are checked in the order they
379 appear in the file, stopping at the first successful match.
382 .\"Because the plus sign + is a character recognized by the regular expression engine,
383 .\"and it will appear in names that include a REALM, be careful to escape the
384 .\"plus sign with a backslash \\+ to remove the character's special meaning.
387 .B concurrency <integer>
388 Specify a desired level of concurrency. Provided to the underlying
389 thread system as a hint. The default is not to provide any hint.
391 .B conn_max_pending <integer>
392 Specify the maximum number of pending requests for an anonymous session.
393 If requests are submitted faster than the server can process them, they
394 will be queued up to this limit. If the limit is exceeded, the session
395 is closed. The default is 100.
397 .B conn_max_pending_auth <integer>
398 Specify the maximum number of pending requests for an authenticated session.
401 .B defaultsearchbase <dn>
402 Specify a default search base to use when client submits a
403 non-base search request with an empty base DN.
405 .B disallow <features>
406 Specify a set of features (separated by white space) to
407 disallow (default none).
409 disables acceptance of anonymous bind requests.
411 disables simple (bind) authentication.
413 disables Start TLS from forcing session to anonymous status (see also
416 disables StartTLS if authenticated (see also
420 .B ditcontentrule "(\ <oid>\
422 [DESC\ <description>]\
429 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
430 The slapd parser extends the RFC 2252 definition by allowing string
431 forms as well as numeric OIDs to be used for the attribute OID and
432 attribute syntax OID.
438 .B gentlehup { on | off }
439 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
441 will stop listening for new connections, but will not close the
442 connections to the current clients. Future write operations return
443 unwilling-to-perform, though. Slapd terminates when all clients
444 have closed their connections (if they ever do), or \- as before \-
445 if it receives a SIGTERM signal. This can be useful if you wish to
446 terminate the server and start a new
449 .B with another database,
450 without disrupting the currently active clients.
451 The default is off. You may wish to use
453 along with this option.
455 .B idletimeout <integer>
456 Specify the number of seconds to wait before forcibly closing
457 an idle client connection. A idletimeout of 0 disables this
458 feature. The default is 0.
460 .B include <filename>
461 Read additional configuration information from the given file before
462 continuing with the next line of the current file.
464 .B index_substr_if_minlen <integer>
465 Specify the minimum length for subinitial and subfinal indices. An
466 attribute value must have at least this many characters in order to be
467 processed by the indexing functions. The default is 2.
469 .B index_substr_if_maxlen <integer>
470 Specify the maximum length for subinitial and subfinal indices. Only
471 this many characters of an attribute value will be processed by the
472 indexing functions; any excess characters are ignored. The default is 4.
474 .B index_substr_any_len <integer>
475 Specify the length used for subany indices. An attribute value must have
476 at least this many characters in order to be processed. Attribute values
477 longer than this length will be processed in segments of this length. The
478 default is 4. The subany index will also be used in subinitial and
479 subfinal index lookups when the filter string is longer than the
480 .I index_substr_if_maxlen
483 .B index_substr_any_step <integer>
484 Specify the steps used in subany index lookups. This value sets the offset
485 for the segments of a filter string that are processed for a subany index
486 lookup. The default is 2. For example, with the default values, a search
487 using this filter "cn=*abcdefgh*" would generate index lookups for
488 "abcd", "cdef", and "efgh".
490 .\"-- NEW_LOGGING option --
492 .\".B logfile <filename>
493 .\"Specify a file for recording debug log messages. By default these messages
494 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
495 .\"copies messages to both stderr and the logfile.
498 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
499 such as those to the ldapi:// listener. For a description of SSF values,
503 option description. The default is 71.
505 .B loglevel <integer> [...]
506 Specify the level at which debugging statements and operation
507 statistics should be syslogged (currently logged to the
509 LOG_LOCAL4 facility). Log levels are additive, and available levels
521 debug packet handling
525 heavy trace debugging
529 connection management
533 print out packets sent and received
537 search filter processing
541 configuration file processing
545 access control list processing
549 stats log connections/operations/results
553 stats log entries sent
557 print communication with shell backends
564 The desired log level can be input as a single integer that combines
565 the (ORed) desired levels, as a list of integers (that are ORed internally),
566 or as a list of the names that are shown between brackets, such that
577 can be used as a shortcut to enable logging at all levels (equivalent to -1).
580 .B moduleload <filename>
581 Specify the name of a dynamically loadable module to load. The filename
582 may be an absolute path name or a simple filename. Non-absolute names
583 are searched for in the directories specified by the
585 option. This option and the
587 option are only usable if slapd was compiled with --enable-modules.
589 .B modulepath <pathspec>
590 Specify a list of directories to search for loadable modules. Typically
591 the path is colon-separated but this depends on the operating system.
594 .B objectclass "(\ <oid>\
596 [DESC\ <description]\
599 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
600 [MUST\ <oids>] [MAY\ <oids>] )"
602 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
603 The slapd parser extends the RFC 2252 definition by allowing string
604 forms as well as numeric OIDs to be used for the object class OID.
608 description.) Object classes are "STRUCTURAL" by default.
611 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
612 Define a string name that equates to the given OID. The string can be used
613 in place of the numeric OID in objectclass and attribute definitions. The
614 name can also be used with a suffix of the form ":xx" in which case the
615 value "oid.xx" will be used.
617 .B password-hash <hash> [<hash>...]
618 This option configures one or more hashes to be used in generation of user
619 passwords stored in the userPassword attribute during processing of
620 LDAP Password Modify Extended Operations (RFC 3062).
621 The <hash> must be one of
635 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
640 use the MD5 algorithm (RFC 1321), the latter with a seed.
647 indicates that the new password should be
648 added to userPassword as clear text.
650 Note that this option does not alter the normal user applications
651 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
653 .B password\-crypt\-salt\-format <format>
654 Specify the format of the salt passed to
656 when generating {CRYPT} passwords (see
658 during processing of LDAP Password Modify Extended Operations (RFC 3062).
660 This string needs to be in
662 format and may include one (and only one) %s conversion.
663 This conversion will be substituted with a string of random
664 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
665 provides a two character salt and "$1$%.8s" tells some
666 versions of crypt(3) to use an MD5 algorithm and provides
667 8 random characters of salt. The default is "%s", which
668 provides 31 characters of salt.
670 .B pidfile <filename>
671 The ( absolute ) name of a file that will hold the
673 server's process ID ( see
675 ) if started without the debugging command line option.
678 Specify the referral to pass back when
680 cannot find a local database to handle a request.
681 If specified multiple times, each url is provided.
684 The ( absolute ) name of a file that will hold the
686 server's command line options
687 if started without the debugging command line option.
690 The ( absolute ) name of a file that will hold the
692 server's process ID ( see
694 ) if started without the debugging command line option.
696 .B replicationinterval
697 The number of seconds
699 waits before checking the replogfile for changes.
701 .B require <conditions>
702 Specify a set of conditions (separated by white space) to
703 require (default none).
704 The directive may be specified globally and/or per-database.
706 requires bind operation prior to directory operations.
708 requires session to be using LDAP version 3.
710 requires authentication prior to directory operations.
712 requires SASL authentication prior to directory operations.
714 requires strong authentication prior to directory operations.
715 The strong keyword allows protected "simple" authentication
716 as well as SASL authentication.
718 may be used to require no conditions (useful for clearly globally
719 set conditions within a particular database).
721 .B reverse-lookup on | off
722 Enable/disable client name unverified reverse lookup (default is
724 if compiled with --enable-rlookups).
727 Specify the name of an LDIF(5) file containing user defined attributes
728 for the root DSE. These attributes are returned in addition to the
729 attributes normally produced by slapd.
732 Used to specify the fully qualified domain name used for SASL processing.
734 .B sasl-realm <realm>
735 Specify SASL realm. Default is empty.
737 .B sasl-secprops <properties>
738 Used to specify Cyrus SASL security properties.
741 flag (without any other properties) causes the flag properties
742 default, "noanonymous,noplain", to be cleared.
745 flag disables mechanisms susceptible to simple passive attacks.
748 flag disables mechanisms susceptible to active attacks.
751 flag disables mechanisms susceptible to passive dictionary attacks.
754 flag disables mechanisms which support anonymous login.
757 flag require forward secrecy between sessions.
760 require mechanisms which pass client credentials (and allow
761 mechanisms which can pass credentials to do so).
764 property specifies the minimum acceptable
765 .I security strength factor
766 as an integer approximate to effective key length used for
767 encryption. 0 (zero) implies no protection, 1 implies integrity
768 protection only, 56 allows DES or other weak ciphers, 112
769 allows triple DES and other strong ciphers, 128 allows RC4,
770 Blowfish and other modern strong ciphers. The default is 0.
773 property specifies the maximum acceptable
774 .I security strength factor
775 as an integer (see minssf description). The default is INT_MAX.
778 property specifies the maximum security layer receive buffer
779 size allowed. 0 disables security layers. The default is 65536.
782 Specify the distinguished name for the subschema subentry that
783 controls the entries on this server. The default is "cn=Subschema".
785 .B security <factors>
786 Specify a set of security strength factors (separated by white space)
790 option for a description of security strength factors).
791 The directive may be specified globally and/or per-database.
793 specifies the overall security strength factor.
795 specifies the transport security strength factor.
797 specifies the TLS security strength factor.
799 specifies the SASL security strength factor.
801 specifies the overall security strength factor to require for
803 .B update_transport=<n>
804 specifies the transport security strength factor to require for
807 specifies the TLS security strength factor to require for
810 specifies the SASL security strength factor to require for
813 specifies the security strength factor required for
815 username/password authentication.
818 factor is measure of security provided by the underlying transport,
819 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
821 .B sizelimit {<integer>|unlimited}
823 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
824 Specify the maximum number of entries to return from a search operation.
825 The default size limit is 500.
828 to specify no limits.
829 The second format allows a fine grain setting of the size limits.
830 Extra args can be added on the same line.
833 for an explanation of the different flags.
835 .B sockbuf_max_incoming <integer>
836 Specify the maximum incoming LDAP PDU size for anonymous sessions.
837 The default is 262143.
839 .B sockbuf_max_incoming_auth <integer>
840 Specify the maximum incoming LDAP PDU size for authenticated sessions.
841 The default is 4194303.
844 Specify the maximum size of the primary thread pool.
847 .B timelimit {<integer>|unlimited}
849 .B timelimit time[.{soft|hard}]=<integer> [...]
850 Specify the maximum number of seconds (in real time)
852 will spend answering a search request. The default time limit is 3600.
855 to specify no limits.
856 The second format allows a fine grain setting of the time limits.
857 Extra args can be added on the same line.
860 for an explanation of the different flags.
862 .B ucdata-path <path>
863 Specify the path to the directory containing the Unicode character
864 tables. The default path is DATADIR/ucdata.
868 is built with support for Transport Layer Security, there are more options
871 .B TLSCipherSuite <cipher-suite-spec>
872 Permits configuring what ciphers will be accepted and the preference order.
873 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
875 TLSCipherSuite HIGH:MEDIUM:+SSLv2
877 To check what ciphers a given spec selects, use:
879 openssl ciphers -v <cipher-suite-spec>
881 .B TLSCACertificateFile <filename>
882 Specifies the file that contains certificates for all of the Certificate
887 .B TLSCACertificatePath <path>
888 Specifies the path of a directory that contains Certificate Authority
889 certificates in separate individual files. Usually only one of this
890 or the TLSCACertificateFile is used.
892 .B TLSCertificateFile <filename>
893 Specifies the file that contains the
897 .B TLSCertificateKeyFile <filename>
898 Specifies the file that contains the
900 server private key that matches the certificate stored in the
901 .B TLSCertificateFile
902 file. Currently, the private key must not be protected with a password, so
903 it is of critical importance that it is protected carefully.
905 .B TLSRandFile <filename>
906 Specifies the file to obtain random bits from when /dev/[u]random
907 is not available. Generally set to the name of the EGD/PRNGD socket.
908 The environment variable RANDFILE can also be used to specify the filename.
910 .B TLSVerifyClient <level>
911 Specifies what checks to perform on client certificates in an
912 incoming TLS session, if any.
915 can be specified as one of the following keywords:
921 will not ask the client for a certificate.
924 The client certificate is requested. If no certificate is provided,
925 the session proceeds normally. If a bad certificate is provided,
926 it will be ignored and the session proceeds normally.
929 The client certificate is requested. If no certificate is provided,
930 the session proceeds normally. If a bad certificate is provided,
931 the session is immediately terminated.
933 .B demand | hard | true
934 These keywords are all equivalent, for compatibility reasons.
935 The client certificate is requested. If no certificate is provided,
936 or a bad certificate is provided, the session is immediately terminated.
938 Note that a valid client certificate is required in order to use the
939 SASL EXTERNAL authentication mechanism with a TLS session. As such,
942 setting must be chosen to enable SASL EXTERNAL authentication.
945 .B TLSCRLCheck <level>
946 Specifies if the Certificate Revocation List (CRL) of the CA should be
947 used to verify if the client certificates have not been revoked. This
949 .B TLSCACertificatePath
952 can be specified as one of the following keywords:
956 No CRL checks are performed
959 Check the CRL of the peer certificate
962 Check the CRL for a whole certificate chain
964 .SH GENERAL BACKEND OPTIONS
965 Options in this section only apply to the configuration file section
966 for the specified backend. They are supported by every
969 .B backend <databasetype>
970 Mark the beginning of a backend definition. <databasetype>
988 depending on which backend will serve the database.
990 .SH GENERAL DATABASE OPTIONS
991 Options in this section only apply to the configuration file section
992 for the database in which they are defined. They are supported by every
993 type of backend. Note that the
997 option are mandatory for each database.
999 .B database <databasetype>
1000 Mark the beginning of a new database instance definition. <databasetype>
1018 depending on which backend will serve the database.
1023 will automatically maintain the
1024 modifiersName, modifyTimestamp, creatorsName, and
1025 createTimestamp attributes for entries. By default, lastmod is on.
1027 .B limits <who> <limit> [<limit> [...]]
1028 Specify time and size limits based on who initiated an operation.
1035 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1041 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1046 matches all unauthenticated clients.
1049 matches all authenticated clients;
1052 dn pattern is assumed unless otherwise specified by qualifying
1053 the (optional) key string
1059 (which are synonyms), to require an exact match; with
1061 to require exactly one level of depth match; with
1063 to allow any level of depth match, including the exact match; with
1065 to allow any level of depth match, not including the exact match;
1067 explicitly requires the (default) match based on POSIX (''extended'')
1068 regular expression pattern.
1071 matches unbound operations; the
1074 The same behavior is obtained by using the
1081 with the optional objectClass
1087 sets the limits for any DN listed in the values of the
1093 group objectClass (default
1095 whose DN exactly matches
1098 The currently supported limits are
1103 The syntax for time limits is
1104 .BR time[.{soft|hard}]=<integer> ,
1107 is the number of seconds slapd will spend answering a search request.
1108 If no time limit is explicitly requested by the client, the
1110 limit is used; if the requested time limit exceeds the
1113 .\".I "Administrative limit exceeded"
1114 .\"error is returned.
1115 limit, the value of the limit is used instead.
1118 limit is set to the keyword
1120 the soft limit is used in either case; if it is set to the keyword
1122 no hard limit is enforced.
1123 Explicit requests for time limits smaller or equal to the
1126 If no limit specifier is set, the value is assigned to the
1132 to preserve the original behavior.
1134 The syntax for size limits is
1135 .BR size[.{soft|hard|unchecked}]=<integer> ,
1138 is the maximum number of entries slapd will return answering a search
1140 If no size limit is explicitly requested by the client, the
1142 limit is used; if the requested size limit exceeds the
1145 .\".I "Administrative limit exceeded"
1146 .\"error is returned.
1147 limit, the value of the limit is used instead.
1150 limit is set to the keyword
1152 the soft limit is used in either case; if it is set to the keyword
1154 no hard limit is enforced.
1155 Explicit requests for size limits smaller or equal to the
1160 specifier sets a limit on the number of candidates a search request is allowed
1162 The rationale behind it is that searches for non-properly indexed
1163 attributes may result in large sets of candidates, which must be
1166 to determine whether they match the search filter or not.
1169 limit provides a means to drop such operations before they are even
1171 If the selected candidates exceed the
1173 limit, the search will abort with
1174 .IR "Unwilling to perform" .
1175 If it is set to the keyword
1177 no limit is applied (the default).
1180 the search is not even performed; this can be used to disallow searches
1181 for a specific set of users.
1182 If no limit specifier is set, the value is assigned to the
1188 to preserve the original behavior.
1190 In case of no match, the global limits are used.
1191 The default values are the same of
1200 control is requested, the
1202 size limit is used by default, because the request of a specific page size
1203 is considered an explicit request for a limitation on the number
1204 of entries to be returned.
1205 However, the size limit applies to the total count of entries returned within
1206 the search, and not to a single page.
1207 Additional size limits may be enforced; the syntax is
1208 .BR size.pr={<integer>|noEstimate|unlimited} ,
1211 is the max page size if no explicit limit is set; the keyword
1213 inhibits the server from returning an estimate of the total number
1214 of entries that might be returned
1215 (note: the current implementation does not return any estimate).
1218 indicates that no limit is applied to the pagedResults control page size.
1220 .B size.prtotal={<integer>|unlimited|disabled}
1221 allows to set a limit on the total number of entries that a pagedResults
1222 control allows to return.
1223 By default it is set to the
1228 is the max number of entries that the whole search with pagedResults control
1232 to allow unlimited number of entries to be returned, e.g. to allow
1233 the use of the pagedResults control as a means to circumvent size
1234 limitations on regular searches; the keyword
1236 disables the control, i.e. no paged results can be returned.
1237 Note that the total number of entries returned when the pagedResults control
1238 is requested cannot exceed the
1240 size limit of regular searches unless extended by the
1245 .B maxderefdepth <depth>
1246 Specifies the maximum number of aliases to dereference when trying to
1247 resolve an entry, used to avoid infinite alias loops. The default is 1.
1249 .B overlay <overlay-name>
1250 Add the specified overlay to this database. An overlay is a piece of
1251 code that intercepts database operations in order to extend or change
1252 them. Overlays are pushed onto
1253 a stack over the database, and so they will execute in the reverse
1254 of the order in which they were configured and the database itself
1255 will receive control last of all.
1257 .B readonly on | off
1258 This option puts the database into "read-only" mode. Any attempts to
1259 modify the database will return an "unwilling to perform" error. By
1260 default, readonly is off.
1263 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1264 .B [starttls=yes|critical]
1265 .B [suffix=<suffix> [...]]
1266 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1267 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1268 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1269 .B [attr[!]=<attr list>]
1271 Specify a replication site for this database. Refer to the "OpenLDAP
1272 Administrator's Guide" for detailed information on setting up a replicated
1274 directory service. Zero or more
1276 instances can be used to select the subtrees that will be replicated
1277 (defaults to all the database).
1279 is deprecated in favor of the
1283 allows the replica LDAP server to be specified as an LDAP URI.
1288 requires the options
1292 and should only be used when adequate security services
1293 (e.g TLS or IPSEC) are in place. A
1299 Specific security properties (as with the
1301 keyword above) for a SASL bind can be set with the
1303 option. A non-default SASL realm can be set with the
1308 will use Kerberos, a kerberos instance should be given in
1312 can be given after the
1314 keyword to allow the selective replication of the listed attributes only;
1317 mark is used, the list is considered exclusive, i.e. the listed attributes
1319 If an objectClass is listed, all the related attributes
1320 are (are not) replicated.
1323 .B replogfile <filename>
1324 Specify the name of the replication log file to log changes to.
1325 The replication log is typically written by
1330 .BR slapd.replog (5)
1331 for more information. The specified file should be located
1332 in a directory with limited read/write/execute access as the replication
1333 logs may contain sensitive information.
1335 .B restrict <oplist>
1336 Specify a whitespace separated list of operations that are restricted.
1337 If defined inside a database specification, restrictions apply only
1338 to that database, otherwise they are global.
1339 Operations can be any of
1344 .BR extended[=<OID>] ,
1348 or the special pseudo-operations
1352 which respectively summarize read and write operations.
1360 keyword allows to indicate the OID of the specific operation
1364 Specify the distinguished name that is not subject to access control
1365 or administrative limit restrictions for operations on this database.
1366 This DN may or may not be associated with an entry. An empty root
1367 DN (the default) specifies no root access is to be granted. It is
1368 recommended that the rootdn only be specified when needed (such as
1369 when initially populating a database). If the rootdn is within
1370 a namingContext (suffix) of the database, a simple bind password
1371 may also be provided using the
1373 directive. Note that the rootdn is always needed when using syncrepl.
1375 .B rootpw <password>
1376 Specify a password (or hash of the password) for the rootdn. The
1377 password can only be set if the rootdn is within the namingContext
1378 (suffix) of the database.
1379 This option accepts all RFC 2307 userPassword formats known to
1382 description) as well as cleartext.
1384 may be used to generate a hash of a password. Cleartext
1385 and \fB{CRYPT}\fP passwords are not recommended. If empty
1386 (the default), authentication of the root DN is by other means
1387 (e.g. SASL). Use of SASL is encouraged.
1389 .B suffix <dn suffix>
1390 Specify the DN suffix of queries that will be passed to this
1391 backend database. Multiple suffix lines can be given and at least one is
1392 required for each database definition.
1393 If the suffix of one database is "inside" that of another, the database
1394 with the inner suffix must come first in the configuration file.
1397 .B syncrepl rid=<replica ID>
1398 .B provider=ldap[s]://<hostname>[:port]
1399 .B [type=refreshOnly|refreshAndPersist]
1400 .B [interval=dd:hh:mm:ss]
1401 .B [retry=[<retry interval> <# of retries>]+]
1402 .B [searchbase=<base DN>]
1403 .B [filter=<filter str>]
1404 .B [scope=sub|one|base]
1405 .B [attrs=<attr list>]
1407 .B [sizelimit=<limit>]
1408 .B [timelimit=<limit>]
1409 .B [schemachecking=on|off]
1410 .B [starttls=yes|critical]
1411 .B [bindmethod=simple|sasl]
1413 .B [saslmech=<mech>]
1414 .B [authcid=<identity>]
1415 .B [authzid=<identity>]
1416 .B [credentials=<passwd>]
1418 .B [secprops=<properties>]
1420 Specify the current database as a replica which is kept up-to-date with the
1421 master content by establishing the current
1423 as a replication consumer site running a
1426 The replica content is kept synchronized to the master content using
1427 the LDAP Content Synchronization protocol. Refer to the
1428 "OpenLDAP Administrator's Guide" for detailed information on
1429 setting up a replicated
1431 directory service using the
1435 identifies the current
1437 directive within the replication consumer site.
1438 It is a non-negative integer having no more than three digits.
1440 specifies the replication provider site containing the master content
1441 as an LDAP URI. If <port> is not given, the standard LDAP port number
1442 (389 or 636) is used. The content of the
1444 replica is defined using a search
1445 specification as its result set. The consumer
1447 will send search requests to the provider
1449 according to the search specification. The search specification includes
1450 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1453 parameters as in the normal search specification.
1454 The search specification for the LDAP Content Synchronization operation
1455 has the same value syntax and the same default values as in the
1458 The LDAP Content Synchronization protocol has two operation types.
1461 operation, the next synchronization search operation
1462 is periodically rescheduled at an interval time (specified by
1464 parameter; 1 day by default)
1465 after each synchronization operation finishes.
1467 .B refreshAndPersist
1468 operation, a synchronization search remains persistent in the provider slapd.
1469 Further updates to the master replica will generate
1470 .B searchResultEntry
1471 to the consumer slapd as the search responses to the persistent
1472 synchronization search.
1473 If an error occurs during replication, the consumer will attempt to
1474 reconnect according to the
1476 parameter which is a list of the <retry interval> and <# of retries> pairs.
1477 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1478 for the first 10 times and then retry every 300 seconds for the next 3
1479 times before stop retrying. The `+' in <# of retries> means indefinite
1480 number of retries until success.
1481 The schema checking can be enforced at the LDAP Sync
1482 consumer site by turning on the
1484 parameter. The default is off.
1487 parameter specifies use of the StartTLS extended operation
1488 to establish a TLS session before Binding to the provider. If the
1490 argument is supplied, the session will be aborted if the StartTLS request
1491 fails. Otherwise the syncrepl session continues without TLS.
1496 requires the options
1500 and should only be used when adequate security services
1501 (e.g. TLS or IPSEC) are in place.
1508 Depending on the mechanism, an authentication identity and/or
1509 credentials can be specified using
1515 parameter may be used to specify an authorization identity.
1516 Specific security properties (as with the
1518 keyword above) for a SASL bind can be set with the
1520 option. A non default SASL realm can be set with the
1526 This option is only applicable in a slave
1527 database updated using
1529 It specifies the DN permitted to update (subject to access controls)
1530 the replica (typically, this is the DN
1532 binds to update the replica). Generally, this DN
1539 Specify the referral to pass back when
1541 is asked to modify a replicated local database.
1542 If specified multiple times, each url is provided.
1544 .SH DATABASE-SPECIFIC OPTIONS
1545 Each database may allow specific configuration options; they are
1546 documented separately in the backends' manual pages.
1548 The following backends can be compiled into slapd.
1549 They are documented in the
1550 .BR slapd-<backend> (5)
1554 This is the recommended backend for a normal slapd database.
1555 However, it takes more care than with the LDBM backend to configure
1557 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1560 This backend is used to manage the configuration of slapd run-time.
1563 This backend is experimental.
1564 It serves up referrals based upon SRV resource records held in the
1568 This is a variant of the BDB backend that uses a hierarchical database
1569 layout which supports subtree renames.
1572 This backend acts as a proxy to forward incoming requests to another
1576 This is the database backend which is easiest to configure.
1577 However, it does not offer the data durability features of the BDB
1579 It uses Berkeley DB or GDBM to store data.
1582 This database uses the filesystem to build the tree structure
1583 of the database, using plain ascii files to store data.
1584 Its usage should be limited to very simple databases, where performances
1585 are not a requirement.
1588 This backend performs basic LDAP proxying with respect to a set of
1589 remote LDAP servers. It is an enhancement of the ldap backend. The
1590 proxy cache extension of meta backend provides answering of search
1591 requests from the proxy using results of previously cached requests.
1594 This backend provides information about the running status of the slapd
1598 Operations in this backend succeed but do nothing.
1601 This backend is provided for demonstration purposes only.
1602 It serves up user account information from the system
1607 This backend embeds a
1609 interpreter into slapd.
1610 It runs Perl subroutines to implement LDAP operations.
1613 This backend redirects LDAP operations to another database
1614 in the same server, based on the naming context of the request.
1615 Its use requires the
1619 for details) to rewrite the naming context of the request.
1620 It is is primarily intended to implement virtual views on databases
1621 that actually store data.
1624 This backend executes external programs to implement LDAP operations.
1625 It is primarily intended to be used in prototypes.
1628 This backend is experimental.
1629 It services LDAP requests from an SQL database.
1632 Here is a short example of a configuration file:
1636 include SYSCONFDIR/schema/core.schema
1637 pidfile LOCALSTATEDIR/slapd.pid
1639 # Subtypes of "name" (e.g. "cn" and "ou") with the
1640 # option ";x-hidden" can be searched for/compared,
1641 # but are not shown. See \fBslapd.access\fP(5).
1642 attributeoptions x-hidden lang-
1643 access to attr=name;x-hidden by * =cs
1646 suffix "dc=our-domain,dc=com"
1647 # The database directory MUST exist prior to
1648 # running slapd AND should only be accessible
1649 # by the slapd/tools. Mode 0700 recommended.
1650 directory LOCALSTATEDIR/openldap-data
1651 # Indices to maintain
1652 index objectClass eq
1653 index cn,sn,mail pres,eq,approx,sub
1655 # We serve small clients that do not handle referrals,
1656 # so handle remote lookups on their behalf.
1659 uri ldap://ldap.some-server.com/
1664 "OpenLDAP Administrator's Guide" contains a longer annotated
1665 example of a configuration file.
1666 The original ETCDIR/slapd.conf is another example.
1667 .SH OBSOLETED DIRECTIVES
1670 This directive was used in OpenLDAP 2.1 and 2.2 to glue a database
1671 with its superior. The same functionality is now provided by the
1679 default slapd configuration file
1683 .BR slapd\-dnssrv (5),
1685 .BR slapd\-ldap (5),
1686 .BR slapd\-ldbm (5),
1687 .BR slapd\-ldif (5),
1688 .BR slapd\-meta (5),
1689 .BR slapd\-monitor (5),
1690 .BR slapd\-null (5),
1691 .BR slapd\-passwd (5),
1692 .BR slapd\-perl (5),
1693 .BR slapd\-relay (5),
1694 .BR slapd\-shell (5),
1696 .BR slapd.access (5),
1697 .BR slapd.plugin (5),
1698 .BR slapd.replog (5),
1710 Known overlays are documented in
1711 .BR slapo\-accesslog (5),
1712 .BR slapo\-auditlog (5),
1713 .BR slapo\-chain (5),
1714 .BR slapo\-dynlist (5),
1715 .BR slapo\-glue (5),
1716 .BR slapo\-lastmod (5),
1717 .BR slapo\-pcache (5),
1718 .BR slapo\-ppolicy (5),
1719 .BR slapo\-refint (5),
1720 .BR slapo\-retcode (5),
1722 .BR slapo\-syncprov (5),
1723 .BR slapo\-translucent (5),
1724 .BR slapo\-unique (5).
1726 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1727 .SH ACKNOWLEDGEMENTS
1729 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1731 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob