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
84 and the "OpenLDAP's Administrator's Guide" for details.
87 Specify a set of features (separated by white space) to
90 allows acceptance of LDAPv2 bind requests. Note that
92 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
94 allows anonymous bind when credentials are not empty (e.g.
97 allows unauthenticated (anonymous) bind when DN is not empty.
99 allow unauthenticated (anonymous) update operations to be processed
100 (subject to access controls and other administrative limits).
102 .B argsfile <filename>
103 The ( absolute ) name of a file that will hold the
105 server's command line options
106 if started without the debugging command line option.
108 .B attributeoptions [option-name]...
109 Define tagging attribute options or option tag/range prefixes.
110 Options must not end with `-', prefixes must end with `-'.
111 The `lang-' prefix is predefined.
114 directive, `lang-' will no longer be defined and you must specify it
115 explicitly if you want it defined.
117 An attribute description with a tagging option is a subtype of that
118 attribute description without the option.
119 Except for that, options defined this way have no special semantics.
120 Prefixes defined this way work like the `lang-' options:
121 They define a prefix for tagging options starting with the prefix.
122 That is, if you define the prefix `x-foo-', you can use the option
124 Furthermore, in a search or compare, a prefix or range name (with
125 a trailing `-') matches all options starting with that name, as well
126 as the option with the range name sans the trailing `-'.
127 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
129 RFC 2251 reserves options beginning with `x-' for private experiments.
130 Other options should be registered with IANA, see RFC 3383 section 3.4.
131 OpenLDAP also has the `binary' option built in, but this is a transfer
132 option, not a tagging option.
135 .B attributetype "(\ <oid>\
137 [DESC\ <description>]\
146 [NO\-USER\-MODIFICATION]\
147 [USAGE\ <attributeUsage>]\ )"
149 Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
150 The slapd parser extends the RFC 2252 definition by allowing string
151 forms as well as numeric OIDs to be used for the attribute OID and
152 attribute syntax OID.
158 .B authz-policy <policy>
159 Used to specify which rules to use for Proxy Authorization. Proxy
160 authorization allows a client to authenticate to the server using one
161 user's credentials, but specify a different identity to use for authorization
162 and access control purposes. It essentially allows user A to login as user
163 B, using user A's password.
166 flag disables proxy authorization. This is the default setting.
169 flag will use rules in the
171 attribute of the authorization DN.
174 flag will use rules in the
176 attribute of the authentication DN.
179 flag, an alias for the deprecated value of
181 will allow any of the above, whatever succeeds first (checked in
187 flag requires both authorizations to succeed.
190 The rules are mechanisms to specify which identities are allowed
191 to perform proxy authorization.
194 attribute in an entry specifies which other users
195 are allowed to proxy login to this entry. The
198 an entry specifies which other users this user can authorize as. Use of
201 abused if users are allowed to write arbitrary values to this attribute.
204 attribute must be protected with ACLs such that
205 only privileged users can modify it.
212 or a set of identities; it can take three forms:
215 .B ldap:///<base>??[<scope>]?<filter>
218 .B dn[.<dnstyle>]:<pattern>
221 .B u[<mech>[<realm>]]:<pattern>
224 .B group[/objectClass[/attributeType]]:<pattern>
231 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
234 The first form is a valid LDAP
242 portions must be absent, so that the search occurs locally on either
248 with the optional style modifiers
254 for exact, onelevel, children and subtree matches, which cause
256 to be normalized according to the DN normalization rules, or the special
258 style, which causes the
260 to be treated as a POSIX (''extended'') regular expression, as
267 means any non-anonymous DN.
268 The third form is a SASL
270 with the optional fields
274 that allow to specify a SASL
276 and eventually a SASL
278 for those mechanisms that support one.
279 The need to allow the specification of a mechanism is still debated,
280 and users are strongly discouraged to rely on this possibility.
281 The fourth form is a group specification, consisting of the keyword
283 optionally followed by the specification of the group
289 is searched with base scope, and in case of match, the values of the
292 are searched for the asserted DN.
293 For backwards compatibility, if no identity type is provided, i.e. only
297 is assumed; as a consequence,
299 is subjected to DN normalization.
300 Since the interpretation of
304 can impact security, users are strongly encouraged
305 to explicitly set the type of identity specification that is being used.
306 A subset of these rules can be used as third arg in the
308 statement (see below); significantly, the
315 .B authz-regexp <match> <replace>
316 Used by the authentication framework to convert simple user names,
317 such as provided by SASL subsystem, to an LDAP DN used for
318 authorization purposes. Note that the resultant DN need not refer
319 to an existing entry to be considered valid. When an authorization
320 request is received from the SASL subsystem, the SASL
325 are taken, when available, and combined into a name of the form
329 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
332 This name is then compared against the
334 POSIX (''extended'') regular expression, and if the match is successful,
335 the name is replaced with the
337 string. If there are wildcard strings in the
339 regular expression that are enclosed in parenthesis, e.g.
345 then the portion of the name that matched the wildcard will be stored
346 in the numbered placeholder variable $1. If there are other wildcard strings
347 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
348 placeholders can then be used in the
353 .B UID=$1,OU=Accounts,DC=example,DC=com
356 The replaced name can be either a DN or an LDAP URI. If the
357 latter, the server will use the URI to search its own database(s)
358 and, if the search returns exactly one entry, the name is
359 replaced by the DN of that entry. The LDAP URI must have no
360 hostport, attrs, or extensions components, e.g.
363 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
368 options can be given in the configuration file to allow for multiple matching
369 and replacement patterns. The matching patterns are checked in the order they
370 appear in the file, stopping at the first successful match.
373 .\"Because the plus sign + is a character recognized by the regular expression engine,
374 .\"and it will appear in names that include a REALM, be careful to escape the
375 .\"plus sign with a backslash \\+ to remove the character's special meaning.
378 .B concurrency <integer>
379 Specify a desired level of concurrency. Provided to the underlying
380 thread system as a hint. The default is not to provide any hint.
382 .B conn_max_pending <integer>
383 Specify the maximum number of pending requests for an anonymous session.
384 If requests are submitted faster than the server can process them, they
385 will be queued up to this limit. If the limit is exceeded, the session
386 is closed. The default is 100.
388 .B conn_max_pending_auth <integer>
389 Specify the maximum number of pending requests for an authenticated session.
392 .B defaultsearchbase <dn>
393 Specify a default search base to use when client submits a
394 non-base search request with an empty base DN.
396 .B disallow <features>
397 Specify a set of features (separated by white space) to
398 disallow (default none).
400 disables acceptance of anonymous bind requests.
402 disables simple (bind) authentication.
404 disables Kerberos V4 (bind) authentication.
406 disables Start TLS from forcing session to anonymous status (see also
409 disables StartTLS if authenticated (see also
413 .B ditcontentrule "(\ <oid>\
415 [DESC\ <description>]\
422 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
423 The slapd parser extends the RFC 2252 definition by allowing string
424 forms as well as numeric OIDs to be used for the attribute OID and
425 attribute syntax OID.
431 .B gentlehup { on | off }
432 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
434 will stop listening for new connections, but will not close the
435 connections to the current clients. Future write operations return
436 unwilling-to-perform, though. Slapd terminates when all clients
437 have closed their connections (if they ever do), or \- as before \-
438 if it receives a SIGTERM signal. This can be useful if you wish to
439 terminate the server and start a new
442 .B with another database,
443 without disrupting the currently active clients.
444 The default is off. You may wish to use
446 along with this option.
448 .B idletimeout <integer>
449 Specify the number of seconds to wait before forcibly closing
450 an idle client connection. A idletimeout of 0 disables this
451 feature. The default is 0.
453 .B include <filename>
454 Read additional configuration information from the given file before
455 continuing with the next line of the current file.
457 .B index_substr_if_minlen <integer>
458 Specify the minimum length for subinitial and subfinal indices. An
459 attribute value must have at least this many characters in order to be
460 processed by the indexing functions. The default is 2.
462 .B index_substr_if_maxlen <integer>
463 Specify the maximum length for subinitial and subfinal indices. Only
464 this many characters of an attribute value will be processed by the
465 indexing functions; any excess characters are ignored. The default is 4.
467 .B index_substr_any_len <integer>
468 Specify the length used for subany indices. An attribute value must have
469 at least this many characters in order to be processed. Attribute values
470 longer than this length will be processed in segments of this length. The
471 default is 4. The subany index will also be used in subinitial and
472 subfinal index lookups when the filter string is longer than the
473 .I index_substr_if_maxlen
476 .B index_substr_any_step <integer>
477 Specify the steps used in subany index lookups. This value sets the offset
478 for the segments of a filter string that are processed for a subany index
479 lookup. The default is 2. For example, with the default values, a search
480 using this filter "cn=*abcdefgh*" would generate index lookups for
481 "abcd", "cdef", and "efgh".
483 .\"-- NEW_LOGGING option --
485 .\".B logfile <filename>
486 .\"Specify a file for recording debug log messages. By default these messages
487 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
488 .\"copies messages to both stderr and the logfile.
491 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
492 such as those to the ldapi:// listener. For a description of SSF values,
496 option description. The default is 71.
498 .B loglevel <integer> [...]
499 Specify the level at which debugging statements and operation
500 statistics should be syslogged (currently logged to the
502 LOG_LOCAL4 facility). Log levels are additive, and available levels
514 debug packet handling
518 heavy trace debugging
522 connection management
526 print out packets sent and received
530 search filter processing
534 configuration file processing
538 access control list processing
542 stats log connections/operations/results
546 stats log entries sent
550 print communication with shell backends
557 The desired log level can be input as a single integer that combines
558 the (ORed) desired levels, as a list of integers (that are ORed internally),
559 or as a list of the names that are shown between brackets, such that
570 can be used as a shortcut to enable logging at all levels (equivalent to -1).
573 .B moduleload <filename>
574 Specify the name of a dynamically loadable module to load. The filename
575 may be an absolute path name or a simple filename. Non-absolute names
576 are searched for in the directories specified by the
578 option. This option and the
580 option are only usable if slapd was compiled with --enable-modules.
582 .B modulepath <pathspec>
583 Specify a list of directories to search for loadable modules. Typically
584 the path is colon-separated but this depends on the operating system.
587 .B objectclass "(\ <oid>\
589 [DESC\ <description]\
592 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
593 [MUST\ <oids>] [MAY\ <oids>] )"
595 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
596 The slapd parser extends the RFC 2252 definition by allowing string
597 forms as well as numeric OIDs to be used for the object class OID.
601 description.) Object classes are "STRUCTURAL" by default.
604 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
605 Define a string name that equates to the given OID. The string can be used
606 in place of the numeric OID in objectclass and attribute definitions. The
607 name can also be used with a suffix of the form ":xx" in which case the
608 value "oid.xx" will be used.
610 .B password-hash <hash> [<hash>...]
611 This option configures one or more hashes to be used in generation of user
612 passwords stored in the userPassword attribute during processing of
613 LDAP Password Modify Extended Operations (RFC 3062).
614 The <hash> must be one of
628 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
633 use the MD5 algorithm (RFC 1321), the latter with a seed.
640 indicates that the new password should be
641 added to userPassword as clear text.
643 Note that this option does not alter the normal user applications
644 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
646 .B password\-crypt\-salt\-format <format>
647 Specify the format of the salt passed to
649 when generating {CRYPT} passwords (see
651 during processing of LDAP Password Modify Extended Operations (RFC 3062).
653 This string needs to be in
655 format and may include one (and only one) %s conversion.
656 This conversion will be substituted with a string of random
657 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
658 provides a two character salt and "$1$%.8s" tells some
659 versions of crypt(3) to use an MD5 algorithm and provides
660 8 random characters of salt. The default is "%s", which
661 provides 31 characters of salt.
663 .B pidfile <filename>
664 The ( absolute ) name of a file that will hold the
666 server's process ID ( see
668 ) if started without the debugging command line option.
671 Specify the referral to pass back when
673 cannot find a local database to handle a request.
674 If specified multiple times, each url is provided.
677 The ( absolute ) name of a file that will hold the
679 server's command line options
680 if started without the debugging command line option.
683 The ( absolute ) name of a file that will hold the
685 server's process ID ( see
687 ) if started without the debugging command line option.
689 .B replicationinterval
690 The number of seconds
692 waits before checking the replogfile for changes.
694 .B require <conditions>
695 Specify a set of conditions (separated by white space) to
696 require (default none).
697 The directive may be specified globally and/or per-database.
699 requires bind operation prior to directory operations.
701 requires session to be using LDAP version 3.
703 requires authentication prior to directory operations.
705 requires SASL authentication prior to directory operations.
707 requires strong authentication prior to directory operations.
708 The strong keyword allows protected "simple" authentication
709 as well as SASL authentication.
711 may be used to require no conditions (useful for clearly globally
712 set conditions within a particular database).
714 .B reverse-lookup on | off
715 Enable/disable client name unverified reverse lookup (default is
717 if compiled with --enable-rlookups).
720 Specify the name of an LDIF(5) file containing user defined attributes
721 for the root DSE. These attributes are returned in addition to the
722 attributes normally produced by slapd.
725 Used to specify the fully qualified domain name used for SASL processing.
727 .B sasl-realm <realm>
728 Specify SASL realm. Default is empty.
730 .B sasl-secprops <properties>
731 Used to specify Cyrus SASL security properties.
734 flag (without any other properties) causes the flag properties
735 default, "noanonymous,noplain", to be cleared.
738 flag disables mechanisms susceptible to simple passive attacks.
741 flag disables mechanisms susceptible to active attacks.
744 flag disables mechanisms susceptible to passive dictionary attacks.
747 flag disables mechanisms which support anonymous login.
750 flag require forward secrecy between sessions.
753 require mechanisms which pass client credentials (and allow
754 mechanisms which can pass credentials to do so).
757 property specifies the minimum acceptable
758 .I security strength factor
759 as an integer approximate to effective key length used for
760 encryption. 0 (zero) implies no protection, 1 implies integrity
761 protection only, 56 allows DES or other weak ciphers, 112
762 allows triple DES and other strong ciphers, 128 allows RC4,
763 Blowfish and other modern strong ciphers. The default is 0.
766 property specifies the maximum acceptable
767 .I security strength factor
768 as an integer (see minssf description). The default is INT_MAX.
771 property specifies the maximum security layer receive buffer
772 size allowed. 0 disables security layers. The default is 65536.
775 Specify the distinguished name for the subschema subentry that
776 controls the entries on this server. The default is "cn=Subschema".
778 .B security <factors>
779 Specify a set of security strength factors (separated by white space)
783 option for a description of security strength factors).
784 The directive may be specified globally and/or per-database.
786 specifies the overall security strength factor.
788 specifies the transport security strength factor.
790 specifies the TLS security strength factor.
792 specifies the SASL security strength factor.
794 specifies the overall security strength factor to require for
796 .B update_transport=<n>
797 specifies the transport security strength factor to require for
800 specifies the TLS security strength factor to require for
803 specifies the SASL security strength factor to require for
806 specifies the security strength factor required for
808 username/password authentication.
811 factor is measure of security provided by the underlying transport,
812 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
814 .B sizelimit {<integer>|unlimited}
816 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
817 Specify the maximum number of entries to return from a search operation.
818 The default size limit is 500.
821 to specify no limits.
822 The second format allows a fine grain setting of the size limits.
823 Extra args can be added on the same line.
826 for an explanation of the different flags.
828 .B sockbuf_max_incoming <integer>
829 Specify the maximum incoming LDAP PDU size for anonymous sessions.
830 The default is 262143.
832 .B sockbuf_max_incoming_auth <integer>
833 Specify the maximum incoming LDAP PDU size for authenticated sessions.
834 The default is 4194303.
837 Specify the srvtab file in which the kerberos keys necessary for
838 authenticating clients using kerberos can be found. This option is only
839 meaningful if you are using Kerberos authentication.
842 Specify the maximum size of the primary thread pool.
845 .B timelimit {<integer>|unlimited}
847 .B timelimit time[.{soft|hard}]=<integer> [...]
848 Specify the maximum number of seconds (in real time)
850 will spend answering a search request. The default time limit is 3600.
853 to specify no limits.
854 The second format allows a fine grain setting of the time limits.
855 Extra args can be added on the same line.
858 for an explanation of the different flags.
860 .B ucdata-path <path>
861 Specify the path to the directory containing the Unicode character
862 tables. The default path is DATADIR/ucdata.
866 is built with support for Transport Layer Security, there are more options
869 .B TLSCipherSuite <cipher-suite-spec>
870 Permits configuring what ciphers will be accepted and the preference order.
871 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
873 TLSCipherSuite HIGH:MEDIUM:+SSLv2
875 To check what ciphers a given spec selects, use:
877 openssl ciphers -v <cipher-suite-spec>
879 .B TLSCACertificateFile <filename>
880 Specifies the file that contains certificates for all of the Certificate
885 .B TLSCACertificatePath <path>
886 Specifies the path of a directory that contains Certificate Authority
887 certificates in separate individual files. Usually only one of this
888 or the TLSCACertificateFile is used.
890 .B TLSCertificateFile <filename>
891 Specifies the file that contains the
895 .B TLSCertificateKeyFile <filename>
896 Specifies the file that contains the
898 server private key that matches the certificate stored in the
899 .B TLSCertificateFile
900 file. Currently, the private key must not be protected with a password, so
901 it is of critical importance that it is protected carefully.
903 .B TLSRandFile <filename>
904 Specifies the file to obtain random bits from when /dev/[u]random
905 is not available. Generally set to the name of the EGD/PRNGD socket.
906 The environment variable RANDFILE can also be used to specify the filename.
908 .B TLSVerifyClient <level>
909 Specifies what checks to perform on client certificates in an
910 incoming TLS session, if any.
913 can be specified as one of the following keywords:
919 will not ask the client for a certificate.
922 The client certificate is requested. If no certificate is provided,
923 the session proceeds normally. If a bad certificate is provided,
924 it will be ignored and the session proceeds normally.
927 The client certificate is requested. If no certificate is provided,
928 the session proceeds normally. If a bad certificate is provided,
929 the session is immediately terminated.
931 .B demand | hard | true
932 These keywords are all equivalent, for compatibility reasons.
933 The client certificate is requested. If no certificate is provided,
934 or a bad certificate is provided, the session is immediately terminated.
936 Note that a valid client certificate is required in order to use the
937 SASL EXTERNAL authentication mechanism with a TLS session. As such,
940 setting must be chosen to enable SASL EXTERNAL authentication.
942 .SH GENERAL BACKEND OPTIONS
943 Options in this section only apply to the configuration file section
944 for the specified backend. They are supported by every
947 .B backend <databasetype>
948 Mark the beginning of a backend definition. <databasetype>
964 depending on which backend will serve the database.
966 .SH GENERAL DATABASE OPTIONS
967 Options in this section only apply to the configuration file section
968 for the database in which they are defined. They are supported by every
969 type of backend. Note that the
973 option are mandatory for each database.
975 .B database <databasetype>
976 Mark the beginning of a new database instance definition. <databasetype>
992 depending on which backend will serve the database.
997 will automatically maintain the
998 modifiersName, modifyTimestamp, creatorsName, and
999 createTimestamp attributes for entries. By default, lastmod is on.
1001 .B limits <who> <limit> [<limit> [...]]
1002 Specify time and size limits based on who initiated an operation.
1009 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1015 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1020 matches all unauthenticated clients.
1023 matches all authenticated clients;
1026 dn pattern is assumed unless otherwise specified by qualifying
1027 the (optional) key string
1033 (which are synonyms), to require an exact match; with
1035 to require exactly one level of depth match; with
1037 to allow any level of depth match, including the exact match; with
1039 to allow any level of depth match, not including the exact match;
1041 explicitly requires the (default) match based on POSIX (''extended'')
1042 regular expression pattern.
1045 matches unbound operations; the
1048 The same behavior is obtained by using the
1055 with the optional objectClass
1061 sets the limits for any DN listed in the values of the
1067 group objectClass (default
1069 whose DN exactly matches
1072 The currently supported limits are
1077 The syntax for time limits is
1078 .BR time[.{soft|hard}]=<integer> ,
1081 is the number of seconds slapd will spend answering a search request.
1082 If no time limit is explicitly requested by the client, the
1084 limit is used; if the requested time limit exceeds the
1087 .\".I "Administrative limit exceeded"
1088 .\"error is returned.
1089 limit, the value of the limit is used instead.
1092 limit is set to the keyword
1094 the soft limit is used in either case; if it is set to the keyword
1096 no hard limit is enforced.
1097 Explicit requests for time limits smaller or equal to the
1100 If no limit specifier is set, the value is assigned to the
1106 to preserve the original behavior.
1108 The syntax for size limits is
1109 .BR size[.{soft|hard|unchecked}]=<integer> ,
1112 is the maximum number of entries slapd will return answering a search
1114 If no size limit is explicitly requested by the client, the
1116 limit is used; if the requested size limit exceeds the
1119 .\".I "Administrative limit exceeded"
1120 .\"error is returned.
1121 limit, the value of the limit is used instead.
1124 limit is set to the keyword
1126 the soft limit is used in either case; if it is set to the keyword
1128 no hard limit is enforced.
1129 Explicit requests for size limits smaller or equal to the
1134 specifier sets a limit on the number of candidates a search request is allowed
1136 The rationale behind it is that searches for non-properly indicized
1137 attributes may result in large sets of candidates, which must be
1140 to determine whether they match the search filter or not.
1143 limit provides a means to drop such operations before they are even
1145 If the selected candidates exceed the
1147 limit, the search will abort with
1148 .IR "Unwilling to perform" .
1149 If it is set to the keyword
1151 no limit is applied (the default).
1154 the search is not even performed; this can be used to disallow searches
1155 for a specific set of users.
1156 If no limit specifier is set, the value is assigned to the
1162 to preserve the original behavior.
1164 In case of no match, the global limits are used.
1165 The default values are the same of
1174 control is requested, the
1176 size limit is used by default, because the request of a specific page size
1177 is considered an explicit request for a limitation on the number
1178 of entries to be returned.
1179 However, the size limit applies to the total count of entries returned within
1180 the search, and not to a single page.
1181 Additional size limits may be enforced; the syntax is
1182 .BR size.pr={<integer>|noEstimate|unlimited} ,
1185 is the max page size if no explicit limit is set; the keyword
1187 inhibits the server from returning an estimate of the total number
1188 of entries that might be returned
1189 (note: the current implementation does not return any estimate).
1192 indicates that no limit is applied to the pagedResults control page size.
1194 .B size.prtotal={<integer>|unlimited|disabled}
1195 allows to set a limit on the total number of entries that a pagedResults
1196 control allows to return.
1197 By default it is set to the
1202 is the max number of entries that the whole search with pagedResults control
1206 to allow unlimited number of entries to be returned, e.g. to allow
1207 the use of the pagedResults control as a means to circumvent size
1208 limitations on regular searches; the keyword
1210 disables the control, i.e. no paged results can be returned.
1211 Note that the total number of entries returned when the pagedResults control
1212 is requested cannot exceed the
1214 size limit of regular searches unless extended by the
1219 .B maxderefdepth <depth>
1220 Specifies the maximum number of aliases to dereference when trying to
1221 resolve an entry, used to avoid infinite alias loops. The default is 1.
1223 .B overlay <overlay-name>
1224 Add the specified overlay to this database. An overlay is a piece of
1225 code that intercepts database operations in order to extend or change
1226 them. Overlays are pushed onto
1227 a stack over the database, and so they will execute in the reverse
1228 of the order in which they were configured and the database itself
1229 will receive control last of all.
1231 .B readonly on | off
1232 This option puts the database into "read-only" mode. Any attempts to
1233 modify the database will return an "unwilling to perform" error. By
1234 default, readonly is off.
1237 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1238 .B [starttls=yes|critical]
1239 .B [suffix=<suffix> [...]]
1240 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1241 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1242 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1243 .B [attr[!]=<attr list>]
1245 Specify a replication site for this database. Refer to the "OpenLDAP
1246 Administrator's Guide" for detailed information on setting up a replicated
1248 directory service. Zero or more
1250 instances can be used to select the subtrees that will be replicated
1251 (defaults to all the database).
1253 is deprecated in favor of the
1257 allows the replica LDAP server to be specified as an LDAP URI.
1262 requires the options
1266 and should only be used when adequate security services
1267 (e.g TLS or IPSEC) are in place. A
1273 Specific security properties (as with the
1275 keyword above) for a SASL bind can be set with the
1277 option. A non-default SASL realm can be set with the
1282 will use Kerberos, a kerberos instance should be given in
1286 can be given after the
1288 keyword to allow the selective replication of the listed attributes only;
1291 mark is used, the list is considered exclusive, i.e. the listed attributes
1293 If an objectClass is listed, all the related attributes
1294 are (are not) replicated.
1297 .B replogfile <filename>
1298 Specify the name of the replication log file to log changes to.
1299 The replication log is typically written by
1304 .BR slapd.replog (5)
1305 for more information. The specified file should be located
1306 in a directory with limited read/write/execute access as the replication
1307 logs may contain sensitive information.
1309 .B restrict <oplist>
1310 Specify a whitespace separated list of operations that are restricted.
1311 If defined inside a database specification, restrictions apply only
1312 to that database, otherwise they are global.
1313 Operations can be any of
1318 .BR extended[=<OID>] ,
1322 or the special pseudo-operations
1326 which respectively summarize read and write operations.
1334 keyword allows to indicate the OID of the specific operation
1338 Specify the distinguished name that is not subject to access control
1339 or administrative limit restrictions for operations on this database.
1340 This DN may or may not be associated with an entry. An empty root
1341 DN (the default) specifies no root access is to be granted. It is
1342 recommended that the rootdn only be specified when needed (such as
1343 when initially populating a database). If the rootdn is within
1344 a namingContext (suffix) of the database, a simple bind password
1345 may also be provided using the
1349 .B rootpw <password>
1350 Specify a password (or hash of the password) for the rootdn. The
1351 password can only be set if the rootdn is within the namingContext
1352 (suffix) of the database.
1353 This option accepts all RFC 2307 userPassword formats known to
1356 description) as well as cleartext.
1358 may be used to generate a hash of a password. Cleartext
1359 and \fB{CRYPT}\fP passwords are not recommended. If empty
1360 (the default), authentication of the root DN is by other means
1361 (e.g. SASL). Use of SASL is encouraged.
1363 .B suffix <dn suffix>
1364 Specify the DN suffix of queries that will be passed to this
1365 backend database. Multiple suffix lines can be given and at least one is
1366 required for each database definition.
1367 If the suffix of one database is "inside" that of another, the database
1368 with the inner suffix must come first in the configuration file.
1371 Specify that the current backend database is a subordinate of another
1372 backend database. A subordinate database may have only one suffix. This
1373 option may be used to glue multiple databases into a single namingContext.
1374 If the suffix of the current database is within the namingContext of a
1375 superior database, searches against the superior database will be
1376 propagated to the subordinate as well. All of the databases
1377 associated with a single namingContext should have identical rootdns.
1378 Behavior of other LDAP operations is unaffected by this setting. In
1379 particular, it is not possible to use moddn to move an entry from
1380 one subordinate to another subordinate within the namingContext.
1383 .B syncrepl rid=<replica ID>
1384 .B provider=ldap[s]://<hostname>[:port]
1385 .B [type=refreshOnly|refreshAndPersist]
1386 .B [interval=dd:hh:mm:ss]
1387 .B [searchbase=<base DN>]
1388 .B [filter=<filter str>]
1389 .B [scope=sub|one|base]
1390 .B [attrs=<attr list>]
1392 .B [sizelimit=<limit>]
1393 .B [timelimit=<limit>]
1394 .B [schemachecking=on|off]
1396 .B [bindmethod=simple|sasl]
1398 .B [saslmech=<mech>]
1399 .B [authcid=<identity>]
1400 .B [authzid=<identity>]
1401 .B [credentials=<passwd>]
1403 .B [secprops=<properties>]
1405 Specify the current database as a replica which is kept up-to-date with the
1406 master content by establishing the current
1408 as a replication consumer site running a
1411 The replica content is kept synchronized to the master content using
1412 the LDAP Content Synchronization protocol. Refer to the
1413 "OpenLDAP Administrator's Guide" for detailed information on
1414 setting up a replicated
1416 directory service using the
1420 identifies the current
1422 directive within the replication consumer site.
1423 It is a non-negative integer having no more than three digits.
1425 specifies the replication provider site containing the master content
1426 as an LDAP URI. If <port> is not given, the standard LDAP port number
1427 (389 or 636) is used. The content of the
1429 replica is defined using a search
1430 specification as its result set. The consumer
1432 will send search requests to the provider
1434 according to the search specification. The search specification includes
1435 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1438 parameters as in the normal search specification.
1439 The search specification for the LDAP Content Synchronization operation
1440 has the same value syntax and the same default values as in the
1443 The LDAP Content Synchronization protocol has two operation types.
1446 operation, the next synchronization search operation
1447 is periodically rescheduled at an interval time (specified by
1449 parameter; 1 day by default)
1450 after each synchronization operation finishes.
1452 .B refreshAndPersist
1453 operation, a synchronization search remains persistent in the provider slapd.
1454 Further updates to the master replica will generate
1455 .B searchResultEntry
1456 to the consumer slapd as the search responses to the persistent
1457 synchronization search. If the connection is lost, the consumer will
1458 attempt to reconnect at an interval time (specified by
1460 parameter; 60 seconds by default) until the session is re-established.
1461 The schema checking can be enforced at the LDAP Sync
1462 consumer site by turning on the
1464 parameter. The default is off.
1467 parameter specifies the DN in the consumer site
1468 which is allowed to make changes to the replica.
1469 The DN should have read/write access to the replica database.
1474 of the master database.
1479 requires the options
1483 and should only be used when adequate security services
1484 (e.g. TLS or IPSEC) are in place.
1491 Depending on the mechanism, an authentication identity and/or
1492 credentials can be specified using
1498 parameter may be used to specify an authorization identity.
1499 Specific security properties (as with the
1501 keyword above) for a SASL bind can be set with the
1503 option. A non default SASL realm can be set with the
1509 This option is only applicable in a slave
1510 database updated using
1512 It specifies the DN permitted to update (subject to access controls)
1513 the replica (typically, this is the DN
1515 binds to update the replica). Generally, this DN
1522 Specify the referral to pass back when
1524 is asked to modify a replicated local database.
1525 If specified multiple times, each url is provided.
1527 .SH DATABASE-SPECIFIC OPTIONS
1528 Each database may allow specific configuration options; they are
1529 documented separately in the backends' manual pages.
1531 The following backends can be compiled into slapd.
1532 They are documented in the
1533 .BR slapd-<backend> (5)
1537 This is the recommended backend for a normal slapd database.
1538 However, it takes more care than with the LDBM backend to configure
1540 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1543 This is the database backend which is easiest to configure.
1544 However, it does not offer the data durability features of the BDB
1546 It uses Berkeley DB or GDBM to store data.
1549 This backend is experimental.
1550 It serves up referrals based upon SRV resource records held in the
1554 This backend acts as a proxy to forward incoming requests to another
1558 This backend performs basic LDAP proxying with respect to a set of
1559 remote LDAP servers. It is an enhancement of the ldap backend. The
1560 proxy cache extension of meta backend provides answering of search
1561 requests from the proxy using results of previously cached requests.
1564 This backend provides information about the running status of the slapd
1568 Operations in this backend succeed but do nothing.
1571 This backend is provided for demonstration purposes only.
1572 It serves up user account information from the system
1577 This backend embeds a
1579 interpreter into slapd.
1580 It runs Perl subroutines to implement LDAP operations.
1583 This backend redirects LDAP operations to another database
1584 in the same server, based on the naming context of the request.
1585 Its use requires the
1589 for details) to rewrite the naming context of the request.
1590 It is is primarily intended to implement virtual views on databases
1591 that actually store data.
1594 This backend executes external programs to implement LDAP operations.
1595 It is primarily intended to be used in prototypes.
1598 This backend is experimental.
1599 It services LDAP requests from an SQL database.
1602 This backend is experimental.
1605 interpreter into slapd.
1606 It runs Tcl commands to implement LDAP operations.
1609 Here is a short example of a configuration file:
1613 include SYSCONFDIR/schema/core.schema
1614 pidfile LOCALSTATEDIR/slapd.pid
1616 # Subtypes of "name" (e.g. "cn" and "ou") with the
1617 # option ";x-hidden" can be searched for/compared,
1618 # but are not shown. See \fBslapd.access\fP(5).
1619 attributeoptions x-hidden lang-
1620 access to attr=name;x-hidden by * =cs
1623 suffix "dc=our-domain,dc=com"
1624 # The database directory MUST exist prior to
1625 # running slapd AND should only be accessible
1626 # by the slapd/tools. Mode 0700 recommended.
1627 directory LOCALSTATEDIR/openldap-data
1628 # Indices to maintain
1629 index objectClass eq
1630 index cn,sn,mail pres,eq,approx,sub
1632 # We serve small clients that do not handle referrals,
1633 # so handle remote lookups on their behalf.
1636 uri ldap://ldap.some-server.com/
1641 "OpenLDAP Administrator's Guide" contains a longer annotated
1642 example of a configuration file.
1643 The original ETCDIR/slapd.conf is another example.
1647 default slapd configuration file
1651 .BR slapd\-dnssrv (5),
1652 .BR slapd\-ldap (5),
1653 .BR slapd\-ldbm (5),
1654 .BR slapd\-meta (5),
1655 .BR slapd\-monitor (5),
1656 .BR slapd\-null (5),
1657 .BR slapd\-passwd (5),
1658 .BR slapd\-perl (5),
1659 .BR slapd\-relay (5),
1660 .BR slapd\-shell (5),
1663 .BR slapd.access (5),
1664 .BR slapd.plugin (5),
1665 .BR slapd.replog (5),
1677 Known overlays are documented in
1678 .BR slapo\-lastmod (5),
1679 .BR slapo\-pcache (5),
1680 .BR slapo\-ppolicy (5),
1681 .BR slapo\-refint (5),
1683 .BR slapo\-unique (5).
1685 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1686 .SH ACKNOWLEDGEMENTS
1688 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1690 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob