1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
12 contains configuration information for the
14 daemon. This configuration file is also used by the 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
323 .B authz-regexp <match> <replace>
324 Used by the authentication framework to convert simple user names,
325 such as provided by SASL subsystem, to an LDAP DN used for
326 authorization purposes. Note that the resultant DN need not refer
327 to an existing entry to be considered valid. When an authorization
328 request is received from the SASL subsystem, the SASL
333 are taken, when available, and combined into a name of the form
337 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
340 This name is then compared against the
342 POSIX (''extended'') regular expression, and if the match is successful,
343 the name is replaced with the
345 string. If there are wildcard strings in the
347 regular expression that are enclosed in parenthesis, e.g.
353 then the portion of the name that matched the wildcard will be stored
354 in the numbered placeholder variable $1. If there are other wildcard strings
355 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
356 placeholders can then be used in the
361 .B UID=$1,OU=Accounts,DC=example,DC=com
364 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
366 If the latter, the server will use the URI to search its own database(s)
367 and, if the search returns exactly one entry, the name is
368 replaced by the DN of that entry. The LDAP URI must have no
369 hostport, attrs, or extensions components, but the filter is mandatory,
373 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
376 The protocol portion of the URI must be strictly
378 Note that this search is subject to access controls. Specifically,
379 the authentication identity must have "auth" access in the subject.
383 options can be given in the configuration file to allow for multiple matching
384 and replacement patterns. The matching patterns are checked in the order they
385 appear in the file, stopping at the first successful match.
388 .\"Because the plus sign + is a character recognized by the regular expression engine,
389 .\"and it will appear in names that include a REALM, be careful to escape the
390 .\"plus sign with a backslash \\+ to remove the character's special meaning.
393 .B concurrency <integer>
394 Specify a desired level of concurrency. Provided to the underlying
395 thread system as a hint. The default is not to provide any hint.
397 .B conn_max_pending <integer>
398 Specify the maximum number of pending requests for an anonymous session.
399 If requests are submitted faster than the server can process them, they
400 will be queued up to this limit. If the limit is exceeded, the session
401 is closed. The default is 100.
403 .B conn_max_pending_auth <integer>
404 Specify the maximum number of pending requests for an authenticated session.
407 .B defaultsearchbase <dn>
408 Specify a default search base to use when client submits a
409 non-base search request with an empty base DN.
410 Base scoped search requests with an empty base DN are not affected.
412 .B disallow <features>
413 Specify a set of features (separated by white space) to
414 disallow (default none).
416 disables acceptance of anonymous bind requests. Note that this setting
417 does not prohibit anonymous directory access (See "require authc").
419 disables simple (bind) authentication.
421 disables forcing session to anonymous status (see also
423 upon StartTLS operation receipt.
425 disallows the StartTLS operation if authenticated (see also
429 .B ditcontentrule "(\ <oid>\
431 [DESC\ <description>]\
438 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
439 The slapd parser extends the RFC 4512 definition by allowing string
440 forms as well as numeric OIDs to be used for the attribute OID and
441 attribute syntax OID.
447 .B gentlehup { on | off }
448 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
450 will stop listening for new connections, but will not close the
451 connections to the current clients. Future write operations return
452 unwilling-to-perform, though. Slapd terminates when all clients
453 have closed their connections (if they ever do), or \- as before \-
454 if it receives a SIGTERM signal. This can be useful if you wish to
455 terminate the server and start a new
458 .B with another database,
459 without disrupting the currently active clients.
460 The default is off. You may wish to use
462 along with this option.
464 .B idletimeout <integer>
465 Specify the number of seconds to wait before forcibly closing
466 an idle client connection. A idletimeout of 0 disables this
467 feature. The default is 0.
469 .B include <filename>
470 Read additional configuration information from the given file before
471 continuing with the next line of the current file.
473 .B index_substr_if_minlen <integer>
474 Specify the minimum length for subinitial and subfinal indices. An
475 attribute value must have at least this many characters in order to be
476 processed by the indexing functions. The default is 2.
478 .B index_substr_if_maxlen <integer>
479 Specify the maximum length for subinitial and subfinal indices. Only
480 this many characters of an attribute value will be processed by the
481 indexing functions; any excess characters are ignored. The default is 4.
483 .B index_substr_any_len <integer>
484 Specify the length used for subany indices. An attribute value must have
485 at least this many characters in order to be processed. Attribute values
486 longer than this length will be processed in segments of this length. The
487 default is 4. The subany index will also be used in subinitial and
488 subfinal index lookups when the filter string is longer than the
489 .I index_substr_if_maxlen
492 .B index_substr_any_step <integer>
493 Specify the steps used in subany index lookups. This value sets the offset
494 for the segments of a filter string that are processed for a subany index
495 lookup. The default is 2. For example, with the default values, a search
496 using this filter "cn=*abcdefgh*" would generate index lookups for
497 "abcd", "cdef", and "efgh".
499 Note: Indexing support depends on the particular backend in use.
503 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
504 such as those to the ldapi:// listener. For a description of SSF values,
508 option description. The default is 71.
510 .B logfile <filename>
511 Specify a file for recording debug log messages. By default these messages
512 only go to stderr and are not recorded anywhere else. Specifying a logfile
513 copies messages to both stderr and the logfile.
515 .B loglevel <integer> [...]
516 Specify the level at which debugging statements and operation
517 statistics should be syslogged (currently logged to the
519 LOG_LOCAL4 facility).
520 They must be considered subsystems rather than increasingly verbose
522 Some messages with higher priority are logged regardless
523 of the configured loglevel as soon as any logging is configured.
524 Log levels are additive, and available levels are:
535 debug packet handling
539 heavy trace debugging (function args)
543 connection management
547 print out packets sent and received
551 search filter processing
555 configuration file processing
559 access control list processing
563 connections, LDAP operations, results (recommended)
567 stats log entries sent
571 print communication with shell backends
583 \"data indexing (unused)
591 only messages that get logged whatever log level is set
594 The desired log level can be input as a single integer that combines
595 the (ORed) desired levels, both in decimal or in hexadecimal notation,
596 as a list of integers (that are ORed internally),
597 or as a list of the names that are shown between brackets, such that
610 can be used as a shortcut to enable logging at all levels (equivalent to -1).
613 or the equivalent integer representation, causes those messages
614 that are logged regardless of the configured loglevel to be logged.
615 In fact, if loglevel is set to 0, no logging occurs,
618 level is required to have high priority messages logged.
620 The loglevel defaults to \fBstats\fP.
621 This level should usually also be included when using other loglevels, to
622 help analyze the logs.
625 .B moduleload <filename>
626 Specify the name of a dynamically loadable module to load. The filename
627 may be an absolute path name or a simple filename. Non-absolute names
628 are searched for in the directories specified by the
630 option. This option and the
632 option are only usable if slapd was compiled with --enable-modules.
634 .B modulepath <pathspec>
635 Specify a list of directories to search for loadable modules. Typically
636 the path is colon-separated but this depends on the operating system.
639 .B objectclass "(\ <oid>\
641 [DESC\ <description>]\
644 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
645 [MUST\ <oids>] [MAY\ <oids>] )"
647 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
648 The slapd parser extends the RFC 4512 definition by allowing string
649 forms as well as numeric OIDs to be used for the object class OID.
653 description.) Object classes are "STRUCTURAL" by default.
656 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
657 Define a string name that equates to the given OID. The string can be used
658 in place of the numeric OID in objectclass and attribute definitions. The
659 name can also be used with a suffix of the form ":xx" in which case the
660 value "oid.xx" will be used.
662 .B password-hash <hash> [<hash>...]
663 This option configures one or more hashes to be used in generation of user
664 passwords stored in the userPassword attribute during processing of
665 LDAP Password Modify Extended Operations (RFC 3062).
666 The <hash> must be one of
680 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
685 use the MD5 algorithm (RFC 1321), the latter with a seed.
692 indicates that the new password should be
693 added to userPassword as clear text.
695 Note that this option does not alter the normal user applications
696 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
698 .B password\-crypt\-salt\-format <format>
699 Specify the format of the salt passed to
701 when generating {CRYPT} passwords (see
703 during processing of LDAP Password Modify Extended Operations (RFC 3062).
705 This string needs to be in
707 format and may include one (and only one) %s conversion.
708 This conversion will be substituted with a string of random
709 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
710 provides a two character salt and "$1$%.8s" tells some
711 versions of crypt(3) to use an MD5 algorithm and provides
712 8 random characters of salt. The default is "%s", which
713 provides 31 characters of salt.
715 .B pidfile <filename>
716 The ( absolute ) name of a file that will hold the
718 server's process ID ( see
720 ) if started without the debugging command line option.
723 Specify the referral to pass back when
725 cannot find a local database to handle a request.
726 If specified multiple times, each url is provided.
728 .B require <conditions>
729 Specify a set of conditions (separated by white space) to
730 require (default none).
731 The directive may be specified globally and/or per-database;
732 databases inherit global conditions, so per-database specifications
735 requires bind operation prior to directory operations.
737 requires session to be using LDAP version 3.
739 requires authentication prior to directory operations.
741 requires SASL authentication prior to directory operations.
743 requires strong authentication prior to directory operations.
744 The strong keyword allows protected "simple" authentication
745 as well as SASL authentication.
747 may be used to require no conditions (useful to clear out globally
748 set conditions within a particular database); it must occur first
749 in the list of conditions.
751 .B reverse-lookup on | off
752 Enable/disable client name unverified reverse lookup (default is
754 if compiled with --enable-rlookups).
757 Specify the name of an LDIF(5) file containing user defined attributes
758 for the root DSE. These attributes are returned in addition to the
759 attributes normally produced by slapd.
761 The root DSE is an entry with information about the server and its
762 capabilities, in operational attributes.
763 It has the empty DN, and can be read with e.g.:
765 ldapsearch -x -b "" -s base "+"
767 See RFC 4512 section 5.1 for details.
770 Used to specify the fully qualified domain name used for SASL processing.
772 .B sasl-realm <realm>
773 Specify SASL realm. Default is empty.
775 .B sasl-secprops <properties>
776 Used to specify Cyrus SASL security properties.
779 flag (without any other properties) causes the flag properties
780 default, "noanonymous,noplain", to be cleared.
783 flag disables mechanisms susceptible to simple passive attacks.
786 flag disables mechanisms susceptible to active attacks.
789 flag disables mechanisms susceptible to passive dictionary attacks.
792 flag disables mechanisms which support anonymous login.
795 flag require forward secrecy between sessions.
798 require mechanisms which pass client credentials (and allow
799 mechanisms which can pass credentials to do so).
802 property specifies the minimum acceptable
803 .I security strength factor
804 as an integer approximate to effective key length used for
805 encryption. 0 (zero) implies no protection, 1 implies integrity
806 protection only, 56 allows DES or other weak ciphers, 112
807 allows triple DES and other strong ciphers, 128 allows RC4,
808 Blowfish and other modern strong ciphers. The default is 0.
811 property specifies the maximum acceptable
812 .I security strength factor
813 as an integer (see minssf description). The default is INT_MAX.
816 property specifies the maximum security layer receive buffer
817 size allowed. 0 disables security layers. The default is 65536.
820 Specify the distinguished name for the subschema subentry that
821 controls the entries on this server. The default is "cn=Subschema".
823 .B security <factors>
824 Specify a set of security strength factors (separated by white space)
828 option for a description of security strength factors).
829 The directive may be specified globally and/or per-database.
831 specifies the overall security strength factor.
833 specifies the transport security strength factor.
835 specifies the TLS security strength factor.
837 specifies the SASL security strength factor.
839 specifies the overall security strength factor to require for
841 .B update_transport=<n>
842 specifies the transport security strength factor to require for
845 specifies the TLS security strength factor to require for
848 specifies the SASL security strength factor to require for
851 specifies the security strength factor required for
853 username/password authentication.
856 factor is measure of security provided by the underlying transport,
857 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
859 .B serverID <integer> [<URL>]
860 Specify an integer ID from 0 to 4095 for this server (limited
861 to 3 hexadecimal digits).
863 required when using multimaster replication and each master must have a
864 unique ID. If the URL is provided, this directive may be specified
865 multiple times, providing a complete list of participating servers
866 and their IDs. The fully qualified hostname of each server should be
867 used in the supplied URLs. The IDs are used in the "replica id" field
868 of all CSNs generated by the specified server. The default value is zero.
875 .B sizelimit {<integer>|unlimited}
877 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
878 Specify the maximum number of entries to return from a search operation.
879 The default size limit is 500.
882 to specify no limits.
883 The second format allows a fine grain setting of the size limits.
884 Extra args can be added on the same line.
887 for an explanation of the different flags.
889 .B sockbuf_max_incoming <integer>
890 Specify the maximum incoming LDAP PDU size for anonymous sessions.
891 The default is 262143.
893 .B sockbuf_max_incoming_auth <integer>
894 Specify the maximum incoming LDAP PDU size for authenticated sessions.
895 The default is 4194303.
897 .B sortvals <attr> [...]
898 Specify a list of multi-valued attributes whose values will always
899 be maintained in sorted order. Using this option will allow Modify,
900 Compare, and filter evaluations on these attributes to be performed
901 more efficiently. The resulting sort order depends on the
902 attributes' syntax and matching rules and may not correspond to
903 lexical order or any other recognizable order.
906 Specify the maximum size of the primary thread pool.
907 The default is 16; the minimum value is 2.
909 .B timelimit {<integer>|unlimited}
911 .B timelimit time[.{soft|hard}]=<integer> [...]
912 Specify the maximum number of seconds (in real time)
914 will spend answering a search request. The default time limit is 3600.
917 to specify no limits.
918 The second format allows a fine grain setting of the time limits.
919 Extra args can be added on the same line.
922 for an explanation of the different flags.
924 .B tool-threads <integer>
925 Specify the maximum number of threads to use in tool mode.
926 This should not be greater than the number of CPUs in the system.
928 .\"ucdata-path is obsolete / ignored...
930 .\".B ucdata-path <path>
931 .\"Specify the path to the directory containing the Unicode character
932 .\"tables. The default path is DATADIR/ucdata.
936 is built with support for Transport Layer Security, there are more options
939 .B TLSCipherSuite <cipher-suite-spec>
940 Permits configuring what ciphers will be accepted and the preference order.
941 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
943 TLSCipherSuite HIGH:MEDIUM:+SSLv2
945 To check what ciphers a given spec selects, use:
948 openssl ciphers -v <cipher-suite-spec>
951 To obtain the list of ciphers in GNUtls use:
958 .B TLSCACertificateFile <filename>
959 Specifies the file that contains certificates for all of the Certificate
964 .B TLSCACertificatePath <path>
965 Specifies the path of a directory that contains Certificate Authority
966 certificates in separate individual files. Usually only one of this
967 or the TLSCACertificateFile is used. This directive is not supported
970 .B TLSCertificateFile <filename>
971 Specifies the file that contains the
975 .B TLSCertificateKeyFile <filename>
976 Specifies the file that contains the
978 server private key that matches the certificate stored in the
979 .B TLSCertificateFile
980 file. Currently, the private key must not be protected with a password, so
981 it is of critical importance that it is protected carefully.
983 .B TLSDHParamFile <filename>
984 This directive specifies the file that contains parameters for Diffie-Hellman
985 ephemeral key exchange. This is required in order to use a DSA certificate on
986 the server. If multiple sets of parameters are present in the file, all of
987 them will be processed. Note that setting this option may also enable
988 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
989 You should append "!ADH" to your cipher suites if you have changed them
990 from the default, otherwise no certificate exchanges or verification will
991 be done. When using GNUtls these parameters are always generated randomly so
992 this directive is ignored.
994 .B TLSRandFile <filename>
995 Specifies the file to obtain random bits from when /dev/[u]random
996 is not available. Generally set to the name of the EGD/PRNGD socket.
997 The environment variable RANDFILE can also be used to specify the filename.
998 This directive is ignored with GNUtls.
1000 .B TLSVerifyClient <level>
1001 Specifies what checks to perform on client certificates in an
1002 incoming TLS session, if any.
1005 can be specified as one of the following keywords:
1009 This is the default.
1011 will not ask the client for a certificate.
1014 The client certificate is requested. If no certificate is provided,
1015 the session proceeds normally. If a bad certificate is provided,
1016 it will be ignored and the session proceeds normally.
1019 The client certificate is requested. If no certificate is provided,
1020 the session proceeds normally. If a bad certificate is provided,
1021 the session is immediately terminated.
1023 .B demand | hard | true
1024 These keywords are all equivalent, for compatibility reasons.
1025 The client certificate is requested. If no certificate is provided,
1026 or a bad certificate is provided, the session is immediately terminated.
1028 Note that a valid client certificate is required in order to use the
1029 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1032 setting must be chosen to enable SASL EXTERNAL authentication.
1035 .B TLSCRLCheck <level>
1036 Specifies if the Certificate Revocation List (CRL) of the CA should be
1037 used to verify if the client certificates have not been revoked. This
1039 .B TLSCACertificatePath
1040 parameter to be set. This directive is ignored with GNUtls.
1042 can be specified as one of the following keywords:
1046 No CRL checks are performed
1049 Check the CRL of the peer certificate
1052 Check the CRL for a whole certificate chain
1055 .B TLSCRLFile <filename>
1056 Specifies a file containing a Certificate Revocation List to be used
1057 for verifying that certificates have not been revoked. This directive is
1058 only valid when using GNUtls.
1059 .SH GENERAL BACKEND OPTIONS
1060 Options in this section only apply to the configuration file section
1061 for the specified backend. They are supported by every
1064 .B backend <databasetype>
1065 Mark the beginning of a backend definition. <databasetype>
1082 depending on which backend will serve the database.
1084 .SH GENERAL DATABASE OPTIONS
1085 Options in this section only apply to the configuration file section
1086 for the database in which they are defined. They are supported by every
1087 type of backend. Note that the
1091 option are mandatory for each database.
1093 .B database <databasetype>
1094 Mark the beginning of a new database instance definition. <databasetype>
1111 depending on which backend will serve the database.
1114 Controls whether the database will be used to answer
1115 queries. A database that is hidden will never be
1116 selected to answer any queries, and any suffix configured
1117 on the database will be ignored in checks for conflicts
1118 with other databases. By default, hidden is off.
1123 will automatically maintain the
1124 modifiersName, modifyTimestamp, creatorsName, and
1125 createTimestamp attributes for entries. It also controls
1126 the entryCSN and entryUUID attributes, which are needed
1127 by the syncrepl provider. By default, lastmod is on.
1129 .B limits <who> <limit> [<limit> [...]]
1130 Specify time and size limits based on who initiated an operation.
1137 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1143 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1148 matches all unauthenticated clients.
1151 matches all authenticated clients;
1154 dn pattern is assumed unless otherwise specified by qualifying
1155 the (optional) key string
1161 (which are synonyms), to require an exact match; with
1163 to require exactly one level of depth match; with
1165 to allow any level of depth match, including the exact match; with
1167 to allow any level of depth match, not including the exact match;
1169 explicitly requires the (default) match based on POSIX (''extended'')
1170 regular expression pattern.
1173 matches unbound operations; the
1176 The same behavior is obtained by using the
1183 with the optional objectClass
1189 sets the limits for any DN listed in the values of the
1195 group objectClass (default
1197 whose DN exactly matches
1200 The currently supported limits are
1205 The syntax for time limits is
1206 .BR time[.{soft|hard}]=<integer> ,
1209 is the number of seconds slapd will spend answering a search request.
1210 If no time limit is explicitly requested by the client, the
1212 limit is used; if the requested time limit exceeds the
1215 .\".I "Administrative limit exceeded"
1216 .\"error is returned.
1217 limit, the value of the limit is used instead.
1220 limit is set to the keyword
1222 the soft limit is used in either case; if it is set to the keyword
1224 no hard limit is enforced.
1225 Explicit requests for time limits smaller or equal to the
1228 If no limit specifier is set, the value is assigned to the
1234 to preserve the original behavior.
1236 The syntax for size limits is
1237 .BR size[.{soft|hard|unchecked}]=<integer> ,
1240 is the maximum number of entries slapd will return answering a search
1242 If no size limit is explicitly requested by the client, the
1244 limit is used; if the requested size limit exceeds the
1247 .\".I "Administrative limit exceeded"
1248 .\"error is returned.
1249 limit, the value of the limit is used instead.
1252 limit is set to the keyword
1254 the soft limit is used in either case; if it is set to the keyword
1256 no hard limit is enforced.
1257 Explicit requests for size limits smaller or equal to the
1262 specifier sets a limit on the number of candidates a search request is allowed
1264 The rationale behind it is that searches for non-properly indexed
1265 attributes may result in large sets of candidates, which must be
1268 to determine whether they match the search filter or not.
1271 limit provides a means to drop such operations before they are even
1273 If the selected candidates exceed the
1275 limit, the search will abort with
1276 .IR "Unwilling to perform" .
1277 If it is set to the keyword
1279 no limit is applied (the default).
1282 the search is not even performed; this can be used to disallow searches
1283 for a specific set of users.
1284 If no limit specifier is set, the value is assigned to the
1290 to preserve the original behavior.
1292 In case of no match, the global limits are used.
1293 The default values are the same of
1302 control is requested, the
1304 size limit is used by default, because the request of a specific page size
1305 is considered an explicit request for a limitation on the number
1306 of entries to be returned.
1307 However, the size limit applies to the total count of entries returned within
1308 the search, and not to a single page.
1309 Additional size limits may be enforced; the syntax is
1310 .BR size.pr={<integer>|noEstimate|unlimited} ,
1313 is the max page size if no explicit limit is set; the keyword
1315 inhibits the server from returning an estimate of the total number
1316 of entries that might be returned
1317 (note: the current implementation does not return any estimate).
1320 indicates that no limit is applied to the pagedResults control page size.
1322 .B size.prtotal={<integer>|unlimited|disabled}
1323 allows to set a limit on the total number of entries that a pagedResults
1324 control allows to return.
1325 By default it is set to the
1330 is the max number of entries that the whole search with pagedResults control
1334 to allow unlimited number of entries to be returned, e.g. to allow
1335 the use of the pagedResults control as a means to circumvent size
1336 limitations on regular searches; the keyword
1338 disables the control, i.e. no paged results can be returned.
1339 Note that the total number of entries returned when the pagedResults control
1340 is requested cannot exceed the
1342 size limit of regular searches unless extended by the
1346 The \fBlimits\fP statement is typically used to let an unlimited
1347 number of entries be returned by searches performed
1348 with the identity used by the consumer for synchronization purposes
1349 by means of the RFC 4533 LDAP Content Synchronization protocol
1350 (see \fBsyncrepl\fP for details).
1353 .B maxderefdepth <depth>
1354 Specifies the maximum number of aliases to dereference when trying to
1355 resolve an entry, used to avoid infinite alias loops. The default is 15.
1357 .B mirrormode on | off
1358 This option puts a replica database into "mirror" mode. Update
1359 operations will be accepted from any user, not just the updatedn. The
1360 database must already be configured as a syncrepl consumer
1361 before this keyword may be set. This mode also requires a
1363 (see above) to be configured.
1364 By default, mirrormode is off.
1366 .B monitoring on | off
1367 This option enables database-specific monitoring in the entry related
1368 to the current database in the "cn=Databases,cn=Monitor" subtree
1369 of the monitor database, if the monitor database is enabled.
1370 Currently, only the BDB and the HDB databases provide database-specific
1372 The default depends on the backend type.
1374 .B overlay <overlay-name>
1375 Add the specified overlay to this database. An overlay is a piece of
1376 code that intercepts database operations in order to extend or change
1377 them. Overlays are pushed onto
1378 a stack over the database, and so they will execute in the reverse
1379 of the order in which they were configured and the database itself
1380 will receive control last of all. See the
1381 .BR slapd.overlays (5)
1382 manual page for an overview of the available overlays.
1383 Note that all of the database's
1384 regular settings should be configured before any overlay settings.
1386 .B readonly on | off
1387 This option puts the database into "read-only" mode. Any attempts to
1388 modify the database will return an "unwilling to perform" error. By
1389 default, readonly is off.
1392 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1393 .B [starttls=yes|critical]
1394 .B [suffix=<suffix> [...]]
1395 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1396 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1397 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1398 .B [attrs[!]=<attr list>]
1400 Specify a replication site for this database. Refer to the "OpenLDAP
1401 Administrator's Guide" for detailed information on setting up a replicated
1403 directory service. Zero or more
1405 instances can be used to select the subtrees that will be replicated
1406 (defaults to all the database).
1408 is deprecated in favor of the
1412 allows the replica LDAP server to be specified as an LDAP URI.
1417 requires the options
1421 and should only be used when adequate security services
1422 (e.g TLS or IPSEC) are in place. A
1428 Specific security properties (as with the
1430 keyword above) for a SASL bind can be set with the
1432 option. A non-default SASL realm can be set with the
1437 will use Kerberos, a kerberos instance should be given in
1441 can be given after the
1443 keyword to allow the selective replication of the listed attributes only;
1446 mark is used, the list is considered exclusive, i.e. the listed attributes
1448 If an objectClass is listed, all the related attributes
1449 are (are not) replicated.
1452 .B restrict <oplist>
1453 Specify a whitespace separated list of operations that are restricted.
1454 If defined inside a database specification, restrictions apply only
1455 to that database, otherwise they are global.
1456 Operations can be any of
1461 .BR extended[=<OID>] ,
1465 or the special pseudo-operations
1469 which respectively summarize read and write operations.
1477 keyword allows to indicate the OID of the specific operation
1481 Specify the distinguished name that is not subject to access control
1482 or administrative limit restrictions for operations on this database.
1483 This DN may or may not be associated with an entry. An empty root
1484 DN (the default) specifies no root access is to be granted. It is
1485 recommended that the rootdn only be specified when needed (such as
1486 when initially populating a database). If the rootdn is within
1487 a namingContext (suffix) of the database, a simple bind password
1488 may also be provided using the
1490 directive. Many optional features, including syncrepl, require the
1491 rootdn to be defined for the database.
1493 .B rootpw <password>
1494 Specify a password (or hash of the password) for the rootdn. The
1495 password can only be set if the rootdn is within the namingContext
1496 (suffix) of the database.
1497 This option accepts all RFC 2307 userPassword formats known to
1500 description) as well as cleartext.
1502 may be used to generate a hash of a password. Cleartext
1503 and \fB{CRYPT}\fP passwords are not recommended. If empty
1504 (the default), authentication of the root DN is by other means
1505 (e.g. SASL). Use of SASL is encouraged.
1507 .B suffix <dn suffix>
1508 Specify the DN suffix of queries that will be passed to this
1509 backend database. Multiple suffix lines can be given and at least one is
1510 required for each database definition.
1511 If the suffix of one database is "inside" that of another, the database
1512 with the inner suffix must come first in the configuration file.
1514 .B subordinate [advertise]
1515 Specify that the current backend database is a subordinate of another
1516 backend database. A subordinate database may have only one suffix. This
1517 option may be used to glue multiple databases into a single namingContext.
1518 If the suffix of the current database is within the namingContext of a
1519 superior database, searches against the superior database will be
1520 propagated to the subordinate as well. All of the databases
1521 associated with a single namingContext should have identical rootdns.
1522 Behavior of other LDAP operations is unaffected by this setting. In
1523 particular, it is not possible to use moddn to move an entry from
1524 one subordinate to another subordinate within the namingContext.
1526 If the optional \fBadvertise\fP flag is supplied, the naming context of
1527 this database is advertised in the root DSE. The default is to hide this
1528 database context, so that only the superior context is visible.
1535 are used on the superior database, any glued subordinates that support
1536 these tools are opened as well.
1538 Databases that are glued together should usually be configured with the
1539 same indices (assuming they support indexing), even for attributes that
1540 only exist in some of these databases. In general, all of the glued
1541 databases should be configured as similarly as possible, since the intent
1542 is to provide the appearance of a single directory.
1544 Note that the \fIsubordinate\fP functionality is implemented internally
1545 by the \fIglue\fP overlay and as such its behavior will interact with other
1546 overlays in use. By default, the glue overlay is automatically configured as
1547 the last overlay on the superior backend. Its position on the backend
1548 can be explicitly configured by setting an \fBoverlay glue\fP directive
1549 at the desired position. This explicit configuration is necessary e.g.
1550 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1551 in order to work over all of the glued databases. E.g.
1555 suffix dc=example,dc=com
1563 .B syncrepl rid=<replica ID>
1564 .B provider=ldap[s]://<hostname>[:port]
1565 .B searchbase=<base DN>
1566 .B [type=refreshOnly|refreshAndPersist]
1567 .B [interval=dd:hh:mm:ss]
1568 .B [retry=[<retry interval> <# of retries>]+]
1569 .B [filter=<filter str>]
1570 .B [scope=sub|one|base|subord]
1571 .B [attrs=<attr list>]
1573 .B [sizelimit=<limit>]
1574 .B [timelimit=<limit>]
1575 .B [schemachecking=on|off]
1576 .B [bindmethod=simple|sasl]
1578 .B [saslmech=<mech>]
1579 .B [authcid=<identity>]
1580 .B [authzid=<identity>]
1581 .B [credentials=<passwd>]
1583 .B [secprops=<properties>]
1584 .B [starttls=yes|critical]
1585 .B [tls_cert=<file>]
1587 .B [tls_cacert=<file>]
1588 .B [tls_cacertdir=<path>]
1589 .B [tls_reqcert=never|allow|try|demand]
1590 .B [tls_ciphersuite=<ciphers>]
1591 .B [tls_crlcheck=none|peer|all]
1592 .B [logbase=<base DN>]
1593 .B [logfilter=<filter str>]
1594 .B [syncdata=default|accesslog|changelog]
1596 Specify the current database as a replica which is kept up-to-date with the
1597 master content by establishing the current
1599 as a replication consumer site running a
1602 The replica content is kept synchronized to the master content using
1603 the LDAP Content Synchronization protocol. Refer to the
1604 "OpenLDAP Administrator's Guide" for detailed information on
1605 setting up a replicated
1607 directory service using the
1612 identifies the current
1614 directive within the replication consumer site.
1615 It is a non-negative integer not greater than 4095 (limited
1616 to three hexadecimal digits).
1619 specifies the replication provider site containing the master content
1620 as an LDAP URI. If <port> is not given, the standard LDAP port number
1621 (389 or 636) is used.
1625 replica is defined using a search
1626 specification as its result set. The consumer
1628 will send search requests to the provider
1630 according to the search specification. The search specification includes
1631 .BR searchbase ", " scope ", " filter ", " attrs ", " attrsonly ", " sizelimit ", "
1634 parameters as in the normal search specification.
1635 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1636 \fB(objectclass=*)\fP, while there is no default \fBsearchbase\fP. The
1637 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1638 attributes, and \fBattrsonly\fP is unset by default.
1639 The \fBsizelimit\fP and \fBtimelimit\fP only
1640 accept "unlimited" and positive integers, and both default to "unlimited".
1641 The \fBsizelimit\fP and \fBtimelimit\fP parameters define
1642 a consumer requested limitation on the number of entries that can be returned
1643 by the LDAP Content Synchronization operation; as such, it is intended
1644 to implement partial replication based on the size of the replicated database
1645 and on the time required by the synchronization.
1646 Note, however, that any provider-side limits for the replication identity
1647 will be enforced by the provider regardless of the limits requested
1648 by the LDAP Content Synchronization operation, much like for any other
1651 The LDAP Content Synchronization protocol has two operation types.
1654 operation, the next synchronization search operation
1655 is periodically rescheduled at an interval time (specified by
1657 parameter; 1 day by default)
1658 after each synchronization operation finishes.
1660 .B refreshAndPersist
1661 operation, a synchronization search remains persistent in the provider slapd.
1662 Further updates to the master replica will generate
1663 .B searchResultEntry
1664 to the consumer slapd as the search responses to the persistent
1665 synchronization search.
1667 If an error occurs during replication, the consumer will attempt to
1668 reconnect according to the
1670 parameter which is a list of the <retry interval> and <# of retries> pairs.
1671 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1672 for the first 10 times and then retry every 300 seconds for the next 3
1673 times before stop retrying. The `+' in <# of retries> means indefinite
1674 number of retries until success.
1676 The schema checking can be enforced at the LDAP Sync
1677 consumer site by turning on the
1679 parameter. The default is \fBoff\fP.
1680 Schema checking \fBon\fP means that replicated entries must have
1681 a structural objectClass, must obey to objectClass requirements
1682 in terms of required/allowed attributes, and that naming attributes
1683 and distinguished values must be present.
1684 As a consequence, schema checking should be \fBoff\fP when partial
1685 replication is used.
1691 requires the options
1695 and should only be used when adequate security services
1696 (e.g. TLS or IPSEC) are in place.
1697 .B REMEMBER: simple bind credentials must be in cleartext!
1704 Depending on the mechanism, an authentication identity and/or
1705 credentials can be specified using
1711 parameter may be used to specify an authorization identity.
1712 Specific security properties (as with the
1714 keyword above) for a SASL bind can be set with the
1716 option. A non default SASL realm can be set with the
1719 The identity used for synchronization by the consumer should be allowed
1720 to receive an unlimited number of entries in response to a search request.
1721 The provider, other than allow authentication of the syncrepl identity,
1722 should grant that identity appropriate access privileges to the data
1723 that is being replicated (\fBaccess\fP directive), and appropriate time
1725 This can be accomplished by either allowing unlimited \fBsizelimit\fP
1726 and \fBtimelimit\fP, or by setting an appropriate \fBlimits\fP statement
1727 in the consumer's configuration (see \fBsizelimit\fP and \fBlimits\fP
1732 parameter specifies use of the StartTLS extended operation
1733 to establish a TLS session before Binding to the provider. If the
1735 argument is supplied, the session will be aborted if the StartTLS request
1736 fails. Otherwise the syncrepl session continues without TLS. The
1737 tls_reqcert setting defaults to "demand" and the other TLS settings
1738 default to the same as the main slapd TLS settings.
1740 Rather than replicating whole entries, the consumer can query logs of
1741 data modifications. This mode of operation is referred to as \fIdelta
1742 syncrepl\fP. In addition to the above parameters, the
1746 parameters must be set appropriately for the log that will be used. The
1748 parameter must be set to either "accesslog" if the log conforms to the
1749 .BR slapo-accesslog (5)
1750 log format, or "changelog" if the log conforms
1751 to the obsolete \fIchangelog\fP format. If the
1753 parameter is omitted or set to "default" then the log parameters are
1758 This option is only applicable in a slave
1760 It specifies the DN permitted to update (subject to access controls)
1761 the replica. It is only needed in certain push-mode
1762 replication scenarios. Generally, this DN
1769 Specify the referral to pass back when
1771 is asked to modify a replicated local database.
1772 If specified multiple times, each url is provided.
1774 .SH DATABASE-SPECIFIC OPTIONS
1775 Each database may allow specific configuration options; they are
1776 documented separately in the backends' manual pages. See the
1777 .BR slapd.backends (5)
1778 manual page for an overview of available backends.
1781 Here is a short example of a configuration file:
1785 include SYSCONFDIR/schema/core.schema
1786 pidfile LOCALSTATEDIR/run/slapd.pid
1788 # Subtypes of "name" (e.g. "cn" and "ou") with the
1789 # option ";x-hidden" can be searched for/compared,
1790 # but are not shown. See \fBslapd.access\fP(5).
1791 attributeoptions x-hidden lang-
1792 access to attrs=name;x-hidden by * =cs
1794 # Protect passwords. See \fBslapd.access\fP(5).
1795 access to attrs=userPassword by * auth
1796 # Read access to other attributes and entries.
1797 access to * by * read
1800 suffix "dc=our-domain,dc=com"
1801 # The database directory MUST exist prior to
1802 # running slapd AND should only be accessible
1803 # by the slapd/tools. Mode 0700 recommended.
1804 directory LOCALSTATEDIR/openldap-data
1805 # Indices to maintain
1806 index objectClass eq
1807 index cn,sn,mail pres,eq,approx,sub
1809 # We serve small clients that do not handle referrals,
1810 # so handle remote lookups on their behalf.
1813 uri ldap://ldap.some-server.com/
1818 "OpenLDAP Administrator's Guide" contains a longer annotated
1819 example of a configuration file.
1820 The original ETCDIR/slapd.conf is another example.
1824 default slapd configuration file
1827 .BR slapd\-config (5),
1828 .BR slapd.access (5),
1829 .BR slapd.backends (5),
1830 .BR slapd.overlays (5),
1831 .BR slapd.plugin (5),
1832 .BR slapd.replog (5),
1843 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1844 .SH ACKNOWLEDGEMENTS
projects / openldap / blob