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 tool-threads <integer>
863 Specify the maximum number of threads to use in tool mode.
864 This should not be greater than the number of CPUs in the system.
866 .\"ucdata-path is obsolete / ignored...
868 .\".B ucdata-path <path>
869 .\"Specify the path to the directory containing the Unicode character
870 .\"tables. The default path is DATADIR/ucdata.
874 is built with support for Transport Layer Security, there are more options
877 .B TLSCipherSuite <cipher-suite-spec>
878 Permits configuring what ciphers will be accepted and the preference order.
879 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
881 TLSCipherSuite HIGH:MEDIUM:+SSLv2
883 To check what ciphers a given spec selects, use:
885 openssl ciphers -v <cipher-suite-spec>
887 .B TLSCACertificateFile <filename>
888 Specifies the file that contains certificates for all of the Certificate
893 .B TLSCACertificatePath <path>
894 Specifies the path of a directory that contains Certificate Authority
895 certificates in separate individual files. Usually only one of this
896 or the TLSCACertificateFile is used.
898 .B TLSCertificateFile <filename>
899 Specifies the file that contains the
903 .B TLSCertificateKeyFile <filename>
904 Specifies the file that contains the
906 server private key that matches the certificate stored in the
907 .B TLSCertificateFile
908 file. Currently, the private key must not be protected with a password, so
909 it is of critical importance that it is protected carefully.
911 .B TLSDHParamFile <filename>
912 This directive specifies the file that contains parameters for Diffie-Hellman
913 ephemeral key exchange. This is required in order to use a DSA certificate on
914 the server. If multiple sets of parameters are present in the file, all of
915 them will be processed.
917 .B TLSRandFile <filename>
918 Specifies the file to obtain random bits from when /dev/[u]random
919 is not available. Generally set to the name of the EGD/PRNGD socket.
920 The environment variable RANDFILE can also be used to specify the filename.
922 .B TLSVerifyClient <level>
923 Specifies what checks to perform on client certificates in an
924 incoming TLS session, if any.
927 can be specified as one of the following keywords:
933 will not ask the client for a certificate.
936 The client certificate is requested. If no certificate is provided,
937 the session proceeds normally. If a bad certificate is provided,
938 it will be ignored and the session proceeds normally.
941 The client certificate is requested. If no certificate is provided,
942 the session proceeds normally. If a bad certificate is provided,
943 the session is immediately terminated.
945 .B demand | hard | true
946 These keywords are all equivalent, for compatibility reasons.
947 The client certificate is requested. If no certificate is provided,
948 or a bad certificate is provided, the session is immediately terminated.
950 Note that a valid client certificate is required in order to use the
951 SASL EXTERNAL authentication mechanism with a TLS session. As such,
954 setting must be chosen to enable SASL EXTERNAL authentication.
957 .B TLSCRLCheck <level>
958 Specifies if the Certificate Revocation List (CRL) of the CA should be
959 used to verify if the client certificates have not been revoked. This
961 .B TLSCACertificatePath
964 can be specified as one of the following keywords:
968 No CRL checks are performed
971 Check the CRL of the peer certificate
974 Check the CRL for a whole certificate chain
976 .SH GENERAL BACKEND OPTIONS
977 Options in this section only apply to the configuration file section
978 for the specified backend. They are supported by every
981 .B backend <databasetype>
982 Mark the beginning of a backend definition. <databasetype>
1000 depending on which backend will serve the database.
1002 .SH GENERAL DATABASE OPTIONS
1003 Options in this section only apply to the configuration file section
1004 for the database in which they are defined. They are supported by every
1005 type of backend. Note that the
1009 option are mandatory for each database.
1011 .B database <databasetype>
1012 Mark the beginning of a new database instance definition. <databasetype>
1030 depending on which backend will serve the database.
1035 will automatically maintain the
1036 modifiersName, modifyTimestamp, creatorsName, and
1037 createTimestamp attributes for entries. By default, lastmod is on.
1039 .B limits <who> <limit> [<limit> [...]]
1040 Specify time and size limits based on who initiated an operation.
1047 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1053 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1058 matches all unauthenticated clients.
1061 matches all authenticated clients;
1064 dn pattern is assumed unless otherwise specified by qualifying
1065 the (optional) key string
1071 (which are synonyms), to require an exact match; with
1073 to require exactly one level of depth match; with
1075 to allow any level of depth match, including the exact match; with
1077 to allow any level of depth match, not including the exact match;
1079 explicitly requires the (default) match based on POSIX (''extended'')
1080 regular expression pattern.
1083 matches unbound operations; the
1086 The same behavior is obtained by using the
1093 with the optional objectClass
1099 sets the limits for any DN listed in the values of the
1105 group objectClass (default
1107 whose DN exactly matches
1110 The currently supported limits are
1115 The syntax for time limits is
1116 .BR time[.{soft|hard}]=<integer> ,
1119 is the number of seconds slapd will spend answering a search request.
1120 If no time limit is explicitly requested by the client, the
1122 limit is used; if the requested time limit exceeds the
1125 .\".I "Administrative limit exceeded"
1126 .\"error is returned.
1127 limit, the value of the limit is used instead.
1130 limit is set to the keyword
1132 the soft limit is used in either case; if it is set to the keyword
1134 no hard limit is enforced.
1135 Explicit requests for time limits smaller or equal to the
1138 If no limit specifier is set, the value is assigned to the
1144 to preserve the original behavior.
1146 The syntax for size limits is
1147 .BR size[.{soft|hard|unchecked}]=<integer> ,
1150 is the maximum number of entries slapd will return answering a search
1152 If no size limit is explicitly requested by the client, the
1154 limit is used; if the requested size limit exceeds the
1157 .\".I "Administrative limit exceeded"
1158 .\"error is returned.
1159 limit, the value of the limit is used instead.
1162 limit is set to the keyword
1164 the soft limit is used in either case; if it is set to the keyword
1166 no hard limit is enforced.
1167 Explicit requests for size limits smaller or equal to the
1172 specifier sets a limit on the number of candidates a search request is allowed
1174 The rationale behind it is that searches for non-properly indexed
1175 attributes may result in large sets of candidates, which must be
1178 to determine whether they match the search filter or not.
1181 limit provides a means to drop such operations before they are even
1183 If the selected candidates exceed the
1185 limit, the search will abort with
1186 .IR "Unwilling to perform" .
1187 If it is set to the keyword
1189 no limit is applied (the default).
1192 the search is not even performed; this can be used to disallow searches
1193 for a specific set of users.
1194 If no limit specifier is set, the value is assigned to the
1200 to preserve the original behavior.
1202 In case of no match, the global limits are used.
1203 The default values are the same of
1212 control is requested, the
1214 size limit is used by default, because the request of a specific page size
1215 is considered an explicit request for a limitation on the number
1216 of entries to be returned.
1217 However, the size limit applies to the total count of entries returned within
1218 the search, and not to a single page.
1219 Additional size limits may be enforced; the syntax is
1220 .BR size.pr={<integer>|noEstimate|unlimited} ,
1223 is the max page size if no explicit limit is set; the keyword
1225 inhibits the server from returning an estimate of the total number
1226 of entries that might be returned
1227 (note: the current implementation does not return any estimate).
1230 indicates that no limit is applied to the pagedResults control page size.
1232 .B size.prtotal={<integer>|unlimited|disabled}
1233 allows to set a limit on the total number of entries that a pagedResults
1234 control allows to return.
1235 By default it is set to the
1240 is the max number of entries that the whole search with pagedResults control
1244 to allow unlimited number of entries to be returned, e.g. to allow
1245 the use of the pagedResults control as a means to circumvent size
1246 limitations on regular searches; the keyword
1248 disables the control, i.e. no paged results can be returned.
1249 Note that the total number of entries returned when the pagedResults control
1250 is requested cannot exceed the
1252 size limit of regular searches unless extended by the
1257 .B maxderefdepth <depth>
1258 Specifies the maximum number of aliases to dereference when trying to
1259 resolve an entry, used to avoid infinite alias loops. The default is 1.
1261 .B overlay <overlay-name>
1262 Add the specified overlay to this database. An overlay is a piece of
1263 code that intercepts database operations in order to extend or change
1264 them. Overlays are pushed onto
1265 a stack over the database, and so they will execute in the reverse
1266 of the order in which they were configured and the database itself
1267 will receive control last of all.
1269 .B readonly on | off
1270 This option puts the database into "read-only" mode. Any attempts to
1271 modify the database will return an "unwilling to perform" error. By
1272 default, readonly is off.
1275 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1276 .B [starttls=yes|critical]
1277 .B [suffix=<suffix> [...]]
1278 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1279 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1280 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1281 .B [attr[!]=<attr list>]
1283 Specify a replication site for this database. Refer to the "OpenLDAP
1284 Administrator's Guide" for detailed information on setting up a replicated
1286 directory service. Zero or more
1288 instances can be used to select the subtrees that will be replicated
1289 (defaults to all the database).
1291 is deprecated in favor of the
1295 allows the replica LDAP server to be specified as an LDAP URI.
1300 requires the options
1304 and should only be used when adequate security services
1305 (e.g TLS or IPSEC) are in place. A
1311 Specific security properties (as with the
1313 keyword above) for a SASL bind can be set with the
1315 option. A non-default SASL realm can be set with the
1320 will use Kerberos, a kerberos instance should be given in
1324 can be given after the
1326 keyword to allow the selective replication of the listed attributes only;
1329 mark is used, the list is considered exclusive, i.e. the listed attributes
1331 If an objectClass is listed, all the related attributes
1332 are (are not) replicated.
1335 .B replogfile <filename>
1336 Specify the name of the replication log file to log changes to.
1337 The replication log is typically written by
1342 .BR slapd.replog (5)
1343 for more information. The specified file should be located
1344 in a directory with limited read/write/execute access as the replication
1345 logs may contain sensitive information.
1347 .B restrict <oplist>
1348 Specify a whitespace separated list of operations that are restricted.
1349 If defined inside a database specification, restrictions apply only
1350 to that database, otherwise they are global.
1351 Operations can be any of
1356 .BR extended[=<OID>] ,
1360 or the special pseudo-operations
1364 which respectively summarize read and write operations.
1372 keyword allows to indicate the OID of the specific operation
1376 Specify the distinguished name that is not subject to access control
1377 or administrative limit restrictions for operations on this database.
1378 This DN may or may not be associated with an entry. An empty root
1379 DN (the default) specifies no root access is to be granted. It is
1380 recommended that the rootdn only be specified when needed (such as
1381 when initially populating a database). If the rootdn is within
1382 a namingContext (suffix) of the database, a simple bind password
1383 may also be provided using the
1385 directive. Note that the rootdn is always needed when using syncrepl.
1387 .B rootpw <password>
1388 Specify a password (or hash of the password) for the rootdn. The
1389 password can only be set if the rootdn is within the namingContext
1390 (suffix) of the database.
1391 This option accepts all RFC 2307 userPassword formats known to
1394 description) as well as cleartext.
1396 may be used to generate a hash of a password. Cleartext
1397 and \fB{CRYPT}\fP passwords are not recommended. If empty
1398 (the default), authentication of the root DN is by other means
1399 (e.g. SASL). Use of SASL is encouraged.
1401 .B suffix <dn suffix>
1402 Specify the DN suffix of queries that will be passed to this
1403 backend database. Multiple suffix lines can be given and at least one is
1404 required for each database definition.
1405 If the suffix of one database is "inside" that of another, the database
1406 with the inner suffix must come first in the configuration file.
1408 .B subordinate [advertise]
1409 Specify that the current backend database is a subordinate of another
1410 backend database. A subordinate database may have only one suffix. This
1411 option may be used to glue multiple databases into a single namingContext.
1412 If the suffix of the current database is within the namingContext of a
1413 superior database, searches against the superior database will be
1414 propagated to the subordinate as well. All of the databases
1415 associated with a single namingContext should have identical rootdns.
1416 Behavior of other LDAP operations is unaffected by this setting. In
1417 particular, it is not possible to use moddn to move an entry from
1418 one subordinate to another subordinate within the namingContext.
1420 If the optional \fBadvertise\fP flag is supplied, the naming context of
1421 this database is advertised in the root DSE. The default is to hide this
1422 database context, so that only the superior context is visible.
1429 are used on the superior database, any glued subordinates that support
1430 these tools are opened as well.
1432 Databases that are glued together should usually be configured with the
1433 same indices (assuming they support indexing), even for attributes that
1434 only exist in some of these databases. In general, all of the glued
1435 databases should be configured as similarly as possible, since the intent
1436 is to provide the appearance of a single directory.
1438 Note that the \fIsubordinate\fP functionality is implemented internally
1439 by the \fIglue\fP overlay and as such its behavior will interact with other
1440 overlays in use. By default, the glue overlay is automatically configured as
1441 the last overlay on the superior backend. Its position on the backend
1442 can be explicitly configured by setting an \fBoverlay glue\fP directive
1443 at the desired position. This explicit configuration is necessary e.g.
1444 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1445 in order to work over all of the glued databases. E.g.
1449 suffix dc=example,dc=com
1457 .B syncrepl rid=<replica ID>
1458 .B provider=ldap[s]://<hostname>[:port]
1459 .B [type=refreshOnly|refreshAndPersist]
1460 .B [interval=dd:hh:mm:ss]
1461 .B [retry=[<retry interval> <# of retries>]+]
1462 .B [searchbase=<base DN>]
1463 .B [filter=<filter str>]
1464 .B [scope=sub|one|base]
1465 .B [attrs=<attr list>]
1467 .B [sizelimit=<limit>]
1468 .B [timelimit=<limit>]
1469 .B [schemachecking=on|off]
1470 .B [starttls=yes|critical]
1471 .B [bindmethod=simple|sasl]
1473 .B [saslmech=<mech>]
1474 .B [authcid=<identity>]
1475 .B [authzid=<identity>]
1476 .B [credentials=<passwd>]
1478 .B [secprops=<properties>]
1479 .B [logbase=<base DN>]
1480 .B [logfilter=<filter str>]
1481 .B [syncdata=default|accesslog|changelog]
1483 Specify the current database as a replica which is kept up-to-date with the
1484 master content by establishing the current
1486 as a replication consumer site running a
1489 The replica content is kept synchronized to the master content using
1490 the LDAP Content Synchronization protocol. Refer to the
1491 "OpenLDAP Administrator's Guide" for detailed information on
1492 setting up a replicated
1494 directory service using the
1498 identifies the current
1500 directive within the replication consumer site.
1501 It is a non-negative integer having no more than three digits.
1503 specifies the replication provider site containing the master content
1504 as an LDAP URI. If <port> is not given, the standard LDAP port number
1505 (389 or 636) is used. The content of the
1507 replica is defined using a search
1508 specification as its result set. The consumer
1510 will send search requests to the provider
1512 according to the search specification. The search specification includes
1513 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1516 parameters as in the normal search specification.
1517 The search specification for the LDAP Content Synchronization operation
1518 has the same value syntax and the same default values as in the
1521 The LDAP Content Synchronization protocol has two operation types.
1524 operation, the next synchronization search operation
1525 is periodically rescheduled at an interval time (specified by
1527 parameter; 1 day by default)
1528 after each synchronization operation finishes.
1530 .B refreshAndPersist
1531 operation, a synchronization search remains persistent in the provider slapd.
1532 Further updates to the master replica will generate
1533 .B searchResultEntry
1534 to the consumer slapd as the search responses to the persistent
1535 synchronization search.
1536 If an error occurs during replication, the consumer will attempt to
1537 reconnect according to the
1539 parameter which is a list of the <retry interval> and <# of retries> pairs.
1540 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1541 for the first 10 times and then retry every 300 seconds for the next 3
1542 times before stop retrying. The `+' in <# of retries> means indefinite
1543 number of retries until success.
1544 The schema checking can be enforced at the LDAP Sync
1545 consumer site by turning on the
1547 parameter. The default is off.
1550 parameter specifies use of the StartTLS extended operation
1551 to establish a TLS session before Binding to the provider. If the
1553 argument is supplied, the session will be aborted if the StartTLS request
1554 fails. Otherwise the syncrepl session continues without TLS.
1559 requires the options
1563 and should only be used when adequate security services
1564 (e.g. TLS or IPSEC) are in place.
1571 Depending on the mechanism, an authentication identity and/or
1572 credentials can be specified using
1578 parameter may be used to specify an authorization identity.
1579 Specific security properties (as with the
1581 keyword above) for a SASL bind can be set with the
1583 option. A non default SASL realm can be set with the
1587 Rather than replicating whole entries, the consumer can query logs of
1588 data modifications. This mode of operation is referred to as \fIdelta
1589 syncrepl\fP. In addition to the above parameters, the
1593 parameters must be set appropriately for the log that will be used. The
1595 parameter must be set to either "accesslog" if the log conforms to the
1596 .BR slapo-accesslog (5)
1597 log format, or "changelog" if the log conforms
1598 to the obsolete \fIchangelog\fP format. If the
1600 parameter is omitted or set to "default" then the log parameters are
1605 This option is only applicable in a slave
1606 database updated using
1608 It specifies the DN permitted to update (subject to access controls)
1609 the replica (typically, this is the DN
1611 binds to update the replica). Generally, this DN
1618 Specify the referral to pass back when
1620 is asked to modify a replicated local database.
1621 If specified multiple times, each url is provided.
1623 .SH DATABASE-SPECIFIC OPTIONS
1624 Each database may allow specific configuration options; they are
1625 documented separately in the backends' manual pages.
1627 The following backends can be compiled into slapd.
1628 They are documented in the
1629 .BR slapd-<backend> (5)
1633 This is the recommended backend for a normal slapd database.
1634 However, it takes more care than with the LDBM backend to configure
1636 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1639 This backend is used to manage the configuration of slapd run-time.
1642 This backend is experimental.
1643 It serves up referrals based upon SRV resource records held in the
1647 This is a variant of the BDB backend that uses a hierarchical database
1648 layout which supports subtree renames.
1651 This backend acts as a proxy to forward incoming requests to another
1655 This is the database backend which is easiest to configure.
1656 However, it does not offer the data durability features of the BDB
1658 It uses Berkeley DB or GDBM to store data.
1661 This database uses the filesystem to build the tree structure
1662 of the database, using plain ascii files to store data.
1663 Its usage should be limited to very simple databases, where performance
1664 is not a requirement.
1667 This backend performs basic LDAP proxying with respect to a set of
1668 remote LDAP servers. It is an enhancement of the ldap backend.
1671 This backend provides information about the running status of the slapd
1675 Operations in this backend succeed but do nothing.
1678 This backend is provided for demonstration purposes only.
1679 It serves up user account information from the system
1684 This backend embeds a
1686 interpreter into slapd.
1687 It runs Perl subroutines to implement LDAP operations.
1690 This backend is experimental.
1691 It redirects LDAP operations to another database
1692 in the same server, based on the naming context of the request.
1693 Its use requires the
1697 for details) to rewrite the naming context of the request.
1698 It is is primarily intended to implement virtual views on databases
1699 that actually store data.
1702 This backend executes external programs to implement LDAP operations.
1703 It is primarily intended to be used in prototypes.
1706 This backend is experimental.
1707 It services LDAP requests from an SQL database.
1709 The following overlays can be compiled into slapd.
1710 They are documented in the
1711 .BR slapo-<overlay> (5)
1716 This overlay can record accesses to a given backend database on another
1721 This overlay records changes on a given backend database to an LDIF log
1723 By default it is not built.
1727 This overlay allows automatic referral chasing when a referral would
1732 This overlay allows selected operations to be denied, similar to the
1733 \fBrestrict\fP option.
1737 This is a demo overlay which extends the Compare operation to detect
1738 members of a dynamic group.
1739 It has no effect on any other operations.
1743 This overlay allows expansion of dynamic groups and more.
1747 This overlay maintains a service entry in the database with the DN,
1748 modification type, modifiersName and modifyTimestamp of the last write
1749 operation performed on that database.
1753 This overlay allows caching of LDAP search requests in a local database.
1754 It is most often used with the ldap or meta backends.
1758 This overlay provides a variety of password control mechanisms,
1759 e.g. password aging, password reuse and duplication control, mandatory
1760 password resets, etc.
1763 Referential Integrity.
1764 This overlay can be used with a backend database such as
1766 to maintain the cohesiveness of a schema which utilizes reference
1771 This overlay is useful to test the behavior of clients when
1772 server-generated erroneous and/or unusual responses occur.
1776 This overlay is experimental.
1777 It performs basic DN/data rewrite and
1778 objectClass/attributeType mapping.
1782 This overlay implements the provider-side support for
1784 replication, including persistent search functionality.
1788 This overlay can be used with a backend database such as
1790 to create a "translucent proxy".
1791 Content of entries retrieved from a remote LDAP server can be partially
1792 overridden by the database.
1795 Attribute Uniqueness.
1796 This overlay can be used with a backend database such as
1798 to enforce the uniqueness of some or all attributes within a subtree.
1801 Here is a short example of a configuration file:
1805 include SYSCONFDIR/schema/core.schema
1806 pidfile LOCALSTATEDIR/slapd.pid
1808 # Subtypes of "name" (e.g. "cn" and "ou") with the
1809 # option ";x-hidden" can be searched for/compared,
1810 # but are not shown. See \fBslapd.access\fP(5).
1811 attributeoptions x-hidden lang-
1812 access to attr=name;x-hidden by * =cs
1814 # Protect passwords. See \fBslapd.access\fP(5).
1815 access to attrs=userPassword by * auth
1816 # Read access to other attributes and entries.
1817 access to * by * read
1820 suffix "dc=our-domain,dc=com"
1821 # The database directory MUST exist prior to
1822 # running slapd AND should only be accessible
1823 # by the slapd/tools. Mode 0700 recommended.
1824 directory LOCALSTATEDIR/openldap-data
1825 # Indices to maintain
1826 index objectClass eq
1827 index cn,sn,mail pres,eq,approx,sub
1829 # We serve small clients that do not handle referrals,
1830 # so handle remote lookups on their behalf.
1833 uri ldap://ldap.some-server.com/
1838 "OpenLDAP Administrator's Guide" contains a longer annotated
1839 example of a configuration file.
1840 The original ETCDIR/slapd.conf is another example.
1844 default slapd configuration file
1848 .BR slapd\-dnssrv (5),
1850 .BR slapd\-ldap (5),
1851 .BR slapd\-ldbm (5),
1852 .BR slapd\-ldif (5),
1853 .BR slapd\-meta (5),
1854 .BR slapd\-monitor (5),
1855 .BR slapd\-null (5),
1856 .BR slapd\-passwd (5),
1857 .BR slapd\-perl (5),
1858 .BR slapd\-relay (5),
1859 .BR slapd\-shell (5),
1861 .BR slapd.access (5),
1862 .BR slapd.plugin (5),
1863 .BR slapd.replog (5),
1875 Known overlays are documented in
1876 .BR slapo\-accesslog (5),
1877 .BR slapo\-auditlog (5),
1878 .BR slapo\-chain (5),
1879 .BR slapo\-dynlist (5),
1880 .BR slapo\-lastmod (5),
1881 .BR slapo\-pcache (5),
1882 .BR slapo\-ppolicy (5),
1883 .BR slapo\-refint (5),
1884 .BR slapo\-retcode (5),
1886 .BR slapo\-syncprov (5),
1887 .BR slapo\-translucent (5),
1888 .BR slapo\-unique (5).
1890 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1891 .SH ACKNOWLEDGEMENTS
1893 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1895 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob