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 authz-policy <policy>
153 Used to specify which rules to use for Proxy Authorization. Proxy
154 authorization allows a client to authenticate to the server using one
155 user's credentials, but specify a different identity to use for authorization
156 and access control purposes. It essentially allows user A to login as user
157 B, using user A's password.
160 flag disables proxy authorization. This is the default setting.
163 flag will use rules in the
165 attribute of the authorization DN.
168 flag will use rules in the
170 attribute of the authentication DN.
173 flag, an alias for the deprecated value of
175 will allow any of the above, whatever succeeds first (checked in
181 flag requires both authorizations to succeed.
182 The rules are simply regular expressions specifying which DNs are allowed
183 to perform proxy authorization.
186 attribute in an entry specifies which other users
187 are allowed to proxy login to this entry. The
190 an entry specifies which other users this user can authorize as. Use of
193 abused if users are allowed to write arbitrary values to this attribute.
196 attribute must be protected with ACLs such that
197 only privileged users can modify it.
204 or a set of identities; it can take three forms:
208 .B ldap:///<base>??[<scope>]?<filter>
211 .B dn[.<dnstyle>]:<pattern>
214 .B u[<mech>[<realm>]]:<pattern>
221 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
224 The first form is a valid LDAP
232 portions must be absent, so that the search occurs locally on either
238 with the optional style modifiers
244 for exact, onelevel, children and subtree matches, which cause
246 to be normalized according to the DN normalization rules, or the special
250 to be compiled according to
252 The third form is a SASL
254 with the optional fields
258 that allow to specify a SASL
260 and eventually a SASL
262 for those mechanisms that support one.
263 The need to allow the specification of a mechanism is still debated,
264 and users are strongly discouraged to rely on this possibility.
265 For backwards compatibility, if no identity type is provided, i.e. only
269 is assumed; as a consequence,
271 is subjected to DN normalization.
272 Since the interpretation of
276 can impact security, users are strongly encouraged
277 to explicitly set the type of identity specification that is being used.
280 .B authz-regexp <match> <replace>
281 Used by the authentication framework to convert simple user names,
282 such as provided by SASL subsystem, to an LDAP DN used for
283 authorization purposes. Note that the resultant DN need not refer
284 to an existing entry to be considered valid. When an authorization
285 request is received from the SASL subsystem, the SASL
290 are taken, when available, and combined into a name of the form
294 .B UID=<username>[[,CN=<realm>],CN=<mechanism>,]CN=auth
297 This name is then compared against the
299 regular expression, and if the match is successful, the name is
302 string. If there are wildcard strings in the
304 regular expression that are enclosed in parenthesis, e.g.
310 then the portion of the name that matched the wildcard will be stored
311 in the numbered placeholder variable $1. If there are other wildcard strings
312 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
313 placeholders can then be used in the
318 .B UID=$1,OU=Accounts,DC=example,DC=com
321 The replaced name can be either a DN or an LDAP URI. If the
322 latter, the server will use the URI to search its own database(s)
323 and, if the search returns exactly one entry, the name is
324 replaced by the DN of that entry. The LDAP URI must have no
325 hostport, attrs, or extensions components, e.g.
328 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
333 options can be given in the configuration file to allow for multiple matching
334 and replacement patterns. The matching patterns are checked in the order they
335 appear in the file, stopping at the first successful match.
338 .\"Because the plus sign + is a character recognized by the regular expression engine,
339 .\"and it will appear in names that include a REALM, be careful to escape the
340 .\"plus sign with a backslash \\+ to remove the character's special meaning.
343 .B concurrency <integer>
344 Specify a desired level of concurrency. Provided to the underlying
345 thread system as a hint. The default is not to provide any hint.
347 .B conn_max_pending <integer>
348 Specify the maximum number of pending requests for an anonymous session.
349 If requests are submitted faster than the server can process them, they
350 will be queued up to this limit. If the limit is exceeded, the session
351 is closed. The default is 100.
353 .B conn_max_pending_auth <integer>
354 Specify the maximum number of pending requests for an authenticated session.
356 .\"-- NEW_LOGGING option --
358 .\".B debug <subsys> <level>
359 .\"Specify a logging level for a particular subsystem. The subsystems include
361 .\"a global level for all subsystems,
365 .\"the backend databases,
367 .\"the entry cache manager,
369 .\"the config file reader,
371 .\"the connection manager,
373 .\"the Cyrus SASL library interface,
375 .\"the search filter processor,
377 .\"the DN normalization library,
379 .\"the database indexer,
381 .\"the ASN.1 BER library,
383 .\"the dynamic module loader,
385 .\"the LDAP operation processors,
387 .\"the SASL authentication subsystem,
389 .\"the schema processor, and
391 .\"the TLS library interface. This is not an exhaustive list; there are many
392 .\"other subsystems and more are added over time.
394 .\"The levels are, in order of decreasing priority:
395 .\".B emergency, alert, critical, error, warning, notice, information, entry,
396 .\".B args, results, detail1, detail2
397 .\"An integer may be used instead, with 0 corresponding to
403 .\"level logs function entry points,
405 .\"adds function call parameters, and
407 .\"adds the function results to the logs.
412 .\"levels add even more low level detail from individual functions.
414 .B defaultsearchbase <dn>
415 Specify a default search base to use when client submits a
416 non-base search request with an empty base DN.
418 .B disallow <features>
419 Specify a set of features (separated by white space) to
420 disallow (default none).
422 disables acceptance of anonymous bind requests.
424 disables simple (bind) authentication.
426 disables Kerberos V4 (bind) authentication.
428 disables Start TLS from forcing session to anonymous status (see also
431 disables StartTLS if authenticated (see also
435 .B ditcontentrule "(\ <oid>\
437 [DESC\ <description>]\
444 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
445 The slapd parser extends the RFC 2252 definition by allowing string
446 forms as well as numeric OIDs to be used for the attribute OID and
447 attribute syntax OID.
453 .B gentlehup { on | off }
454 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
456 will stop listening for new connections, but will not close the
457 connections to the current clients. Future write operations return
458 unwilling-to-perform, though. Slapd terminates when all clients
459 have closed their connections (if they ever do), or \- as before \-
460 if it receives a SIGTERM signal. This can be useful if you wish to
461 terminate the server and start a new
464 .B with another database,
465 without disrupting the currently active clients.
466 The default is off. You may wish to use
468 along with this option.
470 .B idletimeout <integer>
471 Specify the number of seconds to wait before forcibly closing
472 an idle client connection. A idletimeout of 0 disables this
473 feature. The default is 0.
475 .B include <filename>
476 Read additional configuration information from the given file before
477 continuing with the next line of the current file.
478 .\"-- NEW_LOGGING option --
480 .\".B logfile <filename>
481 .\"Specify a file for recording debug log messages. By default these messages
482 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
483 .\"copies messages to both stderr and the logfile.
485 .B loglevel <integer>
486 Specify the level at which debugging statements and operation
487 statistics should be syslogged (currently logged to the
489 LOG_LOCAL4 facility). Log levels are additive, and available levels
499 debug packet handling
502 heavy trace debugging
505 connection management
508 print out packets sent and received
511 search filter processing
514 configuration file processing
517 access control list processing
520 stats log connections/operations/results
523 stats log entries sent
526 print communication with shell backends
534 .B moduleload <filename>
535 Specify the name of a dynamically loadable module to load. The filename
536 may be an absolute path name or a simple filename. Non-absolute names
537 are searched for in the directories specified by the
539 option. This option and the
541 option are only usable if slapd was compiled with --enable-modules.
543 .B modulepath <pathspec>
544 Specify a list of directories to search for loadable modules. Typically
545 the path is colon-separated but this depends on the operating system.
548 .B objectclass "(\ <oid>\
550 [DESC\ <description]\
553 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
554 [MUST\ <oids>] [MAY\ <oids>] )"
556 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
557 The slapd parser extends the RFC 2252 definition by allowing string
558 forms as well as numeric OIDs to be used for the object class OID.
562 description.) Object classes are "STRUCTURAL" by default.
565 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
566 Define a string name that equates to the given OID. The string can be used
567 in place of the numeric OID in objectclass and attribute definitions. The
568 name can also be used with a suffix of the form ":xx" in which case the
569 value "oid.xx" will be used.
571 .B password-hash <hash> [<hash>...]
572 This option configures one or more hashes to be used in generation of user
573 passwords stored in the userPassword attribute during processing of
574 LDAP Password Modify Extended Operations (RFC 3062).
575 The <hash> must be one of
589 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
594 use the MD5 algorithm (RFC 1321), the latter with a seed.
601 indicates that the new password should be
602 added to userPassword as clear text.
604 Note that this option does not alter the normal user applications
605 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
607 .B password\-crypt\-salt\-format <format>
608 Specify the format of the salt passed to
610 when generating {CRYPT} passwords (see
612 during processing of LDAP Password Modify Extended Operations (RFC 3062).
614 This string needs to be in
616 format and may include one (and only one) %s conversion.
617 This conversion will be substituted with a string random
618 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
619 provides a two character salt and "$1$%.8s" tells some
620 versions of crypt(3) to use an MD5 algorithm and provides
621 8 random characters of salt. The default is "%s", which
622 provides 31 characters of salt.
624 .B pidfile <filename>
625 The ( absolute ) name of a file that will hold the
627 server's process ID ( see
629 ) if started without the debugging command line option.
632 Specify the referral to pass back when
634 cannot find a local database to handle a request.
635 If specified multiple times, each url is provided.
638 The ( absolute ) name of a file that will hold the
640 server's command line options
641 if started without the debugging command line option.
644 The ( absolute ) name of a file that will hold the
646 server's process ID ( see
648 ) if started without the debugging command line option.
650 .B replicationinterval
651 The number of seconds
653 waits before checking the replogfile for changes.
655 .B require <conditions>
656 Specify a set of conditions (separated by white space) to
657 require (default none).
658 The directive may be specified globally and/or per-database.
660 requires bind operation prior to directory operations.
662 requires session to be using LDAP version 3.
664 requires authentication prior to directory operations.
666 requires SASL authentication prior to directory operations.
668 requires strong authentication prior to directory operations.
669 The strong keyword allows protected "simple" authentication
670 as well as SASL authentication.
672 may be used to require no conditions (useful for clearly globally
673 set conditions within a particular database).
675 .B reverse-lookup on | off
676 Enable/disable client name unverified reverse lookup (default is
678 if compiled with --enable-rlookups).
681 Specify the name of an LDIF(5) file containing user defined attributes
682 for the root DSE. These attributes are returned in addition to the
683 attributes normally produced by slapd.
686 Used to specify the fully qualified domain name used for SASL processing.
688 .B sasl-realm <realm>
689 Specify SASL realm. Default is empty.
691 .B sasl-secprops <properties>
692 Used to specify Cyrus SASL security properties.
695 flag (without any other properties) causes the flag properties
696 default, "noanonymous,noplain", to be cleared.
699 flag disables mechanisms susceptible to simple passive attacks.
702 flag disables mechanisms susceptible to active attacks.
705 flag disables mechanisms susceptible to passive dictionary attacks.
708 flag disables mechanisms which support anonymous login.
711 flag require forward secrecy between sessions.
714 require mechanisms which pass client credentials (and allow
715 mechanisms which can pass credentials to do so).
718 property specifies the minimum acceptable
719 .I security strength factor
720 as an integer approximate to effective key length used for
721 encryption. 0 (zero) implies no protection, 1 implies integrity
722 protection only, 56 allows DES or other weak ciphers, 112
723 allows triple DES and other strong ciphers, 128 allows RC4,
724 Blowfish and other modern strong ciphers. The default is 0.
727 property specifies the maximum acceptable
728 .I security strength factor
729 as an integer (see minssf description). The default is INT_MAX.
732 property specifies the maximum security layer receive buffer
733 size allowed. 0 disables security layers. The default is 65536.
736 Specify the distinguished name for the subschema subentry that
737 controls the entries on this server. The default is "cn=Subschema".
739 .B security <factors>
740 Specify a set of factors (separated by white space) to require.
741 An integer value is associated with each factor and is roughly
742 equivalent of the encryption key length to require. A value
743 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
744 The directive may be specified globally and/or per-database.
746 specifies the overall security strength factor.
748 specifies the transport security strength factor.
750 specifies the TLS security strength factor.
752 specifies the SASL security strength factor.
754 specifies the overall security strength factor to require for
756 .B update_transport=<n>
757 specifies the transport security strength factor to require for
760 specifies the TLS security strength factor to require for
763 specifies the SASL security strength factor to require for
766 specifies the security strength factor required for
768 username/password authentication.
771 factor is measure of security provided by the underlying transport,
772 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
774 .B sizelimit {<integer>|unlimited}
776 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
777 Specify the maximum number of entries to return from a search operation.
778 The default size limit is 500.
783 to specify no limits.
784 The second format allows a fine grain setting of the size limits.
785 Extra args can be added on the same line.
788 for an explanation of the different flags.
790 .B sockbuf_max_incoming <integer>
791 Specify the maximum incoming LDAP PDU size for anonymous sessions.
792 The default is 262143.
794 .B sockbuf_max_incoming_auth <integer>
795 Specify the maximum incoming LDAP PDU size for authenticated sessions.
796 The default is 4194303.
799 Specify the srvtab file in which the kerberos keys necessary for
800 authenticating clients using kerberos can be found. This option is only
801 meaningful if you are using Kerberos authentication.
804 Specify the maximum size of the primary thread pool.
807 .B timelimit {<integer>|unlimited}
809 .B timelimit time[.{soft|hard}]=<integer> [...]
810 Specify the maximum number of seconds (in real time)
812 will spend answering a search request. The default time limit is 3600.
817 to specify no limits.
818 The second format allows a fine grain setting of the time limits.
819 Extra args can be added on the same line.
822 for an explanation of the different flags.
824 .B ucdata-path <path>
825 Specify the path to the directory containing the Unicode character
826 tables. The default path is DATADIR/ucdata.
830 is built with support for Transport Layer Security, there are more options
833 .B TLSCipherSuite <cipher-suite-spec>
834 Permits configuring what ciphers will be accepted and the preference order.
835 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
837 TLSCipherSuite HIGH:MEDIUM:+SSLv2
839 To check what ciphers a given spec selects, use:
841 openssl ciphers -v <cipher-suite-spec>
843 .B TLSCACertificateFile <filename>
844 Specifies the file that contains certificates for all of the Certificate
849 .B TLSCACertificatePath <path>
850 Specifies the path of a directory that contains Certificate Authority
851 certificates in separate individual files. Usually only one of this
852 or the TLSCACertificateFile is used.
854 .B TLSCertificateFile <filename>
855 Specifies the file that contains the
859 .B TLSCertificateKeyFile <filename>
860 Specifies the file that contains the
862 server private key that matches the certificate stored in the
863 .B TLSCertificateFile
864 file. Currently, the private key must not be protected with a password, so
865 it is of critical importance that it is protected carefully.
867 .B TLSRandFile <filename>
868 Specifies the file to obtain random bits from when /dev/[u]random
869 is not available. Generally set to the name of the EGD/PRNGD socket.
870 The environment variable RANDFILE can also be used to specify the filename.
872 .B TLSVerifyClient <level>
873 Specifies what checks to perform on client certificates in an
874 incoming TLS session, if any.
877 can be specified as one of the following keywords:
883 will not ask the client for a certificate.
886 The client certificate is requested. If no certificate is provided,
887 the session proceeds normally. If a bad certificate is provided,
888 it will be ignored and the session proceeds normally.
891 The client certificate is requested. If no certificate is provided,
892 the session proceeds normally. If a bad certificate is provided,
893 the session is immediately terminated.
895 .B demand | hard | true
896 These keywords are all equivalent, for compatibility reasons.
897 The client certificate is requested. If no certificate is provided,
898 or a bad certificate is provided, the session is immediately terminated.
900 Note that a valid client certificate is required in order to use the
901 SASL EXTERNAL authentication mechanism with a TLS session. As such,
904 setting must be chosen to enable SASL EXTERNAL authentication.
906 .SH GENERAL BACKEND OPTIONS
907 Options in this section only apply to the configuration file section
908 for the specified backend. They are supported by every
911 .B backend <databasetype>
912 Mark the beginning of a backend definition. <databasetype>
927 depending on which backend will serve the database.
929 .SH GENERAL DATABASE OPTIONS
930 Options in this section only apply to the configuration file section
931 for the database in which they are defined. They are supported by every
932 type of backend. Note that the
936 option are mandatory for each database.
938 .B database <databasetype>
939 Mark the beginning of a new database instance definition. <databasetype>
954 depending on which backend will serve the database.
959 will automatically maintain the
960 modifiersName, modifyTimestamp, creatorsName, and
961 createTimestamp attributes for entries. By default, lastmod is on.
963 .B limits <who> <limit> [<limit> [...]]
964 Specify time and size limits based on who initiated an operation.
971 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
977 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
982 matches all unauthenticated clients.
985 matches all authenticated clients;
988 dn pattern is assumed unless otherwise specified by qualifying
989 the (optional) key string
995 (which are synonyms), to require an exact match; with
997 to require exactly one level of depth match; with
999 to allow any level of depth match, including the exact match; with
1001 to allow any level of depth match, not including the exact match;
1003 explicitly requires the (default) match based on regular expression
1004 pattern, as detailed in
1008 matches unbound operations; the
1011 The same behavior is obtained by using the
1018 with the optional objectClass
1024 sets the limits for any DN listed in the values of the
1030 group objectClass (default
1032 whose DN exactly matches
1035 The currently supported limits are
1040 The syntax for time limits is
1041 .BR time[.{soft|hard}]=<integer> ,
1044 is the number of seconds slapd will spend answering a search request.
1045 If no time limit is explicitly requested by the client, the
1047 limit is used; if the requested time limit exceeds the
1050 .I \"Administrative limit exceeded\"
1054 limit is set to 0 or to the keyword
1056 the soft limit is used in either case; if it is set to
1060 no hard limit is enforced.
1061 Explicit requests for time limits smaller or equal to the
1064 If no flag is set, the value is assigned to the
1068 limit is set to zero, to preserve the original behavior.
1070 The syntax for size limits is
1071 .BR size[.{soft|hard|unchecked}]=<integer> ,
1074 is the maximum number of entries slapd will return answering a search
1076 If no size limit is explicitly requested by the client, the
1078 limit is used; if the requested size limit exceeds the
1081 .I \"Administrative limit exceeded\"
1085 limit is set to 0 or to the keyword
1087 the soft limit is used in either case; if it is set to
1091 no hard limit is enforced.
1092 Explicit requests for size limits smaller or equal to the
1097 flag sets a limit on the number of candidates a search request is allowed
1099 If the selected candidates exceed the
1101 limit, the search will abort with
1102 .IR \"Unwilling to perform\" .
1107 no limit is applied (the default).
1110 the search is not even performed; this can be used to disallow searches
1111 for a specific set of users.
1112 If no flag is set, the value is assigned to the
1116 limit is set to zero, to preserve the original behavior.
1118 In case of no match, the global limits are used.
1119 The default values are the same of
1128 control is requested, the
1130 size limit is used by default, because the request of a specific page size
1131 is considered as an explicit request for a limitation on the number
1132 of entries to be returned.
1133 However, the size limit applies to the total count of entries returned within
1134 the search, and not to a single page.
1135 Additional size limits may be enforced; the syntax is
1136 .BR size.pr={<integer>|noEstimate|none} ,
1139 is the max page size if no explicit limit is set; the keyword
1141 inhibits the server to return an estimate of the total number
1142 of entries that will be returned; the keyword
1144 indicates that no limit is applied to the pagedResults control page size.
1146 .B size.prtotal={<integer>|none|disabled}
1147 allows to set a limit on the total number of entries that a pagedResults
1148 control allows to return.
1149 By default it is set to the
1154 is the max number of entries that the whole search with pagedResults control
1158 to allow unlimited number of entries to be returned, i.e. to use
1159 pagedResults as a means to allow clients to circumvent size limitations
1160 on regular searches; the keyword
1162 disables the control, i.e. no paged results can be returned.
1163 Note that the total number of entries returned when the pagedResults control
1164 is requested cannot exceed the
1166 size limit of regular searches unless extended by the
1171 .B maxderefdepth <depth>
1172 Specifies the maximum number of aliases to dereference when trying to
1173 resolve an entry, used to avoid infinite alias loops. The default is 1.
1175 .B overlay <overlay-name>
1176 Add the specified overlay to this database. An overlay is a piece of
1177 code that intercepts database operations in order to extend or change
1178 them. Overlays are pushed onto
1179 a stack over the database, and so they will execute in the reverse
1180 of the order in which they were configured and the database itself
1181 will receive control last of all.
1183 .B readonly on | off
1184 This option puts the database into "read-only" mode. Any attempts to
1185 modify the database will return an "unwilling to perform" error. By
1186 default, readonly is off.
1189 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1190 .B [starttls=yes|critical]
1191 .B [suffix=<suffix> [...]]
1192 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1193 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1194 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1195 .B [attr[!]=<attr list>]
1197 Specify a replication site for this database. Refer to the "OpenLDAP
1198 Administrator's Guide" for detailed information on setting up a replicated
1200 directory service. Zero or more
1202 instances can be used to select the subtrees that will be replicated
1203 (defaults to all the database).
1205 is deprecated in favor of the
1209 allows the replica LDAP server to be specified as an LDAP URI.
1214 requires the options
1218 and should only be used when adequate security services
1219 (e.g TLS or IPSEC) are in place. A
1225 Specific security properties (as with the
1227 keyword above) for a SASL bind can be set with the
1229 option. A non-default SASL realm can be set with the
1234 will use Kerberos, a kerberos instance should be given in
1238 can be given after the
1240 keyword to allow the selective replication of the listed attributes only;
1243 mark is used, the list is considered exclusive, i.e. the listed attributes
1245 If an objectClass is listed, all the related attributes
1246 are (are not) replicated.
1249 .B replogfile <filename>
1250 Specify the name of the replication log file to log changes to.
1251 The replication log is typically written by
1256 .BR slapd.replog (5)
1257 for more information. The specified file should be located
1258 in a directory with limited read/write/execute access as the replication
1259 logs may contain sensitive information.
1262 Specify the distinguished name that is not subject to access control
1263 or administrative limit restrictions for operations on this database.
1264 This DN may or may not be associated with an entry. An empty root
1265 DN (the default) specifies no root access is to be granted. It is
1266 recommended that the rootdn only be specified when needed (such as
1267 when initially populating a database). If the rootdn is within
1268 a namingContext (suffix) of the database, a simple bind password
1269 may also be provided using the
1273 .B rootpw <password>
1274 Specify a password (or hash of the password) for the rootdn. The
1275 password can only be set if the rootdn is within the namingContext
1276 (suffix) of the database.
1277 This option accepts all RFC 2307 userPassword formats known to
1280 description) as well as cleartext.
1282 may be used to generate a hash of a password. Cleartext
1283 and \fB{CRYPT}\fP passwords are not recommended. If empty
1284 (the default), authentication of the root DN is by other means
1285 (e.g. SASL). Use of SASL is encouraged.
1287 .B suffix <dn suffix>
1288 Specify the DN suffix of queries that will be passed to this
1289 backend database. Multiple suffix lines can be given and at least one is
1290 required for each database definition.
1291 If the suffix of one database is "inside" that of another, the database
1292 with the inner suffix must come first in the configuration file.
1295 Specify that the current backend database is a subordinate of another
1296 backend database. A subordinate database may have only one suffix. This
1297 option may be used to glue multiple databases into a single namingContext.
1298 If the suffix of the current database is within the namingContext of a
1299 superior database, searches against the superior database will be
1300 propagated to the subordinate as well. All of the databases
1301 associated with a single namingContext should have identical rootdns.
1302 Behavior of other LDAP operations is unaffected by this setting. In
1303 particular, it is not possible to use moddn to move an entry from
1304 one subordinate to another subordinate within the namingContext.
1307 .B syncrepl rid=<replica ID>
1308 .B provider=ldap[s]://<hostname>[:port]
1309 .B [type=refreshOnly|refreshAndPersist]
1310 .B [interval=dd:hh:mm:ss]
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. The schema checking can be enforced at the LDAP Sync
1382 consumer site by turning on the
1384 parameter. The default is off.
1387 parameter specifies the DN in the consumer site
1388 which is allowed to make changes to the replica.
1389 The DN should have read/write access to the replica database.
1394 of the master database.
1399 requires the options
1403 and should only be used when adequate security services
1404 (e.g. TLS or IPSEC) are in place.
1411 Depending on the mechanism, an authentication identity and/or
1412 credentials can be specified using
1418 parameter may be used to specify an authorization identity.
1419 Specific security properties (as with the
1421 keyword above) for a SASL bind can be set with the
1423 option. A non default SASL realm can be set with the
1429 This option is only applicable in a slave
1430 database updated using
1432 It specifies the DN permitted to update (subject to access controls)
1433 the replica (typically, this is the DN
1435 binds to update the replica). Generally, this DN
1442 Specify the referral to pass back when
1444 is asked to modify a replicated local database.
1445 If specified multiple times, each url is provided.
1447 .SH DATABASE-SPECIFIC OPTIONS
1448 Each database may allow specific configuration options; they are
1449 documented separately in the backends' manual pages.
1451 The following backends can be compiled into slapd.
1452 They are documented in the
1453 .BR slapd-<backend> (5)
1457 This is the recommended backend for a normal slapd database.
1458 However, it takes more care than with the LDBM backend to configure
1460 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1463 This is the database backend which is easiest to configure.
1464 However, it does not offer the data durability features of the BDB
1466 It uses Berkeley DB or GDBM to store data.
1469 This backend is experimental.
1470 It serves up referrals based upon SRV resource records held in the
1474 This backend acts as a proxy to forward incoming requests to another
1478 This backend performs basic LDAP proxying with respect to a set of
1479 remote LDAP servers. It is an enhancement of the ldap backend. The
1480 proxy cache extension of meta backend provides answering of search
1481 requests from the proxy using results of previously cached requests.
1484 This backend provides information about the running status of the slapd
1488 Operations in this backend succeed but do nothing.
1491 This backend is provided for demonstration purposes only.
1492 It serves up user account information from the system
1497 This backend embeds a
1499 interpreter into slapd.
1500 It runs Perl subroutines to implement LDAP operations.
1503 This backend executes external programs to implement LDAP operations.
1504 It is is primarily intended to be used in prototypes.
1507 This backend is experimental.
1508 It services LDAP requests from an SQL database.
1511 This backend is experimental.
1514 interpreter into slapd.
1515 It runs Tcl commands to implement LDAP operations.
1518 Here is a short example of a configuration file:
1522 include SYSCONFDIR/schema/core.schema
1523 pidfile LOCALSTATEDIR/slapd.pid
1525 # Subtypes of "name" (e.g. "cn" and "ou") with the
1526 # option ";x-hidden" can be searched for/compared,
1527 # but are not shown. See \fBslapd.access\fP(5).
1528 attributeoptions x-hidden lang-
1529 access to attr=name;x-hidden by * =cs
1532 suffix "dc=our-domain,dc=com"
1533 # The database directory MUST exist prior to
1534 # running slapd AND should only be accessible
1535 # by the slapd/tools. Mode 0700 recommended.
1536 directory LOCALSTATEDIR/openldap-data
1537 # Indices to maintain
1538 index objectClass eq
1539 index cn,sn,mail pres,eq,approx,sub
1541 # We serve small clients that do not handle referrals,
1542 # so handle remote lookups on their behalf.
1545 uri ldap://ldap.some-server.com/
1550 "OpenLDAP Administrator's Guide" contains a longer annotated
1551 example of a configuration file.
1552 The original ETCDIR/slapd.conf is another example.
1556 default slapd configuration file
1560 .BR slapd-dnssrv (5),
1564 .BR slapd-monitor (5),
1566 .BR slapd-passwd (5),
1568 .BR slapd-shell (5),
1571 .BR slapd.access (5),
1572 .BR slapd.plugin (5),
1573 .BR slapd.replog (5),
1581 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1582 .SH ACKNOWLEDGEMENTS
1584 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1586 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob