1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2004 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 Kerberos V4 (bind) authentication.
415 disables Start TLS from forcing session to anonymous status (see also
418 disables StartTLS if authenticated (see also
422 .B ditcontentrule "(\ <oid>\
424 [DESC\ <description>]\
431 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
432 The slapd parser extends the RFC 2252 definition by allowing string
433 forms as well as numeric OIDs to be used for the attribute OID and
434 attribute syntax OID.
440 .B gentlehup { on | off }
441 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
443 will stop listening for new connections, but will not close the
444 connections to the current clients. Future write operations return
445 unwilling-to-perform, though. Slapd terminates when all clients
446 have closed their connections (if they ever do), or \- as before \-
447 if it receives a SIGTERM signal. This can be useful if you wish to
448 terminate the server and start a new
451 .B with another database,
452 without disrupting the currently active clients.
453 The default is off. You may wish to use
455 along with this option.
457 .B idletimeout <integer>
458 Specify the number of seconds to wait before forcibly closing
459 an idle client connection. A idletimeout of 0 disables this
460 feature. The default is 0.
462 .B include <filename>
463 Read additional configuration information from the given file before
464 continuing with the next line of the current file.
466 .B index_substr_if_minlen <integer>
467 Specify the minimum length for subinitial and subfinal indices. An
468 attribute value must have at least this many characters in order to be
469 processed by the indexing functions. The default is 2.
471 .B index_substr_if_maxlen <integer>
472 Specify the maximum length for subinitial and subfinal indices. Only
473 this many characters of an attribute value will be processed by the
474 indexing functions; any excess characters are ignored. The default is 4.
476 .B index_substr_any_len <integer>
477 Specify the length used for subany indices. An attribute value must have
478 at least this many characters in order to be processed. Attribute values
479 longer than this length will be processed in segments of this length. The
480 default is 4. The subany index will also be used in subinitial and
481 subfinal index lookups when the filter string is longer than the
482 .I index_substr_if_maxlen
485 .B index_substr_any_step <integer>
486 Specify the steps used in subany index lookups. This value sets the offset
487 for the segments of a filter string that are processed for a subany index
488 lookup. The default is 2. For example, with the default values, a search
489 using this filter "cn=*abcdefgh*" would generate index lookups for
490 "abcd", "cdef", and "efgh".
492 .\"-- NEW_LOGGING option --
494 .\".B logfile <filename>
495 .\"Specify a file for recording debug log messages. By default these messages
496 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
497 .\"copies messages to both stderr and the logfile.
500 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
501 such as those to the ldapi:// listener. For a description of SSF values,
505 option description. The default is 71.
507 .B loglevel <integer> [...]
508 Specify the level at which debugging statements and operation
509 statistics should be syslogged (currently logged to the
511 LOG_LOCAL4 facility). Log levels are additive, and available levels
523 debug packet handling
527 heavy trace debugging
531 connection management
535 print out packets sent and received
539 search filter processing
543 configuration file processing
547 access control list processing
551 stats log connections/operations/results
555 stats log entries sent
559 print communication with shell backends
566 The desired log level can be input as a single integer that combines
567 the (ORed) desired levels, as a list of integers (that are ORed internally),
568 or as a list of the names that are shown between brackets, such that
579 can be used as a shortcut to enable logging at all levels (equivalent to -1).
582 .B moduleload <filename>
583 Specify the name of a dynamically loadable module to load. The filename
584 may be an absolute path name or a simple filename. Non-absolute names
585 are searched for in the directories specified by the
587 option. This option and the
589 option are only usable if slapd was compiled with --enable-modules.
591 .B modulepath <pathspec>
592 Specify a list of directories to search for loadable modules. Typically
593 the path is colon-separated but this depends on the operating system.
596 .B objectclass "(\ <oid>\
598 [DESC\ <description]\
601 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
602 [MUST\ <oids>] [MAY\ <oids>] )"
604 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
605 The slapd parser extends the RFC 2252 definition by allowing string
606 forms as well as numeric OIDs to be used for the object class OID.
610 description.) Object classes are "STRUCTURAL" by default.
613 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
614 Define a string name that equates to the given OID. The string can be used
615 in place of the numeric OID in objectclass and attribute definitions. The
616 name can also be used with a suffix of the form ":xx" in which case the
617 value "oid.xx" will be used.
619 .B password-hash <hash> [<hash>...]
620 This option configures one or more hashes to be used in generation of user
621 passwords stored in the userPassword attribute during processing of
622 LDAP Password Modify Extended Operations (RFC 3062).
623 The <hash> must be one of
637 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
642 use the MD5 algorithm (RFC 1321), the latter with a seed.
649 indicates that the new password should be
650 added to userPassword as clear text.
652 Note that this option does not alter the normal user applications
653 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
655 .B password\-crypt\-salt\-format <format>
656 Specify the format of the salt passed to
658 when generating {CRYPT} passwords (see
660 during processing of LDAP Password Modify Extended Operations (RFC 3062).
662 This string needs to be in
664 format and may include one (and only one) %s conversion.
665 This conversion will be substituted with a string of random
666 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
667 provides a two character salt and "$1$%.8s" tells some
668 versions of crypt(3) to use an MD5 algorithm and provides
669 8 random characters of salt. The default is "%s", which
670 provides 31 characters of salt.
672 .B pidfile <filename>
673 The ( absolute ) name of a file that will hold the
675 server's process ID ( see
677 ) if started without the debugging command line option.
680 Specify the referral to pass back when
682 cannot find a local database to handle a request.
683 If specified multiple times, each url is provided.
686 The ( absolute ) name of a file that will hold the
688 server's command line options
689 if started without the debugging command line option.
692 The ( absolute ) name of a file that will hold the
694 server's process ID ( see
696 ) if started without the debugging command line option.
698 .B replicationinterval
699 The number of seconds
701 waits before checking the replogfile for changes.
703 .B require <conditions>
704 Specify a set of conditions (separated by white space) to
705 require (default none).
706 The directive may be specified globally and/or per-database.
708 requires bind operation prior to directory operations.
710 requires session to be using LDAP version 3.
712 requires authentication prior to directory operations.
714 requires SASL authentication prior to directory operations.
716 requires strong authentication prior to directory operations.
717 The strong keyword allows protected "simple" authentication
718 as well as SASL authentication.
720 may be used to require no conditions (useful for clearly globally
721 set conditions within a particular database).
723 .B reverse-lookup on | off
724 Enable/disable client name unverified reverse lookup (default is
726 if compiled with --enable-rlookups).
729 Specify the name of an LDIF(5) file containing user defined attributes
730 for the root DSE. These attributes are returned in addition to the
731 attributes normally produced by slapd.
734 Used to specify the fully qualified domain name used for SASL processing.
736 .B sasl-realm <realm>
737 Specify SASL realm. Default is empty.
739 .B sasl-secprops <properties>
740 Used to specify Cyrus SASL security properties.
743 flag (without any other properties) causes the flag properties
744 default, "noanonymous,noplain", to be cleared.
747 flag disables mechanisms susceptible to simple passive attacks.
750 flag disables mechanisms susceptible to active attacks.
753 flag disables mechanisms susceptible to passive dictionary attacks.
756 flag disables mechanisms which support anonymous login.
759 flag require forward secrecy between sessions.
762 require mechanisms which pass client credentials (and allow
763 mechanisms which can pass credentials to do so).
766 property specifies the minimum acceptable
767 .I security strength factor
768 as an integer approximate to effective key length used for
769 encryption. 0 (zero) implies no protection, 1 implies integrity
770 protection only, 56 allows DES or other weak ciphers, 112
771 allows triple DES and other strong ciphers, 128 allows RC4,
772 Blowfish and other modern strong ciphers. The default is 0.
775 property specifies the maximum acceptable
776 .I security strength factor
777 as an integer (see minssf description). The default is INT_MAX.
780 property specifies the maximum security layer receive buffer
781 size allowed. 0 disables security layers. The default is 65536.
784 Specify the distinguished name for the subschema subentry that
785 controls the entries on this server. The default is "cn=Subschema".
787 .B security <factors>
788 Specify a set of security strength factors (separated by white space)
792 option for a description of security strength factors).
793 The directive may be specified globally and/or per-database.
795 specifies the overall security strength factor.
797 specifies the transport security strength factor.
799 specifies the TLS security strength factor.
801 specifies the SASL security strength factor.
803 specifies the overall security strength factor to require for
805 .B update_transport=<n>
806 specifies the transport security strength factor to require for
809 specifies the TLS security strength factor to require for
812 specifies the SASL security strength factor to require for
815 specifies the security strength factor required for
817 username/password authentication.
820 factor is measure of security provided by the underlying transport,
821 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
823 .B sizelimit {<integer>|unlimited}
825 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
826 Specify the maximum number of entries to return from a search operation.
827 The default size limit is 500.
830 to specify no limits.
831 The second format allows a fine grain setting of the size limits.
832 Extra args can be added on the same line.
835 for an explanation of the different flags.
837 .B sockbuf_max_incoming <integer>
838 Specify the maximum incoming LDAP PDU size for anonymous sessions.
839 The default is 262143.
841 .B sockbuf_max_incoming_auth <integer>
842 Specify the maximum incoming LDAP PDU size for authenticated sessions.
843 The default is 4194303.
846 Specify the srvtab file in which the kerberos keys necessary for
847 authenticating clients using kerberos can be found. This option is only
848 meaningful if you are using Kerberos authentication.
851 Specify the maximum size of the primary thread pool.
854 .B timelimit {<integer>|unlimited}
856 .B timelimit time[.{soft|hard}]=<integer> [...]
857 Specify the maximum number of seconds (in real time)
859 will spend answering a search request. The default time limit is 3600.
862 to specify no limits.
863 The second format allows a fine grain setting of the time limits.
864 Extra args can be added on the same line.
867 for an explanation of the different flags.
869 .B ucdata-path <path>
870 Specify the path to the directory containing the Unicode character
871 tables. The default path is DATADIR/ucdata.
875 is built with support for Transport Layer Security, there are more options
878 .B TLSCipherSuite <cipher-suite-spec>
879 Permits configuring what ciphers will be accepted and the preference order.
880 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
882 TLSCipherSuite HIGH:MEDIUM:+SSLv2
884 To check what ciphers a given spec selects, use:
886 openssl ciphers -v <cipher-suite-spec>
888 .B TLSCACertificateFile <filename>
889 Specifies the file that contains certificates for all of the Certificate
894 .B TLSCACertificatePath <path>
895 Specifies the path of a directory that contains Certificate Authority
896 certificates in separate individual files. Usually only one of this
897 or the TLSCACertificateFile is used.
899 .B TLSCertificateFile <filename>
900 Specifies the file that contains the
904 .B TLSCertificateKeyFile <filename>
905 Specifies the file that contains the
907 server private key that matches the certificate stored in the
908 .B TLSCertificateFile
909 file. Currently, the private key must not be protected with a password, so
910 it is of critical importance that it is protected carefully.
912 .B TLSRandFile <filename>
913 Specifies the file to obtain random bits from when /dev/[u]random
914 is not available. Generally set to the name of the EGD/PRNGD socket.
915 The environment variable RANDFILE can also be used to specify the filename.
917 .B TLSVerifyClient <level>
918 Specifies what checks to perform on client certificates in an
919 incoming TLS session, if any.
922 can be specified as one of the following keywords:
928 will not ask the client for a certificate.
931 The client certificate is requested. If no certificate is provided,
932 the session proceeds normally. If a bad certificate is provided,
933 it will be ignored and the session proceeds normally.
936 The client certificate is requested. If no certificate is provided,
937 the session proceeds normally. If a bad certificate is provided,
938 the session is immediately terminated.
940 .B demand | hard | true
941 These keywords are all equivalent, for compatibility reasons.
942 The client certificate is requested. If no certificate is provided,
943 or a bad certificate is provided, the session is immediately terminated.
945 Note that a valid client certificate is required in order to use the
946 SASL EXTERNAL authentication mechanism with a TLS session. As such,
949 setting must be chosen to enable SASL EXTERNAL authentication.
952 .B TLSCRLCheck <level>
953 Specifies if the Certificate Revocation List (CRL) of the CA should be
954 used to verify if the client certicates have not been revoked. This
956 .B TLSCACertificatePath
959 can be specified as one of the following keywords:
963 No CRL checks are performed
966 Check the CRL of the peer certificate
969 Check the CRL for a whole certificate chain
971 .SH GENERAL BACKEND OPTIONS
972 Options in this section only apply to the configuration file section
973 for the specified backend. They are supported by every
976 .B backend <databasetype>
977 Mark the beginning of a backend definition. <databasetype>
993 depending on which backend will serve the database.
995 .SH GENERAL DATABASE OPTIONS
996 Options in this section only apply to the configuration file section
997 for the database in which they are defined. They are supported by every
998 type of backend. Note that the
1002 option are mandatory for each database.
1004 .B database <databasetype>
1005 Mark the beginning of a new database instance definition. <databasetype>
1021 depending on which backend will serve the database.
1026 will automatically maintain the
1027 modifiersName, modifyTimestamp, creatorsName, and
1028 createTimestamp attributes for entries. By default, lastmod is on.
1030 .B limits <who> <limit> [<limit> [...]]
1031 Specify time and size limits based on who initiated an operation.
1038 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1044 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1049 matches all unauthenticated clients.
1052 matches all authenticated clients;
1055 dn pattern is assumed unless otherwise specified by qualifying
1056 the (optional) key string
1062 (which are synonyms), to require an exact match; with
1064 to require exactly one level of depth match; with
1066 to allow any level of depth match, including the exact match; with
1068 to allow any level of depth match, not including the exact match;
1070 explicitly requires the (default) match based on POSIX (''extended'')
1071 regular expression pattern.
1074 matches unbound operations; the
1077 The same behavior is obtained by using the
1084 with the optional objectClass
1090 sets the limits for any DN listed in the values of the
1096 group objectClass (default
1098 whose DN exactly matches
1101 The currently supported limits are
1106 The syntax for time limits is
1107 .BR time[.{soft|hard}]=<integer> ,
1110 is the number of seconds slapd will spend answering a search request.
1111 If no time limit is explicitly requested by the client, the
1113 limit is used; if the requested time limit exceeds the
1116 .\".I "Administrative limit exceeded"
1117 .\"error is returned.
1118 limit, the value of the limit is used instead.
1121 limit is set to the keyword
1123 the soft limit is used in either case; if it is set to the keyword
1125 no hard limit is enforced.
1126 Explicit requests for time limits smaller or equal to the
1129 If no limit specifier is set, the value is assigned to the
1135 to preserve the original behavior.
1137 The syntax for size limits is
1138 .BR size[.{soft|hard|unchecked}]=<integer> ,
1141 is the maximum number of entries slapd will return answering a search
1143 If no size limit is explicitly requested by the client, the
1145 limit is used; if the requested size limit exceeds the
1148 .\".I "Administrative limit exceeded"
1149 .\"error is returned.
1150 limit, the value of the limit is used instead.
1153 limit is set to the keyword
1155 the soft limit is used in either case; if it is set to the keyword
1157 no hard limit is enforced.
1158 Explicit requests for size limits smaller or equal to the
1163 specifier sets a limit on the number of candidates a search request is allowed
1165 The rationale behind it is that searches for non-properly indicized
1166 attributes may result in large sets of candidates, which must be
1169 to determine whether they match the search filter or not.
1172 limit provides a means to drop such operations before they are even
1174 If the selected candidates exceed the
1176 limit, the search will abort with
1177 .IR "Unwilling to perform" .
1178 If it is set to the keyword
1180 no limit is applied (the default).
1183 the search is not even performed; this can be used to disallow searches
1184 for a specific set of users.
1185 If no limit specifier is set, the value is assigned to the
1191 to preserve the original behavior.
1193 In case of no match, the global limits are used.
1194 The default values are the same of
1203 control is requested, the
1205 size limit is used by default, because the request of a specific page size
1206 is considered an explicit request for a limitation on the number
1207 of entries to be returned.
1208 However, the size limit applies to the total count of entries returned within
1209 the search, and not to a single page.
1210 Additional size limits may be enforced; the syntax is
1211 .BR size.pr={<integer>|noEstimate|unlimited} ,
1214 is the max page size if no explicit limit is set; the keyword
1216 inhibits the server from returning an estimate of the total number
1217 of entries that might be returned
1218 (note: the current implementation does not return any estimate).
1221 indicates that no limit is applied to the pagedResults control page size.
1223 .B size.prtotal={<integer>|unlimited|disabled}
1224 allows to set a limit on the total number of entries that a pagedResults
1225 control allows to return.
1226 By default it is set to the
1231 is the max number of entries that the whole search with pagedResults control
1235 to allow unlimited number of entries to be returned, e.g. to allow
1236 the use of the pagedResults control as a means to circumvent size
1237 limitations on regular searches; the keyword
1239 disables the control, i.e. no paged results can be returned.
1240 Note that the total number of entries returned when the pagedResults control
1241 is requested cannot exceed the
1243 size limit of regular searches unless extended by the
1248 .B maxderefdepth <depth>
1249 Specifies the maximum number of aliases to dereference when trying to
1250 resolve an entry, used to avoid infinite alias loops. The default is 1.
1252 .B overlay <overlay-name>
1253 Add the specified overlay to this database. An overlay is a piece of
1254 code that intercepts database operations in order to extend or change
1255 them. Overlays are pushed onto
1256 a stack over the database, and so they will execute in the reverse
1257 of the order in which they were configured and the database itself
1258 will receive control last of all.
1260 .B readonly on | off
1261 This option puts the database into "read-only" mode. Any attempts to
1262 modify the database will return an "unwilling to perform" error. By
1263 default, readonly is off.
1266 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1267 .B [starttls=yes|critical]
1268 .B [suffix=<suffix> [...]]
1269 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1270 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1271 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1272 .B [attr[!]=<attr list>]
1274 Specify a replication site for this database. Refer to the "OpenLDAP
1275 Administrator's Guide" for detailed information on setting up a replicated
1277 directory service. Zero or more
1279 instances can be used to select the subtrees that will be replicated
1280 (defaults to all the database).
1282 is deprecated in favor of the
1286 allows the replica LDAP server to be specified as an LDAP URI.
1291 requires the options
1295 and should only be used when adequate security services
1296 (e.g TLS or IPSEC) are in place. A
1302 Specific security properties (as with the
1304 keyword above) for a SASL bind can be set with the
1306 option. A non-default SASL realm can be set with the
1311 will use Kerberos, a kerberos instance should be given in
1315 can be given after the
1317 keyword to allow the selective replication of the listed attributes only;
1320 mark is used, the list is considered exclusive, i.e. the listed attributes
1322 If an objectClass is listed, all the related attributes
1323 are (are not) replicated.
1326 .B replogfile <filename>
1327 Specify the name of the replication log file to log changes to.
1328 The replication log is typically written by
1333 .BR slapd.replog (5)
1334 for more information. The specified file should be located
1335 in a directory with limited read/write/execute access as the replication
1336 logs may contain sensitive information.
1338 .B restrict <oplist>
1339 Specify a whitespace separated list of operations that are restricted.
1340 If defined inside a database specification, restrictions apply only
1341 to that database, otherwise they are global.
1342 Operations can be any of
1347 .BR extended[=<OID>] ,
1351 or the special pseudo-operations
1355 which respectively summarize read and write operations.
1363 keyword allows to indicate the OID of the specific operation
1367 Specify the distinguished name that is not subject to access control
1368 or administrative limit restrictions for operations on this database.
1369 This DN may or may not be associated with an entry. An empty root
1370 DN (the default) specifies no root access is to be granted. It is
1371 recommended that the rootdn only be specified when needed (such as
1372 when initially populating a database). If the rootdn is within
1373 a namingContext (suffix) of the database, a simple bind password
1374 may also be provided using the
1378 .B rootpw <password>
1379 Specify a password (or hash of the password) for the rootdn. The
1380 password can only be set if the rootdn is within the namingContext
1381 (suffix) of the database.
1382 This option accepts all RFC 2307 userPassword formats known to
1385 description) as well as cleartext.
1387 may be used to generate a hash of a password. Cleartext
1388 and \fB{CRYPT}\fP passwords are not recommended. If empty
1389 (the default), authentication of the root DN is by other means
1390 (e.g. SASL). Use of SASL is encouraged.
1392 .B suffix <dn suffix>
1393 Specify the DN suffix of queries that will be passed to this
1394 backend database. Multiple suffix lines can be given and at least one is
1395 required for each database definition.
1396 If the suffix of one database is "inside" that of another, the database
1397 with the inner suffix must come first in the configuration file.
1400 .B syncrepl rid=<replica ID>
1401 .B provider=ldap[s]://<hostname>[:port]
1402 .B [type=refreshOnly|refreshAndPersist]
1403 .B [interval=dd:hh:mm:ss]
1404 .B [retry=[<retry interval> <# of retries>]+]
1405 .B [searchbase=<base DN>]
1406 .B [filter=<filter str>]
1407 .B [scope=sub|one|base]
1408 .B [attrs=<attr list>]
1410 .B [sizelimit=<limit>]
1411 .B [timelimit=<limit>]
1412 .B [schemachecking=on|off]
1414 .B [bindmethod=simple|sasl]
1416 .B [saslmech=<mech>]
1417 .B [authcid=<identity>]
1418 .B [authzid=<identity>]
1419 .B [credentials=<passwd>]
1421 .B [secprops=<properties>]
1423 Specify the current database as a replica which is kept up-to-date with the
1424 master content by establishing the current
1426 as a replication consumer site running a
1429 The replica content is kept synchronized to the master content using
1430 the LDAP Content Synchronization protocol. Refer to the
1431 "OpenLDAP Administrator's Guide" for detailed information on
1432 setting up a replicated
1434 directory service using the
1438 identifies the current
1440 directive within the replication consumer site.
1441 It is a non-negative integer having no more than three digits.
1443 specifies the replication provider site containing the master content
1444 as an LDAP URI. If <port> is not given, the standard LDAP port number
1445 (389 or 636) is used. The content of the
1447 replica is defined using a search
1448 specification as its result set. The consumer
1450 will send search requests to the provider
1452 according to the search specification. The search specification includes
1453 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1456 parameters as in the normal search specification.
1457 The search specification for the LDAP Content Synchronization operation
1458 has the same value syntax and the same default values as in the
1461 The LDAP Content Synchronization protocol has two operation types.
1464 operation, the next synchronization search operation
1465 is periodically rescheduled at an interval time (specified by
1467 parameter; 1 day by default)
1468 after each synchronization operation finishes.
1470 .B refreshAndPersist
1471 operation, a synchronization search remains persistent in the provider slapd.
1472 Further updates to the master replica will generate
1473 .B searchResultEntry
1474 to the consumer slapd as the search responses to the persistent
1475 synchronization search.
1476 If an error occurs during replication, the consumer will attempt to
1477 reconnect according to the
1479 parameter which is a list of the <retry interval> and <# of retries> pairs.
1480 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1481 for the first 10 times and then retry every 300 seconds for the next 3
1482 times before stop retrying. The `+' in <# of retries> means indefinite
1483 number of retries until success.
1484 The schema checking can be enforced at the LDAP Sync
1485 consumer site by turning on the
1487 parameter. The default is off.
1490 parameter specifies the DN in the consumer site
1491 which is allowed to make changes to the replica.
1492 The DN should have read/write access to the replica database.
1497 of the master database.
1502 requires the options
1506 and should only be used when adequate security services
1507 (e.g. TLS or IPSEC) are in place.
1514 Depending on the mechanism, an authentication identity and/or
1515 credentials can be specified using
1521 parameter may be used to specify an authorization identity.
1522 Specific security properties (as with the
1524 keyword above) for a SASL bind can be set with the
1526 option. A non default SASL realm can be set with the
1532 This option is only applicable in a slave
1533 database updated using
1535 It specifies the DN permitted to update (subject to access controls)
1536 the replica (typically, this is the DN
1538 binds to update the replica). Generally, this DN
1545 Specify the referral to pass back when
1547 is asked to modify a replicated local database.
1548 If specified multiple times, each url is provided.
1550 .SH DATABASE-SPECIFIC OPTIONS
1551 Each database may allow specific configuration options; they are
1552 documented separately in the backends' manual pages.
1554 The following backends can be compiled into slapd.
1555 They are documented in the
1556 .BR slapd-<backend> (5)
1560 This is the recommended backend for a normal slapd database.
1561 However, it takes more care than with the LDBM backend to configure
1563 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1566 This is the database backend which is easiest to configure.
1567 However, it does not offer the data durability features of the BDB
1569 It uses Berkeley DB or GDBM to store data.
1572 This backend is experimental.
1573 It serves up referrals based upon SRV resource records held in the
1577 This backend acts as a proxy to forward incoming requests to another
1581 This backend performs basic LDAP proxying with respect to a set of
1582 remote LDAP servers. It is an enhancement of the ldap backend. The
1583 proxy cache extension of meta backend provides answering of search
1584 requests from the proxy using results of previously cached requests.
1587 This backend provides information about the running status of the slapd
1591 Operations in this backend succeed but do nothing.
1594 This backend is provided for demonstration purposes only.
1595 It serves up user account information from the system
1600 This backend embeds a
1602 interpreter into slapd.
1603 It runs Perl subroutines to implement LDAP operations.
1606 This backend redirects LDAP operations to another database
1607 in the same server, based on the naming context of the request.
1608 Its use requires the
1612 for details) to rewrite the naming context of the request.
1613 It is is primarily intended to implement virtual views on databases
1614 that actually store data.
1617 This backend executes external programs to implement LDAP operations.
1618 It is primarily intended to be used in prototypes.
1621 This backend is experimental.
1622 It services LDAP requests from an SQL database.
1625 This backend is experimental.
1628 interpreter into slapd.
1629 It runs Tcl commands to implement LDAP operations.
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.
1670 default slapd configuration file
1674 .BR slapd\-dnssrv (5),
1675 .BR slapd\-ldap (5),
1676 .BR slapd\-ldbm (5),
1677 .BR slapd\-meta (5),
1678 .BR slapd\-monitor (5),
1679 .BR slapd\-null (5),
1680 .BR slapd\-passwd (5),
1681 .BR slapd\-perl (5),
1682 .BR slapd\-relay (5),
1683 .BR slapd\-shell (5),
1686 .BR slapd.access (5),
1687 .BR slapd.plugin (5),
1688 .BR slapd.replog (5),
1700 Known overlays are documented in
1701 .BR slapo\-lastmod (5),
1702 .BR slapo\-pcache (5),
1703 .BR slapo\-ppolicy (5),
1704 .BR slapo\-refint (5),
1706 .BR slapo\-unique (5).
1708 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1709 .SH ACKNOWLEDGEMENTS
1711 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1713 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob