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
24 file consists of a series of global configuration options that apply to
26 as a whole (including all backends), followed by zero or more database
27 backend definitions that contain information specific to a backend
35 # comment - these options apply to every database
36 <global configuration options>
37 # first database definition & configuration options
38 database <backend 1 type>
39 <configuration options specific to backend 1>
40 # subsequent database definitions & configuration options
44 As many backend-specific sections as desired may be included. Global
45 options can be overridden in a backend (for options that appear more
46 than once, the last appearance in the
50 If a line begins with white space, it is considered a continuation
51 of the previous line. Blank lines and comment lines beginning with
52 a `#' character are ignored. (Note: continuation lines are unwrapped
53 before comment processing is applied.)
55 Arguments on configuration lines are separated by white space. If an
56 argument contains white space, the argument should be enclosed in
57 double quotes. If an argument contains a double quote (`"') or a
58 backslash character (`\\'), the character should be preceded by a
61 The specific configuration options available are discussed below in the
62 Global Configuration Options, General Backend Options, and General Database
63 Options. Backend-specific options are discussed in the
65 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
66 details on the slapd configuration file.
67 .SH GLOBAL CONFIGURATION OPTIONS
68 Options described in this section apply to all backends, unless specifically
69 overridden in a backend definition. Arguments that should be replaced by
70 actual text are shown in brackets <>.
72 .B access to <what> "[ by <who> <access> <control> ]+"
73 Grant access (specified by <access>) to a set of entries and/or
74 attributes (specified by <what>) by one or more requestors (specified
78 and the "OpenLDAP's Administrator's Guide" for details.
81 Specify a set of features (separated by white space) to
84 allows acceptance of LDAPv2 bind requests. Note that
86 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
88 allows anonymous bind when credentials are not empty (e.g.
91 allows unauthenticated (anonymous) bind when DN is not empty.
93 allow unauthenticated (anonymous) update operations to be processed
94 (subject to access controls and other administrative limits).
96 .B argsfile <filename>
97 The ( absolute ) name of a file that will hold the
99 server's command line options
100 if started without the debugging command line option.
102 .B attributeoptions [option-name]...
103 Define tagging attribute options or option tag/range prefixes.
104 Options must not end with `-', prefixes must end with `-'.
105 The `lang-' prefix is predefined.
108 directive, `lang-' will no longer be defined and you must specify it
109 explicitly if you want it defined.
111 An attribute description with a tagging option is a subtype of that
112 attribute description without the option.
113 Except for that, options defined this way have no special semantics.
114 Prefixes defined this way work like the `lang-' options:
115 They define a prefix for tagging options starting with the prefix.
116 That is, if you define the prefix `x-foo-', you can use the option
118 Furthermore, in a search or compare, a prefix or range name (with
119 a trailing `-') matches all options starting with that name, as well
120 as the option with the range name sans the trailing `-'.
121 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
123 RFC 2251 reserves options beginning with `x-' for private experiments.
124 Other options should be registered with IANA, see RFC 3383 section 3.4.
125 OpenLDAP also has the `binary' option built in, but this is a transfer
126 option, not a tagging option.
129 .B attributetype "(\ <oid>\
131 [DESC\ <description>]\
140 [NO\-USER\-MODIFICATION]\
141 [USAGE\ <attributeUsage>]\ )"
143 Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
144 The slapd parser extends the RFC 2252 definition by allowing string
145 forms as well as numeric OIDs to be used for the attribute OID and
146 attribute syntax OID.
152 .B concurrency <integer>
153 Specify a desired level of concurrency. Provided to the underlying
154 thread system as a hint. The default is not to provide any hint.
156 .B conn_max_pending <integer>
157 Specify the maximum number of pending requests for an anonymous session.
158 If requests are submitted faster than the server can process them, they
159 will be queued up to this limit. If the limit is exceeded, the session
160 is closed. The default is 100.
162 .B conn_max_pending_auth <integer>
163 Specify the maximum number of pending requests for an authenticated session.
165 .\"-- NEW_LOGGING option --
167 .\".B debug <subsys> <level>
168 .\"Specify a logging level for a particular subsystem. The subsystems include
170 .\"a global level for all subsystems,
174 .\"the backend databases,
176 .\"the entry cache manager,
178 .\"the config file reader,
180 .\"the connection manager,
182 .\"the Cyrus SASL library interface,
184 .\"the search filter processor,
186 .\"the DN normalization library,
188 .\"the database indexer,
190 .\"the ASN.1 BER library,
192 .\"the dynamic module loader,
194 .\"the LDAP operation processors,
196 .\"the SASL authentication subsystem,
198 .\"the schema processor, and
200 .\"the TLS library interface. This is not an exhaustive list; there are many
201 .\"other subsystems and more are added over time.
203 .\"The levels are, in order of decreasing priority:
204 .\".B emergency, alert, critical, error, warning, notice, information, entry,
205 .\".B args, results, detail1, detail2
206 .\"An integer may be used instead, with 0 corresponding to
212 .\"level logs function entry points,
214 .\"adds function call parameters, and
216 .\"adds the function results to the logs.
221 .\"levels add even more low level detail from individual functions.
223 .B defaultsearchbase <dn>
224 Specify a default search base to use when client submits a
225 non-base search request with an empty base DN.
227 .B disallow <features>
228 Specify a set of features (separated by white space) to
229 disallow (default none).
231 disables acceptance of anonymous bind requests.
233 disables simple (bind) authentication.
235 disables Kerberos V4 (bind) authentication.
237 disables Start TLS from forcing session to anonymous status (see also
240 disables StartTLS if authenticated (see also
244 .B ditcontentrule "(\ <oid>\
246 [DESC\ <description>]\
253 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
254 The slapd parser extends the RFC 2252 definition by allowing string
255 forms as well as numeric OIDs to be used for the attribute OID and
256 attribute syntax OID.
262 .B gentlehup { on | off }
263 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
265 will stop listening for new connections, but will not close the
266 connections to the current clients. Future write operations return
267 unwilling-to-perform, though. Slapd terminates when all clients
268 have closed their connections (if they ever do), or \- as before \-
269 if it receives a SIGTERM signal. This can be useful if you wish to
270 terminate the server and start a new
273 .B with another database,
274 without disrupting the currently active clients.
275 The default is off. You may wish to use
277 along with this option.
279 .B idletimeout <integer>
280 Specify the number of seconds to wait before forcibly closing
281 an idle client connection. A idletimeout of 0 disables this
282 feature. The default is 0.
284 .B include <filename>
285 Read additional configuration information from the given file before
286 continuing with the next line of the current file.
287 .\"-- NEW_LOGGING option --
289 .\".B logfile <filename>
290 .\"Specify a file for recording debug log messages. By default these messages
291 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
292 .\"copies messages to both stderr and the logfile.
294 .B loglevel <integer>
295 Specify the level at which debugging statements and operation
296 statistics should be syslogged (currently logged to the
298 LOG_LOCAL4 facility). Log levels are additive, and available levels
308 debug packet handling
311 heavy trace debugging
314 connection management
317 print out packets sent and received
320 search filter processing
323 configuration file processing
326 access control list processing
329 stats log connections/operations/results
332 stats log entries sent
335 print communication with shell backends
343 .B moduleload <filename>
344 Specify the name of a dynamically loadable module to load. The filename
345 may be an absolute path name or a simple filename. Non-absolute names
346 are searched for in the directories specified by the
348 option. This option and the
350 option are only usable if slapd was compiled with --enable-modules.
352 .B modulepath <pathspec>
353 Specify a list of directories to search for loadable modules. Typically
354 the path is colon-separated but this depends on the operating system.
357 .B objectclass "(\ <oid>\
359 [DESC\ <description]\
362 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
363 [MUST\ <oids>] [MAY\ <oids>] )"
365 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
366 The slapd parser extends the RFC 2252 definition by allowing string
367 forms as well as numeric OIDs to be used for the object class OID.
371 description.) Object classes are "STRUCTURAL" by default.
374 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
375 Define a string name that equates to the given OID. The string can be used
376 in place of the numeric OID in objectclass and attribute definitions. The
377 name can also be used with a suffix of the form ":xx" in which case the
378 value "oid.xx" will be used.
380 .B password-hash <hash> [<hash>...]
381 This option configures one or more hashes to be used in generation of user
382 passwords stored in the userPassword attribute during processing of
383 LDAP Password Modify Extended Operations (RFC 3062).
384 The <hash> must be one of
398 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
403 use the MD5 algorithm (RFC 1321), the latter with a seed.
410 indicates that the new password should be
411 added to userPassword as clear text.
413 Note that this option does not alter the normal user applications
414 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
416 .B password\-crypt\-salt\-format <format>
417 Specify the format of the salt passed to
419 when generating {CRYPT} passwords (see
421 during processing of LDAP Password Modify Extended Operations (RFC 3062).
423 This string needs to be in
425 format and may include one (and only one) %s conversion.
426 This conversion will be substituted with a string random
427 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
428 provides a two character salt and "$1$%.8s" tells some
429 versions of crypt(3) to use an MD5 algorithm and provides
430 8 random characters of salt. The default is "%s", which
431 provides 31 characters of salt.
433 .B pidfile <filename>
434 The ( absolute ) name of a file that will hold the
436 server's process ID ( see
438 ) if started without the debugging command line option.
441 Specify the referral to pass back when
443 cannot find a local database to handle a request.
444 If specified multiple times, each url is provided.
447 The ( absolute ) name of a file that will hold the
449 server's command line options
450 if started without the debugging command line option.
453 The ( absolute ) name of a file that will hold the
455 server's process ID ( see
457 ) if started without the debugging command line option.
459 .B replicationinterval
460 The number of seconds
462 waits before checking the replogfile for changes.
464 .B require <conditions>
465 Specify a set of conditions (separated by white space) to
466 require (default none).
467 The directive may be specified globally and/or per-database.
469 requires bind operation prior to directory operations.
471 requires session to be using LDAP version 3.
473 requires authentication prior to directory operations.
475 requires SASL authentication prior to directory operations.
477 requires strong authentication prior to directory operations.
478 The strong keyword allows protected "simple" authentication
479 as well as SASL authentication.
481 may be used to require no conditions (useful for clearly globally
482 set conditions within a particular database).
484 .B reverse-lookup on | off
485 Enable/disable client name unverified reverse lookup (default is
487 if compiled with --enable-rlookups).
490 Specify the name of an LDIF(5) file containing user defined attributes
491 for the root DSE. These attributes are returned in addition to the
492 attributes normally produced by slapd.
494 .B sasl-authz-policy <policy>
495 Used to specify which rules to use for SASL Proxy Authorization. Proxy
496 authorization allows a client to authenticate to the server using one
497 user's credentials, but specify a different identity to use for authorization
498 and access control purposes. It essentially allows user A to login as user
499 B, using user A's password.
502 flag disables proxy authorization. This is the default setting.
505 flag will use rules in the
507 attribute of the authorization DN.
510 flag will use rules in the
512 attribute of the authentication DN.
515 flag, an alias for the deprecated value of
517 will allow any of the above, whatever succeeds first (checked in
523 flag requires both authorizations to succeed.
524 The rules are simply regular expressions specifying which DNs are allowed
525 to perform proxy authorization.
528 attribute in an entry specifies which other users
529 are allowed to proxy login to this entry. The
532 an entry specifies which other users this user can authorize as. Use of
535 abused if users are allowed to write arbitrary values to this attribute.
538 attribute must be protected with ACLs such that
539 only privileged users can modify it.
546 or a set of identities; it can take three forms:
550 .B ldap:///<base>??[<scope>]?<filter>
553 .B dn[.<dnstyle>]:<pattern>
556 .B u[<mech>[<realm>]]:<pattern>
563 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
566 The first form is a valid LDAP
574 portions must be absent, so that the search occurs locally on either
580 with the optional style modifiers
586 for exact, onelevel, children and subtree matches, which cause
588 to be normalized according to the DN normalization rules, or the special
592 to be compiled according to
594 The third form is a SASL
596 with the optional fields
600 that allow to specify a SASL
602 and eventually a SASL
604 for those mechanisms that support one.
605 The need to allow the specification of a mechanism is still debated,
606 and users are strongly discouraged to rely on this possibility.
607 For backwards compatibility, if no identity type is provided, i.e. only
611 is assumed; as a consequence,
613 is subjected to DN normalization.
614 Since the interpretation of
618 can impact security, users are strongly encouraged
619 to explicitly set the type of identity specification that is being used.
623 Used to specify the fully qualified domain name used for SASL processing.
625 .B sasl-realm <realm>
626 Specify SASL realm. Default is empty.
628 .B sasl-regexp <match> <replace>
629 Used by the SASL mechanism to convert a SASL authenticated
630 username to an LDAP DN used for authorization purposes. Note that
631 the resultant DN need not refer to an existing entry to be considered
632 valid. When an authorization request is received, the SASL
636 are taken, when available, and combined into a SASL name of the
641 .B UID=<username>[[,CN=<realm>],CN=<mechanism>,]CN=auth
644 This SASL name is then compared against the
646 regular expression, and if the match is successful, the SASL name is
649 string. If there are wildcard strings in the
651 regular expression that are enclosed in parenthesis, e.g.
657 then the portion of the SASL name that matched the wildcard will be stored
658 in the numbered placeholder variable $1. If there are other wildcard strings
659 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
660 placeholders can then be used in the
665 .B UID=$1,OU=Accounts,DC=example,DC=com
668 The replaced SASL name can be either a DN or an LDAP URI. If the
669 latter, the server will use the URI to search its own database(s)
670 and, if the search returns exactly one entry, the SASL name is
671 replaced by the DN of that entry. The LDAP URI must have no
672 hostport, attrs, or extensions components, e.g.
675 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
680 options can be given in the configuration file to allow for multiple matching
681 and replacement patterns. The matching patterns are checked in the order they
682 appear in the file, stopping at the first successful match.
685 .\"Because the plus sign + is a character recognized by the regular expression engine,
686 .\"and it will appear in SASL names that include a REALM, be careful to escape the
687 .\"plus sign with a backslash \\+ to remove the character's special meaning.
690 .B sasl-secprops <properties>
691 Used to specify Cyrus SASL security properties.
694 flag (without any other properties) causes the flag properties
695 default, "noanonymous,noplain", to be cleared.
698 flag disables mechanisms susceptible to simple passive attacks.
701 flag disables mechanisms susceptible to active attacks.
704 flag disables mechanisms susceptible to passive dictionary attacks.
707 flag disables mechanisms which support anonymous login.
710 flag require forward secrecy between sessions.
713 require mechanisms which pass client credentials (and allow
714 mechanisms which can pass credentials to do so).
717 property specifies the minimum acceptable
718 .I security strength factor
719 as an integer approximate to effective key length used for
720 encryption. 0 (zero) implies no protection, 1 implies integrity
721 protection only, 56 allows DES or other weak ciphers, 112
722 allows triple DES and other strong ciphers, 128 allows RC4,
723 Blowfish and other modern strong ciphers. The default is 0.
726 property specifies the maximum acceptable
727 .I security strength factor
728 as an integer (see minssf description). The default is INT_MAX.
731 property specifies the maximum security layer receive buffer
732 size allowed. 0 disables security layers. The default is 65536.
735 Specify the distinguished name for the subschema subentry that
736 controls the entries on this server. The default is "cn=Subschema".
738 .B security <factors>
739 Specify a set of factors (separated by white space) to require.
740 An integer value is associated with each factor and is roughly
741 equivalent of the encryption key length to require. A value
742 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
743 The directive may be specified globally and/or per-database.
745 specifies the overall security strength factor.
747 specifies the transport security strength factor.
749 specifies the TLS security strength factor.
751 specifies the SASL security strength factor.
753 specifies the overall security strength factor to require for
755 .B update_transport=<n>
756 specifies the transport security strength factor to require for
759 specifies the TLS security strength factor to require for
762 specifies the SASL security strength factor to require for
765 specifies the security strength factor required for
767 username/password authentication.
770 factor is measure of security provided by the underlying transport,
771 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
773 .B sizelimit {<integer>|unlimited}
775 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
776 Specify the maximum number of entries to return from a search operation.
777 The default size limit is 500.
782 to specify no limits.
783 The second format allows a fine grain setting of the size limits.
784 Extra args can be added on the same line.
787 for an explanation of the different flags.
789 .B sockbuf_max_incoming <integer>
790 Specify the maximum incoming LDAP PDU size for anonymous sessions.
791 The default is 262143.
793 .B sockbuf_max_incoming_auth <integer>
794 Specify the maximum incoming LDAP PDU size for authenticated sessions.
795 The default is 4194303.
798 Specify the srvtab file in which the kerberos keys necessary for
799 authenticating clients using kerberos can be found. This option is only
800 meaningful if you are using Kerberos authentication.
803 Specify the maximum size of the primary thread pool.
806 .B timelimit {<integer>|unlimited}
808 .B timelimit time[.{soft|hard}]=<integer> [...]
809 Specify the maximum number of seconds (in real time)
811 will spend answering a search request. The default time limit is 3600.
816 to specify no limits.
817 The second format allows a fine grain setting of the time limits.
818 Extra args can be added on the same line.
821 for an explanation of the different flags.
823 .B ucdata-path <path>
824 Specify the path to the directory containing the Unicode character
825 tables. The default path is DATADIR/ucdata.
829 is built with support for Transport Layer Security, there are more options
832 .B TLSCipherSuite <cipher-suite-spec>
833 Permits configuring what ciphers will be accepted and the preference order.
834 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
836 TLSCipherSuite HIGH:MEDIUM:+SSLv2
838 To check what ciphers a given spec selects, use:
840 openssl ciphers -v <cipher-suite-spec>
842 .B TLSCACertificateFile <filename>
843 Specifies the file that contains certificates for all of the Certificate
848 .B TLSCACertificatePath <path>
849 Specifies the path of a directory that contains Certificate Authority
850 certificates in separate individual files. Usually only one of this
851 or the TLSCACertificateFile is used.
853 .B TLSCertificateFile <filename>
854 Specifies the file that contains the
858 .B TLSCertificateKeyFile <filename>
859 Specifies the file that contains the
861 server private key that matches the certificate stored in the
862 .B TLSCertificateFile
863 file. Currently, the private key must not be protected with a password, so
864 it is of critical importance that it is protected carefully.
866 .B TLSRandFile <filename>
867 Specifies the file to obtain random bits from when /dev/[u]random
868 is not available. Generally set to the name of the EGD/PRNGD socket.
869 The environment variable RANDFILE can also be used to specify the filename.
871 .B TLSVerifyClient <level>
872 Specifies what checks to perform on client certificates in an
873 incoming TLS session, if any.
876 can be specified as one of the following keywords:
882 will not ask the client for a certificate.
885 The client certificate is requested. If no certificate is provided,
886 the session proceeds normally. If a bad certificate is provided,
887 it will be ignored and the session proceeds normally.
890 The client certificate is requested. If no certificate is provided,
891 the session proceeds normally. If a bad certificate is provided,
892 the session is immediately terminated.
894 .B demand | hard | true
895 These keywords are all equivalent, for compatibility reasons.
896 The client certificate is requested. If no certificate is provided,
897 or a bad certificate is provided, the session is immediately terminated.
899 Note that a valid client certificate is required in order to use the
900 SASL EXTERNAL authentication mechanism with a TLS session. As such,
903 setting must be chosen to enable SASL EXTERNAL authentication.
905 .SH GENERAL BACKEND OPTIONS
906 Options in this section only apply to the configuration file section
907 for the specified backend. They are supported by every
910 .B backend <databasetype>
911 Mark the beginning of a backend definition. <databasetype>
926 depending on which backend will serve the database.
928 .SH GENERAL DATABASE OPTIONS
929 Options in this section only apply to the configuration file section
930 for the database in which they are defined. They are supported by every
931 type of backend. Note that the
935 option are mandatory for each database.
937 .B database <databasetype>
938 Mark the beginning of a new database instance definition. <databasetype>
953 depending on which backend will serve the database.
958 will automatically maintain the
959 modifiersName, modifyTimestamp, creatorsName, and
960 createTimestamp attributes for entries. By default, lastmod is on.
962 .B limits <who> <limit> [<limit> [...]]
963 Specify time and size limits based on who initiated an operation.
970 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
976 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
981 matches all unauthenticated clients.
984 matches all authenticated clients;
987 dn pattern is assumed unless otherwise specified by qualifying
988 the (optional) key string
994 (which are synonyms), to require an exact match; with
996 to require exactly one level of depth match; with
998 to allow any level of depth match, including the exact match; with
1000 to allow any level of depth match, not including the exact match;
1002 explicitly requires the (default) match based on regular expression
1003 pattern, as detailed in
1007 matches unbound operations; the
1010 The same behavior is obtained by using the
1017 with the optional objectClass
1023 sets the limits for any DN listed in the values of the
1029 group objectClass (default
1031 whose DN exactly matches
1034 The currently supported limits are
1039 The syntax for time limits is
1040 .BR time[.{soft|hard}]=<integer> ,
1043 is the number of seconds slapd will spend answering a search request.
1044 If no time limit is explicitly requested by the client, the
1046 limit is used; if the requested time limit exceeds the
1049 .I \"Administrative limit exceeded\"
1053 limit is set to 0 or to the keyword
1055 the soft limit is used in either case; if it is set to
1059 no hard limit is enforced.
1060 Explicit requests for time limits smaller or equal to the
1063 If no flag is set, the value is assigned to the
1067 limit is set to zero, to preserve the original behavior.
1069 The syntax for size limits is
1070 .BR size[.{soft|hard|unchecked}]=<integer> ,
1073 is the maximum number of entries slapd will return answering a search
1075 If no size limit is explicitly requested by the client, the
1077 limit is used; if the requested size limit exceeds the
1080 .I \"Administrative limit exceeded\"
1084 limit is set to 0 or to the keyword
1086 the soft limit is used in either case; if it is set to
1090 no hard limit is enforced.
1091 Explicit requests for size limits smaller or equal to the
1096 flag sets a limit on the number of candidates a search request is allowed
1098 If the selected candidates exceed the
1100 limit, the search will abort with
1101 .IR \"Unwilling to perform\" .
1106 no limit is applied (the default).
1109 the search is not even performed; this can be used to disallow searches
1110 for a specific set of users.
1111 If no flag is set, the value is assigned to the
1115 limit is set to zero, to preserve the original behavior.
1117 In case of no match, the global limits are used.
1118 The default values are the same of
1127 control is requested, the
1129 size limit is used by default, because the request of a specific page size
1130 is considered as an explicit request for a limitation on the number
1131 of entries to be returned.
1132 However, the size limit applies to the total count of entries returned within
1133 the search, and not to a single page.
1134 Additional size limits may be enforced; the syntax is
1135 .BR size.pr={<integer>|noEstimate|none} ,
1138 is the max page size if no explicit limit is set; the keyword
1140 inhibits the server to return an estimate of the total number
1141 of entries that will be returned; the keyword
1143 indicates that no limit is applied to the pagedResults control page size.
1145 .B size.prtotal={<integer>|none|disabled}
1146 allows to set a limit on the total number of entries that a pagedResults
1147 control allows to return.
1148 By default it is set to the
1153 is the max number of entries that the whole search with pagedResults control
1157 to allow unlimited number of entries to be returned, i.e. to use
1158 pagedResults as a means to allow clients to circumvent size limitations
1159 on regular searches; the keyword
1161 disables the control, i.e. no paged results can be returned.
1162 Note that the total number of entries returned when the pagedResults control
1163 is requested cannot exceed the
1165 size limit of regular searches unless extended by the
1170 .B maxderefdepth <depth>
1171 Specifies the maximum number of aliases to dereference when trying to
1172 resolve an entry, used to avoid infinite alias loops. The default is 1.
1174 .B overlay <overlay-name>
1175 Add the specified overlay to this database. An overlay is a piece of
1176 code that intercepts database operations in order to extend or change
1177 them. Overlays are pushed onto
1178 a stack over the database, and so they will execute in the reverse
1179 of the order in which they were configured and the database itself
1180 will receive control last of all.
1182 .B readonly on | off
1183 This option puts the database into "read-only" mode. Any attempts to
1184 modify the database will return an "unwilling to perform" error. By
1185 default, readonly is off.
1188 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1189 .B [starttls=yes|critical]
1190 .B [suffix=<suffix> [...]]
1191 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1192 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1193 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1194 .B [attr[!]=<attr list>]
1196 Specify a replication site for this database. Refer to the "OpenLDAP
1197 Administrator's Guide" for detailed information on setting up a replicated
1199 directory service. Zero or more
1201 instances can be used to select the subtrees that will be replicated
1202 (defaults to all the database).
1204 is deprecated in favor of the
1208 allows the replica LDAP server to be specified as an LDAP URI.
1213 requires the options
1217 and should only be used when adequate security services
1218 (e.g TLS or IPSEC) are in place. A
1224 Specific security properties (as with the
1226 keyword above) for a SASL bind can be set with the
1228 option. A non-default SASL realm can be set with the
1233 will use Kerberos, a kerberos instance should be given in
1237 can be given after the
1239 keyword to allow the selective replication of the listed attributes only;
1242 mark is used, the list is considered exclusive, i.e. the listed attributes
1244 If an objectClass is listed, all the related attributes
1245 are (are not) replicated.
1248 .B replogfile <filename>
1249 Specify the name of the replication log file to log changes to.
1250 The replication log is typically written by
1255 .BR slapd.replog (5)
1256 for more information. The specified file should be located
1257 in a directory with limited read/write/execute access as the replication
1258 logs may contain sensitive information.
1261 Specify the distinguished name that is not subject to access control
1262 or administrative limit restrictions for operations on this database.
1263 This DN may or may not be associated with an entry. An empty root
1264 DN (the default) specifies no root access is to be granted. It is
1265 recommended that the rootdn only be specified when needed (such as
1266 when initially populating a database). If the rootdn is within
1267 a namingContext (suffix) of the database, a simple bind password
1268 may also be provided using the
1272 .B rootpw <password>
1273 Specify a password (or hash of the password) for the rootdn. The
1274 password can only be set if the rootdn is within the namingContext
1275 (suffix) of the database.
1276 This option accepts all RFC 2307 userPassword formats known to
1279 description) as well as cleartext.
1281 may be used to generate a hash of a password. Cleartext
1282 and \fB{CRYPT}\fP passwords are not recommended. If empty
1283 (the default), authentication of the root DN is by other means
1284 (e.g. SASL). Use of SASL is encouraged.
1286 .B suffix <dn suffix>
1287 Specify the DN suffix of queries that will be passed to this
1288 backend database. Multiple suffix lines can be given and at least one is
1289 required for each database definition.
1290 If the suffix of one database is "inside" that of another, the database
1291 with the inner suffix must come first in the configuration file.
1294 Specify that the current backend database is a subordinate of another
1295 backend database. A subordinate database may have only one suffix. This
1296 option may be used to glue multiple databases into a single namingContext.
1297 If the suffix of the current database is within the namingContext of a
1298 superior database, searches against the superior database will be
1299 propagated to the subordinate as well. All of the databases
1300 associated with a single namingContext should have identical rootdns.
1301 Behavior of other LDAP operations is unaffected by this setting. In
1302 particular, it is not possible to use moddn to move an entry from
1303 one subordinate to another subordinate within the namingContext.
1306 .B syncrepl rid=<replica ID>
1307 .B provider=ldap[s]://<hostname>[:port]
1308 .B [type=refreshOnly|refreshAndPersist]
1309 .B [interval=dd:hh:mm:ss]
1310 .B [retry=[<retry interval> <# of retries>]+]
1311 .B [searchbase=<base DN>]
1312 .B [filter=<filter str>]
1313 .B [scope=sub|one|base]
1314 .B [attrs=<attr list>]
1316 .B [sizelimit=<limit>]
1317 .B [timelimit=<limit>]
1318 .B [schemachecking=on|off]
1320 .B [bindmethod=simple|sasl]
1322 .B [saslmech=<mech>]
1323 .B [authcid=<identity>]
1324 .B [authzid=<identity>]
1325 .B [credentials=<passwd>]
1327 .B [secprops=<properties>]
1329 Specify the current database as a replica which is kept up-to-date with the
1330 master content by establishing the current
1332 as a replication consumer site running a
1335 The replica content is kept synchronized to the master content using
1336 the LDAP Content Synchronization protocol. Refer to the
1337 "OpenLDAP Administrator's Guide" for detailed information on
1338 setting up a replicated
1340 directory service using the
1344 identifies the current
1346 directive within the replication consumer site.
1347 It is a non-negative integer having no more than three digits.
1349 specifies the replication provider site containing the master content
1350 as an LDAP URI. If <port> is not given, the standard LDAP port number
1351 (389 or 636) is used. The content of the
1353 replica is defined using a search
1354 specification as its result set. The consumer
1356 will send search requests to the provider
1358 according to the search specification. The search specification includes
1359 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1362 parameters as in the normal search specification.
1363 The search specification for the LDAP Content Synchronization operation
1364 has the same value syntax and the same default values as in the
1367 The LDAP Content Synchronization protocol has two operation types.
1370 operation, the next synchronization search operation
1371 is periodically rescheduled at an interval time (specified by
1373 parameter; 1 day by default)
1374 after each synchronization operation finishes.
1376 .B refreshAndPersist
1377 operation, a synchronization search remains persistent in the provider slapd.
1378 Further updates to the master replica will generate
1379 .B searchResultEntry
1380 to the consumer slapd as the search responses to the persistent
1381 synchronization search.
1382 If an error occurs during replication, the consumer will attempt to
1383 reconnect according to the
1385 parameter which is a list of the <retry interval> and <# of retries> pairs.
1386 For example, retry="60 5 300 3" lets the consumer retry every 60 seconds
1387 for the first 10 times and then retry every 300 seconds for the next three
1388 times before stop retrying. + in <# of retries> means indefinite
1389 number of retries until success.
1390 The schema checking can be enforced at the LDAP Sync
1391 consumer site by turning on the
1393 parameter. The default is off.
1396 parameter specifies the DN in the consumer site
1397 which is allowed to make changes to the replica.
1398 The DN should have read/write access to the replica database.
1403 of the master database.
1408 requires the options
1412 and should only be used when adequate security services
1413 (e.g. TLS or IPSEC) are in place.
1420 Depending on the mechanism, an authentication identity and/or
1421 credentials can be specified using
1427 parameter may be used to specify an authorization identity.
1428 Specific security properties (as with the
1430 keyword above) for a SASL bind can be set with the
1432 option. A non default SASL realm can be set with the
1438 This option is only applicable in a slave
1439 database updated using
1441 It specifies the DN permitted to update (subject to access controls)
1442 the replica (typically, this is the DN
1444 binds to update the replica). Generally, this DN
1451 Specify the referral to pass back when
1453 is asked to modify a replicated local database.
1454 If specified multiple times, each url is provided.
1456 .SH DATABASE-SPECIFIC OPTIONS
1457 Each database may allow specific configuration options; they are
1458 documented separately in the backends' manual pages.
1460 The following backends can be compiled into slapd.
1461 They are documented in the
1462 .BR slapd-<backend> (5)
1466 This is the recommended backend for a normal slapd database.
1467 However, it takes more care than with the LDBM backend to configure
1469 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1472 This is the database backend which is easiest to configure.
1473 However, it does not offer the data durability features of the BDB
1475 It uses Berkeley DB or GDBM to store data.
1478 This backend is experimental.
1479 It serves up referrals based upon SRV resource records held in the
1483 This backend acts as a proxy to forward incoming requests to another
1487 This backend performs basic LDAP proxying with respect to a set of
1488 remote LDAP servers. It is an enhancement of the ldap backend. The
1489 proxy cache extension of meta backend provides answering of search
1490 requests from the proxy using results of previously cached requests.
1493 This backend provides information about the running status of the slapd
1497 Operations in this backend succeed but do nothing.
1500 This backend is provided for demonstration purposes only.
1501 It serves up user account information from the system
1506 This backend embeds a
1508 interpreter into slapd.
1509 It runs Perl subroutines to implement LDAP operations.
1512 This backend executes external programs to implement LDAP operations.
1513 It is is primarily intended to be used in prototypes.
1516 This backend is experimental.
1517 It services LDAP requests from an SQL database.
1520 This backend is experimental.
1523 interpreter into slapd.
1524 It runs Tcl commands to implement LDAP operations.
1527 Here is a short example of a configuration file:
1531 include SYSCONFDIR/schema/core.schema
1532 pidfile LOCALSTATEDIR/slapd.pid
1534 # Subtypes of "name" (e.g. "cn" and "ou") with the
1535 # option ";x-hidden" can be searched for/compared,
1536 # but are not shown. See \fBslapd.access\fP(5).
1537 attributeoptions x-hidden lang-
1538 access to attr=name;x-hidden by * =cs
1541 suffix "dc=our-domain,dc=com"
1542 # The database directory MUST exist prior to
1543 # running slapd AND should only be accessible
1544 # by the slapd/tools. Mode 0700 recommended.
1545 directory LOCALSTATEDIR/openldap-data
1546 # Indices to maintain
1547 index objectClass eq
1548 index cn,sn,mail pres,eq,approx,sub
1550 # We serve small clients that do not handle referrals,
1551 # so handle remote lookups on their behalf.
1554 uri ldap://ldap.some-server.com/
1559 "OpenLDAP Administrator's Guide" contains a longer annotated
1560 example of a configuration file.
1561 The original ETCDIR/slapd.conf is another example.
1565 default slapd configuration file
1569 .BR slapd-dnssrv (5),
1573 .BR slapd-monitor (5),
1575 .BR slapd-passwd (5),
1577 .BR slapd-shell (5),
1580 .BR slapd.access (5),
1581 .BR slapd.plugin (5),
1582 .BR slapd.replog (5),
1590 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1591 .SH ACKNOWLEDGEMENTS
1593 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1595 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob