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 or an LDAP URI. If the
361 latter, the server will use the URI to search its own database(s)
362 and, if the search returns exactly one entry, the name is
363 replaced by the DN of that entry. The LDAP URI must have no
364 hostport, attrs, or extensions components, e.g.
367 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
372 options can be given in the configuration file to allow for multiple matching
373 and replacement patterns. The matching patterns are checked in the order they
374 appear in the file, stopping at the first successful match.
377 .\"Because the plus sign + is a character recognized by the regular expression engine,
378 .\"and it will appear in names that include a REALM, be careful to escape the
379 .\"plus sign with a backslash \\+ to remove the character's special meaning.
382 .B concurrency <integer>
383 Specify a desired level of concurrency. Provided to the underlying
384 thread system as a hint. The default is not to provide any hint.
386 .B conn_max_pending <integer>
387 Specify the maximum number of pending requests for an anonymous session.
388 If requests are submitted faster than the server can process them, they
389 will be queued up to this limit. If the limit is exceeded, the session
390 is closed. The default is 100.
392 .B conn_max_pending_auth <integer>
393 Specify the maximum number of pending requests for an authenticated session.
396 .B defaultsearchbase <dn>
397 Specify a default search base to use when client submits a
398 non-base search request with an empty base DN.
400 .B disallow <features>
401 Specify a set of features (separated by white space) to
402 disallow (default none).
404 disables acceptance of anonymous bind requests.
406 disables simple (bind) authentication.
408 disables Kerberos V4 (bind) authentication.
410 disables Start TLS from forcing session to anonymous status (see also
413 disables StartTLS if authenticated (see also
417 .B ditcontentrule "(\ <oid>\
419 [DESC\ <description>]\
426 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
427 The slapd parser extends the RFC 2252 definition by allowing string
428 forms as well as numeric OIDs to be used for the attribute OID and
429 attribute syntax OID.
435 .B gentlehup { on | off }
436 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
438 will stop listening for new connections, but will not close the
439 connections to the current clients. Future write operations return
440 unwilling-to-perform, though. Slapd terminates when all clients
441 have closed their connections (if they ever do), or \- as before \-
442 if it receives a SIGTERM signal. This can be useful if you wish to
443 terminate the server and start a new
446 .B with another database,
447 without disrupting the currently active clients.
448 The default is off. You may wish to use
450 along with this option.
452 .B idletimeout <integer>
453 Specify the number of seconds to wait before forcibly closing
454 an idle client connection. A idletimeout of 0 disables this
455 feature. The default is 0.
457 .B include <filename>
458 Read additional configuration information from the given file before
459 continuing with the next line of the current file.
461 .B index_substr_if_minlen <integer>
462 Specify the minimum length for subinitial and subfinal indices. An
463 attribute value must have at least this many characters in order to be
464 processed by the indexing functions. The default is 2.
466 .B index_substr_if_maxlen <integer>
467 Specify the maximum length for subinitial and subfinal indices. Only
468 this many characters of an attribute value will be processed by the
469 indexing functions; any excess characters are ignored. The default is 4.
471 .B index_substr_any_len <integer>
472 Specify the length used for subany indices. An attribute value must have
473 at least this many characters in order to be processed. Attribute values
474 longer than this length will be processed in segments of this length. The
475 default is 4. The subany index will also be used in subinitial and
476 subfinal index lookups when the filter string is longer than the
477 .I index_substr_if_maxlen
480 .B index_substr_any_step <integer>
481 Specify the steps used in subany index lookups. This value sets the offset
482 for the segments of a filter string that are processed for a subany index
483 lookup. The default is 2. For example, with the default values, a search
484 using this filter "cn=*abcdefgh*" would generate index lookups for
485 "abcd", "cdef", and "efgh".
487 .\"-- NEW_LOGGING option --
489 .\".B logfile <filename>
490 .\"Specify a file for recording debug log messages. By default these messages
491 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
492 .\"copies messages to both stderr and the logfile.
495 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
496 such as those to the ldapi:// listener. For a description of SSF values,
500 option description. The default is 71.
502 .B loglevel <integer> [...]
503 Specify the level at which debugging statements and operation
504 statistics should be syslogged (currently logged to the
506 LOG_LOCAL4 facility). Log levels are additive, and available levels
518 debug packet handling
522 heavy trace debugging
526 connection management
530 print out packets sent and received
534 search filter processing
538 configuration file processing
542 access control list processing
546 stats log connections/operations/results
550 stats log entries sent
554 print communication with shell backends
561 The desired log level can be input as a single integer that combines
562 the (ORed) desired levels, as a list of integers (that are ORed internally),
563 or as a list of the names that are shown between brackets, such that
574 can be used as a shortcut to enable logging at all levels (equivalent to -1).
577 .B moduleload <filename>
578 Specify the name of a dynamically loadable module to load. The filename
579 may be an absolute path name or a simple filename. Non-absolute names
580 are searched for in the directories specified by the
582 option. This option and the
584 option are only usable if slapd was compiled with --enable-modules.
586 .B modulepath <pathspec>
587 Specify a list of directories to search for loadable modules. Typically
588 the path is colon-separated but this depends on the operating system.
591 .B objectclass "(\ <oid>\
593 [DESC\ <description]\
596 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
597 [MUST\ <oids>] [MAY\ <oids>] )"
599 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
600 The slapd parser extends the RFC 2252 definition by allowing string
601 forms as well as numeric OIDs to be used for the object class OID.
605 description.) Object classes are "STRUCTURAL" by default.
608 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
609 Define a string name that equates to the given OID. The string can be used
610 in place of the numeric OID in objectclass and attribute definitions. The
611 name can also be used with a suffix of the form ":xx" in which case the
612 value "oid.xx" will be used.
614 .B password-hash <hash> [<hash>...]
615 This option configures one or more hashes to be used in generation of user
616 passwords stored in the userPassword attribute during processing of
617 LDAP Password Modify Extended Operations (RFC 3062).
618 The <hash> must be one of
632 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
637 use the MD5 algorithm (RFC 1321), the latter with a seed.
644 indicates that the new password should be
645 added to userPassword as clear text.
647 Note that this option does not alter the normal user applications
648 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
650 .B password\-crypt\-salt\-format <format>
651 Specify the format of the salt passed to
653 when generating {CRYPT} passwords (see
655 during processing of LDAP Password Modify Extended Operations (RFC 3062).
657 This string needs to be in
659 format and may include one (and only one) %s conversion.
660 This conversion will be substituted with a string of random
661 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
662 provides a two character salt and "$1$%.8s" tells some
663 versions of crypt(3) to use an MD5 algorithm and provides
664 8 random characters of salt. The default is "%s", which
665 provides 31 characters of salt.
667 .B pidfile <filename>
668 The ( absolute ) name of a file that will hold the
670 server's process ID ( see
672 ) if started without the debugging command line option.
675 Specify the referral to pass back when
677 cannot find a local database to handle a request.
678 If specified multiple times, each url is provided.
681 The ( absolute ) name of a file that will hold the
683 server's command line options
684 if started without the debugging command line option.
687 The ( absolute ) name of a file that will hold the
689 server's process ID ( see
691 ) if started without the debugging command line option.
693 .B replicationinterval
694 The number of seconds
696 waits before checking the replogfile for changes.
698 .B require <conditions>
699 Specify a set of conditions (separated by white space) to
700 require (default none).
701 The directive may be specified globally and/or per-database.
703 requires bind operation prior to directory operations.
705 requires session to be using LDAP version 3.
707 requires authentication prior to directory operations.
709 requires SASL authentication prior to directory operations.
711 requires strong authentication prior to directory operations.
712 The strong keyword allows protected "simple" authentication
713 as well as SASL authentication.
715 may be used to require no conditions (useful for clearly globally
716 set conditions within a particular database).
718 .B reverse-lookup on | off
719 Enable/disable client name unverified reverse lookup (default is
721 if compiled with --enable-rlookups).
724 Specify the name of an LDIF(5) file containing user defined attributes
725 for the root DSE. These attributes are returned in addition to the
726 attributes normally produced by slapd.
729 Used to specify the fully qualified domain name used for SASL processing.
731 .B sasl-realm <realm>
732 Specify SASL realm. Default is empty.
734 .B sasl-secprops <properties>
735 Used to specify Cyrus SASL security properties.
738 flag (without any other properties) causes the flag properties
739 default, "noanonymous,noplain", to be cleared.
742 flag disables mechanisms susceptible to simple passive attacks.
745 flag disables mechanisms susceptible to active attacks.
748 flag disables mechanisms susceptible to passive dictionary attacks.
751 flag disables mechanisms which support anonymous login.
754 flag require forward secrecy between sessions.
757 require mechanisms which pass client credentials (and allow
758 mechanisms which can pass credentials to do so).
761 property specifies the minimum acceptable
762 .I security strength factor
763 as an integer approximate to effective key length used for
764 encryption. 0 (zero) implies no protection, 1 implies integrity
765 protection only, 56 allows DES or other weak ciphers, 112
766 allows triple DES and other strong ciphers, 128 allows RC4,
767 Blowfish and other modern strong ciphers. The default is 0.
770 property specifies the maximum acceptable
771 .I security strength factor
772 as an integer (see minssf description). The default is INT_MAX.
775 property specifies the maximum security layer receive buffer
776 size allowed. 0 disables security layers. The default is 65536.
779 Specify the distinguished name for the subschema subentry that
780 controls the entries on this server. The default is "cn=Subschema".
782 .B security <factors>
783 Specify a set of security strength factors (separated by white space)
787 option for a description of security strength factors).
788 The directive may be specified globally and/or per-database.
790 specifies the overall security strength factor.
792 specifies the transport security strength factor.
794 specifies the TLS security strength factor.
796 specifies the SASL security strength factor.
798 specifies the overall security strength factor to require for
800 .B update_transport=<n>
801 specifies the transport security strength factor to require for
804 specifies the TLS security strength factor to require for
807 specifies the SASL security strength factor to require for
810 specifies the security strength factor required for
812 username/password authentication.
815 factor is measure of security provided by the underlying transport,
816 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
818 .B sizelimit {<integer>|unlimited}
820 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
821 Specify the maximum number of entries to return from a search operation.
822 The default size limit is 500.
825 to specify no limits.
826 The second format allows a fine grain setting of the size limits.
827 Extra args can be added on the same line.
830 for an explanation of the different flags.
832 .B sockbuf_max_incoming <integer>
833 Specify the maximum incoming LDAP PDU size for anonymous sessions.
834 The default is 262143.
836 .B sockbuf_max_incoming_auth <integer>
837 Specify the maximum incoming LDAP PDU size for authenticated sessions.
838 The default is 4194303.
841 Specify the srvtab file in which the kerberos keys necessary for
842 authenticating clients using kerberos can be found. This option is only
843 meaningful if you are using Kerberos authentication.
846 Specify the maximum size of the primary thread pool.
849 .B timelimit {<integer>|unlimited}
851 .B timelimit time[.{soft|hard}]=<integer> [...]
852 Specify the maximum number of seconds (in real time)
854 will spend answering a search request. The default time limit is 3600.
857 to specify no limits.
858 The second format allows a fine grain setting of the time limits.
859 Extra args can be added on the same line.
862 for an explanation of the different flags.
864 .B ucdata-path <path>
865 Specify the path to the directory containing the Unicode character
866 tables. The default path is DATADIR/ucdata.
870 is built with support for Transport Layer Security, there are more options
873 .B TLSCipherSuite <cipher-suite-spec>
874 Permits configuring what ciphers will be accepted and the preference order.
875 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
877 TLSCipherSuite HIGH:MEDIUM:+SSLv2
879 To check what ciphers a given spec selects, use:
881 openssl ciphers -v <cipher-suite-spec>
883 .B TLSCACertificateFile <filename>
884 Specifies the file that contains certificates for all of the Certificate
889 .B TLSCACertificatePath <path>
890 Specifies the path of a directory that contains Certificate Authority
891 certificates in separate individual files. Usually only one of this
892 or the TLSCACertificateFile is used.
894 .B TLSCertificateFile <filename>
895 Specifies the file that contains the
899 .B TLSCertificateKeyFile <filename>
900 Specifies the file that contains the
902 server private key that matches the certificate stored in the
903 .B TLSCertificateFile
904 file. Currently, the private key must not be protected with a password, so
905 it is of critical importance that it is protected carefully.
907 .B TLSRandFile <filename>
908 Specifies the file to obtain random bits from when /dev/[u]random
909 is not available. Generally set to the name of the EGD/PRNGD socket.
910 The environment variable RANDFILE can also be used to specify the filename.
912 .B TLSVerifyClient <level>
913 Specifies what checks to perform on client certificates in an
914 incoming TLS session, if any.
917 can be specified as one of the following keywords:
923 will not ask the client for a certificate.
926 The client certificate is requested. If no certificate is provided,
927 the session proceeds normally. If a bad certificate is provided,
928 it will be ignored and the session proceeds normally.
931 The client certificate is requested. If no certificate is provided,
932 the session proceeds normally. If a bad certificate is provided,
933 the session is immediately terminated.
935 .B demand | hard | true
936 These keywords are all equivalent, for compatibility reasons.
937 The client certificate is requested. If no certificate is provided,
938 or a bad certificate is provided, the session is immediately terminated.
940 Note that a valid client certificate is required in order to use the
941 SASL EXTERNAL authentication mechanism with a TLS session. As such,
944 setting must be chosen to enable SASL EXTERNAL authentication.
946 .SH GENERAL BACKEND OPTIONS
947 Options in this section only apply to the configuration file section
948 for the specified backend. They are supported by every
951 .B backend <databasetype>
952 Mark the beginning of a backend definition. <databasetype>
968 depending on which backend will serve the database.
970 .SH GENERAL DATABASE OPTIONS
971 Options in this section only apply to the configuration file section
972 for the database in which they are defined. They are supported by every
973 type of backend. Note that the
977 option are mandatory for each database.
979 .B database <databasetype>
980 Mark the beginning of a new database instance definition. <databasetype>
996 depending on which backend will serve the database.
1001 will automatically maintain the
1002 modifiersName, modifyTimestamp, creatorsName, and
1003 createTimestamp attributes for entries. By default, lastmod is on.
1005 .B limits <who> <limit> [<limit> [...]]
1006 Specify time and size limits based on who initiated an operation.
1013 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1019 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1024 matches all unauthenticated clients.
1027 matches all authenticated clients;
1030 dn pattern is assumed unless otherwise specified by qualifying
1031 the (optional) key string
1037 (which are synonyms), to require an exact match; with
1039 to require exactly one level of depth match; with
1041 to allow any level of depth match, including the exact match; with
1043 to allow any level of depth match, not including the exact match;
1045 explicitly requires the (default) match based on POSIX (''extended'')
1046 regular expression pattern.
1049 matches unbound operations; the
1052 The same behavior is obtained by using the
1059 with the optional objectClass
1065 sets the limits for any DN listed in the values of the
1071 group objectClass (default
1073 whose DN exactly matches
1076 The currently supported limits are
1081 The syntax for time limits is
1082 .BR time[.{soft|hard}]=<integer> ,
1085 is the number of seconds slapd will spend answering a search request.
1086 If no time limit is explicitly requested by the client, the
1088 limit is used; if the requested time limit exceeds the
1091 .\".I "Administrative limit exceeded"
1092 .\"error is returned.
1093 limit, the value of the limit is used instead.
1096 limit is set to the keyword
1098 the soft limit is used in either case; if it is set to the keyword
1100 no hard limit is enforced.
1101 Explicit requests for time limits smaller or equal to the
1104 If no limit specifier is set, the value is assigned to the
1110 to preserve the original behavior.
1112 The syntax for size limits is
1113 .BR size[.{soft|hard|unchecked}]=<integer> ,
1116 is the maximum number of entries slapd will return answering a search
1118 If no size limit is explicitly requested by the client, the
1120 limit is used; if the requested size limit exceeds the
1123 .\".I "Administrative limit exceeded"
1124 .\"error is returned.
1125 limit, the value of the limit is used instead.
1128 limit is set to the keyword
1130 the soft limit is used in either case; if it is set to the keyword
1132 no hard limit is enforced.
1133 Explicit requests for size limits smaller or equal to the
1138 specifier sets a limit on the number of candidates a search request is allowed
1140 The rationale behind it is that searches for non-properly indicized
1141 attributes may result in large sets of candidates, which must be
1144 to determine whether they match the search filter or not.
1147 limit provides a means to drop such operations before they are even
1149 If the selected candidates exceed the
1151 limit, the search will abort with
1152 .IR "Unwilling to perform" .
1153 If it is set to the keyword
1155 no limit is applied (the default).
1158 the search is not even performed; this can be used to disallow searches
1159 for a specific set of users.
1160 If no limit specifier is set, the value is assigned to the
1166 to preserve the original behavior.
1168 In case of no match, the global limits are used.
1169 The default values are the same of
1178 control is requested, the
1180 size limit is used by default, because the request of a specific page size
1181 is considered an explicit request for a limitation on the number
1182 of entries to be returned.
1183 However, the size limit applies to the total count of entries returned within
1184 the search, and not to a single page.
1185 Additional size limits may be enforced; the syntax is
1186 .BR size.pr={<integer>|noEstimate|unlimited} ,
1189 is the max page size if no explicit limit is set; the keyword
1191 inhibits the server from returning an estimate of the total number
1192 of entries that might be returned
1193 (note: the current implementation does not return any estimate).
1196 indicates that no limit is applied to the pagedResults control page size.
1198 .B size.prtotal={<integer>|unlimited|disabled}
1199 allows to set a limit on the total number of entries that a pagedResults
1200 control allows to return.
1201 By default it is set to the
1206 is the max number of entries that the whole search with pagedResults control
1210 to allow unlimited number of entries to be returned, e.g. to allow
1211 the use of the pagedResults control as a means to circumvent size
1212 limitations on regular searches; the keyword
1214 disables the control, i.e. no paged results can be returned.
1215 Note that the total number of entries returned when the pagedResults control
1216 is requested cannot exceed the
1218 size limit of regular searches unless extended by the
1223 .B maxderefdepth <depth>
1224 Specifies the maximum number of aliases to dereference when trying to
1225 resolve an entry, used to avoid infinite alias loops. The default is 1.
1227 .B overlay <overlay-name>
1228 Add the specified overlay to this database. An overlay is a piece of
1229 code that intercepts database operations in order to extend or change
1230 them. Overlays are pushed onto
1231 a stack over the database, and so they will execute in the reverse
1232 of the order in which they were configured and the database itself
1233 will receive control last of all.
1235 .B readonly on | off
1236 This option puts the database into "read-only" mode. Any attempts to
1237 modify the database will return an "unwilling to perform" error. By
1238 default, readonly is off.
1241 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1242 .B [starttls=yes|critical]
1243 .B [suffix=<suffix> [...]]
1244 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1245 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1246 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1247 .B [attr[!]=<attr list>]
1249 Specify a replication site for this database. Refer to the "OpenLDAP
1250 Administrator's Guide" for detailed information on setting up a replicated
1252 directory service. Zero or more
1254 instances can be used to select the subtrees that will be replicated
1255 (defaults to all the database).
1257 is deprecated in favor of the
1261 allows the replica LDAP server to be specified as an LDAP URI.
1266 requires the options
1270 and should only be used when adequate security services
1271 (e.g TLS or IPSEC) are in place. A
1277 Specific security properties (as with the
1279 keyword above) for a SASL bind can be set with the
1281 option. A non-default SASL realm can be set with the
1286 will use Kerberos, a kerberos instance should be given in
1290 can be given after the
1292 keyword to allow the selective replication of the listed attributes only;
1295 mark is used, the list is considered exclusive, i.e. the listed attributes
1297 If an objectClass is listed, all the related attributes
1298 are (are not) replicated.
1301 .B replogfile <filename>
1302 Specify the name of the replication log file to log changes to.
1303 The replication log is typically written by
1308 .BR slapd.replog (5)
1309 for more information. The specified file should be located
1310 in a directory with limited read/write/execute access as the replication
1311 logs may contain sensitive information.
1313 .B restrict <oplist>
1314 Specify a whitespace separated list of operations that are restricted.
1315 If defined inside a database specification, restrictions apply only
1316 to that database, otherwise they are global.
1317 Operations can be any of
1322 .BR extended[=<OID>] ,
1326 or the special pseudo-operations
1330 which respectively summarize read and write operations.
1338 keyword allows to indicate the OID of the specific operation
1342 Specify the distinguished name that is not subject to access control
1343 or administrative limit restrictions for operations on this database.
1344 This DN may or may not be associated with an entry. An empty root
1345 DN (the default) specifies no root access is to be granted. It is
1346 recommended that the rootdn only be specified when needed (such as
1347 when initially populating a database). If the rootdn is within
1348 a namingContext (suffix) of the database, a simple bind password
1349 may also be provided using the
1353 .B rootpw <password>
1354 Specify a password (or hash of the password) for the rootdn. The
1355 password can only be set if the rootdn is within the namingContext
1356 (suffix) of the database.
1357 This option accepts all RFC 2307 userPassword formats known to
1360 description) as well as cleartext.
1362 may be used to generate a hash of a password. Cleartext
1363 and \fB{CRYPT}\fP passwords are not recommended. If empty
1364 (the default), authentication of the root DN is by other means
1365 (e.g. SASL). Use of SASL is encouraged.
1367 .B suffix <dn suffix>
1368 Specify the DN suffix of queries that will be passed to this
1369 backend database. Multiple suffix lines can be given and at least one is
1370 required for each database definition.
1371 If the suffix of one database is "inside" that of another, the database
1372 with the inner suffix must come first in the configuration file.
1375 Specify that the current backend database is a subordinate of another
1376 backend database. A subordinate database may have only one suffix. This
1377 option may be used to glue multiple databases into a single namingContext.
1378 If the suffix of the current database is within the namingContext of a
1379 superior database, searches against the superior database will be
1380 propagated to the subordinate as well. All of the databases
1381 associated with a single namingContext should have identical rootdns.
1382 Behavior of other LDAP operations is unaffected by this setting. In
1383 particular, it is not possible to use moddn to move an entry from
1384 one subordinate to another subordinate within the namingContext.
1387 .B syncrepl rid=<replica ID>
1388 .B provider=ldap[s]://<hostname>[:port]
1389 .B [type=refreshOnly|refreshAndPersist]
1390 .B [interval=dd:hh:mm:ss]
1391 .B [retry=[<retry interval> <# of retries>]+]
1392 .B [searchbase=<base DN>]
1393 .B [filter=<filter str>]
1394 .B [scope=sub|one|base]
1395 .B [attrs=<attr list>]
1397 .B [sizelimit=<limit>]
1398 .B [timelimit=<limit>]
1399 .B [schemachecking=on|off]
1401 .B [bindmethod=simple|sasl]
1403 .B [saslmech=<mech>]
1404 .B [authcid=<identity>]
1405 .B [authzid=<identity>]
1406 .B [credentials=<passwd>]
1408 .B [secprops=<properties>]
1410 Specify the current database as a replica which is kept up-to-date with the
1411 master content by establishing the current
1413 as a replication consumer site running a
1416 The replica content is kept synchronized to the master content using
1417 the LDAP Content Synchronization protocol. Refer to the
1418 "OpenLDAP Administrator's Guide" for detailed information on
1419 setting up a replicated
1421 directory service using the
1425 identifies the current
1427 directive within the replication consumer site.
1428 It is a non-negative integer having no more than three digits.
1430 specifies the replication provider site containing the master content
1431 as an LDAP URI. If <port> is not given, the standard LDAP port number
1432 (389 or 636) is used. The content of the
1434 replica is defined using a search
1435 specification as its result set. The consumer
1437 will send search requests to the provider
1439 according to the search specification. The search specification includes
1440 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1443 parameters as in the normal search specification.
1444 The search specification for the LDAP Content Synchronization operation
1445 has the same value syntax and the same default values as in the
1448 The LDAP Content Synchronization protocol has two operation types.
1451 operation, the next synchronization search operation
1452 is periodically rescheduled at an interval time (specified by
1454 parameter; 1 day by default)
1455 after each synchronization operation finishes.
1457 .B refreshAndPersist
1458 operation, a synchronization search remains persistent in the provider slapd.
1459 Further updates to the master replica will generate
1460 .B searchResultEntry
1461 to the consumer slapd as the search responses to the persistent
1462 synchronization search.
1463 If an error occurs during replication, the consumer will attempt to
1464 reconnect according to the
1466 parameter which is a list of the <retry interval> and <# of retries> pairs.
1467 For example, retry="60 5 300 3" lets the consumer retry every 60 seconds
1468 for the first 10 times and then retry every 300 seconds for the next three
1469 times before stop retrying. + in <# of retries> means indefinite
1470 number of retries until success.
1471 The schema checking can be enforced at the LDAP Sync
1472 consumer site by turning on the
1474 parameter. The default is off.
1477 parameter specifies the DN in the consumer site
1478 which is allowed to make changes to the replica.
1479 The DN should have read/write access to the replica database.
1484 of the master database.
1489 requires the options
1493 and should only be used when adequate security services
1494 (e.g. TLS or IPSEC) are in place.
1501 Depending on the mechanism, an authentication identity and/or
1502 credentials can be specified using
1508 parameter may be used to specify an authorization identity.
1509 Specific security properties (as with the
1511 keyword above) for a SASL bind can be set with the
1513 option. A non default SASL realm can be set with the
1519 This option is only applicable in a slave
1520 database updated using
1522 It specifies the DN permitted to update (subject to access controls)
1523 the replica (typically, this is the DN
1525 binds to update the replica). Generally, this DN
1532 Specify the referral to pass back when
1534 is asked to modify a replicated local database.
1535 If specified multiple times, each url is provided.
1537 .SH DATABASE-SPECIFIC OPTIONS
1538 Each database may allow specific configuration options; they are
1539 documented separately in the backends' manual pages.
1541 The following backends can be compiled into slapd.
1542 They are documented in the
1543 .BR slapd-<backend> (5)
1547 This is the recommended backend for a normal slapd database.
1548 However, it takes more care than with the LDBM backend to configure
1550 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1553 This is the database backend which is easiest to configure.
1554 However, it does not offer the data durability features of the BDB
1556 It uses Berkeley DB or GDBM to store data.
1559 This backend is experimental.
1560 It serves up referrals based upon SRV resource records held in the
1564 This backend acts as a proxy to forward incoming requests to another
1568 This backend performs basic LDAP proxying with respect to a set of
1569 remote LDAP servers. It is an enhancement of the ldap backend. The
1570 proxy cache extension of meta backend provides answering of search
1571 requests from the proxy using results of previously cached requests.
1574 This backend provides information about the running status of the slapd
1578 Operations in this backend succeed but do nothing.
1581 This backend is provided for demonstration purposes only.
1582 It serves up user account information from the system
1587 This backend embeds a
1589 interpreter into slapd.
1590 It runs Perl subroutines to implement LDAP operations.
1593 This backend redirects LDAP operations to another database
1594 in the same server, based on the naming context of the request.
1595 Its use requires the
1599 for details) to rewrite the naming context of the request.
1600 It is is primarily intended to implement virtual views on databases
1601 that actually store data.
1604 This backend executes external programs to implement LDAP operations.
1605 It is primarily intended to be used in prototypes.
1608 This backend is experimental.
1609 It services LDAP requests from an SQL database.
1612 This backend is experimental.
1615 interpreter into slapd.
1616 It runs Tcl commands to implement LDAP operations.
1619 Here is a short example of a configuration file:
1623 include SYSCONFDIR/schema/core.schema
1624 pidfile LOCALSTATEDIR/slapd.pid
1626 # Subtypes of "name" (e.g. "cn" and "ou") with the
1627 # option ";x-hidden" can be searched for/compared,
1628 # but are not shown. See \fBslapd.access\fP(5).
1629 attributeoptions x-hidden lang-
1630 access to attr=name;x-hidden by * =cs
1633 suffix "dc=our-domain,dc=com"
1634 # The database directory MUST exist prior to
1635 # running slapd AND should only be accessible
1636 # by the slapd/tools. Mode 0700 recommended.
1637 directory LOCALSTATEDIR/openldap-data
1638 # Indices to maintain
1639 index objectClass eq
1640 index cn,sn,mail pres,eq,approx,sub
1642 # We serve small clients that do not handle referrals,
1643 # so handle remote lookups on their behalf.
1646 uri ldap://ldap.some-server.com/
1651 "OpenLDAP Administrator's Guide" contains a longer annotated
1652 example of a configuration file.
1653 The original ETCDIR/slapd.conf is another example.
1657 default slapd configuration file
1661 .BR slapd\-dnssrv (5),
1662 .BR slapd\-ldap (5),
1663 .BR slapd\-ldbm (5),
1664 .BR slapd\-meta (5),
1665 .BR slapd\-monitor (5),
1666 .BR slapd\-null (5),
1667 .BR slapd\-passwd (5),
1668 .BR slapd\-perl (5),
1669 .BR slapd\-relay (5),
1670 .BR slapd\-shell (5),
1673 .BR slapd.access (5),
1674 .BR slapd.plugin (5),
1675 .BR slapd.replog (5),
1687 Known overlays are documented in
1688 .BR slapo\-lastmod (5),
1689 .BR slapo\-pcache (5),
1690 .BR slapo\-ppolicy (5),
1691 .BR slapo\-refint (5),
1693 .BR slapo\-unique (5).
1695 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1696 .SH ACKNOWLEDGEMENTS
1698 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1700 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob