1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
12 contains configuration information for the
14 daemon. This configuration file is also used by the
16 replication daemon and by the SLAPD tools
28 file consists of a series of global configuration options that apply to
30 as a whole (including all backends), followed by zero or more database
31 backend definitions that contain information specific to a backend
33 The configuration options are case-insensitive;
34 their value, on a case by case basis, may be case-sensitive.
41 # comment - these options apply to every database
42 <global configuration options>
43 # first database definition & configuration options
44 database <backend 1 type>
45 <configuration options specific to backend 1>
46 # subsequent database definitions & configuration options
50 As many backend-specific sections as desired may be included. Global
51 options can be overridden in a backend (for options that appear more
52 than once, the last appearance in the
56 If a line begins with white space, it is considered a continuation
57 of the previous line. No physical line should be over 2000 bytes
60 Blank lines and comment lines beginning with
61 a `#' character are ignored. Note: continuation lines are unwrapped
62 before comment processing is applied.
64 Arguments on configuration lines are separated by white space. If an
65 argument contains white space, the argument should be enclosed in
66 double quotes. If an argument contains a double quote (`"') or a
67 backslash character (`\\'), the character should be preceded by a
70 The specific configuration options available are discussed below in the
71 Global Configuration Options, General Backend Options, and General Database
72 Options. Backend-specific options are discussed in the
74 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
75 details on the slapd configuration file.
76 .SH GLOBAL CONFIGURATION OPTIONS
77 Options described in this section apply to all backends, unless specifically
78 overridden in a backend definition. Arguments that should be replaced by
79 actual text are shown in brackets <>.
81 .B access to <what> "[ by <who> <access> <control> ]+"
82 Grant access (specified by <access>) to a set of entries and/or
83 attributes (specified by <what>) by one or more requestors (specified
85 If no access controls are present, the default policy
86 allows anyone and everyone to read anything but restricts
87 updates to rootdn. (e.g., "access to * by * read").
88 The rootdn can always read and write EVERYTHING!
91 and the "OpenLDAP's Administrator's Guide" for details.
94 Specify a set of features (separated by white space) to
97 allows acceptance of LDAPv2 bind requests. Note that
99 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
101 allows anonymous bind when credentials are not empty (e.g.
104 allows unauthenticated (anonymous) bind when DN is not empty.
106 allows unauthenticated (anonymous) update operations to be processed
107 (subject to access controls and other administrative limits).
109 allows unauthenticated (anonymous) proxy authorization control to be processed
110 (subject to access controls, authorization and other administrative limits).
112 .B argsfile <filename>
113 The ( absolute ) name of a file that will hold the
115 server's command line options
116 if started without the debugging command line option.
118 .B attributeoptions [option-name]...
119 Define tagging attribute options or option tag/range prefixes.
120 Options must not end with `-', prefixes must end with `-'.
121 The `lang-' prefix is predefined.
124 directive, `lang-' will no longer be defined and you must specify it
125 explicitly if you want it defined.
127 An attribute description with a tagging option is a subtype of that
128 attribute description without the option.
129 Except for that, options defined this way have no special semantics.
130 Prefixes defined this way work like the `lang-' options:
131 They define a prefix for tagging options starting with the prefix.
132 That is, if you define the prefix `x-foo-', you can use the option
134 Furthermore, in a search or compare, a prefix or range name (with
135 a trailing `-') matches all options starting with that name, as well
136 as the option with the range name sans the trailing `-'.
137 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
139 RFC 4520 reserves options beginning with `x-' for private experiments.
140 Other options should be registered with IANA, see RFC 4520 section 3.5.
141 OpenLDAP also has the `binary' option built in, but this is a transfer
142 option, not a tagging option.
145 .B attributetype "(\ <oid>\
147 [DESC\ <description>]\
156 [NO\-USER\-MODIFICATION]\
157 [USAGE\ <attributeUsage>]\ )"
159 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
160 The slapd parser extends the RFC 4512 definition by allowing string
161 forms as well as numeric OIDs to be used for the attribute OID and
162 attribute syntax OID.
168 .B authz-policy <policy>
169 Used to specify which rules to use for Proxy Authorization. Proxy
170 authorization allows a client to authenticate to the server using one
171 user's credentials, but specify a different identity to use for authorization
172 and access control purposes. It essentially allows user A to login as user
173 B, using user A's password.
176 flag disables proxy authorization. This is the default setting.
179 flag will use rules in the
181 attribute of the authorization DN.
184 flag will use rules in the
186 attribute of the authentication DN.
189 flag, an alias for the deprecated value of
191 will allow any of the above, whatever succeeds first (checked in
197 flag requires both authorizations to succeed.
200 The rules are mechanisms to specify which identities are allowed
201 to perform proxy authorization.
204 attribute in an entry specifies which other users
205 are allowed to proxy login to this entry. The
208 an entry specifies which other users this user can authorize as. Use of
211 abused if users are allowed to write arbitrary values to this attribute.
214 attribute must be protected with ACLs such that
215 only privileged users can modify it.
222 or a set of identities; it can take five forms:
225 .B ldap:///<base>??[<scope>]?<filter>
228 .B dn[.<dnstyle>]:<pattern>
231 .B u[<mech>[<realm>]]:<pattern>
234 .B group[/objectClass[/attributeType]]:<pattern>
241 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
244 The first form is a valid LDAP
252 portions must be absent, so that the search occurs locally on either
258 with the optional style modifiers
264 for exact, onelevel, children and subtree matches, which cause
266 to be normalized according to the DN normalization rules, or the special
268 style, which causes the
270 to be treated as a POSIX (''extended'') regular expression, as
277 means any non-anonymous DN.
278 The third form is a SASL
280 with the optional fields
284 that allow to specify a SASL
286 and eventually a SASL
288 for those mechanisms that support one.
289 The need to allow the specification of a mechanism is still debated,
290 and users are strongly discouraged to rely on this possibility.
291 The fourth form is a group specification, consisting of the keyword
293 optionally followed by the specification of the group
299 is searched with base scope, and in case of match, the values of the
302 are searched for the asserted DN.
303 For backwards compatibility, if no identity type is provided, i.e. only
307 is assumed; as a consequence,
309 is subjected to DN normalization.
310 Since the interpretation of
314 can impact security, users are strongly encouraged
315 to explicitly set the type of identity specification that is being used.
316 A subset of these rules can be used as third arg in the
318 statement (see below); significantly, the
325 .B authz-regexp <match> <replace>
326 Used by the authentication framework to convert simple user names,
327 such as provided by SASL subsystem, to an LDAP DN used for
328 authorization purposes. Note that the resultant DN need not refer
329 to an existing entry to be considered valid. When an authorization
330 request is received from the SASL subsystem, the SASL
335 are taken, when available, and combined into a name of the form
339 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
342 This name is then compared against the
344 POSIX (''extended'') regular expression, and if the match is successful,
345 the name is replaced with the
347 string. If there are wildcard strings in the
349 regular expression that are enclosed in parenthesis, e.g.
355 then the portion of the name that matched the wildcard will be stored
356 in the numbered placeholder variable $1. If there are other wildcard strings
357 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
358 placeholders can then be used in the
363 .B UID=$1,OU=Accounts,DC=example,DC=com
366 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
368 If the latter, the server will use the URI to search its own database(s)
369 and, if the search returns exactly one entry, the name is
370 replaced by the DN of that entry. The LDAP URI must have no
371 hostport, attrs, or extensions components, but the filter is mandatory,
375 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
378 The protocol portion of the URI must be strictly
380 Note that this search is subject to access controls. Specifically,
381 the authentication identity must have "auth" access in the subject.
385 options can be given in the configuration file to allow for multiple matching
386 and replacement patterns. The matching patterns are checked in the order they
387 appear in the file, stopping at the first successful match.
390 .\"Because the plus sign + is a character recognized by the regular expression engine,
391 .\"and it will appear in names that include a REALM, be careful to escape the
392 .\"plus sign with a backslash \\+ to remove the character's special meaning.
395 .B concurrency <integer>
396 Specify a desired level of concurrency. Provided to the underlying
397 thread system as a hint. The default is not to provide any hint.
399 .B conn_max_pending <integer>
400 Specify the maximum number of pending requests for an anonymous session.
401 If requests are submitted faster than the server can process them, they
402 will be queued up to this limit. If the limit is exceeded, the session
403 is closed. The default is 100.
405 .B conn_max_pending_auth <integer>
406 Specify the maximum number of pending requests for an authenticated session.
409 .B defaultsearchbase <dn>
410 Specify a default search base to use when client submits a
411 non-base search request with an empty base DN.
412 Base scoped search requests with an empty base DN are not affected.
414 .B disallow <features>
415 Specify a set of features (separated by white space) to
416 disallow (default none).
418 disables acceptance of anonymous bind requests. Note that this setting
419 does not prohibit anonymous directory access (See "require authc").
421 disables simple (bind) authentication.
423 disables forcing session to anonymous status (see also
425 upon StartTLS operation receipt.
427 disallows the StartTLS operation if authenticated (see also
431 .B ditcontentrule "(\ <oid>\
433 [DESC\ <description>]\
440 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
441 The slapd parser extends the RFC 4512 definition by allowing string
442 forms as well as numeric OIDs to be used for the attribute OID and
443 attribute syntax OID.
449 .B gentlehup { on | off }
450 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
452 will stop listening for new connections, but will not close the
453 connections to the current clients. Future write operations return
454 unwilling-to-perform, though. Slapd terminates when all clients
455 have closed their connections (if they ever do), or \- as before \-
456 if it receives a SIGTERM signal. This can be useful if you wish to
457 terminate the server and start a new
460 .B with another database,
461 without disrupting the currently active clients.
462 The default is off. You may wish to use
464 along with this option.
466 .B idletimeout <integer>
467 Specify the number of seconds to wait before forcibly closing
468 an idle client connection. A idletimeout of 0 disables this
469 feature. The default is 0.
471 .B include <filename>
472 Read additional configuration information from the given file before
473 continuing with the next line of the current file.
475 .B index_substr_if_minlen <integer>
476 Specify the minimum length for subinitial and subfinal indices. An
477 attribute value must have at least this many characters in order to be
478 processed by the indexing functions. The default is 2.
480 .B index_substr_if_maxlen <integer>
481 Specify the maximum length for subinitial and subfinal indices. Only
482 this many characters of an attribute value will be processed by the
483 indexing functions; any excess characters are ignored. The default is 4.
485 .B index_substr_any_len <integer>
486 Specify the length used for subany indices. An attribute value must have
487 at least this many characters in order to be processed. Attribute values
488 longer than this length will be processed in segments of this length. The
489 default is 4. The subany index will also be used in subinitial and
490 subfinal index lookups when the filter string is longer than the
491 .I index_substr_if_maxlen
494 .B index_substr_any_step <integer>
495 Specify the steps used in subany index lookups. This value sets the offset
496 for the segments of a filter string that are processed for a subany index
497 lookup. The default is 2. For example, with the default values, a search
498 using this filter "cn=*abcdefgh*" would generate index lookups for
499 "abcd", "cdef", and "efgh".
502 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
503 such as those to the ldapi:// listener. For a description of SSF values,
507 option description. The default is 71.
509 .B logfile <filename>
510 Specify a file for recording debug log messages. By default these messages
511 only go to stderr and are not recorded anywhere else. Specifying a logfile
512 copies messages to both stderr and the logfile.
514 .B loglevel <integer> [...]
515 Specify the level at which debugging statements and operation
516 statistics should be syslogged (currently logged to the
518 LOG_LOCAL4 facility).
519 They must be considered subsystems rather than increasingly verbose
521 Some messages with higher priority are logged regardless
522 of the configured loglevel as soon as any logging is configured.
523 Log levels are additive, and available levels are:
534 debug packet handling
538 heavy trace debugging (function args)
542 connection management
546 print out packets sent and received
550 search filter processing
554 configuration file processing
558 access control list processing
562 stats log connections/operations/results
566 stats log entries sent
570 print communication with shell backends
582 \"data indexing (unused)
590 only messages that get logged whatever log level is set
593 The desired log level can be input as a single integer that combines
594 the (ORed) desired levels, both in decimal or in hexadecimal notation,
595 as a list of integers (that are ORed internally),
596 or as a list of the names that are shown between brackets, such that
609 can be used as a shortcut to enable logging at all levels (equivalent to -1).
612 or the equivalent integer representation, causes those messages
613 that are logged regardless of the configured loglevel to be logged.
614 In fact, if no loglevel (or a 0 level) is defined, no logging occurs,
617 level is required to have high priority messages logged.
620 .B moduleload <filename>
621 Specify the name of a dynamically loadable module to load. The filename
622 may be an absolute path name or a simple filename. Non-absolute names
623 are searched for in the directories specified by the
625 option. This option and the
627 option are only usable if slapd was compiled with --enable-modules.
629 .B modulepath <pathspec>
630 Specify a list of directories to search for loadable modules. Typically
631 the path is colon-separated but this depends on the operating system.
634 .B objectclass "(\ <oid>\
636 [DESC\ <description>]\
639 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
640 [MUST\ <oids>] [MAY\ <oids>] )"
642 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
643 The slapd parser extends the RFC 4512 definition by allowing string
644 forms as well as numeric OIDs to be used for the object class OID.
648 description.) Object classes are "STRUCTURAL" by default.
651 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
652 Define a string name that equates to the given OID. The string can be used
653 in place of the numeric OID in objectclass and attribute definitions. The
654 name can also be used with a suffix of the form ":xx" in which case the
655 value "oid.xx" will be used.
657 .B password-hash <hash> [<hash>...]
658 This option configures one or more hashes to be used in generation of user
659 passwords stored in the userPassword attribute during processing of
660 LDAP Password Modify Extended Operations (RFC 3062).
661 The <hash> must be one of
675 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
680 use the MD5 algorithm (RFC 1321), the latter with a seed.
687 indicates that the new password should be
688 added to userPassword as clear text.
690 Note that this option does not alter the normal user applications
691 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
693 .B password\-crypt\-salt\-format <format>
694 Specify the format of the salt passed to
696 when generating {CRYPT} passwords (see
698 during processing of LDAP Password Modify Extended Operations (RFC 3062).
700 This string needs to be in
702 format and may include one (and only one) %s conversion.
703 This conversion will be substituted with a string of random
704 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
705 provides a two character salt and "$1$%.8s" tells some
706 versions of crypt(3) to use an MD5 algorithm and provides
707 8 random characters of salt. The default is "%s", which
708 provides 31 characters of salt.
710 .B pidfile <filename>
711 The ( absolute ) name of a file that will hold the
713 server's process ID ( see
715 ) if started without the debugging command line option.
718 Specify the referral to pass back when
720 cannot find a local database to handle a request.
721 If specified multiple times, each url is provided.
724 The ( absolute ) name of a file that will hold the
726 server's command line options
727 if started without the debugging command line option.
728 If it appears after a
730 directive, the args file is specific to the
732 instance that handles that replication log.
735 The ( absolute ) name of a file that will hold the
737 server's process ID ( see
739 ) if started without the debugging command line option.
740 If it appears after a
742 directive, the pid file is specific to the
744 instance that handles that replication log.
746 .B replicationinterval
747 The number of seconds
749 waits before checking the replogfile for changes.
750 If it appears after a
752 directive, the replication interval is specific to the
754 instance that handles that replication log.
756 .B require <conditions>
757 Specify a set of conditions (separated by white space) to
758 require (default none).
759 The directive may be specified globally and/or per-database;
760 databases inherit global conditions, so per-database specifications
763 requires bind operation prior to directory operations.
765 requires session to be using LDAP version 3.
767 requires authentication prior to directory operations.
769 requires SASL authentication prior to directory operations.
771 requires strong authentication prior to directory operations.
772 The strong keyword allows protected "simple" authentication
773 as well as SASL authentication.
775 may be used to require no conditions (useful to clear out globally
776 set conditions within a particular database); it must occur first
777 in the list of conditions.
779 .B reverse-lookup on | off
780 Enable/disable client name unverified reverse lookup (default is
782 if compiled with --enable-rlookups).
785 Specify the name of an LDIF(5) file containing user defined attributes
786 for the root DSE. These attributes are returned in addition to the
787 attributes normally produced by slapd.
790 Used to specify the fully qualified domain name used for SASL processing.
792 .B sasl-realm <realm>
793 Specify SASL realm. Default is empty.
795 .B sasl-secprops <properties>
796 Used to specify Cyrus SASL security properties.
799 flag (without any other properties) causes the flag properties
800 default, "noanonymous,noplain", to be cleared.
803 flag disables mechanisms susceptible to simple passive attacks.
806 flag disables mechanisms susceptible to active attacks.
809 flag disables mechanisms susceptible to passive dictionary attacks.
812 flag disables mechanisms which support anonymous login.
815 flag require forward secrecy between sessions.
818 require mechanisms which pass client credentials (and allow
819 mechanisms which can pass credentials to do so).
822 property specifies the minimum acceptable
823 .I security strength factor
824 as an integer approximate to effective key length used for
825 encryption. 0 (zero) implies no protection, 1 implies integrity
826 protection only, 56 allows DES or other weak ciphers, 112
827 allows triple DES and other strong ciphers, 128 allows RC4,
828 Blowfish and other modern strong ciphers. The default is 0.
831 property specifies the maximum acceptable
832 .I security strength factor
833 as an integer (see minssf description). The default is INT_MAX.
836 property specifies the maximum security layer receive buffer
837 size allowed. 0 disables security layers. The default is 65536.
840 Specify the distinguished name for the subschema subentry that
841 controls the entries on this server. The default is "cn=Subschema".
843 .B security <factors>
844 Specify a set of security strength factors (separated by white space)
848 option for a description of security strength factors).
849 The directive may be specified globally and/or per-database.
851 specifies the overall security strength factor.
853 specifies the transport security strength factor.
855 specifies the TLS security strength factor.
857 specifies the SASL security strength factor.
859 specifies the overall security strength factor to require for
861 .B update_transport=<n>
862 specifies the transport security strength factor to require for
865 specifies the TLS security strength factor to require for
868 specifies the SASL security strength factor to require for
871 specifies the security strength factor required for
873 username/password authentication.
876 factor is measure of security provided by the underlying transport,
877 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
879 .B serverID <integer> [<URL>]
880 Specify an integer ID from 0 to 4095 for this server. These IDs are
881 required when using multimaster replication and each master must have a
882 unique ID. If the URL is provided, this directive may be specified
883 multiple times, providing a complete list of participating servers
884 and their IDs. The fully qualified hostname of each server should be
885 used in the supplied URLs. The IDs are used in the "replica id" field
886 of all CSNs generated by the specified server. The default value is zero.
893 .B sizelimit {<integer>|unlimited}
895 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
896 Specify the maximum number of entries to return from a search operation.
897 The default size limit is 500.
900 to specify no limits.
901 The second format allows a fine grain setting of the size limits.
902 Extra args can be added on the same line.
905 for an explanation of the different flags.
907 .B sockbuf_max_incoming <integer>
908 Specify the maximum incoming LDAP PDU size for anonymous sessions.
909 The default is 262143.
911 .B sockbuf_max_incoming_auth <integer>
912 Specify the maximum incoming LDAP PDU size for authenticated sessions.
913 The default is 4194303.
916 Specify the maximum size of the primary thread pool.
917 The default is 16; the minimum value is 2.
919 .B timelimit {<integer>|unlimited}
921 .B timelimit time[.{soft|hard}]=<integer> [...]
922 Specify the maximum number of seconds (in real time)
924 will spend answering a search request. The default time limit is 3600.
927 to specify no limits.
928 The second format allows a fine grain setting of the time limits.
929 Extra args can be added on the same line.
932 for an explanation of the different flags.
934 .B tool-threads <integer>
935 Specify the maximum number of threads to use in tool mode.
936 This should not be greater than the number of CPUs in the system.
938 .\"ucdata-path is obsolete / ignored...
940 .\".B ucdata-path <path>
941 .\"Specify the path to the directory containing the Unicode character
942 .\"tables. The default path is DATADIR/ucdata.
946 is built with support for Transport Layer Security, there are more options
949 .B TLSCipherSuite <cipher-suite-spec>
950 Permits configuring what ciphers will be accepted and the preference order.
951 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
953 TLSCipherSuite HIGH:MEDIUM:+SSLv2
955 To check what ciphers a given spec selects, use:
957 openssl ciphers -v <cipher-suite-spec>
959 .B TLSCACertificateFile <filename>
960 Specifies the file that contains certificates for all of the Certificate
965 .B TLSCACertificatePath <path>
966 Specifies the path of a directory that contains Certificate Authority
967 certificates in separate individual files. Usually only one of this
968 or the TLSCACertificateFile is used.
970 .B TLSCertificateFile <filename>
971 Specifies the file that contains the
975 .B TLSCertificateKeyFile <filename>
976 Specifies the file that contains the
978 server private key that matches the certificate stored in the
979 .B TLSCertificateFile
980 file. Currently, the private key must not be protected with a password, so
981 it is of critical importance that it is protected carefully.
983 .B TLSDHParamFile <filename>
984 This directive specifies the file that contains parameters for Diffie-Hellman
985 ephemeral key exchange. This is required in order to use a DSA certificate on
986 the server. If multiple sets of parameters are present in the file, all of
987 them will be processed. Note that setting this option may also enable
988 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
989 You should append "!ADH" to your cipher suites if you have changed them
990 from the default, otherwise no certificate exchanges or verification will
993 .B TLSRandFile <filename>
994 Specifies the file to obtain random bits from when /dev/[u]random
995 is not available. Generally set to the name of the EGD/PRNGD socket.
996 The environment variable RANDFILE can also be used to specify the filename.
998 .B TLSVerifyClient <level>
999 Specifies what checks to perform on client certificates in an
1000 incoming TLS session, if any.
1003 can be specified as one of the following keywords:
1007 This is the default.
1009 will not ask the client for a certificate.
1012 The client certificate is requested. If no certificate is provided,
1013 the session proceeds normally. If a bad certificate is provided,
1014 it will be ignored and the session proceeds normally.
1017 The client certificate is requested. If no certificate is provided,
1018 the session proceeds normally. If a bad certificate is provided,
1019 the session is immediately terminated.
1021 .B demand | hard | true
1022 These keywords are all equivalent, for compatibility reasons.
1023 The client certificate is requested. If no certificate is provided,
1024 or a bad certificate is provided, the session is immediately terminated.
1026 Note that a valid client certificate is required in order to use the
1027 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1030 setting must be chosen to enable SASL EXTERNAL authentication.
1033 .B TLSCRLCheck <level>
1034 Specifies if the Certificate Revocation List (CRL) of the CA should be
1035 used to verify if the client certificates have not been revoked. This
1037 .B TLSCACertificatePath
1038 parameter to be set.
1040 can be specified as one of the following keywords:
1044 No CRL checks are performed
1047 Check the CRL of the peer certificate
1050 Check the CRL for a whole certificate chain
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>
1076 depending on which backend will serve the database.
1078 .SH GENERAL DATABASE OPTIONS
1079 Options in this section only apply to the configuration file section
1080 for the database in which they are defined. They are supported by every
1081 type of backend. Note that the
1085 option are mandatory for each database.
1087 .B database <databasetype>
1088 Mark the beginning of a new database instance definition. <databasetype>
1106 depending on which backend will serve the database.
1109 Controls whether the database will be used to answer
1110 queries. A database that is hidden will never be
1111 selected to answer any queries, and any suffix configured
1112 on the database will be ignored in checks for conflicts
1113 with other databases. By default, hidden is off.
1118 will automatically maintain the
1119 modifiersName, modifyTimestamp, creatorsName, and
1120 createTimestamp attributes for entries. It also controls
1121 the entryCSN and entryUUID attributes, which are needed
1122 by the syncrepl provider. By default, lastmod is on.
1124 .B limits <who> <limit> [<limit> [...]]
1125 Specify time and size limits based on who initiated an operation.
1132 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1138 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1143 matches all unauthenticated clients.
1146 matches all authenticated clients;
1149 dn pattern is assumed unless otherwise specified by qualifying
1150 the (optional) key string
1156 (which are synonyms), to require an exact match; with
1158 to require exactly one level of depth match; with
1160 to allow any level of depth match, including the exact match; with
1162 to allow any level of depth match, not including the exact match;
1164 explicitly requires the (default) match based on POSIX (''extended'')
1165 regular expression pattern.
1168 matches unbound operations; the
1171 The same behavior is obtained by using the
1178 with the optional objectClass
1184 sets the limits for any DN listed in the values of the
1190 group objectClass (default
1192 whose DN exactly matches
1195 The currently supported limits are
1200 The syntax for time limits is
1201 .BR time[.{soft|hard}]=<integer> ,
1204 is the number of seconds slapd will spend answering a search request.
1205 If no time limit is explicitly requested by the client, the
1207 limit is used; if the requested time limit exceeds the
1210 .\".I "Administrative limit exceeded"
1211 .\"error is returned.
1212 limit, the value of the limit is used instead.
1215 limit is set to the keyword
1217 the soft limit is used in either case; if it is set to the keyword
1219 no hard limit is enforced.
1220 Explicit requests for time limits smaller or equal to the
1223 If no limit specifier is set, the value is assigned to the
1229 to preserve the original behavior.
1231 The syntax for size limits is
1232 .BR size[.{soft|hard|unchecked}]=<integer> ,
1235 is the maximum number of entries slapd will return answering a search
1237 If no size limit is explicitly requested by the client, the
1239 limit is used; if the requested size limit exceeds the
1242 .\".I "Administrative limit exceeded"
1243 .\"error is returned.
1244 limit, the value of the limit is used instead.
1247 limit is set to the keyword
1249 the soft limit is used in either case; if it is set to the keyword
1251 no hard limit is enforced.
1252 Explicit requests for size limits smaller or equal to the
1257 specifier sets a limit on the number of candidates a search request is allowed
1259 The rationale behind it is that searches for non-properly indexed
1260 attributes may result in large sets of candidates, which must be
1263 to determine whether they match the search filter or not.
1266 limit provides a means to drop such operations before they are even
1268 If the selected candidates exceed the
1270 limit, the search will abort with
1271 .IR "Unwilling to perform" .
1272 If it is set to the keyword
1274 no limit is applied (the default).
1277 the search is not even performed; this can be used to disallow searches
1278 for a specific set of users.
1279 If no limit specifier is set, the value is assigned to the
1285 to preserve the original behavior.
1287 In case of no match, the global limits are used.
1288 The default values are the same of
1297 control is requested, the
1299 size limit is used by default, because the request of a specific page size
1300 is considered an explicit request for a limitation on the number
1301 of entries to be returned.
1302 However, the size limit applies to the total count of entries returned within
1303 the search, and not to a single page.
1304 Additional size limits may be enforced; the syntax is
1305 .BR size.pr={<integer>|noEstimate|unlimited} ,
1308 is the max page size if no explicit limit is set; the keyword
1310 inhibits the server from returning an estimate of the total number
1311 of entries that might be returned
1312 (note: the current implementation does not return any estimate).
1315 indicates that no limit is applied to the pagedResults control page size.
1317 .B size.prtotal={<integer>|unlimited|disabled}
1318 allows to set a limit on the total number of entries that a pagedResults
1319 control allows to return.
1320 By default it is set to the
1325 is the max number of entries that the whole search with pagedResults control
1329 to allow unlimited number of entries to be returned, e.g. to allow
1330 the use of the pagedResults control as a means to circumvent size
1331 limitations on regular searches; the keyword
1333 disables the control, i.e. no paged results can be returned.
1334 Note that the total number of entries returned when the pagedResults control
1335 is requested cannot exceed the
1337 size limit of regular searches unless extended by the
1342 .B maxderefdepth <depth>
1343 Specifies the maximum number of aliases to dereference when trying to
1344 resolve an entry, used to avoid infinite alias loops. The default is 1.
1346 .B mirrormode on | off
1347 This option puts a replica database into "mirror" mode. Update
1348 operations will be accepted from any user, not just the updatedn. The
1349 database must already be configured as a slurpd or syncrepl consumer
1350 before this keyword may be set. This mode must be used with extreme
1351 care, as it does not offer any consistency guarantees. This feature
1352 is intended to be used with an external frontend that guarantees that
1353 writes are only directed to a single master, switching to an alternate
1354 server only if the original master goes down.
1355 By default, mirrormode is off.
1357 .B overlay <overlay-name>
1358 Add the specified overlay to this database. An overlay is a piece of
1359 code that intercepts database operations in order to extend or change
1360 them. Overlays are pushed onto
1361 a stack over the database, and so they will execute in the reverse
1362 of the order in which they were configured and the database itself
1363 will receive control last of all. See the
1364 .BR slapd.overlays (5)
1365 manual page for an overview of the available overlays.
1366 Note that all of the database's
1367 regular settings should be configured before any overlay settings.
1369 .B readonly on | off
1370 This option puts the database into "read-only" mode. Any attempts to
1371 modify the database will return an "unwilling to perform" error. By
1372 default, readonly is off.
1375 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1376 .B [starttls=yes|critical]
1377 .B [suffix=<suffix> [...]]
1378 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1379 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1380 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1381 .B [attrs[!]=<attr list>]
1383 Specify a replication site for this database. Refer to the "OpenLDAP
1384 Administrator's Guide" for detailed information on setting up a replicated
1386 directory service. Zero or more
1388 instances can be used to select the subtrees that will be replicated
1389 (defaults to all the database).
1391 is deprecated in favor of the
1395 allows the replica LDAP server to be specified as an LDAP URI.
1400 requires the options
1404 and should only be used when adequate security services
1405 (e.g TLS or IPSEC) are in place. A
1411 Specific security properties (as with the
1413 keyword above) for a SASL bind can be set with the
1415 option. A non-default SASL realm can be set with the
1420 will use Kerberos, a kerberos instance should be given in
1424 can be given after the
1426 keyword to allow the selective replication of the listed attributes only;
1429 mark is used, the list is considered exclusive, i.e. the listed attributes
1431 If an objectClass is listed, all the related attributes
1432 are (are not) replicated.
1435 .B replogfile <filename>
1436 Specify the name of the replication log file to log changes to.
1437 The replication log is typically written by
1442 .BR slapd.replog (5)
1443 for more information. The specified file should be located
1444 in a directory with limited read/write/execute access as the replication
1445 logs may contain sensitive information.
1447 .B restrict <oplist>
1448 Specify a whitespace separated list of operations that are restricted.
1449 If defined inside a database specification, restrictions apply only
1450 to that database, otherwise they are global.
1451 Operations can be any of
1456 .BR extended[=<OID>] ,
1460 or the special pseudo-operations
1464 which respectively summarize read and write operations.
1472 keyword allows to indicate the OID of the specific operation
1476 Specify the distinguished name that is not subject to access control
1477 or administrative limit restrictions for operations on this database.
1478 This DN may or may not be associated with an entry. An empty root
1479 DN (the default) specifies no root access is to be granted. It is
1480 recommended that the rootdn only be specified when needed (such as
1481 when initially populating a database). If the rootdn is within
1482 a namingContext (suffix) of the database, a simple bind password
1483 may also be provided using the
1485 directive. Note that the rootdn is always needed when using syncrepl.
1487 .B rootpw <password>
1488 Specify a password (or hash of the password) for the rootdn. The
1489 password can only be set if the rootdn is within the namingContext
1490 (suffix) of the database.
1491 This option accepts all RFC 2307 userPassword formats known to
1494 description) as well as cleartext.
1496 may be used to generate a hash of a password. Cleartext
1497 and \fB{CRYPT}\fP passwords are not recommended. If empty
1498 (the default), authentication of the root DN is by other means
1499 (e.g. SASL). Use of SASL is encouraged.
1501 .B suffix <dn suffix>
1502 Specify the DN suffix of queries that will be passed to this
1503 backend database. Multiple suffix lines can be given and at least one is
1504 required for each database definition.
1505 If the suffix of one database is "inside" that of another, the database
1506 with the inner suffix must come first in the configuration file.
1508 .B subordinate [advertise]
1509 Specify that the current backend database is a subordinate of another
1510 backend database. A subordinate database may have only one suffix. This
1511 option may be used to glue multiple databases into a single namingContext.
1512 If the suffix of the current database is within the namingContext of a
1513 superior database, searches against the superior database will be
1514 propagated to the subordinate as well. All of the databases
1515 associated with a single namingContext should have identical rootdns.
1516 Behavior of other LDAP operations is unaffected by this setting. In
1517 particular, it is not possible to use moddn to move an entry from
1518 one subordinate to another subordinate within the namingContext.
1520 If the optional \fBadvertise\fP flag is supplied, the naming context of
1521 this database is advertised in the root DSE. The default is to hide this
1522 database context, so that only the superior context is visible.
1529 are used on the superior database, any glued subordinates that support
1530 these tools are opened as well.
1532 Databases that are glued together should usually be configured with the
1533 same indices (assuming they support indexing), even for attributes that
1534 only exist in some of these databases. In general, all of the glued
1535 databases should be configured as similarly as possible, since the intent
1536 is to provide the appearance of a single directory.
1538 Note that the \fIsubordinate\fP functionality is implemented internally
1539 by the \fIglue\fP overlay and as such its behavior will interact with other
1540 overlays in use. By default, the glue overlay is automatically configured as
1541 the last overlay on the superior backend. Its position on the backend
1542 can be explicitly configured by setting an \fBoverlay glue\fP directive
1543 at the desired position. This explicit configuration is necessary e.g.
1544 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1545 in order to work over all of the glued databases. E.g.
1549 suffix dc=example,dc=com
1557 .B syncrepl rid=<replica ID>
1558 .B provider=ldap[s]://<hostname>[:port]
1559 .B searchbase=<base DN>
1560 .B [type=refreshOnly|refreshAndPersist]
1561 .B [interval=dd:hh:mm:ss]
1562 .B [retry=[<retry interval> <# of retries>]+]
1563 .B [filter=<filter str>]
1564 .B [scope=sub|one|base|subord]
1565 .B [attrs=<attr list>]
1567 .B [sizelimit=<limit>]
1568 .B [timelimit=<limit>]
1569 .B [schemachecking=on|off]
1570 .B [bindmethod=simple|sasl]
1572 .B [saslmech=<mech>]
1573 .B [authcid=<identity>]
1574 .B [authzid=<identity>]
1575 .B [credentials=<passwd>]
1577 .B [secprops=<properties>]
1578 .B [starttls=yes|critical]
1579 .B [tls_cert=<file>]
1581 .B [tls_cacert=<file>]
1582 .B [tls_cacertdir=<path>]
1583 .B [tls_reqcert=never|allow|try|demand]
1584 .B [tls_ciphersuite=<ciphers>]
1585 .B [tls_crlcheck=none|peer|all]
1586 .B [logbase=<base DN>]
1587 .B [logfilter=<filter str>]
1588 .B [syncdata=default|accesslog|changelog]
1590 Specify the current database as a replica which is kept up-to-date with the
1591 master content by establishing the current
1593 as a replication consumer site running a
1596 The replica content is kept synchronized to the master content using
1597 the LDAP Content Synchronization protocol. Refer to the
1598 "OpenLDAP Administrator's Guide" for detailed information on
1599 setting up a replicated
1601 directory service using the
1606 identifies the current
1608 directive within the replication consumer site.
1609 It is a non-negative integer having no more than three digits.
1612 specifies the replication provider site containing the master content
1613 as an LDAP URI. If <port> is not given, the standard LDAP port number
1614 (389 or 636) is used.
1618 replica is defined using a search
1619 specification as its result set. The consumer
1621 will send search requests to the provider
1623 according to the search specification. The search specification includes
1624 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1627 parameters as in the normal search specification.
1628 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1629 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1630 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1631 attributes, and \fBattrsonly\fP is unset by default.
1632 The \fBsizelimit\fP and \fBtimelimit\fP only
1633 accept "unlimited" and positive integers, and both default to "unlimited".
1634 Note, however, that any provider-side limits for the replication identity
1635 will be enforced by the provider regardless of the limits requested
1636 by the LDAP Content Synchronization operation, much like for any other
1639 The LDAP Content Synchronization protocol has two operation types.
1642 operation, the next synchronization search operation
1643 is periodically rescheduled at an interval time (specified by
1645 parameter; 1 day by default)
1646 after each synchronization operation finishes.
1648 .B refreshAndPersist
1649 operation, a synchronization search remains persistent in the provider slapd.
1650 Further updates to the master replica will generate
1651 .B searchResultEntry
1652 to the consumer slapd as the search responses to the persistent
1653 synchronization search.
1655 If an error occurs during replication, the consumer will attempt to
1656 reconnect according to the
1658 parameter which is a list of the <retry interval> and <# of retries> pairs.
1659 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1660 for the first 10 times and then retry every 300 seconds for the next 3
1661 times before stop retrying. The `+' in <# of retries> means indefinite
1662 number of retries until success.
1664 The schema checking can be enforced at the LDAP Sync
1665 consumer site by turning on the
1667 parameter. The default is off.
1673 requires the options
1677 and should only be used when adequate security services
1678 (e.g. TLS or IPSEC) are in place.
1679 .B REMEMBER: simple bind credentials must be in cleartext!
1686 Depending on the mechanism, an authentication identity and/or
1687 credentials can be specified using
1693 parameter may be used to specify an authorization identity.
1694 Specific security properties (as with the
1696 keyword above) for a SASL bind can be set with the
1698 option. A non default SASL realm can be set with the
1701 The provider, other than allow authentication of the syncrepl identity,
1702 should grant that identity appropriate access privileges to the data
1703 that is being replicated (\fBaccess\fP directive), and appropriate time
1704 and size limits (\fBlimits\fP directive).
1709 parameter specifies use of the StartTLS extended operation
1710 to establish a TLS session before Binding to the provider. If the
1712 argument is supplied, the session will be aborted if the StartTLS request
1713 fails. Otherwise the syncrepl session continues without TLS. The
1714 tls_reqcert setting defaults to "demand" and the other TLS settings
1715 default to the same as the main slapd TLS settings.
1717 Rather than replicating whole entries, the consumer can query logs of
1718 data modifications. This mode of operation is referred to as \fIdelta
1719 syncrepl\fP. In addition to the above parameters, the
1723 parameters must be set appropriately for the log that will be used. The
1725 parameter must be set to either "accesslog" if the log conforms to the
1726 .BR slapo-accesslog (5)
1727 log format, or "changelog" if the log conforms
1728 to the obsolete \fIchangelog\fP format. If the
1730 parameter is omitted or set to "default" then the log parameters are
1735 This option is only applicable in a slave
1736 database updated using
1738 It specifies the DN permitted to update (subject to access controls)
1739 the replica (typically, this is the DN
1741 binds to update the replica). Generally, this DN
1748 Specify the referral to pass back when
1750 is asked to modify a replicated local database.
1751 If specified multiple times, each url is provided.
1753 .SH DATABASE-SPECIFIC OPTIONS
1754 Each database may allow specific configuration options; they are
1755 documented separately in the backends' manual pages. See the
1756 .BR slapd.backends (5)
1757 manual page for an overview of available backends.
1760 Here is a short example of a configuration file:
1764 include SYSCONFDIR/schema/core.schema
1765 pidfile LOCALSTATEDIR/run/slapd.pid
1767 # Subtypes of "name" (e.g. "cn" and "ou") with the
1768 # option ";x-hidden" can be searched for/compared,
1769 # but are not shown. See \fBslapd.access\fP(5).
1770 attributeoptions x-hidden lang-
1771 access to attrs=name;x-hidden by * =cs
1773 # Protect passwords. See \fBslapd.access\fP(5).
1774 access to attrs=userPassword by * auth
1775 # Read access to other attributes and entries.
1776 access to * by * read
1779 suffix "dc=our-domain,dc=com"
1780 # The database directory MUST exist prior to
1781 # running slapd AND should only be accessible
1782 # by the slapd/tools. Mode 0700 recommended.
1783 directory LOCALSTATEDIR/openldap-data
1784 # Indices to maintain
1785 index objectClass eq
1786 index cn,sn,mail pres,eq,approx,sub
1788 # We serve small clients that do not handle referrals,
1789 # so handle remote lookups on their behalf.
1792 uri ldap://ldap.some-server.com/
1797 "OpenLDAP Administrator's Guide" contains a longer annotated
1798 example of a configuration file.
1799 The original ETCDIR/slapd.conf is another example.
1803 default slapd configuration file
1806 .BR slapd\-config (5),
1807 .BR slapd.access (5),
1808 .BR slapd.backends (5),
1809 .BR slapd.overlays (5),
1810 .BR slapd.plugin (5),
1811 .BR slapd.replog (5),
1823 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1824 .SH ACKNOWLEDGEMENTS
projects / openldap / blob