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.
166 .\".B debug <subsys> <level>
167 .\"Specify a logging level for a particular subsystem. The subsystems include
169 .\"a global level for all subsystems,
173 .\"the backend databases,
175 .\"the entry cache manager,
177 .\"the config file reader,
179 .\"the connection manager,
181 .\"the Cyrus SASL library interface,
183 .\"the search filter processor,
185 .\"the DN normalization library,
187 .\"the database indexer,
189 .\"the ASN.1 BER library,
191 .\"the dynamic module loader,
193 .\"the LDAP operation processors,
195 .\"the SASL authentication subsystem,
197 .\"the schema processor, and
199 .\"the TLS library interface. This is not an exhaustive list; there are many
200 .\"other subsystems and more are added over time.
202 .\"The levels are, in order of decreasing priority:
203 .\".B emergency, alert, critical, error, warning, notice, information, entry,
204 .\".B args, results, detail1, detail2
205 .\"An integer may be used instead, with 0 corresponding to
211 .\"level logs function entry points,
213 .\"adds function call parameters, and
215 .\"adds the function results to the logs.
220 .\"levels add even more low level detail from individual functions.
222 .B defaultsearchbase <dn>
223 Specify a default search base to use when client submits a
224 non-base search request with an empty base DN.
226 .B disallow <features>
227 Specify a set of features (separated by white space) to
228 disallow (default none).
230 disables acceptance of anonymous bind requests.
232 disables simple (bind) authentication.
234 disables Kerberos V4 (bind) authentication.
236 disables Start TLS from forcing session to anonymous status (see also
239 disables StartTLS if authenticated (see also
243 .B ditcontentrule "(\ <oid>\
245 [DESC\ <description>]\
252 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
253 The slapd parser extends the RFC 2252 definition by allowing string
254 forms as well as numeric OIDs to be used for the attribute OID and
255 attribute syntax OID.
261 .B gentlehup { on | off }
262 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
264 will stop listening for new connections, but will not close the
265 connections to the current clients. Future write operations return
266 unwilling-to-perform, though. Slapd terminates when all clients
267 have closed their connections (if they ever do), or \- as before \-
268 if it receives a SIGTERM signal. This can be useful if you wish to
269 terminate the server and start a new
272 .B with another database,
273 without disrupting the currently active clients.
274 The default is off. You may wish to use
276 along with this option.
278 .B idletimeout <integer>
279 Specify the number of seconds to wait before forcibly closing
280 an idle client connection. A idletimeout of 0 disables this
281 feature. The default is 0.
283 .B include <filename>
284 Read additional configuration information from the given file before
285 continuing with the next line of the current file.
287 .B limits <who> <limit> [<limit> [...]]
288 Specify time and size limits based on who initiated an operation.
295 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
301 <style> ::= exact | base | one | subtree | children | regex | anonymous
306 matches all unauthenticated clients.
309 matches all authenticated clients;
312 dn pattern is assumed unless otherwise specified by qualifying
313 the (optional) key string
319 (which are synonyms), to require an exact match; with
321 to require exactly one level of depth match; with
323 to allow any level of depth match, including the exact match; with
325 to allow any level of depth match, not including the exact match;
327 explicitly requires the (default) match based on regular expression
328 pattern, as detailed in
332 matches unbound operations; the
335 The same behavior is obtained by using the
342 with the optional objectClass
348 sets the limits for any DN listed in the values of the
354 group objectClass (default
356 whose DN exactly matches
359 The currently supported limits are
364 The syntax for time limits is
365 .BR time[.{soft|hard}]=<integer> ,
368 is the number of seconds slapd will spend answering a search request.
369 If no time limit is explicitly requested by the client, the
371 limit is used; if the requested time limit exceeds the
373 limit, an "Administrative limit exceeded" is returned.
376 limit is set to 0 or to the keyword "soft", the soft limit is used
377 in either case; if it is set to -1 or to the keyword "none",
378 no hard limit is enforced.
379 Explicit requests for time limits smaller or equal to the
382 If no flag is set, the value is assigned to the
386 limit is set to zero, to preserve the original behavior.
388 The syntax for size limits is
389 .BR size[.{soft|hard|unchecked}]=<integer> ,
392 is the maximum number of entries slapd will return answering a search
394 If no size limit is explicitly requested by the client, the
396 limit is used; if the requested size limit exceeds the
398 limit, an "Administrative limit exceeded" is returned.
401 limit is set to 0 or to the keyword "soft", the soft limit is used
402 in either case; if it is set to -1 or to the keyword "none",
403 no hard limit is enforced.
404 Explicit requests for size limits smaller or equal to the
409 flag sets a limit on the number of candidates a search request is allowed
411 If the selected candidates exceed the
413 limit, the search will abort with "Unwilling to perform".
414 If it is set to -1 or to the keyword "none", no limit is applied (the default).
415 If no flag is set, the value is assigned to the
419 limit is set to zero, to preserve the original behavior.
421 In case of no match, the global limits are used.
422 The default values are the same of
431 control is defined, additional size limits may be enforced; the syntax is
432 .BR size.pr={<integer>|noEstimate} ,
435 is the max page size if no explicit limit is set; the keyword
437 inhibits the server to return an estimate of the total number
438 of entries that will be returned.
441 .\".B logfile <filename>
442 .\"Specify a file for recording debug log messages. By default these messages
443 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
444 .\"copies messages to both stderr and the logfile.
446 .B loglevel <integer>
447 Specify the level at which debugging statements and operation
448 statistics should be syslogged (currently logged to the
450 LOG_LOCAL4 facility). Log levels are additive, and available levels
460 debug packet handling
463 heavy trace debugging
466 connection management
469 print out packets sent and received
472 search filter processing
475 configuration file processing
478 access control list processing
481 stats log connections/operations/results
484 stats log entries sent
487 print communication with shell backends
495 .B moduleload <filename>
496 Specify the name of a dynamically loadable module to load. The filename
497 may be an absolute path name or a simple filename. Non-absolute names
498 are searched for in the directories specified by the
500 option. This option and the
502 option are only usable if slapd was compiled with --enable-modules.
504 .B modulepath <pathspec>
505 Specify a list of directories to search for loadable modules. Typically
506 the path is colon-separated but this depends on the operating system.
509 .B objectclass "(\ <oid>\
511 [DESC\ <description]\
514 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
515 [MUST\ <oids>] [MAY\ <oids>] )"
517 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
518 The slapd parser extends the RFC 2252 definition by allowing string
519 forms as well as numeric OIDs to be used for the object class OID.
523 description.) Object classes are "STRUCTURAL" by default.
526 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
527 Define a string name that equates to the given OID. The string can be used
528 in place of the numeric OID in objectclass and attribute definitions. The
529 name can also be used with a suffix of the form ":xx" in which case the
530 value "oid.xx" will be used.
532 .B password-hash <hash> [<hash>...]
533 This option configures one or more hashes to be used in generation of user
534 passwords stored in the userPassword attribute during processing of
535 LDAP Password Modify Extended Operations (RFC 3062).
536 The <hash> must be one of
550 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
555 use the MD5 algorithm (RFC 1321), the latter with a seed.
562 indicates that the new password should be
563 added to userPassword as clear text.
565 Note that this option does not alter the normal user applications
566 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
568 .B password\-crypt\-salt\-format <format>
569 Specify the format of the salt passed to
571 when generating {CRYPT} passwords (see
573 during processing of LDAP Password Modify Extended Operations (RFC 3062).
575 This string needs to be in
577 format and may include one (and only one) %s conversion.
578 This conversion will be substituted with a string random
579 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
580 provides a two character salt and "$1$%.8s" tells some
581 versions of crypt(3) to use an MD5 algorithm and provides
582 8 random characters of salt. The default is "%s", which
583 provides 31 characters of salt.
585 .B pidfile <filename>
586 The ( absolute ) name of a file that will hold the
588 server's process ID ( see
590 ) if started without the debugging command line option.
593 Specify the referral to pass back when
595 cannot find a local database to handle a request.
596 If specified multiple times, each url is provided.
599 The ( absolute ) name of a file that will hold the
601 server's command line options
602 if started without the debugging command line option.
605 The ( absolute ) name of a file that will hold the
607 server's process ID ( see
609 ) if started without the debugging command line option.
611 .B require <conditions>
612 Specify a set of conditions (separated by white space) to
613 require (default none).
614 The directive may be specified globally and/or per-database.
616 requires bind operation prior to directory operations.
618 requires session to be using LDAP version 3.
620 requires authentication prior to directory operations.
622 requires SASL authentication prior to directory operations.
624 requires strong authentication prior to directory operations.
625 The strong keyword allows protected "simple" authentication
626 as well as SASL authentication.
628 may be used to require no conditions (useful for clearly globally
629 set conditions within a particular database).
631 .B reverse-lookup on | off
632 Enable/disable client name unverified reverse lookup (default is
634 if compiled with --enable-rlookups).
637 Specify the name of an LDIF(5) file containing user defined attributes
638 for the root DSE. These attributes are returned in addition to the
639 attributes normally produced by slapd.
641 .B sasl-authz-policy <policy>
642 Used to specify which rules to use for SASL Proxy Authorization. Proxy
643 authorization allows a client to authenticate to the server using one
644 user's credentials, but specify a different identity to use for authorization
645 and access control purposes. It essentially allows user A to login as user
646 B, using user A's password.
649 flag disables proxy authorization. This is the default setting.
652 flag will use rules in the
654 attribute of the authorization DN.
657 flag will use rules in the
659 attribute of the authentication DN.
662 flag, an alias for the deprecated value of
664 will allow any of the above, whatever succeeds first (checked in
670 flag requires both authorizations to succeed.
671 The rules are simply regular expressions specifying which DNs are allowed
672 to perform proxy authorization.
675 attribute in an entry specifies which other users
676 are allowed to proxy login to this entry. The
679 an entry specifies which other users this user can authorize as. Use of
682 abused if users are allowed to write arbitrary values to this attribute.
685 attribute must be protected with ACLs such that
686 only privileged users can modify it.
693 or a set of identities; it can take three forms:
697 .B ldap:///<base>??[<scope>]?<filter>
700 .B dn[.<dnstyle>]:<pattern>
703 .B u[<mech>[<realm>]]:<pattern>
710 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
713 The first form is a valid LDAP
721 portions must be absent, so that the search occurs locally on either
727 with the optional style modifiers
733 for exact, onelevel, children and subtree matches, which cause
735 to be normalized according to the DN normalization rules, or the special
739 to be compiled according to
741 The third form is a SASL
743 with the optional fields
747 that allow to specify a SASL
749 and eventually a SASL
751 for those mechanisms that support one.
752 The need to allow the specification of a mechanism is still debated,
753 and users are strongly discouraged to rely on this possibility.
754 For backwards compatibility, if no identity type is provided, i.e. only
758 is assumed; as a consequence,
760 is subjected to DN normalization.
761 Since the interpretation of
765 can impact security, users are strongly encouraged
766 to explicitly set the type of identity specification that is being used.
770 Used to specify the fully qualified domain name used for SASL processing.
772 .B sasl-realm <realm>
773 Specify SASL realm. Default is empty.
775 .B sasl-regexp <match> <replace>
776 Used by the SASL mechanism to convert a SASL authenticated
777 username to an LDAP DN used for authorization purposes. Note that
778 the resultant DN need not refer to an existing entry to be considered
779 valid. When an authorization request is received, the SASL
783 are taken, when available, and combined into a SASL name of the
788 .B UID=<username>[[,CN=<realm>],CN=<mechanism>,]CN=auth
791 This SASL name is then compared against the
793 regular expression, and if the match is successful, the SASL name is
796 string. If there are wildcard strings in the
798 regular expression that are enclosed in parenthesis, e.g.
804 then the portion of the SASL name that matched the wildcard will be stored
805 in the numbered placeholder variable $1. If there are other wildcard strings
806 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
807 placeholders can then be used in the
812 .B UID=$1,OU=Accounts,DC=example,DC=com
815 The replaced SASL name can be either a DN or an LDAP URI. If the
816 latter, the server will use the URI to search its own database(s)
817 and, if the search returns exactly one entry, the SASL name is
818 replaced by the DN of that entry. The LDAP URI must have no
819 hostport, attrs, or extensions components, e.g.
822 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
827 options can be given in the configuration file to allow for multiple matching
828 and replacement patterns. The matching patterns are checked in the order they
829 appear in the file, stopping at the first successful match.
832 .\"Because the plus sign + is a character recognized by the regular expression engine,
833 .\"and it will appear in SASL names that include a REALM, be careful to escape the
834 .\"plus sign with a backslash \\+ to remove the character's special meaning.
837 .B sasl-secprops <properties>
838 Used to specify Cyrus SASL security properties.
841 flag (without any other properties) causes the flag properties
842 default, "noanonymous,noplain", to be cleared.
845 flag disables mechanisms susceptible to simple passive attacks.
848 flag disables mechanisms susceptible to active attacks.
851 flag disables mechanisms susceptible to passive dictionary attacks.
854 flag disables mechanisms which support anonymous login.
857 flag require forward secrecy between sessions.
860 require mechanisms which pass client credentials (and allow
861 mechanisms which can pass credentials to do so).
864 property specifies the minimum acceptable
865 .I security strength factor
866 as an integer approximate to effective key length used for
867 encryption. 0 (zero) implies no protection, 1 implies integrity
868 protection only, 56 allows DES or other weak ciphers, 112
869 allows triple DES and other strong ciphers, 128 allows RC4,
870 Blowfish and other modern strong ciphers. The default is 0.
873 property specifies the maximum acceptable
874 .I security strength factor
875 as an integer (see minssf description). The default is INT_MAX.
878 property specifies the maximum security layer receive buffer
879 size allowed. 0 disables security layers. The default is 65536.
882 Specify the distinguished name for the subschema subentry that
883 controls the entries on this server. The default is "cn=Subschema".
885 .B security <factors>
886 Specify a set of factors (separated by white space) to require.
887 An integer value is associated with each factor and is roughly
888 equivalent of the encryption key length to require. A value
889 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
890 The directive may be specified globally and/or per-database.
892 specifies the overall security strength factor.
894 specifies the transport security strength factor.
896 specifies the TLS security strength factor.
898 specifies the SASL security strength factor.
900 specifies the overall security strength factor to require for
902 .B update_transport=<n>
903 specifies the transport security strength factor to require for
906 specifies the TLS security strength factor to require for
909 specifies the SASL security strength factor to require for
912 specifies the security strength factor required for
914 username/password authentication.
917 factor is measure of security provided by the underlying transport,
918 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
920 .B sizelimit {<integer>|unlimited}
922 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
923 Specify the maximum number of entries to return from a search operation.
924 The default size limit is 500.
929 to specify no limits.
930 The second format allows a fine grain setting of the size limits.
931 Extra args can be added on the same line.
934 for an explanation of the different flags.
936 .B sockbuf_max_incoming <integer>
937 Specify the maximum incoming LDAP PDU size for anonymous sessions.
938 The default is 262143.
940 .B sockbuf_max_incoming_auth <integer>
941 Specify the maximum incoming LDAP PDU size for authenticated sessions.
942 The default is 4194303.
945 Specify the srvtab file in which the kerberos keys necessary for
946 authenticating clients using kerberos can be found. This option is only
947 meaningful if you are using Kerberos authentication.
950 Specify the maximum size of the primary thread pool.
953 .B timelimit {<integer>|unlimited}
955 .B timelimit time[.{soft|hard}]=<integer> [...]
956 Specify the maximum number of seconds (in real time)
958 will spend answering a search request. The default time limit is 3600.
963 to specify no limits.
964 The second format allows a fine grain setting of the time limits.
965 Extra args can be added on the same line.
968 for an explanation of the different flags.
970 .B ucdata-path <path>
971 Specify the path to the directory containing the Unicode character
972 tables. The default path is DATADIR/ucdata.
976 is built with support for Transport Layer Security, there are more options
979 .B TLSCipherSuite <cipher-suite-spec>
980 Permits configuring what ciphers will be accepted and the preference order.
981 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
983 TLSCipherSuite HIGH:MEDIUM:+SSLv2
985 To check what ciphers a given spec selects, use:
987 openssl ciphers -v <cipher-suite-spec>
989 .B TLSCACertificateFile <filename>
990 Specifies the file that contains certificates for all of the Certificate
995 .B TLSCACertificatePath <path>
996 Specifies the path of a directory that contains Certificate Authority
997 certificates in separate individual files. Usually only one of this
998 or the TLSCACertificateFile is used.
1000 .B TLSCertificateFile <filename>
1001 Specifies the file that contains the
1005 .B TLSCertificateKeyFile <filename>
1006 Specifies the file that contains the
1008 server private key that matches the certificate stored in the
1009 .B TLSCertificateFile
1010 file. Currently, the private key must not be protected with a password, so
1011 it is of critical importance that it is protected carefully.
1013 .B TLSRandFile <filename>
1014 Specifies the file to obtain random bits from when /dev/[u]random
1015 is not available. Generally set to the name of the EGD/PRNGD socket.
1016 The environment variable RANDFILE can also be used to specify the filename.
1018 .B TLSVerifyClient <level>
1019 Specifies what checks to perform on client certificates in an
1020 incoming TLS session, if any.
1023 can be specified as one of the following keywords:
1027 This is the default.
1029 will not ask the client for a certificate.
1032 The client certificate is requested. If no certificate is provided,
1033 the session proceeds normally. If a bad certificate is provided,
1034 it will be ignored and the session proceeds normally.
1037 The client certificate is requested. If no certificate is provided,
1038 the session proceeds normally. If a bad certificate is provided,
1039 the session is immediately terminated.
1041 .B demand | hard | true
1042 These keywords are all equivalent, for compatibility reasons.
1043 The client certificate is requested. If no certificate is provided,
1044 or a bad certificate is provided, the session is immediately terminated.
1046 Note that a valid client certificate is required in order to use the
1047 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1050 setting must be chosen to enable SASL EXTERNAL authentication.
1052 .SH GENERAL BACKEND OPTIONS
1053 Options in this section only apply to the configuration file section
1054 for the specified backend. They are supported by every
1057 .B backend <databasetype>
1058 Mark the beginning of a backend definition. <databasetype>
1073 depending on which backend will serve the database.
1075 .SH GENERAL DATABASE OPTIONS
1076 Options in this section only apply to the configuration file section
1077 for the database in which they are defined. They are supported by every
1078 type of backend. Note that the
1082 option are mandatory for each database.
1084 .B database <databasetype>
1085 Mark the beginning of a new database instance definition. <databasetype>
1100 depending on which backend will serve the database.
1105 will automatically maintain the
1106 modifiersName, modifyTimestamp, creatorsName, and
1107 createTimestamp attributes for entries. By default, lastmod is on.
1109 .B maxderefdepth <depth>
1110 Specifies the maximum number of aliases to dereference when trying to
1111 resolve an entry, used to avoid infinite alias loops. The default is 1.
1113 .B readonly on | off
1114 This option puts the database into "read-only" mode. Any attempts to
1115 modify the database will return an "unwilling to perform" error. By
1116 default, readonly is off.
1119 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1120 .B [starttls=yes|critical]
1121 .B [suffix=<suffix> [...]]
1122 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1123 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1124 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1125 .B [attr[!]=<attr list>]
1127 Specify a replication site for this database. Refer to the "OpenLDAP
1128 Administrator's Guide" for detailed information on setting up a replicated
1130 directory service. Zero or more
1132 instances can be used to select the subtrees that will be replicated
1133 (defaults to all the database).
1135 is deprecated in favor of the
1139 allows the replica LDAP server to be specified as an LDAP URI.
1144 requires the options
1148 and should only be used when adequate security services
1149 (e.g TLS or IPSEC) are in place. A
1155 Specific security properties (as with the
1157 keyword above) for a SASL bind can be set with the
1159 option. A non-default SASL realm can be set with the
1164 will use Kerberos, a kerberos instance should be given in
1168 can be given after the
1170 keyword to allow the selective replication of the listed attributes only;
1173 mark is used, the list is considered exclusive, i.e. the listed attributes
1175 If an objectClass is listed, all the related attributes
1176 are (are not) replicated.
1179 .B replogfile <filename>
1180 Specify the name of the replication log file to log changes to.
1181 The replication log is typically written by
1186 .BR slapd.replog (5)
1187 for more information. The specified file should be located
1188 in a directory with limited read/write/execute access as the replication
1189 logs may contain sensitive information.
1192 Specify the distinguished name that is not subject to access control
1193 or administrative limit restrictions for operations on this database.
1194 This DN may or may not be associated with an entry. An empty root
1195 DN (the default) specifies no root access is to be granted. It is
1196 recommended that the rootdn only be specified when needed (such as
1197 when initially populating a database). If the rootdn is within
1198 a namingContext (suffix) of the database, a simple bind password
1199 may also be provided using the
1203 .B rootpw <password>
1204 Specify a password (or hash of the password) for the rootdn. The
1205 password can only be set if the rootdn is within the namingContext
1206 (suffix) of the database.
1207 This option accepts all RFC 2307 userPassword formats known to
1210 description) as well as cleartext.
1212 may be used to generate a hash of a password. Cleartext
1213 and \fB{CRYPT}\fP passwords are not recommended. If empty
1214 (the default), authentication of the root DN is by other means
1215 (e.g. SASL). Use of SASL is encouraged.
1217 .B suffix <dn suffix>
1218 Specify the DN suffix of queries that will be passed to this
1219 backend database. Multiple suffix lines can be given and at least one is
1220 required for each database definition.
1221 If the suffix of one database is "inside" that of another, the database
1222 with the inner suffix must come first in the configuration file.
1225 Specify that the current backend database is a subordinate of another
1226 backend database. A subordinate database may have only one suffix. This
1227 option may be used to glue multiple databases into a single namingContext.
1228 If the suffix of the current database is within the namingContext of a
1229 superior database, searches against the superior database will be
1230 propagated to the subordinate as well. All of the databases
1231 associated with a single namingContext should have identical rootdns.
1232 Behavior of other LDAP operations is unaffected by this setting. In
1233 particular, it is not possible to use moddn to move an entry from
1234 one subordinate to another subordinate within the namingContext.
1237 .B syncrepl rid=<replica ID>
1238 .B provider=ldap[s]://<hostname>[:port]
1239 .B [type=refreshOnly|refreshAndPersist]
1240 .B [interval=dd:hh:mm:ss]
1241 .B [searchbase=<base DN>]
1242 .B [filter=<filter str>]
1243 .B [scope=sub|one|base]
1244 .B [attrs=<attr list>]
1246 .B [sizelimit=<limit>]
1247 .B [timelimit=<limit>]
1248 .B [schemachecking=on|off]
1250 .B [bindmethod=simple|sasl]
1252 .B [saslmech=<mech>]
1253 .B [authcid=<identity>]
1254 .B [authzid=<identity>]
1255 .B [credentials=<passwd>]
1257 .B [secprops=<properties>]
1259 Specify the current database as a replica which is kept up-to-date with the
1260 master content by establishing the current
1262 as a replication consumer site running a
1265 The replica content is kept synchronized to the master content using
1266 the LDAP Content Synchronization protocol. Refer to the
1267 "OpenLDAP Administrator's Guide" for detailed information on
1268 setting up a replicated
1270 directory service using the
1274 identifies the current
1276 directive within the replication consumer site.
1277 It is a non-negative integer having no more than three digits.
1279 specifies the replication provider site containing the master content
1280 as an LDAP URI. If <port> is not given, the standard LDAP port number
1281 (389 or 636) is used. The content of the
1283 replica is defined using a search
1284 specification as its result set. The consumer
1286 will send search requests to the provider
1288 according to the search specification. The search specification includes
1289 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1292 parameters as in the normal search specification.
1293 The search specification for the LDAP Content Synchronization operation
1294 has the same value syntax and the same default values as in the
1297 The LDAP Content Synchronization protocol has two operation types.
1300 operation, the next synchronization search operation
1301 is periodically rescheduled at an interval time (specified by
1303 parameter; 1 day by default)
1304 after each synchronization operation finishes.
1306 .B refreshAndPersist
1307 operation, a synchronization search remains persistent in the provider slapd.
1308 Further updates to the master replica will generate
1309 .B searchResultEntry
1310 to the consumer slapd as the search responses to the persistent
1311 synchronization search. The schema checking can be enforced at the LDAP Sync
1312 consumer site by turning on the
1314 parameter. The default is off.
1317 parameter specifies the DN in the consumer site
1318 which is allowed to make changes to the replica.
1319 The DN should have read/write access to the replica database.
1324 of the master database.
1329 requires the options
1333 and should only be used when adequate security services
1334 (e.g. TLS or IPSEC) are in place.
1341 Depending on the mechanism, an authentication identity and/or
1342 credentials can be specified using
1348 parameter may be used to specify an authorization identity.
1349 Specific security properties (as with the
1351 keyword above) for a SASL bind can be set with the
1353 option. A non default SASL realm can be set with the
1359 This option is only applicable in a slave
1361 It specifies the DN permitted to update (subject to access controls)
1362 the replica (typically, this is the DN
1364 binds to update the replica). Generally, this DN
1370 Specify the referral to pass back when
1372 is asked to modify a replicated local database.
1373 If specified multiple times, each url is provided.
1375 .SH DATABASE-SPECIFIC OPTIONS
1376 Each database may allow specific configuration options; they are
1377 documented separately in the backends' manual pages.
1379 The following backends can be compiled into slapd.
1380 They are documented in the
1381 .BR slapd-<backend> (5)
1385 This is the recommended backend for a normal slapd database.
1386 However, it takes more care than with the LDBM backend to configure
1388 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1391 This is the database backend which is easiest to configure.
1392 However, it does not offer the data durability features of the BDB
1394 It uses Berkeley DB or GDBM to store data.
1397 This backend is experimental.
1398 It serves up referrals based upon SRV resource records held in the
1402 This backend acts as a proxy to forward incoming requests to another
1406 This backend performs basic LDAP proxying with respect to a set of
1407 remote LDAP servers. It is an enhancement of the ldap backend. The
1408 proxy cache extension of meta backend provides answering of search
1409 requests from the proxy using results of previously cached requests.
1412 This backend provides information about the running status of the slapd
1416 Operations in this backend succeed but do nothing.
1419 This backend is provided for demonstration purposes only.
1420 It serves up user account information from the system
1425 This backend embeds a
1427 interpreter into slapd.
1428 It runs Perl subroutines to implement LDAP operations.
1431 This backend executes external programs to implement LDAP operations.
1432 It is is primarily intended to be used in prototypes.
1435 This backend is experimental.
1436 It services LDAP requests from an SQL database.
1439 This backend is experimental.
1442 interpreter into slapd.
1443 It runs Tcl commands to implement LDAP operations.
1446 Here is a short example of a configuration file:
1450 include SYSCONFDIR/schema/core.schema
1451 pidfile LOCALSTATEDIR/slapd.pid
1453 # Subtypes of "name" (e.g. "cn" and "ou") with the
1454 # option ";x-hidden" can be searched for/compared,
1455 # but are not shown. See \fBslapd.access\fP(5).
1456 attributeoptions x-hidden lang-
1457 access to attr=name;x-hidden by * =cs
1460 suffix "dc=our-domain,dc=com"
1461 # The database directory MUST exist prior to
1462 # running slapd AND should only be accessible
1463 # by the slapd/tools. Mode 0700 recommended.
1464 directory LOCALSTATEDIR/openldap-data
1465 # Indices to maintain
1466 index objectClass eq
1467 index cn,sn,mail pres,eq,approx,sub
1469 # We serve small clients that do not handle referrals,
1470 # so handle remote lookups on their behalf.
1473 uri ldap://ldap.some-server.com/
1478 "OpenLDAP Administrator's Guide" contains a longer annotated
1479 example of a configuration file.
1480 The original ETCDIR/slapd.conf is another example.
1484 default slapd configuration file
1488 .BR slapd-dnssrv (5),
1492 .BR slapd-monitor (5),
1494 .BR slapd-passwd (5),
1496 .BR slapd-shell (5),
1499 .BR slapd.access (5),
1500 .BR slapd.plugin (5),
1501 .BR slapd.replog (5),
1509 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1510 .SH ACKNOWLEDGEMENTS
1512 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1514 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob