1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2008 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 options
114 if started without the debugging command line option.
116 .B attributeoptions [option-name]...
117 Define tagging attribute options or option tag/range prefixes.
118 Options must not end with `-', prefixes must end with `-'.
119 The `lang-' prefix is predefined.
122 directive, `lang-' will no longer be defined and you must specify it
123 explicitly if you want it defined.
125 An attribute description with a tagging option is a subtype of that
126 attribute description without the option.
127 Except for that, options defined this way have no special semantics.
128 Prefixes defined this way work like the `lang-' options:
129 They define a prefix for tagging options starting with the prefix.
130 That is, if you define the prefix `x-foo-', you can use the option
132 Furthermore, in a search or compare, a prefix or range name (with
133 a trailing `-') matches all options starting with that name, as well
134 as the option with the range name sans the trailing `-'.
135 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
137 RFC 4520 reserves options beginning with `x-' for private experiments.
138 Other options should be registered with IANA, see RFC 4520 section 3.5.
139 OpenLDAP also has the `binary' option built in, but this is a transfer
140 option, not a tagging option.
143 .B attributetype "(\ <oid>\
145 [DESC\ <description>]\
154 [NO\-USER\-MODIFICATION]\
155 [USAGE\ <attributeUsage>]\ )"
157 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
158 The slapd parser extends the RFC 4512 definition by allowing string
159 forms as well as numeric OIDs to be used for the attribute OID and
160 attribute syntax OID.
166 .B authz-policy <policy>
167 Used to specify which rules to use for Proxy Authorization. Proxy
168 authorization allows a client to authenticate to the server using one
169 user's credentials, but specify a different identity to use for authorization
170 and access control purposes. It essentially allows user A to login as user
171 B, using user A's password.
174 flag disables proxy authorization. This is the default setting.
177 flag will use rules in the
179 attribute of the authorization DN.
182 flag will use rules in the
184 attribute of the authentication DN.
187 flag, an alias for the deprecated value of
189 will allow any of the above, whatever succeeds first (checked in
195 flag requires both authorizations to succeed.
198 The rules are mechanisms to specify which identities are allowed
199 to perform proxy authorization.
202 attribute in an entry specifies which other users
203 are allowed to proxy login to this entry. The
206 an entry specifies which other users this user can authorize as. Use of
209 abused if users are allowed to write arbitrary values to this attribute.
212 attribute must be protected with ACLs such that
213 only privileged users can modify it.
220 or a set of identities; it can take five forms:
223 .B ldap:///<base>??[<scope>]?<filter>
226 .B dn[.<dnstyle>]:<pattern>
229 .B u[.<mech>[/<realm>]]:<pattern>
232 .B group[/objectClass[/attributeType]]:<pattern>
239 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
242 The first form is a valid LDAP
250 portions must be absent, so that the search occurs locally on either
256 with the optional style modifiers
262 for exact, onelevel, children and subtree matches, which cause
264 to be normalized according to the DN normalization rules, or the special
266 style, which causes the
268 to be treated as a POSIX (''extended'') regular expression, as
275 means any non-anonymous DN.
276 The third form is a SASL
278 with the optional fields
282 that allow to specify a SASL
284 and eventually a SASL
286 for those mechanisms that support one.
287 The need to allow the specification of a mechanism is still debated,
288 and users are strongly discouraged to rely on this possibility.
289 The fourth form is a group specification, consisting of the keyword
291 optionally followed by the specification of the group
297 is searched with base scope, and in case of match, the values of the
300 are searched for the asserted DN.
301 For backwards compatibility, if no identity type is provided, i.e. only
305 is assumed; as a consequence,
307 is subjected to DN normalization.
308 Since the interpretation of
312 can impact security, users are strongly encouraged
313 to explicitly set the type of identity specification that is being used.
314 A subset of these rules can be used as third arg in the
316 statement (see below); significantly, the
318 provided it results in exactly one entry,
324 .B authz-regexp <match> <replace>
325 Used by the authentication framework to convert simple user names,
326 such as provided by SASL subsystem, or extracted from certificates
327 in case of cert-based SASL EXTERNAL, or provided within the RFC 4370
328 "proxied authorization" control, to an LDAP DN used for
329 authorization purposes. Note that the resulting DN need not refer
330 to an existing entry to be considered valid. When an authorization
331 request is received from the SASL subsystem, the SASL
336 are taken, when available, and combined into a name of the form
340 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
343 This name is then compared against the
345 POSIX (''extended'') regular expression, and if the match is successful,
346 the name is replaced with the
348 string. If there are wildcard strings in the
350 regular expression that are enclosed in parenthesis, e.g.
356 then the portion of the name that matched the wildcard will be stored
357 in the numbered placeholder variable $1. If there are other wildcard strings
358 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
359 placeholders can then be used in the
364 .B UID=$1,OU=Accounts,DC=example,DC=com
367 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
369 If the latter, the server will use the URI to search its own database(s)
370 and, if the search returns exactly one entry, the name is
371 replaced by the DN of that entry. The LDAP URI must have no
372 hostport, attrs, or extensions components, but the filter is mandatory,
376 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
379 The protocol portion of the URI must be strictly
381 Note that this search is subject to access controls. Specifically,
382 the authentication identity must have "auth" access in the subject.
386 options can be given in the configuration file to allow for multiple matching
387 and replacement patterns. The matching patterns are checked in the order they
388 appear in the file, stopping at the first successful match.
391 .\"Because the plus sign + is a character recognized by the regular expression engine,
392 .\"and it will appear in names that include a REALM, be careful to escape the
393 .\"plus sign with a backslash \\+ to remove the character's special meaning.
396 .B concurrency <integer>
397 Specify a desired level of concurrency. Provided to the underlying
398 thread system as a hint. The default is not to provide any hint.
400 .B conn_max_pending <integer>
401 Specify the maximum number of pending requests for an anonymous session.
402 If requests are submitted faster than the server can process them, they
403 will be queued up to this limit. If the limit is exceeded, the session
404 is closed. The default is 100.
406 .B conn_max_pending_auth <integer>
407 Specify the maximum number of pending requests for an authenticated session.
410 .B defaultsearchbase <dn>
411 Specify a default search base to use when client submits a
412 non-base search request with an empty base DN.
413 Base scoped search requests with an empty base DN are not affected.
415 .B disallow <features>
416 Specify a set of features (separated by white space) to
417 disallow (default none).
419 disables acceptance of anonymous bind requests. Note that this setting
420 does not prohibit anonymous directory access (See "require authc").
422 disables simple (bind) authentication.
424 disables forcing session to anonymous status (see also
426 upon StartTLS operation receipt.
428 disallows the StartTLS operation if authenticated (see also
430 .B proxy_authz_non_critical
431 disables acceptance of the proxied authorization control (RFC4370)
432 when criticality is FALSE.
433 .B dontusecopy_non_critical
434 disables acceptance of the dontUseCopy control (a work in progress)
435 when criticality is FALSE.
438 .B ditcontentrule "(\ <oid>\
440 [DESC\ <description>]\
447 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
448 The slapd parser extends the RFC 4512 definition by allowing string
449 forms as well as numeric OIDs to be used for the attribute OID and
450 attribute syntax OID.
456 .B gentlehup { on | off }
457 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
459 will stop listening for new connections, but will not close the
460 connections to the current clients. Future write operations return
461 unwilling-to-perform, though. Slapd terminates when all clients
462 have closed their connections (if they ever do), or \- as before \-
463 if it receives a SIGTERM signal. This can be useful if you wish to
464 terminate the server and start a new
467 .B with another database,
468 without disrupting the currently active clients.
469 The default is off. You may wish to use
471 along with this option.
473 .B idletimeout <integer>
474 Specify the number of seconds to wait before forcibly closing
475 an idle client connection. A idletimeout of 0 disables this
476 feature. The default is 0.
478 .B include <filename>
479 Read additional configuration information from the given file before
480 continuing with the next line of the current file.
482 .B index_intlen <integer>
483 Specify the key length for ordered integer indices. The most significant
484 bytes of the binary integer will be used for index keys. The default
485 value is 4, which provides exact indexing for 31 bit values.
486 A floating point representation is used to index too large values.
488 .B index_substr_if_minlen <integer>
489 Specify the minimum length for subinitial and subfinal indices. An
490 attribute value must have at least this many characters in order to be
491 processed by the indexing functions. The default is 2.
493 .B index_substr_if_maxlen <integer>
494 Specify the maximum length for subinitial and subfinal indices. Only
495 this many characters of an attribute value will be processed by the
496 indexing functions; any excess characters are ignored. The default is 4.
498 .B index_substr_any_len <integer>
499 Specify the length used for subany indices. An attribute value must have
500 at least this many characters in order to be processed. Attribute values
501 longer than this length will be processed in segments of this length. The
502 default is 4. The subany index will also be used in subinitial and
503 subfinal index lookups when the filter string is longer than the
504 .I index_substr_if_maxlen
507 .B index_substr_any_step <integer>
508 Specify the steps used in subany index lookups. This value sets the offset
509 for the segments of a filter string that are processed for a subany index
510 lookup. The default is 2. For example, with the default values, a search
511 using this filter "cn=*abcdefgh*" would generate index lookups for
512 "abcd", "cdef", and "efgh".
515 Note: Indexing support depends on the particular backend in use. Also,
516 changing these settings will generally require deleting any indices that
517 depend on these parameters and recreating them with
522 .B ldapsyntax "(\ <oid>\
523 [DESC\ <description>]\
524 [X-SUBST <substitute\-syntax>]\ )"
526 Specify an LDAP syntax using the LDAPv3 syntax defined in RFC 4512.
527 The slapd parser extends the RFC 4512 definition by allowing string
528 forms as well as numeric OIDs to be used for the syntax OID.
532 The slapd parser also honors the
534 extension (an OpenLDAP-specific extension), which allows to use the
536 statement to define a non-implemented syntax along with another syntax,
538 .IR substitute\-syntax ,
539 as its temporary replacement.
541 .I substitute\-syntax
543 This allows to define attribute types that make use of non-implemented syntaxes
544 using the correct syntax OID.
547 is used, this configuration statement would result in an error,
548 since no handlers would be associated to the resulting syntax structure.
553 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
554 such as those to the ldapi:// listener. For a description of SSF values,
558 option description. The default is 71.
560 .B logfile <filename>
561 Specify a file for recording debug log messages. By default these messages
562 only go to stderr and are not recorded anywhere else. Specifying a logfile
563 copies messages to both stderr and the logfile.
565 .B loglevel <integer> [...]
566 Specify the level at which debugging statements and operation
567 statistics should be syslogged (currently logged to the
569 LOG_LOCAL4 facility).
570 They must be considered subsystems rather than increasingly verbose
572 Some messages with higher priority are logged regardless
573 of the configured loglevel as soon as any logging is configured.
574 Log levels are additive, and available levels are:
585 debug packet handling
589 heavy trace debugging (function args)
593 connection management
597 print out packets sent and received
601 search filter processing
605 configuration file processing
609 access control list processing
613 connections, LDAP operations, results (recommended)
617 stats log entries sent
621 print communication with shell backends
633 \"data indexing (unused)
641 only messages that get logged whatever log level is set
644 The desired log level can be input as a single integer that combines
645 the (ORed) desired levels, both in decimal or in hexadecimal notation,
646 as a list of integers (that are ORed internally),
647 or as a list of the names that are shown between brackets, such that
660 can be used as a shortcut to enable logging at all levels (equivalent to -1).
663 or the equivalent integer representation, causes those messages
664 that are logged regardless of the configured loglevel to be logged.
665 In fact, if loglevel is set to 0, no logging occurs,
668 level is required to have high priority messages logged.
670 The loglevel defaults to \fBstats\fP.
671 This level should usually also be included when using other loglevels, to
672 help analyze the logs.
675 .B moduleload <filename>
676 Specify the name of a dynamically loadable module to load. The filename
677 may be an absolute path name or a simple filename. Non-absolute names
678 are searched for in the directories specified by the
680 option. This option and the
682 option are only usable if slapd was compiled with --enable-modules.
684 .B modulepath <pathspec>
685 Specify a list of directories to search for loadable modules. Typically
686 the path is colon-separated but this depends on the operating system.
689 .B objectclass "(\ <oid>\
691 [DESC\ <description>]\
694 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
695 [MUST\ <oids>] [MAY\ <oids>] )"
697 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
698 The slapd parser extends the RFC 4512 definition by allowing string
699 forms as well as numeric OIDs to be used for the object class OID.
703 description.) Object classes are "STRUCTURAL" by default.
706 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
707 Define a string name that equates to the given OID. The string can be used
708 in place of the numeric OID in objectclass and attribute definitions. The
709 name can also be used with a suffix of the form ":xx" in which case the
710 value "oid.xx" will be used.
712 .B password-hash <hash> [<hash>...]
713 This option configures one or more hashes to be used in generation of user
714 passwords stored in the userPassword attribute during processing of
715 LDAP Password Modify Extended Operations (RFC 3062).
716 The <hash> must be one of
730 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
735 use the MD5 algorithm (RFC 1321), the latter with a seed.
742 indicates that the new password should be
743 added to userPassword as clear text.
745 Note that this option does not alter the normal user applications
746 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
748 .B password\-crypt\-salt\-format <format>
749 Specify the format of the salt passed to
751 when generating {CRYPT} passwords (see
753 during processing of LDAP Password Modify Extended Operations (RFC 3062).
755 This string needs to be in
757 format and may include one (and only one) %s conversion.
758 This conversion will be substituted with a string of random
759 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
760 provides a two character salt and "$1$%.8s" tells some
761 versions of crypt(3) to use an MD5 algorithm and provides
762 8 random characters of salt. The default is "%s", which
763 provides 31 characters of salt.
765 .B pidfile <filename>
766 The ( absolute ) name of a file that will hold the
768 server's process ID ( see
770 ) if started without the debugging command line option.
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.
820 Used to specify the fully qualified domain name used for SASL processing.
822 .B sasl-realm <realm>
823 Specify SASL realm. Default is empty.
825 .B sasl-secprops <properties>
826 Used to specify Cyrus SASL security properties.
829 flag (without any other properties) causes the flag properties
830 default, "noanonymous,noplain", to be cleared.
833 flag disables mechanisms susceptible to simple passive attacks.
836 flag disables mechanisms susceptible to active attacks.
839 flag disables mechanisms susceptible to passive dictionary attacks.
842 flag disables mechanisms which support anonymous login.
845 flag require forward secrecy between sessions.
848 require mechanisms which pass client credentials (and allow
849 mechanisms which can pass credentials to do so).
852 property specifies the minimum acceptable
853 .I security strength factor
854 as an integer approximate to effective key length used for
855 encryption. 0 (zero) implies no protection, 1 implies integrity
856 protection only, 56 allows DES or other weak ciphers, 112
857 allows triple DES and other strong ciphers, 128 allows RC4,
858 Blowfish and other modern strong ciphers. The default is 0.
861 property specifies the maximum acceptable
862 .I security strength factor
863 as an integer (see minssf description). The default is INT_MAX.
866 property specifies the maximum security layer receive buffer
867 size allowed. 0 disables security layers. The default is 65536.
870 Specify the distinguished name for the subschema subentry that
871 controls the entries on this server. The default is "cn=Subschema".
873 .B security <factors>
874 Specify a set of security strength factors (separated by white space)
878 option for a description of security strength factors).
879 The directive may be specified globally and/or per-database.
881 specifies the overall security strength factor.
883 specifies the transport security strength factor.
885 specifies the TLS security strength factor.
887 specifies the SASL security strength factor.
889 specifies the overall security strength factor to require for
891 .B update_transport=<n>
892 specifies the transport security strength factor to require for
895 specifies the TLS security strength factor to require for
898 specifies the SASL security strength factor to require for
901 specifies the security strength factor required for
903 username/password authentication.
906 factor is measure of security provided by the underlying transport,
907 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
909 .B serverID <integer> [<URL>]
910 Specify an integer ID from 0 to 4095 for this server (limited
911 to 3 hexadecimal digits).
913 required when using multimaster replication and each master must have a
914 unique ID. Note that this requirement also applies to separate masters
915 contributing to a glued set of databases.
916 If the URL is provided, this directive may be specified
917 multiple times, providing a complete list of participating servers
918 and their IDs. The fully qualified hostname of each server should be
919 used in the supplied URLs. The IDs are used in the "replica id" field
920 of all CSNs generated by the specified server. The default value is zero.
927 .B sizelimit {<integer>|unlimited}
929 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
930 Specify the maximum number of entries to return from a search operation.
931 The default size limit is 500.
934 to specify no limits.
935 The second format allows a fine grain setting of the size limits.
936 Extra args can be added on the same line.
939 for an explanation of the different flags.
941 .B sockbuf_max_incoming <integer>
942 Specify the maximum incoming LDAP PDU size for anonymous sessions.
943 The default is 262143.
945 .B sockbuf_max_incoming_auth <integer>
946 Specify the maximum incoming LDAP PDU size for authenticated sessions.
947 The default is 4194303.
949 .B sortvals <attr> [...]
950 Specify a list of multi-valued attributes whose values will always
951 be maintained in sorted order. Using this option will allow Modify,
952 Compare, and filter evaluations on these attributes to be performed
953 more efficiently. The resulting sort order depends on the
954 attributes' syntax and matching rules and may not correspond to
955 lexical order or any other recognizable order.
958 Specify the maximum size of the primary thread pool.
959 The default is 16; the minimum value is 2.
961 .B timelimit {<integer>|unlimited}
963 .B timelimit time[.{soft|hard}]=<integer> [...]
964 Specify the maximum number of seconds (in real time)
966 will spend answering a search request. The default time limit is 3600.
969 to specify no limits.
970 The second format allows a fine grain setting of the time limits.
971 Extra args can be added on the same line.
974 for an explanation of the different flags.
976 .B tool-threads <integer>
977 Specify the maximum number of threads to use in tool mode.
978 This should not be greater than the number of CPUs in the system.
980 .\"ucdata-path is obsolete / ignored...
982 .\".B ucdata-path <path>
983 .\"Specify the path to the directory containing the Unicode character
984 .\"tables. The default path is DATADIR/ucdata.
988 is built with support for Transport Layer Security, there are more options
991 .B TLSCipherSuite <cipher-suite-spec>
992 Permits configuring what ciphers will be accepted and the preference order.
993 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
995 TLSCipherSuite HIGH:MEDIUM:+SSLv2
997 To check what ciphers a given spec selects, use:
1000 openssl ciphers -v <cipher-suite-spec>
1003 To obtain the list of ciphers in GNUtls use:
1010 .B TLSCACertificateFile <filename>
1011 Specifies the file that contains certificates for all of the Certificate
1016 .B TLSCACertificatePath <path>
1017 Specifies the path of a directory that contains Certificate Authority
1018 certificates in separate individual files. Usually only one of this
1019 or the TLSCACertificateFile is used. This directive is not supported
1022 .B TLSCertificateFile <filename>
1023 Specifies the file that contains the
1027 .B TLSCertificateKeyFile <filename>
1028 Specifies the file that contains the
1030 server private key that matches the certificate stored in the
1031 .B TLSCertificateFile
1032 file. Currently, the private key must not be protected with a password, so
1033 it is of critical importance that it is protected carefully.
1035 .B TLSDHParamFile <filename>
1036 This directive specifies the file that contains parameters for Diffie-Hellman
1037 ephemeral key exchange. This is required in order to use a DSA certificate on
1038 the server. If multiple sets of parameters are present in the file, all of
1039 them will be processed. Note that setting this option may also enable
1040 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
1041 You should append "!ADH" to your cipher suites if you have changed them
1042 from the default, otherwise no certificate exchanges or verification will
1043 be done. When using GNUtls these parameters are always generated randomly so
1044 this directive is ignored.
1046 .B TLSRandFile <filename>
1047 Specifies the file to obtain random bits from when /dev/[u]random
1048 is not available. Generally set to the name of the EGD/PRNGD socket.
1049 The environment variable RANDFILE can also be used to specify the filename.
1050 This directive is ignored with GNUtls.
1052 .B TLSVerifyClient <level>
1053 Specifies what checks to perform on client certificates in an
1054 incoming TLS session, if any.
1057 can be specified as one of the following keywords:
1061 This is the default.
1063 will not ask the client for a certificate.
1066 The client certificate is requested. If no certificate is provided,
1067 the session proceeds normally. If a bad certificate is provided,
1068 it will be ignored and the session proceeds normally.
1071 The client certificate is requested. If no certificate is provided,
1072 the session proceeds normally. If a bad certificate is provided,
1073 the session is immediately terminated.
1075 .B demand | hard | true
1076 These keywords are all equivalent, for compatibility reasons.
1077 The client certificate is requested. If no certificate is provided,
1078 or a bad certificate is provided, the session is immediately terminated.
1080 Note that a valid client certificate is required in order to use the
1081 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1084 setting must be chosen to enable SASL EXTERNAL authentication.
1087 .B TLSCRLCheck <level>
1088 Specifies if the Certificate Revocation List (CRL) of the CA should be
1089 used to verify if the client certificates have not been revoked. This
1091 .B TLSCACertificatePath
1092 parameter to be set. This directive is ignored with GNUtls.
1094 can be specified as one of the following keywords:
1098 No CRL checks are performed
1101 Check the CRL of the peer certificate
1104 Check the CRL for a whole certificate chain
1107 .B TLSCRLFile <filename>
1108 Specifies a file containing a Certificate Revocation List to be used
1109 for verifying that certificates have not been revoked. This directive is
1110 only valid when using GNUtls.
1111 .SH GENERAL BACKEND OPTIONS
1112 Options in this section only apply to the configuration file section
1113 for the specified backend. They are supported by every
1116 .B backend <databasetype>
1117 Mark the beginning of a backend definition. <databasetype>
1134 depending on which backend will serve the database.
1136 .SH GENERAL DATABASE OPTIONS
1137 Options in this section only apply to the configuration file section
1138 for the database in which they are defined. They are supported by every
1139 type of backend. Note that the
1143 option are mandatory for each database.
1145 .B database <databasetype>
1146 Mark the beginning of a new database instance definition. <databasetype>
1163 depending on which backend will serve the database.
1165 LDAP operations, even subtree searches, normally access only one
1167 That can be changed by gluing databases together with the
1170 Access controls and some overlays can also involve multiple databases.
1172 .B add_content_acl on | off
1173 Controls whether Add operations will perform ACL checks on
1174 the content of the entry being added. This check is off
1176 .BR slapd.access (5)
1177 manual page for more details on ACL requirements for
1181 Controls whether the database will be used to answer
1182 queries. A database that is hidden will never be
1183 selected to answer any queries, and any suffix configured
1184 on the database will be ignored in checks for conflicts
1185 with other databases. By default, hidden is off.
1190 will automatically maintain the
1191 modifiersName, modifyTimestamp, creatorsName, and
1192 createTimestamp attributes for entries. It also controls
1193 the entryCSN and entryUUID attributes, which are needed
1194 by the syncrepl provider. By default, lastmod is on.
1196 .B limits <selector> <limit> [<limit> [...]]
1197 Specify time and size limits based on the operation's initiator or
1205 anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>
1211 <dnspec> ::= dn[.<type>][.<style>]
1213 <type> ::= self | this
1215 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1220 is the default and means the bound user, while
1222 means the base DN of the operation.
1225 matches all unauthenticated clients.
1228 matches all authenticated clients;
1231 dn pattern is assumed unless otherwise specified by qualifying
1232 the (optional) key string
1238 (which are synonyms), to require an exact match; with
1240 to require exactly one level of depth match; with
1242 to allow any level of depth match, including the exact match; with
1244 to allow any level of depth match, not including the exact match;
1246 explicitly requires the (default) match based on POSIX (''extended'')
1247 regular expression pattern.
1250 matches unbound operations; the
1253 The same behavior is obtained by using the
1260 with the optional objectClass
1266 sets the limits for any DN listed in the values of the
1272 group objectClass (default
1274 whose DN exactly matches
1277 The currently supported limits are
1282 The syntax for time limits is
1283 .BR time[.{soft|hard}]=<integer> ,
1286 is the number of seconds slapd will spend answering a search request.
1287 If no time limit is explicitly requested by the client, the
1289 limit is used; if the requested time limit exceeds the
1292 .\".I "Administrative limit exceeded"
1293 .\"error is returned.
1294 limit, the value of the limit is used instead.
1297 limit is set to the keyword
1299 the soft limit is used in either case; if it is set to the keyword
1301 no hard limit is enforced.
1302 Explicit requests for time limits smaller or equal to the
1305 If no limit specifier is set, the value is assigned to the
1311 to preserve the original behavior.
1313 The syntax for size limits is
1314 .BR size[.{soft|hard|unchecked}]=<integer> ,
1317 is the maximum number of entries slapd will return answering a search
1319 If no size limit is explicitly requested by the client, the
1321 limit is used; if the requested size limit exceeds the
1324 .\".I "Administrative limit exceeded"
1325 .\"error is returned.
1326 limit, the value of the limit is used instead.
1329 limit is set to the keyword
1331 the soft limit is used in either case; if it is set to the keyword
1333 no hard limit is enforced.
1334 Explicit requests for size limits smaller or equal to the
1339 specifier sets a limit on the number of candidates a search request is allowed
1341 The rationale behind it is that searches for non-properly indexed
1342 attributes may result in large sets of candidates, which must be
1345 to determine whether they match the search filter or not.
1348 limit provides a means to drop such operations before they are even
1350 If the selected candidates exceed the
1352 limit, the search will abort with
1353 .IR "Unwilling to perform" .
1354 If it is set to the keyword
1356 no limit is applied (the default).
1359 the search is not even performed; this can be used to disallow searches
1360 for a specific set of users.
1361 If no limit specifier is set, the value is assigned to the
1367 to preserve the original behavior.
1369 In case of no match, the global limits are used.
1370 The default values are the same as for
1379 control is requested, the
1381 size limit is used by default, because the request of a specific page size
1382 is considered an explicit request for a limitation on the number
1383 of entries to be returned.
1384 However, the size limit applies to the total count of entries returned within
1385 the search, and not to a single page.
1386 Additional size limits may be enforced; the syntax is
1387 .BR size.pr={<integer>|noEstimate|unlimited} ,
1390 is the max page size if no explicit limit is set; the keyword
1392 inhibits the server from returning an estimate of the total number
1393 of entries that might be returned
1394 (note: the current implementation does not return any estimate).
1397 indicates that no limit is applied to the pagedResults control page size.
1399 .B size.prtotal={<integer>|unlimited|disabled}
1400 allows to set a limit on the total number of entries that a pagedResults
1401 control allows to return.
1402 By default it is set to the
1407 is the max number of entries that the whole search with pagedResults control
1411 to allow unlimited number of entries to be returned, e.g. to allow
1412 the use of the pagedResults control as a means to circumvent size
1413 limitations on regular searches; the keyword
1415 disables the control, i.e. no paged results can be returned.
1416 Note that the total number of entries returned when the pagedResults control
1417 is requested cannot exceed the
1419 size limit of regular searches unless extended by the
1423 The \fBlimits\fP statement is typically used to let an unlimited
1424 number of entries be returned by searches performed
1425 with the identity used by the consumer for synchronization purposes
1426 by means of the RFC 4533 LDAP Content Synchronization protocol
1427 (see \fBsyncrepl\fP for details).
1430 .B maxderefdepth <depth>
1431 Specifies the maximum number of aliases to dereference when trying to
1432 resolve an entry, used to avoid infinite alias loops. The default is 15.
1434 .B mirrormode on | off
1435 This option puts a replica database into "mirror" mode. Update
1436 operations will be accepted from any user, not just the updatedn. The
1437 database must already be configured as a syncrepl consumer
1438 before this keyword may be set. This mode also requires a
1440 (see above) to be configured.
1441 By default, mirrormode is off.
1443 .B monitoring on | off
1444 This option enables database-specific monitoring in the entry related
1445 to the current database in the "cn=Databases,cn=Monitor" subtree
1446 of the monitor database, if the monitor database is enabled.
1447 Currently, only the BDB and the HDB databases provide database-specific
1449 The default depends on the backend type.
1451 .B overlay <overlay-name>
1452 Add the specified overlay to this database. An overlay is a piece of
1453 code that intercepts database operations in order to extend or change
1454 them. Overlays are pushed onto
1455 a stack over the database, and so they will execute in the reverse
1456 of the order in which they were configured and the database itself
1457 will receive control last of all. See the
1458 .BR slapd.overlays (5)
1459 manual page for an overview of the available overlays.
1460 Note that all of the database's
1461 regular settings should be configured before any overlay settings.
1463 .B readonly on | off
1464 This option puts the database into "read-only" mode. Any attempts to
1465 modify the database will return an "unwilling to perform" error. By
1466 default, readonly is off.
1468 .B restrict <oplist>
1469 Specify a whitespace separated list of operations that are restricted.
1470 If defined inside a database specification, restrictions apply only
1471 to that database, otherwise they are global.
1472 Operations can be any of
1477 .BR extended[=<OID>] ,
1481 or the special pseudo-operations
1485 which respectively summarize read and write operations.
1493 keyword allows to indicate the OID of the specific operation
1497 Specify the distinguished name that is not subject to access control
1498 or administrative limit restrictions for operations on this database.
1499 This DN may or may not be associated with an entry. An empty root
1500 DN (the default) specifies no root access is to be granted. It is
1501 recommended that the rootdn only be specified when needed (such as
1502 when initially populating a database). If the rootdn is within
1503 a namingContext (suffix) of the database, a simple bind password
1504 may also be provided using the
1506 directive. Many optional features, including syncrepl, require the
1507 rootdn to be defined for the database.
1509 .B rootpw <password>
1510 Specify a password (or hash of the password) for the rootdn. The
1511 password can only be set if the rootdn is within the namingContext
1512 (suffix) of the database.
1513 This option accepts all RFC 2307 userPassword formats known to
1516 description) as well as cleartext.
1518 may be used to generate a hash of a password. Cleartext
1519 and \fB{CRYPT}\fP passwords are not recommended. If empty
1520 (the default), authentication of the root DN is by other means
1521 (e.g. SASL). Use of SASL is encouraged.
1523 .B suffix <dn suffix>
1524 Specify the DN suffix of queries that will be passed to this
1525 backend database. Multiple suffix lines can be given and at least one is
1526 required for each database definition.
1528 If the suffix of one database is "inside" that of another, the database
1529 with the inner suffix must come first in the configuration file.
1530 You may also want to glue such databases together with the
1534 .B subordinate [advertise]
1535 Specify that the current backend database is a subordinate of another
1536 backend database. A subordinate database may have only one suffix. This
1537 option may be used to glue multiple databases into a single namingContext.
1538 If the suffix of the current database is within the namingContext of a
1539 superior database, searches against the superior database will be
1540 propagated to the subordinate as well. All of the databases
1541 associated with a single namingContext should have identical rootdns.
1542 Behavior of other LDAP operations is unaffected by this setting. In
1543 particular, it is not possible to use moddn to move an entry from
1544 one subordinate to another subordinate within the namingContext.
1546 If the optional \fBadvertise\fP flag is supplied, the naming context of
1547 this database is advertised in the root DSE. The default is to hide this
1548 database context, so that only the superior context is visible.
1555 are used on the superior database, any glued subordinates that support
1556 these tools are opened as well.
1558 Databases that are glued together should usually be configured with the
1559 same indices (assuming they support indexing), even for attributes that
1560 only exist in some of these databases. In general, all of the glued
1561 databases should be configured as similarly as possible, since the intent
1562 is to provide the appearance of a single directory.
1564 Note that the \fIsubordinate\fP functionality is implemented internally
1565 by the \fIglue\fP overlay and as such its behavior will interact with other
1566 overlays in use. By default, the glue overlay is automatically configured as
1567 the last overlay on the superior backend. Its position on the backend
1568 can be explicitly configured by setting an \fBoverlay glue\fP directive
1569 at the desired position. This explicit configuration is necessary e.g.
1570 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1571 in order to work over all of the glued databases. E.g.
1575 suffix dc=example,dc=com
1583 .B syncrepl rid=<replica ID>
1584 .B provider=ldap[s]://<hostname>[:port]
1585 .B searchbase=<base DN>
1586 .B [type=refreshOnly|refreshAndPersist]
1587 .B [interval=dd:hh:mm:ss]
1588 .B [retry=[<retry interval> <# of retries>]+]
1589 .B [filter=<filter str>]
1590 .B [scope=sub|one|base|subord]
1591 .B [attrs=<attr list>]
1593 .B [sizelimit=<limit>]
1594 .B [timelimit=<limit>]
1595 .B [schemachecking=on|off]
1596 .B [network-timeout=<seconds>]
1597 .B [timeout=<seconds>]
1598 .B [bindmethod=simple|sasl]
1600 .B [saslmech=<mech>]
1601 .B [authcid=<identity>]
1602 .B [authzid=<identity>]
1603 .B [credentials=<passwd>]
1605 .B [secprops=<properties>]
1606 .B [starttls=yes|critical]
1607 .B [tls_cert=<file>]
1609 .B [tls_cacert=<file>]
1610 .B [tls_cacertdir=<path>]
1611 .B [tls_reqcert=never|allow|try|demand]
1612 .B [tls_ciphersuite=<ciphers>]
1613 .B [tls_crlcheck=none|peer|all]
1614 .B [logbase=<base DN>]
1615 .B [logfilter=<filter str>]
1616 .B [syncdata=default|accesslog|changelog]
1618 Specify the current database as a replica which is kept up-to-date with the
1619 master content by establishing the current
1621 as a replication consumer site running a
1624 The replica content is kept synchronized to the master content using
1625 the LDAP Content Synchronization protocol. Refer to the
1626 "OpenLDAP Administrator's Guide" for detailed information on
1627 setting up a replicated
1629 directory service using the
1634 identifies the current
1636 directive within the replication consumer site.
1637 It is a non-negative integer not greater than 4095 (limited
1638 to three hexadecimal digits).
1641 specifies the replication provider site containing the master content
1642 as an LDAP URI. If <port> is not given, the standard LDAP port number
1643 (389 or 636) is used.
1647 replica is defined using a search
1648 specification as its result set. The consumer
1650 will send search requests to the provider
1652 according to the search specification. The search specification includes
1653 .BR searchbase ", " scope ", " filter ", " attrs ", " attrsonly ", " sizelimit ", "
1656 parameters as in the normal search specification.
1657 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1658 \fB(objectclass=*)\fP, while there is no default \fBsearchbase\fP. The
1659 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1660 attributes, and \fBattrsonly\fP is unset by default.
1661 The \fBsizelimit\fP and \fBtimelimit\fP only
1662 accept "unlimited" and positive integers, and both default to "unlimited".
1663 The \fBsizelimit\fP and \fBtimelimit\fP parameters define
1664 a consumer requested limitation on the number of entries that can be returned
1665 by the LDAP Content Synchronization operation; as such, it is intended
1666 to implement partial replication based on the size of the replicated database
1667 and on the time required by the synchronization.
1668 Note, however, that any provider-side limits for the replication identity
1669 will be enforced by the provider regardless of the limits requested
1670 by the LDAP Content Synchronization operation, much like for any other
1673 The LDAP Content Synchronization protocol has two operation types.
1676 operation, the next synchronization search operation
1677 is periodically rescheduled at an interval time (specified by
1679 parameter; 1 day by default)
1680 after each synchronization operation finishes.
1682 .B refreshAndPersist
1683 operation, a synchronization search remains persistent in the provider slapd.
1684 Further updates to the master replica will generate
1685 .B searchResultEntry
1686 to the consumer slapd as the search responses to the persistent
1687 synchronization search.
1689 If an error occurs during replication, the consumer will attempt to
1690 reconnect according to the
1692 parameter which is a list of the <retry interval> and <# of retries> pairs.
1693 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1694 for the first 10 times and then retry every 300 seconds for the next 3
1695 times before stop retrying. The `+' in <# of retries> means indefinite
1696 number of retries until success.
1698 The schema checking can be enforced at the LDAP Sync
1699 consumer site by turning on the
1701 parameter. The default is \fBoff\fP.
1702 Schema checking \fBon\fP means that replicated entries must have
1703 a structural objectClass, must obey to objectClass requirements
1704 in terms of required/allowed attributes, and that naming attributes
1705 and distinguished values must be present.
1706 As a consequence, schema checking should be \fBoff\fP when partial
1707 replication is used.
1711 parameter sets how long the consumer will wait to establish a
1712 network connection to the provider. Once a connection is
1715 parameter determines how long the consumer will wait for the initial
1716 Bind request to complete. The defaults for these parameters come
1724 requires the options
1728 and should only be used when adequate security services
1729 (e.g. TLS or IPSEC) are in place.
1730 .B REMEMBER: simple bind credentials must be in cleartext!
1737 Depending on the mechanism, an authentication identity and/or
1738 credentials can be specified using
1744 parameter may be used to specify an authorization identity.
1745 Specific security properties (as with the
1747 keyword above) for a SASL bind can be set with the
1749 option. A non default SASL realm can be set with the
1752 The identity used for synchronization by the consumer should be allowed
1753 to receive an unlimited number of entries in response to a search request.
1754 The provider, other than allow authentication of the syncrepl identity,
1755 should grant that identity appropriate access privileges to the data
1756 that is being replicated (\fBaccess\fP directive), and appropriate time
1758 This can be accomplished by either allowing unlimited \fBsizelimit\fP
1759 and \fBtimelimit\fP, or by setting an appropriate \fBlimits\fP statement
1760 in the consumer's configuration (see \fBsizelimit\fP and \fBlimits\fP
1765 parameter specifies use of the StartTLS extended operation
1766 to establish a TLS session before Binding to the provider. If the
1768 argument is supplied, the session will be aborted if the StartTLS request
1769 fails. Otherwise the syncrepl session continues without TLS. The
1770 tls_reqcert setting defaults to "demand" and the other TLS settings
1771 default to the same as the main slapd TLS settings.
1773 Rather than replicating whole entries, the consumer can query logs of
1774 data modifications. This mode of operation is referred to as \fIdelta
1775 syncrepl\fP. In addition to the above parameters, the
1779 parameters must be set appropriately for the log that will be used. The
1781 parameter must be set to either "accesslog" if the log conforms to the
1782 .BR slapo-accesslog (5)
1783 log format, or "changelog" if the log conforms
1784 to the obsolete \fIchangelog\fP format. If the
1786 parameter is omitted or set to "default" then the log parameters are
1791 This option is only applicable in a slave
1793 It specifies the DN permitted to update (subject to access controls)
1794 the replica. It is only needed in certain push-mode
1795 replication scenarios. Generally, this DN
1802 Specify the referral to pass back when
1804 is asked to modify a replicated local database.
1805 If specified multiple times, each url is provided.
1807 .SH DATABASE-SPECIFIC OPTIONS
1808 Each database may allow specific configuration options; they are
1809 documented separately in the backends' manual pages. See the
1810 .BR slapd.backends (5)
1811 manual page for an overview of available backends.
1814 Here is a short example of a configuration file:
1818 include SYSCONFDIR/schema/core.schema
1819 pidfile LOCALSTATEDIR/run/slapd.pid
1821 # Subtypes of "name" (e.g. "cn" and "ou") with the
1822 # option ";x-hidden" can be searched for/compared,
1823 # but are not shown. See \fBslapd.access\fP(5).
1824 attributeoptions x-hidden lang-
1825 access to attrs=name;x-hidden by * =cs
1827 # Protect passwords. See \fBslapd.access\fP(5).
1828 access to attrs=userPassword by * auth
1829 # Read access to other attributes and entries.
1830 access to * by * read
1833 suffix "dc=our-domain,dc=com"
1834 # The database directory MUST exist prior to
1835 # running slapd AND should only be accessible
1836 # by the slapd/tools. Mode 0700 recommended.
1837 directory LOCALSTATEDIR/openldap-data
1838 # Indices to maintain
1839 index objectClass eq
1840 index cn,sn,mail pres,eq,approx,sub
1842 # We serve small clients that do not handle referrals,
1843 # so handle remote lookups on their behalf.
1846 uri ldap://ldap.some-server.com/
1851 "OpenLDAP Administrator's Guide" contains a longer annotated
1852 example of a configuration file.
1853 The original ETCDIR/slapd.conf is another example.
1857 default slapd configuration file
1860 .BR slapd\-config (5),
1861 .BR slapd.access (5),
1862 .BR slapd.backends (5),
1863 .BR slapd.overlays (5),
1864 .BR slapd.plugin (5),
1865 .BR slapd.replog (5),
1876 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1877 .SH ACKNOWLEDGEMENTS
projects / openldap / blob