1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2009 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 SLAPD tools
26 file consists of a series of global configuration options that apply to
28 as a whole (including all backends), followed by zero or more database
29 backend definitions that contain information specific to a backend
31 The configuration options are case-insensitive;
32 their value, on a case by case basis, may be case-sensitive.
39 # comment - these options apply to every database
40 <global configuration options>
41 # first database definition & configuration options
42 database <backend 1 type>
43 <configuration options specific to backend 1>
44 # subsequent database definitions & configuration options
48 As many backend-specific sections as desired may be included. Global
49 options can be overridden in a backend (for options that appear more
50 than once, the last appearance in the
54 If a line begins with white space, it is considered a continuation
55 of the previous line. No physical line should be over 2000 bytes
58 Blank lines and comment lines beginning with
59 a `#' character are ignored. Note: continuation lines are unwrapped
60 before comment processing is applied.
62 Arguments on configuration lines are separated by white space. If an
63 argument contains white space, the argument should be enclosed in
64 double quotes. If an argument contains a double quote (`"') or a
65 backslash character (`\\'), the character should be preceded by a
68 The specific configuration options available are discussed below in the
69 Global Configuration Options, General Backend Options, and General Database
70 Options. Backend-specific options are discussed in the
72 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
73 details on the slapd configuration file.
74 .SH GLOBAL CONFIGURATION OPTIONS
75 Options described in this section apply to all backends, unless specifically
76 overridden in a backend definition. Arguments that should be replaced by
77 actual text are shown in brackets <>.
79 .B access to <what> "[ by <who> <access> <control> ]+"
80 Grant access (specified by <access>) to a set of entries and/or
81 attributes (specified by <what>) by one or more requestors (specified
83 If no access controls are present, the default policy
84 allows anyone and everyone to read anything but restricts
85 updates to rootdn. (e.g., "access to * by * read").
86 The rootdn can always read and write EVERYTHING!
89 and the "OpenLDAP's Administrator's Guide" for details.
92 Specify a set of features (separated by white space) to
95 allows acceptance of LDAPv2 bind requests. Note that
97 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
99 allows anonymous bind when credentials are not empty (e.g.
102 allows unauthenticated (anonymous) bind when DN is not empty.
104 allows unauthenticated (anonymous) update operations to be processed
105 (subject to access controls and other administrative limits).
107 allows unauthenticated (anonymous) proxy authorization control to be processed
108 (subject to access controls, authorization and other administrative limits).
110 .B argsfile <filename>
111 The (absolute) name of a file that will hold the
113 server's command line (program name and options).
115 .B attributeoptions [option-name]...
116 Define tagging attribute options or option tag/range prefixes.
117 Options must not end with `-', prefixes must end with `-'.
118 The `lang-' prefix is predefined.
121 directive, `lang-' will no longer be defined and you must specify it
122 explicitly if you want it defined.
124 An attribute description with a tagging option is a subtype of that
125 attribute description without the option.
126 Except for that, options defined this way have no special semantics.
127 Prefixes defined this way work like the `lang-' options:
128 They define a prefix for tagging options starting with the prefix.
129 That is, if you define the prefix `x-foo-', you can use the option
131 Furthermore, in a search or compare, a prefix or range name (with
132 a trailing `-') matches all options starting with that name, as well
133 as the option with the range name sans the trailing `-'.
134 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
136 RFC 4520 reserves options beginning with `x-' for private experiments.
137 Other options should be registered with IANA, see RFC 4520 section 3.5.
138 OpenLDAP also has the `binary' option built in, but this is a transfer
139 option, not a tagging option.
142 .B attributetype "(\ <oid>\
144 [DESC\ <description>]\
153 [NO\-USER\-MODIFICATION]\
154 [USAGE\ <attributeUsage>]\ )"
156 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
157 The slapd parser extends the RFC 4512 definition by allowing string
158 forms as well as numeric OIDs to be used for the attribute OID and
159 attribute syntax OID.
165 .B authz-policy <policy>
166 Used to specify which rules to use for Proxy Authorization. Proxy
167 authorization allows a client to authenticate to the server using one
168 user's credentials, but specify a different identity to use for authorization
169 and access control purposes. It essentially allows user A to login as user
170 B, using user A's password.
173 flag disables proxy authorization. This is the default setting.
176 flag will use rules in the
178 attribute of the authorization DN.
181 flag will use rules in the
183 attribute of the authentication DN.
186 flag, an alias for the deprecated value of
188 will allow any of the above, whatever succeeds first (checked in
194 flag requires both authorizations to succeed.
197 The rules are mechanisms to specify which identities are allowed
198 to perform proxy authorization.
201 attribute in an entry specifies which other users
202 are allowed to proxy login to this entry. The
205 an entry specifies which other users this user can authorize as. Use of
208 abused if users are allowed to write arbitrary values to this attribute.
211 attribute must be protected with ACLs such that
212 only privileged users can modify it.
219 or a set of identities; it can take five forms:
222 .B ldap:///<base>??[<scope>]?<filter>
225 .B dn[.<dnstyle>]:<pattern>
228 .B u[.<mech>[/<realm>]]:<pattern>
231 .B group[/objectClass[/attributeType]]:<pattern>
238 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
241 The first form is a valid LDAP
249 portions must be absent, so that the search occurs locally on either
255 with the optional style modifiers
261 for exact, onelevel, children and subtree matches, which cause
263 to be normalized according to the DN normalization rules, or the special
265 style, which causes the
267 to be treated as a POSIX (''extended'') regular expression, as
274 means any non-anonymous DN.
275 The third form is a SASL
277 with the optional fields
281 that allow to specify a SASL
283 and eventually a SASL
285 for those mechanisms that support one.
286 The need to allow the specification of a mechanism is still debated,
287 and users are strongly discouraged to rely on this possibility.
288 The fourth form is a group specification, consisting of the keyword
290 optionally followed by the specification of the group
296 is searched with base scope, and in case of match, the values of the
299 are searched for the asserted DN.
300 For backwards compatibility, if no identity type is provided, i.e. only
304 is assumed; as a consequence,
306 is subjected to DN normalization.
307 Since the interpretation of
311 can impact security, users are strongly encouraged
312 to explicitly set the type of identity specification that is being used.
313 A subset of these rules can be used as third arg in the
315 statement (see below); significantly, the
317 provided it results in exactly one entry,
323 .B authz-regexp <match> <replace>
324 Used by the authentication framework to convert simple user names,
325 such as provided by SASL subsystem, or extracted from certificates
326 in case of cert-based SASL EXTERNAL, or provided within the RFC 4370
327 "proxied authorization" control, to an LDAP DN used for
328 authorization purposes. Note that the resulting 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
429 .B proxy_authz_non_critical
430 disables acceptance of the proxied authorization control (RFC4370)
431 when criticality is FALSE.
432 .B dontusecopy_non_critical
433 disables acceptance of the dontUseCopy control (a work in progress)
434 when criticality is FALSE.
437 .B ditcontentrule "(\ <oid>\
439 [DESC\ <description>]\
446 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
447 The slapd parser extends the RFC 4512 definition by allowing string
448 forms as well as numeric OIDs to be used for the attribute OID and
449 attribute syntax OID.
455 .B gentlehup { on | off }
456 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
458 will stop listening for new connections, but will not close the
459 connections to the current clients. Future write operations return
460 unwilling-to-perform, though. Slapd terminates when all clients
461 have closed their connections (if they ever do), or \- as before \-
462 if it receives a SIGTERM signal. This can be useful if you wish to
463 terminate the server and start a new
466 .B with another database,
467 without disrupting the currently active clients.
468 The default is off. You may wish to use
470 along with this option.
472 .B idletimeout <integer>
473 Specify the number of seconds to wait before forcibly closing
474 an idle client connection. A idletimeout of 0 disables this
475 feature. The default is 0. You may also want to set the
479 .B include <filename>
480 Read additional configuration information from the given file before
481 continuing with the next line of the current file.
483 .B index_intlen <integer>
484 Specify the key length for ordered integer indices. The most significant
485 bytes of the binary integer will be used for index keys. The default
486 value is 4, which provides exact indexing for 31 bit values.
487 A floating point representation is used to index too large values.
489 .B index_substr_if_minlen <integer>
490 Specify the minimum length for subinitial and subfinal indices. An
491 attribute value must have at least this many characters in order to be
492 processed by the indexing functions. The default is 2.
494 .B index_substr_if_maxlen <integer>
495 Specify the maximum length for subinitial and subfinal indices. Only
496 this many characters of an attribute value will be processed by the
497 indexing functions; any excess characters are ignored. The default is 4.
499 .B index_substr_any_len <integer>
500 Specify the length used for subany indices. An attribute value must have
501 at least this many characters in order to be processed. Attribute values
502 longer than this length will be processed in segments of this length. The
503 default is 4. The subany index will also be used in subinitial and
504 subfinal index lookups when the filter string is longer than the
505 .I index_substr_if_maxlen
508 .B index_substr_any_step <integer>
509 Specify the steps used in subany index lookups. This value sets the offset
510 for the segments of a filter string that are processed for a subany index
511 lookup. The default is 2. For example, with the default values, a search
512 using this filter "cn=*abcdefgh*" would generate index lookups for
513 "abcd", "cdef", and "efgh".
516 Note: Indexing support depends on the particular backend in use. Also,
517 changing these settings will generally require deleting any indices that
518 depend on these parameters and recreating them with
523 .B ldapsyntax "(\ <oid>\
524 [DESC\ <description>]\
525 [X-SUBST <substitute\-syntax>]\ )"
527 Specify an LDAP syntax using the LDAPv3 syntax defined in RFC 4512.
528 The slapd parser extends the RFC 4512 definition by allowing string
529 forms as well as numeric OIDs to be used for the syntax OID.
533 The slapd parser also honors the
535 extension (an OpenLDAP-specific extension), which allows to use the
537 statement to define a non-implemented syntax along with another syntax,
539 .IR substitute\-syntax ,
540 as its temporary replacement.
542 .I substitute\-syntax
544 This allows to define attribute types that make use of non-implemented syntaxes
545 using the correct syntax OID.
548 is used, this configuration statement would result in an error,
549 since no handlers would be associated to the resulting syntax structure.
554 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
555 such as those to the ldapi:// listener. For a description of SSF values,
559 option description. The default is 71.
561 .B logfile <filename>
562 Specify a file for recording debug log messages. By default these messages
563 only go to stderr and are not recorded anywhere else. Specifying a logfile
564 copies messages to both stderr and the logfile.
566 .B loglevel <integer> [...]
567 Specify the level at which debugging statements and operation
568 statistics should be syslogged (currently logged to the
570 LOG_LOCAL4 facility).
571 They must be considered subsystems rather than increasingly verbose
573 Some messages with higher priority are logged regardless
574 of the configured loglevel as soon as any logging is configured.
575 Log levels are additive, and available levels are:
586 debug packet handling
590 heavy trace debugging (function args)
594 connection management
598 print out packets sent and received
602 search filter processing
606 configuration file processing
610 access control list processing
614 connections, LDAP operations, results (recommended)
618 stats log entries sent
622 print communication with shell backends
634 \"data indexing (unused)
642 only messages that get logged whatever log level is set
645 The desired log level can be input as a single integer that combines
646 the (ORed) desired levels, both in decimal or in hexadecimal notation,
647 as a list of integers (that are ORed internally),
648 or as a list of the names that are shown between brackets, such that
661 can be used as a shortcut to enable logging at all levels (equivalent to -1).
664 or the equivalent integer representation, causes those messages
665 that are logged regardless of the configured loglevel to be logged.
666 In fact, if loglevel is set to 0, no logging occurs,
669 level is required to have high priority messages logged.
671 The loglevel defaults to \fBstats\fP.
672 This level should usually also be included when using other loglevels, to
673 help analyze the logs.
676 .B moduleload <filename>
677 Specify the name of a dynamically loadable module to load. The filename
678 may be an absolute path name or a simple filename. Non-absolute names
679 are searched for in the directories specified by the
681 option. This option and the
683 option are only usable if slapd was compiled with --enable-modules.
685 .B modulepath <pathspec>
686 Specify a list of directories to search for loadable modules. Typically
687 the path is colon-separated but this depends on the operating system.
690 .B objectclass "(\ <oid>\
692 [DESC\ <description>]\
695 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
696 [MUST\ <oids>] [MAY\ <oids>] )"
698 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
699 The slapd parser extends the RFC 4512 definition by allowing string
700 forms as well as numeric OIDs to be used for the object class OID.
704 description.) Object classes are "STRUCTURAL" by default.
707 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
708 Define a string name that equates to the given OID. The string can be used
709 in place of the numeric OID in objectclass and attribute definitions. The
710 name can also be used with a suffix of the form ":xx" in which case the
711 value "oid.xx" will be used.
713 .B password-hash <hash> [<hash>...]
714 This option configures one or more hashes to be used in generation of user
715 passwords stored in the userPassword attribute during processing of
716 LDAP Password Modify Extended Operations (RFC 3062).
717 The <hash> must be one of
731 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
736 use the MD5 algorithm (RFC 1321), the latter with a seed.
743 indicates that the new password should be
744 added to userPassword as clear text.
746 Note that this option does not alter the normal user applications
747 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
749 .B password\-crypt\-salt\-format <format>
750 Specify the format of the salt passed to
752 when generating {CRYPT} passwords (see
754 during processing of LDAP Password Modify Extended Operations (RFC 3062).
756 This string needs to be in
758 format and may include one (and only one) %s conversion.
759 This conversion will be substituted with a string of random
760 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
761 provides a two character salt and "$1$%.8s" tells some
762 versions of crypt(3) to use an MD5 algorithm and provides
763 8 random characters of salt. The default is "%s", which
764 provides 31 characters of salt.
766 .B pidfile <filename>
767 The (absolute) name of a file that will hold the
769 server's process ID (see
773 Specify the referral to pass back when
775 cannot find a local database to handle a request.
776 If specified multiple times, each url is provided.
778 .B require <conditions>
779 Specify a set of conditions (separated by white space) to
780 require (default none).
781 The directive may be specified globally and/or per-database;
782 databases inherit global conditions, so per-database specifications
785 requires bind operation prior to directory operations.
787 requires session to be using LDAP version 3.
789 requires authentication prior to directory operations.
791 requires SASL authentication prior to directory operations.
793 requires strong authentication prior to directory operations.
794 The strong keyword allows protected "simple" authentication
795 as well as SASL authentication.
797 may be used to require no conditions (useful to clear out globally
798 set conditions within a particular database); it must occur first
799 in the list of conditions.
801 .B reverse-lookup on | off
802 Enable/disable client name unverified reverse lookup (default is
804 if compiled with --enable-rlookups).
807 Specify the name of an LDIF(5) file containing user defined attributes
808 for the root DSE. These attributes are returned in addition to the
809 attributes normally produced by slapd.
811 The root DSE is an entry with information about the server and its
812 capabilities, in operational attributes.
813 It has the empty DN, and can be read with e.g.:
815 ldapsearch -x -b "" -s base "+"
817 See RFC 4512 section 5.1 for details.
819 .B sasl-auxprops <plugin> [...]
820 Specify which auxprop plugins to use for authentication lookups. The
821 default is empty, which just uses slapd's internal support. Usually
822 no other auxprop plugins are needed.
825 Used to specify the fully qualified domain name used for SASL processing.
827 .B sasl-realm <realm>
828 Specify SASL realm. Default is empty.
830 .B sasl-secprops <properties>
831 Used to specify Cyrus SASL security properties.
834 flag (without any other properties) causes the flag properties
835 default, "noanonymous,noplain", to be cleared.
838 flag disables mechanisms susceptible to simple passive attacks.
841 flag disables mechanisms susceptible to active attacks.
844 flag disables mechanisms susceptible to passive dictionary attacks.
847 flag disables mechanisms which support anonymous login.
850 flag require forward secrecy between sessions.
853 require mechanisms which pass client credentials (and allow
854 mechanisms which can pass credentials to do so).
857 property specifies the minimum acceptable
858 .I security strength factor
859 as an integer approximate to effective key length used for
860 encryption. 0 (zero) implies no protection, 1 implies integrity
861 protection only, 56 allows DES or other weak ciphers, 112
862 allows triple DES and other strong ciphers, 128 allows RC4,
863 Blowfish and other modern strong ciphers. The default is 0.
866 property specifies the maximum acceptable
867 .I security strength factor
868 as an integer (see minssf description). The default is INT_MAX.
871 property specifies the maximum security layer receive buffer
872 size allowed. 0 disables security layers. The default is 65536.
875 Specify the distinguished name for the subschema subentry that
876 controls the entries on this server. The default is "cn=Subschema".
878 .B security <factors>
879 Specify a set of security strength factors (separated by white space)
883 option for a description of security strength factors).
884 The directive may be specified globally and/or per-database.
886 specifies the overall security strength factor.
888 specifies the transport security strength factor.
890 specifies the TLS security strength factor.
892 specifies the SASL security strength factor.
894 specifies the overall security strength factor to require for
896 .B update_transport=<n>
897 specifies the transport security strength factor to require for
900 specifies the TLS security strength factor to require for
903 specifies the SASL security strength factor to require for
906 specifies the security strength factor required for
908 username/password authentication.
911 factor is measure of security provided by the underlying transport,
912 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
914 .B serverID <integer> [<URL>]
915 Specify an integer ID from 0 to 4095 for this server (limited
916 to 3 hexadecimal digits).
918 required when using multimaster replication and each master must have a
919 unique ID. Note that this requirement also applies to separate masters
920 contributing to a glued set of databases.
921 If the URL is provided, this directive may be specified
922 multiple times, providing a complete list of participating servers
923 and their IDs. The fully qualified hostname of each server should be
924 used in the supplied URLs. The IDs are used in the "replica id" field
925 of all CSNs generated by the specified server. The default value is zero.
932 .B sizelimit {<integer>|unlimited}
934 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
935 Specify the maximum number of entries to return from a search operation.
936 The default size limit is 500.
939 to specify no limits.
940 The second format allows a fine grain setting of the size limits.
941 Extra args can be added on the same line.
944 for an explanation of the different flags.
946 .B sockbuf_max_incoming <integer>
947 Specify the maximum incoming LDAP PDU size for anonymous sessions.
948 The default is 262143.
950 .B sockbuf_max_incoming_auth <integer>
951 Specify the maximum incoming LDAP PDU size for authenticated sessions.
952 The default is 4194303.
954 .B sortvals <attr> [...]
955 Specify a list of multi-valued attributes whose values will always
956 be maintained in sorted order. Using this option will allow Modify,
957 Compare, and filter evaluations on these attributes to be performed
958 more efficiently. The resulting sort order depends on the
959 attributes' syntax and matching rules and may not correspond to
960 lexical order or any other recognizable order.
963 Specify the maximum size of the primary thread pool.
964 The default is 16; the minimum value is 2.
966 .B timelimit {<integer>|unlimited}
968 .B timelimit time[.{soft|hard}]=<integer> [...]
969 Specify the maximum number of seconds (in real time)
971 will spend answering a search request. The default time limit is 3600.
974 to specify no limits.
975 The second format allows a fine grain setting of the time limits.
976 Extra args can be added on the same line.
979 for an explanation of the different flags.
981 .B tool-threads <integer>
982 Specify the maximum number of threads to use in tool mode.
983 This should not be greater than the number of CPUs in the system.
985 .\"ucdata-path is obsolete / ignored...
987 .\".B ucdata-path <path>
988 .\"Specify the path to the directory containing the Unicode character
989 .\"tables. The default path is DATADIR/ucdata.
991 .B writetimeout <integer>
992 Specify the number of seconds to wait before forcibly closing
993 a connection with an outstanding write. This allows recovery from
994 various network hang conditions. A writetimeout of 0 disables this
995 feature. The default is 0.
999 is built with support for Transport Layer Security, there are more options
1002 .B TLSCipherSuite <cipher-suite-spec>
1003 Permits configuring what ciphers will be accepted and the preference order.
1004 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
1006 TLSCipherSuite HIGH:MEDIUM:+SSLv2
1008 To check what ciphers a given spec selects, use:
1011 openssl ciphers -v <cipher-suite-spec>
1014 To obtain the list of ciphers in GNUtls use:
1021 .B TLSCACertificateFile <filename>
1022 Specifies the file that contains certificates for all of the Certificate
1027 .B TLSCACertificatePath <path>
1028 Specifies the path of a directory that contains Certificate Authority
1029 certificates in separate individual files. Usually only one of this
1030 or the TLSCACertificateFile is used. This directive is not supported
1033 .B TLSCertificateFile <filename>
1034 Specifies the file that contains the
1038 .B TLSCertificateKeyFile <filename>
1039 Specifies the file that contains the
1041 server private key that matches the certificate stored in the
1042 .B TLSCertificateFile
1043 file. Currently, the private key must not be protected with a password, so
1044 it is of critical importance that it is protected carefully.
1046 .B TLSDHParamFile <filename>
1047 This directive specifies the file that contains parameters for Diffie-Hellman
1048 ephemeral key exchange. This is required in order to use a DSA certificate on
1049 the server. If multiple sets of parameters are present in the file, all of
1050 them will be processed. Note that setting this option may also enable
1051 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
1052 You should append "!ADH" to your cipher suites if you have changed them
1053 from the default, otherwise no certificate exchanges or verification will
1054 be done. When using GNUtls these parameters are always generated randomly so
1055 this directive is ignored.
1057 .B TLSRandFile <filename>
1058 Specifies the file to obtain random bits from when /dev/[u]random
1059 is not available. Generally set to the name of the EGD/PRNGD socket.
1060 The environment variable RANDFILE can also be used to specify the filename.
1061 This directive is ignored with GNUtls.
1063 .B TLSVerifyClient <level>
1064 Specifies what checks to perform on client certificates in an
1065 incoming TLS session, if any.
1068 can be specified as one of the following keywords:
1072 This is the default.
1074 will not ask the client for a certificate.
1077 The client certificate is requested. If no certificate is provided,
1078 the session proceeds normally. If a bad certificate is provided,
1079 it will be ignored and the session proceeds normally.
1082 The client certificate is requested. If no certificate is provided,
1083 the session proceeds normally. If a bad certificate is provided,
1084 the session is immediately terminated.
1086 .B demand | hard | true
1087 These keywords are all equivalent, for compatibility reasons.
1088 The client certificate is requested. If no certificate is provided,
1089 or a bad certificate is provided, the session is immediately terminated.
1091 Note that a valid client certificate is required in order to use the
1092 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1095 setting must be chosen to enable SASL EXTERNAL authentication.
1098 .B TLSCRLCheck <level>
1099 Specifies if the Certificate Revocation List (CRL) of the CA should be
1100 used to verify if the client certificates have not been revoked. This
1102 .B TLSCACertificatePath
1103 parameter to be set. This directive is ignored with GNUtls.
1105 can be specified as one of the following keywords:
1109 No CRL checks are performed
1112 Check the CRL of the peer certificate
1115 Check the CRL for a whole certificate chain
1118 .B TLSCRLFile <filename>
1119 Specifies a file containing a Certificate Revocation List to be used
1120 for verifying that certificates have not been revoked. This directive is
1121 only valid when using GNUtls.
1122 .SH GENERAL BACKEND OPTIONS
1123 Options in this section only apply to the configuration file section
1124 for the specified backend. They are supported by every
1127 .B backend <databasetype>
1128 Mark the beginning of a backend definition. <databasetype>
1145 depending on which backend will serve the database.
1147 .SH GENERAL DATABASE OPTIONS
1148 Options in this section only apply to the configuration file section
1149 for the database in which they are defined. They are supported by every
1150 type of backend. Note that the
1154 option are mandatory for each database.
1156 .B database <databasetype>
1157 Mark the beginning of a new database instance definition. <databasetype>
1174 depending on which backend will serve the database.
1176 LDAP operations, even subtree searches, normally access only one
1178 That can be changed by gluing databases together with the
1181 Access controls and some overlays can also involve multiple databases.
1183 .B add_content_acl on | off
1184 Controls whether Add operations will perform ACL checks on
1185 the content of the entry being added. This check is off
1187 .BR slapd.access (5)
1188 manual page for more details on ACL requirements for
1192 Controls whether the database will be used to answer
1193 queries. A database that is hidden will never be
1194 selected to answer any queries, and any suffix configured
1195 on the database will be ignored in checks for conflicts
1196 with other databases. By default, hidden is off.
1201 will automatically maintain the
1202 modifiersName, modifyTimestamp, creatorsName, and
1203 createTimestamp attributes for entries. It also controls
1204 the entryCSN and entryUUID attributes, which are needed
1205 by the syncrepl provider. By default, lastmod is on.
1207 .B limits <selector> <limit> [<limit> [...]]
1208 Specify time and size limits based on the operation's initiator or
1216 anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>
1222 <dnspec> ::= dn[.<type>][.<style>]
1224 <type> ::= self | this
1226 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1231 is the default and means the bound user, while
1233 means the base DN of the operation.
1236 matches all unauthenticated clients.
1239 matches all authenticated clients;
1242 dn pattern is assumed unless otherwise specified by qualifying
1243 the (optional) key string
1249 (which are synonyms), to require an exact match; with
1251 to require exactly one level of depth match; with
1253 to allow any level of depth match, including the exact match; with
1255 to allow any level of depth match, not including the exact match;
1257 explicitly requires the (default) match based on POSIX (''extended'')
1258 regular expression pattern.
1261 matches unbound operations; the
1264 The same behavior is obtained by using the
1271 with the optional objectClass
1277 sets the limits for any DN listed in the values of the
1283 group objectClass (default
1285 whose DN exactly matches
1288 The currently supported limits are
1293 The syntax for time limits is
1294 .BR time[.{soft|hard}]=<integer> ,
1297 is the number of seconds slapd will spend answering a search request.
1298 If no time limit is explicitly requested by the client, the
1300 limit is used; if the requested time limit exceeds the
1303 .\".I "Administrative limit exceeded"
1304 .\"error is returned.
1305 limit, the value of the limit is used instead.
1308 limit is set to the keyword
1310 the soft limit is used in either case; if it is set to the keyword
1312 no hard limit is enforced.
1313 Explicit requests for time limits smaller or equal to the
1316 If no limit specifier is set, the value is assigned to the
1322 to preserve the original behavior.
1324 The syntax for size limits is
1325 .BR size[.{soft|hard|unchecked}]=<integer> ,
1328 is the maximum number of entries slapd will return answering a search
1330 If no size limit is explicitly requested by the client, the
1332 limit is used; if the requested size limit exceeds the
1335 .\".I "Administrative limit exceeded"
1336 .\"error is returned.
1337 limit, the value of the limit is used instead.
1340 limit is set to the keyword
1342 the soft limit is used in either case; if it is set to the keyword
1344 no hard limit is enforced.
1345 Explicit requests for size limits smaller or equal to the
1350 specifier sets a limit on the number of candidates a search request is allowed
1352 The rationale behind it is that searches for non-properly indexed
1353 attributes may result in large sets of candidates, which must be
1356 to determine whether they match the search filter or not.
1359 limit provides a means to drop such operations before they are even
1361 If the selected candidates exceed the
1363 limit, the search will abort with
1364 .IR "Unwilling to perform" .
1365 If it is set to the keyword
1367 no limit is applied (the default).
1370 the search is not even performed; this can be used to disallow searches
1371 for a specific set of users.
1372 If no limit specifier is set, the value is assigned to the
1378 to preserve the original behavior.
1380 In case of no match, the global limits are used.
1381 The default values are the same as for
1390 control is requested, the
1392 size limit is used by default, because the request of a specific page size
1393 is considered an explicit request for a limitation on the number
1394 of entries to be returned.
1395 However, the size limit applies to the total count of entries returned within
1396 the search, and not to a single page.
1397 Additional size limits may be enforced; the syntax is
1398 .BR size.pr={<integer>|noEstimate|unlimited} ,
1401 is the max page size if no explicit limit is set; the keyword
1403 inhibits the server from returning an estimate of the total number
1404 of entries that might be returned
1405 (note: the current implementation does not return any estimate).
1408 indicates that no limit is applied to the pagedResults control page size.
1410 .B size.prtotal={<integer>|unlimited|disabled}
1411 allows to set a limit on the total number of entries that a pagedResults
1412 control allows to return.
1413 By default it is set to the
1418 is the max number of entries that the whole search with pagedResults control
1422 to allow unlimited number of entries to be returned, e.g. to allow
1423 the use of the pagedResults control as a means to circumvent size
1424 limitations on regular searches; the keyword
1426 disables the control, i.e. no paged results can be returned.
1427 Note that the total number of entries returned when the pagedResults control
1428 is requested cannot exceed the
1430 size limit of regular searches unless extended by the
1434 The \fBlimits\fP statement is typically used to let an unlimited
1435 number of entries be returned by searches performed
1436 with the identity used by the consumer for synchronization purposes
1437 by means of the RFC 4533 LDAP Content Synchronization protocol
1438 (see \fBsyncrepl\fP for details).
1441 .B maxderefdepth <depth>
1442 Specifies the maximum number of aliases to dereference when trying to
1443 resolve an entry, used to avoid infinite alias loops. The default is 15.
1445 .B mirrormode on | off
1446 This option puts a replica database into "mirror" mode. Update
1447 operations will be accepted from any user, not just the updatedn. The
1448 database must already be configured as a syncrepl consumer
1449 before this keyword may be set. This mode also requires a
1451 (see above) to be configured.
1452 By default, mirrormode is off.
1454 .B monitoring on | off
1455 This option enables database-specific monitoring in the entry related
1456 to the current database in the "cn=Databases,cn=Monitor" subtree
1457 of the monitor database, if the monitor database is enabled.
1458 Currently, only the BDB and the HDB databases provide database-specific
1460 The default depends on the backend type.
1462 .B overlay <overlay-name>
1463 Add the specified overlay to this database. An overlay is a piece of
1464 code that intercepts database operations in order to extend or change
1465 them. Overlays are pushed onto
1466 a stack over the database, and so they will execute in the reverse
1467 of the order in which they were configured and the database itself
1468 will receive control last of all. See the
1469 .BR slapd.overlays (5)
1470 manual page for an overview of the available overlays.
1471 Note that all of the database's
1472 regular settings should be configured before any overlay settings.
1474 .B readonly on | off
1475 This option puts the database into "read-only" mode. Any attempts to
1476 modify the database will return an "unwilling to perform" error. By
1477 default, readonly is off.
1479 .B restrict <oplist>
1480 Specify a whitespace separated list of operations that are restricted.
1481 If defined inside a database specification, restrictions apply only
1482 to that database, otherwise they are global.
1483 Operations can be any of
1488 .BR extended[=<OID>] ,
1492 or the special pseudo-operations
1496 which respectively summarize read and write operations.
1504 keyword allows to indicate the OID of the specific operation
1508 Specify the distinguished name that is not subject to access control
1509 or administrative limit restrictions for operations on this database.
1510 This DN may or may not be associated with an entry. An empty root
1511 DN (the default) specifies no root access is to be granted. It is
1512 recommended that the rootdn only be specified when needed (such as
1513 when initially populating a database). If the rootdn is within
1514 a namingContext (suffix) of the database, a simple bind password
1515 may also be provided using the
1517 directive. Many optional features, including syncrepl, require the
1518 rootdn to be defined for the database.
1520 .B rootpw <password>
1521 Specify a password (or hash of the password) for the rootdn. The
1522 password can only be set if the rootdn is within the namingContext
1523 (suffix) of the database.
1524 This option accepts all RFC 2307 userPassword formats known to
1527 description) as well as cleartext.
1529 may be used to generate a hash of a password. Cleartext
1530 and \fB{CRYPT}\fP passwords are not recommended. If empty
1531 (the default), authentication of the root DN is by other means
1532 (e.g. SASL). Use of SASL is encouraged.
1534 .B suffix <dn suffix>
1535 Specify the DN suffix of queries that will be passed to this
1536 backend database. Multiple suffix lines can be given and at least one is
1537 required for each database definition.
1539 If the suffix of one database is "inside" that of another, the database
1540 with the inner suffix must come first in the configuration file.
1541 You may also want to glue such databases together with the
1545 .B subordinate [advertise]
1546 Specify that the current backend database is a subordinate of another
1547 backend database. A subordinate database may have only one suffix. This
1548 option may be used to glue multiple databases into a single namingContext.
1549 If the suffix of the current database is within the namingContext of a
1550 superior database, searches against the superior database will be
1551 propagated to the subordinate as well. All of the databases
1552 associated with a single namingContext should have identical rootdns.
1553 Behavior of other LDAP operations is unaffected by this setting. In
1554 particular, it is not possible to use moddn to move an entry from
1555 one subordinate to another subordinate within the namingContext.
1557 If the optional \fBadvertise\fP flag is supplied, the naming context of
1558 this database is advertised in the root DSE. The default is to hide this
1559 database context, so that only the superior context is visible.
1566 are used on the superior database, any glued subordinates that support
1567 these tools are opened as well.
1569 Databases that are glued together should usually be configured with the
1570 same indices (assuming they support indexing), even for attributes that
1571 only exist in some of these databases. In general, all of the glued
1572 databases should be configured as similarly as possible, since the intent
1573 is to provide the appearance of a single directory.
1575 Note that the \fIsubordinate\fP functionality is implemented internally
1576 by the \fIglue\fP overlay and as such its behavior will interact with other
1577 overlays in use. By default, the glue overlay is automatically configured as
1578 the last overlay on the superior backend. Its position on the backend
1579 can be explicitly configured by setting an \fBoverlay glue\fP directive
1580 at the desired position. This explicit configuration is necessary e.g.
1581 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1582 in order to work over all of the glued databases. E.g.
1586 suffix dc=example,dc=com
1594 .B syncrepl rid=<replica ID>
1595 .B provider=ldap[s]://<hostname>[:port]
1596 .B searchbase=<base DN>
1597 .B [type=refreshOnly|refreshAndPersist]
1598 .B [interval=dd:hh:mm:ss]
1599 .B [retry=[<retry interval> <# of retries>]+]
1600 .B [filter=<filter str>]
1601 .B [scope=sub|one|base|subord]
1602 .B [attrs=<attr list>]
1604 .B [sizelimit=<limit>]
1605 .B [timelimit=<limit>]
1606 .B [schemachecking=on|off]
1607 .B [network-timeout=<seconds>]
1608 .B [timeout=<seconds>]
1609 .B [bindmethod=simple|sasl]
1611 .B [saslmech=<mech>]
1612 .B [authcid=<identity>]
1613 .B [authzid=<identity>]
1614 .B [credentials=<passwd>]
1616 .B [secprops=<properties>]
1617 .B [starttls=yes|critical]
1618 .B [tls_cert=<file>]
1620 .B [tls_cacert=<file>]
1621 .B [tls_cacertdir=<path>]
1622 .B [tls_reqcert=never|allow|try|demand]
1623 .B [tls_ciphersuite=<ciphers>]
1624 .B [tls_crlcheck=none|peer|all]
1625 .B [logbase=<base DN>]
1626 .B [logfilter=<filter str>]
1627 .B [syncdata=default|accesslog|changelog]
1629 Specify the current database as a replica which is kept up-to-date with the
1630 master content by establishing the current
1632 as a replication consumer site running a
1635 The replica content is kept synchronized to the master content using
1636 the LDAP Content Synchronization protocol. Refer to the
1637 "OpenLDAP Administrator's Guide" for detailed information on
1638 setting up a replicated
1640 directory service using the
1645 identifies the current
1647 directive within the replication consumer site.
1648 It is a non-negative integer not greater than 4095 (limited
1649 to three hexadecimal digits).
1652 specifies the replication provider site containing the master content
1653 as an LDAP URI. If <port> is not given, the standard LDAP port number
1654 (389 or 636) is used.
1658 replica is defined using a search
1659 specification as its result set. The consumer
1661 will send search requests to the provider
1663 according to the search specification. The search specification includes
1664 .BR searchbase ", " scope ", " filter ", " attrs ", " attrsonly ", " sizelimit ", "
1667 parameters as in the normal search specification.
1668 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1669 \fB(objectclass=*)\fP, while there is no default \fBsearchbase\fP. The
1670 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1671 attributes, and \fBattrsonly\fP is unset by default.
1672 The \fBsizelimit\fP and \fBtimelimit\fP only
1673 accept "unlimited" and positive integers, and both default to "unlimited".
1674 The \fBsizelimit\fP and \fBtimelimit\fP parameters define
1675 a consumer requested limitation on the number of entries that can be returned
1676 by the LDAP Content Synchronization operation; as such, it is intended
1677 to implement partial replication based on the size of the replicated database
1678 and on the time required by the synchronization.
1679 Note, however, that any provider-side limits for the replication identity
1680 will be enforced by the provider regardless of the limits requested
1681 by the LDAP Content Synchronization operation, much like for any other
1684 The LDAP Content Synchronization protocol has two operation types.
1687 operation, the next synchronization search operation
1688 is periodically rescheduled at an interval time (specified by
1690 parameter; 1 day by default)
1691 after each synchronization operation finishes.
1693 .B refreshAndPersist
1694 operation, a synchronization search remains persistent in the provider slapd.
1695 Further updates to the master replica will generate
1696 .B searchResultEntry
1697 to the consumer slapd as the search responses to the persistent
1698 synchronization search.
1700 If an error occurs during replication, the consumer will attempt to
1701 reconnect according to the
1703 parameter which is a list of the <retry interval> and <# of retries> pairs.
1704 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1705 for the first 10 times and then retry every 300 seconds for the next 3
1706 times before stop retrying. The `+' in <# of retries> means indefinite
1707 number of retries until success.
1710 was specified, by default syncrepl retries every hour forever.
1712 The schema checking can be enforced at the LDAP Sync
1713 consumer site by turning on the
1715 parameter. The default is \fBoff\fP.
1716 Schema checking \fBon\fP means that replicated entries must have
1717 a structural objectClass, must obey to objectClass requirements
1718 in terms of required/allowed attributes, and that naming attributes
1719 and distinguished values must be present.
1720 As a consequence, schema checking should be \fBoff\fP when partial
1721 replication is used.
1725 parameter sets how long the consumer will wait to establish a
1726 network connection to the provider. Once a connection is
1729 parameter determines how long the consumer will wait for the initial
1730 Bind request to complete. The defaults for these parameters come
1738 requires the options
1742 and should only be used when adequate security services
1743 (e.g. TLS or IPSEC) are in place.
1744 .B REMEMBER: simple bind credentials must be in cleartext!
1751 Depending on the mechanism, an authentication identity and/or
1752 credentials can be specified using
1758 parameter may be used to specify an authorization identity.
1759 Specific security properties (as with the
1761 keyword above) for a SASL bind can be set with the
1763 option. A non default SASL realm can be set with the
1766 The identity used for synchronization by the consumer should be allowed
1767 to receive an unlimited number of entries in response to a search request.
1768 The provider, other than allow authentication of the syncrepl identity,
1769 should grant that identity appropriate access privileges to the data
1770 that is being replicated (\fBaccess\fP directive), and appropriate time
1772 This can be accomplished by either allowing unlimited \fBsizelimit\fP
1773 and \fBtimelimit\fP, or by setting an appropriate \fBlimits\fP statement
1774 in the consumer's configuration (see \fBsizelimit\fP and \fBlimits\fP
1779 parameter specifies use of the StartTLS extended operation
1780 to establish a TLS session before Binding to the provider. If the
1782 argument is supplied, the session will be aborted if the StartTLS request
1783 fails. Otherwise the syncrepl session continues without TLS. The
1784 tls_reqcert setting defaults to "demand" and the other TLS settings
1785 default to the same as the main slapd TLS settings.
1787 Rather than replicating whole entries, the consumer can query logs of
1788 data modifications. This mode of operation is referred to as \fIdelta
1789 syncrepl\fP. In addition to the above parameters, the
1793 parameters must be set appropriately for the log that will be used. The
1795 parameter must be set to either "accesslog" if the log conforms to the
1796 .BR slapo-accesslog (5)
1797 log format, or "changelog" if the log conforms
1798 to the obsolete \fIchangelog\fP format. If the
1800 parameter is omitted or set to "default" then the log parameters are
1805 This option is only applicable in a slave
1807 It specifies the DN permitted to update (subject to access controls)
1808 the replica. It is only needed in certain push-mode
1809 replication scenarios. Generally, this DN
1816 Specify the referral to pass back when
1818 is asked to modify a replicated local database.
1819 If specified multiple times, each url is provided.
1821 .SH DATABASE-SPECIFIC OPTIONS
1822 Each database may allow specific configuration options; they are
1823 documented separately in the backends' manual pages. See the
1824 .BR slapd.backends (5)
1825 manual page for an overview of available backends.
1828 Here is a short example of a configuration file:
1832 include SYSCONFDIR/schema/core.schema
1833 pidfile LOCALSTATEDIR/run/slapd.pid
1835 # Subtypes of "name" (e.g. "cn" and "ou") with the
1836 # option ";x-hidden" can be searched for/compared,
1837 # but are not shown. See \fBslapd.access\fP(5).
1838 attributeoptions x-hidden lang-
1839 access to attrs=name;x-hidden by * =cs
1841 # Protect passwords. See \fBslapd.access\fP(5).
1842 access to attrs=userPassword by * auth
1843 # Read access to other attributes and entries.
1844 access to * by * read
1847 suffix "dc=our-domain,dc=com"
1848 # The database directory MUST exist prior to
1849 # running slapd AND should only be accessible
1850 # by the slapd/tools. Mode 0700 recommended.
1851 directory LOCALSTATEDIR/openldap-data
1852 # Indices to maintain
1853 index objectClass eq
1854 index cn,sn,mail pres,eq,approx,sub
1856 # We serve small clients that do not handle referrals,
1857 # so handle remote lookups on their behalf.
1860 uri ldap://ldap.some-server.com/
1865 "OpenLDAP Administrator's Guide" contains a longer annotated
1866 example of a configuration file.
1867 The original ETCDIR/slapd.conf is another example.
1871 default slapd configuration file
1874 .BR slapd\-config (5),
1875 .BR slapd.access (5),
1876 .BR slapd.backends (5),
1877 .BR slapd.overlays (5),
1878 .BR slapd.plugin (5),
1879 .BR slapd.replog (5),
1890 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1891 .SH ACKNOWLEDGEMENTS
projects / openldap / blob