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
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_intlen <integer>
474 Specify the key length for ordered integer indices. The most significant
475 bytes of the binary integer will be used for index keys. The default
476 value is 4, which provides exact indexing for 31 bit values.
477 A floating point representation is used to index too large values.
479 .B index_substr_if_minlen <integer>
480 Specify the minimum length for subinitial and subfinal indices. An
481 attribute value must have at least this many characters in order to be
482 processed by the indexing functions. The default is 2.
484 .B index_substr_if_maxlen <integer>
485 Specify the maximum length for subinitial and subfinal indices. Only
486 this many characters of an attribute value will be processed by the
487 indexing functions; any excess characters are ignored. The default is 4.
489 .B index_substr_any_len <integer>
490 Specify the length used for subany indices. An attribute value must have
491 at least this many characters in order to be processed. Attribute values
492 longer than this length will be processed in segments of this length. The
493 default is 4. The subany index will also be used in subinitial and
494 subfinal index lookups when the filter string is longer than the
495 .I index_substr_if_maxlen
498 .B index_substr_any_step <integer>
499 Specify the steps used in subany index lookups. This value sets the offset
500 for the segments of a filter string that are processed for a subany index
501 lookup. The default is 2. For example, with the default values, a search
502 using this filter "cn=*abcdefgh*" would generate index lookups for
503 "abcd", "cdef", and "efgh".
506 Note: Indexing support depends on the particular backend in use. Also,
507 changing these settings will generally require deleting any indices that
508 depend on these parameters and recreating them with
513 .B ldapsyntax "(\ <oid>\
514 [DESC\ <description>]\
515 [X-SUBST <substitute\-syntax>]\ )"
517 Specify an LDAP syntax using the LDAPv3 syntax defined in RFC 4512.
518 The slapd parser extends the RFC 4512 definition by allowing string
519 forms as well as numeric OIDs to be used for the syntax OID.
523 The slapd parser also honors the
525 extension (an OpenLDAP-specific extension), which allows to use the
527 statement to define a non-implemented syntax along with another syntax,
529 .IR substitute\-syntax ,
530 as its temporary replacement.
532 .I substitute\-syntax
534 This allows to define attribute types that make use of non-implemented syntaxes
535 using the correct syntax OID.
538 is used, this configuration statement would result in an error,
539 since no handlers would be associated to the resulting syntax structure.
544 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
545 such as those to the ldapi:// listener. For a description of SSF values,
549 option description. The default is 71.
551 .B logfile <filename>
552 Specify a file for recording debug log messages. By default these messages
553 only go to stderr and are not recorded anywhere else. Specifying a logfile
554 copies messages to both stderr and the logfile.
556 .B loglevel <integer> [...]
557 Specify the level at which debugging statements and operation
558 statistics should be syslogged (currently logged to the
560 LOG_LOCAL4 facility).
561 They must be considered subsystems rather than increasingly verbose
563 Some messages with higher priority are logged regardless
564 of the configured loglevel as soon as any logging is configured.
565 Log levels are additive, and available levels are:
576 debug packet handling
580 heavy trace debugging (function args)
584 connection management
588 print out packets sent and received
592 search filter processing
596 configuration file processing
600 access control list processing
604 connections, LDAP operations, results (recommended)
608 stats log entries sent
612 print communication with shell backends
624 \"data indexing (unused)
632 only messages that get logged whatever log level is set
635 The desired log level can be input as a single integer that combines
636 the (ORed) desired levels, both in decimal or in hexadecimal notation,
637 as a list of integers (that are ORed internally),
638 or as a list of the names that are shown between brackets, such that
651 can be used as a shortcut to enable logging at all levels (equivalent to -1).
654 or the equivalent integer representation, causes those messages
655 that are logged regardless of the configured loglevel to be logged.
656 In fact, if loglevel is set to 0, no logging occurs,
659 level is required to have high priority messages logged.
661 The loglevel defaults to \fBstats\fP.
662 This level should usually also be included when using other loglevels, to
663 help analyze the logs.
666 .B moduleload <filename>
667 Specify the name of a dynamically loadable module to load. The filename
668 may be an absolute path name or a simple filename. Non-absolute names
669 are searched for in the directories specified by the
671 option. This option and the
673 option are only usable if slapd was compiled with --enable-modules.
675 .B modulepath <pathspec>
676 Specify a list of directories to search for loadable modules. Typically
677 the path is colon-separated but this depends on the operating system.
680 .B objectclass "(\ <oid>\
682 [DESC\ <description>]\
685 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
686 [MUST\ <oids>] [MAY\ <oids>] )"
688 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
689 The slapd parser extends the RFC 4512 definition by allowing string
690 forms as well as numeric OIDs to be used for the object class OID.
694 description.) Object classes are "STRUCTURAL" by default.
697 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
698 Define a string name that equates to the given OID. The string can be used
699 in place of the numeric OID in objectclass and attribute definitions. The
700 name can also be used with a suffix of the form ":xx" in which case the
701 value "oid.xx" will be used.
703 .B password-hash <hash> [<hash>...]
704 This option configures one or more hashes to be used in generation of user
705 passwords stored in the userPassword attribute during processing of
706 LDAP Password Modify Extended Operations (RFC 3062).
707 The <hash> must be one of
721 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
726 use the MD5 algorithm (RFC 1321), the latter with a seed.
733 indicates that the new password should be
734 added to userPassword as clear text.
736 Note that this option does not alter the normal user applications
737 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
739 .B password\-crypt\-salt\-format <format>
740 Specify the format of the salt passed to
742 when generating {CRYPT} passwords (see
744 during processing of LDAP Password Modify Extended Operations (RFC 3062).
746 This string needs to be in
748 format and may include one (and only one) %s conversion.
749 This conversion will be substituted with a string of random
750 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
751 provides a two character salt and "$1$%.8s" tells some
752 versions of crypt(3) to use an MD5 algorithm and provides
753 8 random characters of salt. The default is "%s", which
754 provides 31 characters of salt.
756 .B pidfile <filename>
757 The ( absolute ) name of a file that will hold the
759 server's process ID ( see
761 ) if started without the debugging command line option.
764 Specify the referral to pass back when
766 cannot find a local database to handle a request.
767 If specified multiple times, each url is provided.
769 .B require <conditions>
770 Specify a set of conditions (separated by white space) to
771 require (default none).
772 The directive may be specified globally and/or per-database;
773 databases inherit global conditions, so per-database specifications
776 requires bind operation prior to directory operations.
778 requires session to be using LDAP version 3.
780 requires authentication prior to directory operations.
782 requires SASL authentication prior to directory operations.
784 requires strong authentication prior to directory operations.
785 The strong keyword allows protected "simple" authentication
786 as well as SASL authentication.
788 may be used to require no conditions (useful to clear out globally
789 set conditions within a particular database); it must occur first
790 in the list of conditions.
792 .B reverse-lookup on | off
793 Enable/disable client name unverified reverse lookup (default is
795 if compiled with --enable-rlookups).
798 Specify the name of an LDIF(5) file containing user defined attributes
799 for the root DSE. These attributes are returned in addition to the
800 attributes normally produced by slapd.
802 The root DSE is an entry with information about the server and its
803 capabilities, in operational attributes.
804 It has the empty DN, and can be read with e.g.:
806 ldapsearch -x -b "" -s base "+"
808 See RFC 4512 section 5.1 for details.
811 Used to specify the fully qualified domain name used for SASL processing.
813 .B sasl-realm <realm>
814 Specify SASL realm. Default is empty.
816 .B sasl-secprops <properties>
817 Used to specify Cyrus SASL security properties.
820 flag (without any other properties) causes the flag properties
821 default, "noanonymous,noplain", to be cleared.
824 flag disables mechanisms susceptible to simple passive attacks.
827 flag disables mechanisms susceptible to active attacks.
830 flag disables mechanisms susceptible to passive dictionary attacks.
833 flag disables mechanisms which support anonymous login.
836 flag require forward secrecy between sessions.
839 require mechanisms which pass client credentials (and allow
840 mechanisms which can pass credentials to do so).
843 property specifies the minimum acceptable
844 .I security strength factor
845 as an integer approximate to effective key length used for
846 encryption. 0 (zero) implies no protection, 1 implies integrity
847 protection only, 56 allows DES or other weak ciphers, 112
848 allows triple DES and other strong ciphers, 128 allows RC4,
849 Blowfish and other modern strong ciphers. The default is 0.
852 property specifies the maximum acceptable
853 .I security strength factor
854 as an integer (see minssf description). The default is INT_MAX.
857 property specifies the maximum security layer receive buffer
858 size allowed. 0 disables security layers. The default is 65536.
861 Specify the distinguished name for the subschema subentry that
862 controls the entries on this server. The default is "cn=Subschema".
864 .B security <factors>
865 Specify a set of security strength factors (separated by white space)
869 option for a description of security strength factors).
870 The directive may be specified globally and/or per-database.
872 specifies the overall security strength factor.
874 specifies the transport security strength factor.
876 specifies the TLS security strength factor.
878 specifies the SASL security strength factor.
880 specifies the overall security strength factor to require for
882 .B update_transport=<n>
883 specifies the transport security strength factor to require for
886 specifies the TLS security strength factor to require for
889 specifies the SASL security strength factor to require for
892 specifies the security strength factor required for
894 username/password authentication.
897 factor is measure of security provided by the underlying transport,
898 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
900 .B serverID <integer> [<URL>]
901 Specify an integer ID from 0 to 4095 for this server (limited
902 to 3 hexadecimal digits).
904 required when using multimaster replication and each master must have a
905 unique ID. Note that this requirement also applies to separate masters
906 contributing to a glued set of databases.
907 If the URL is provided, this directive may be specified
908 multiple times, providing a complete list of participating servers
909 and their IDs. The fully qualified hostname of each server should be
910 used in the supplied URLs. The IDs are used in the "replica id" field
911 of all CSNs generated by the specified server. The default value is zero.
918 .B sizelimit {<integer>|unlimited}
920 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
921 Specify the maximum number of entries to return from a search operation.
922 The default size limit is 500.
925 to specify no limits.
926 The second format allows a fine grain setting of the size limits.
927 Extra args can be added on the same line.
930 for an explanation of the different flags.
932 .B sockbuf_max_incoming <integer>
933 Specify the maximum incoming LDAP PDU size for anonymous sessions.
934 The default is 262143.
936 .B sockbuf_max_incoming_auth <integer>
937 Specify the maximum incoming LDAP PDU size for authenticated sessions.
938 The default is 4194303.
940 .B sortvals <attr> [...]
941 Specify a list of multi-valued attributes whose values will always
942 be maintained in sorted order. Using this option will allow Modify,
943 Compare, and filter evaluations on these attributes to be performed
944 more efficiently. The resulting sort order depends on the
945 attributes' syntax and matching rules and may not correspond to
946 lexical order or any other recognizable order.
949 Specify the maximum size of the primary thread pool.
950 The default is 16; the minimum value is 2.
952 .B timelimit {<integer>|unlimited}
954 .B timelimit time[.{soft|hard}]=<integer> [...]
955 Specify the maximum number of seconds (in real time)
957 will spend answering a search request. The default time limit is 3600.
960 to specify no limits.
961 The second format allows a fine grain setting of the time limits.
962 Extra args can be added on the same line.
965 for an explanation of the different flags.
967 .B tool-threads <integer>
968 Specify the maximum number of threads to use in tool mode.
969 This should not be greater than the number of CPUs in the system.
971 .\"ucdata-path is obsolete / ignored...
973 .\".B ucdata-path <path>
974 .\"Specify the path to the directory containing the Unicode character
975 .\"tables. The default path is DATADIR/ucdata.
979 is built with support for Transport Layer Security, there are more options
982 .B TLSCipherSuite <cipher-suite-spec>
983 Permits configuring what ciphers will be accepted and the preference order.
984 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
986 TLSCipherSuite HIGH:MEDIUM:+SSLv2
988 To check what ciphers a given spec selects, use:
991 openssl ciphers -v <cipher-suite-spec>
994 To obtain the list of ciphers in GNUtls use:
1001 .B TLSCACertificateFile <filename>
1002 Specifies the file that contains certificates for all of the Certificate
1007 .B TLSCACertificatePath <path>
1008 Specifies the path of a directory that contains Certificate Authority
1009 certificates in separate individual files. Usually only one of this
1010 or the TLSCACertificateFile is used. This directive is not supported
1013 .B TLSCertificateFile <filename>
1014 Specifies the file that contains the
1018 .B TLSCertificateKeyFile <filename>
1019 Specifies the file that contains the
1021 server private key that matches the certificate stored in the
1022 .B TLSCertificateFile
1023 file. Currently, the private key must not be protected with a password, so
1024 it is of critical importance that it is protected carefully.
1026 .B TLSDHParamFile <filename>
1027 This directive specifies the file that contains parameters for Diffie-Hellman
1028 ephemeral key exchange. This is required in order to use a DSA certificate on
1029 the server. If multiple sets of parameters are present in the file, all of
1030 them will be processed. Note that setting this option may also enable
1031 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
1032 You should append "!ADH" to your cipher suites if you have changed them
1033 from the default, otherwise no certificate exchanges or verification will
1034 be done. When using GNUtls these parameters are always generated randomly so
1035 this directive is ignored.
1037 .B TLSRandFile <filename>
1038 Specifies the file to obtain random bits from when /dev/[u]random
1039 is not available. Generally set to the name of the EGD/PRNGD socket.
1040 The environment variable RANDFILE can also be used to specify the filename.
1041 This directive is ignored with GNUtls.
1043 .B TLSVerifyClient <level>
1044 Specifies what checks to perform on client certificates in an
1045 incoming TLS session, if any.
1048 can be specified as one of the following keywords:
1052 This is the default.
1054 will not ask the client for a certificate.
1057 The client certificate is requested. If no certificate is provided,
1058 the session proceeds normally. If a bad certificate is provided,
1059 it will be ignored and the session proceeds normally.
1062 The client certificate is requested. If no certificate is provided,
1063 the session proceeds normally. If a bad certificate is provided,
1064 the session is immediately terminated.
1066 .B demand | hard | true
1067 These keywords are all equivalent, for compatibility reasons.
1068 The client certificate is requested. If no certificate is provided,
1069 or a bad certificate is provided, the session is immediately terminated.
1071 Note that a valid client certificate is required in order to use the
1072 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1075 setting must be chosen to enable SASL EXTERNAL authentication.
1078 .B TLSCRLCheck <level>
1079 Specifies if the Certificate Revocation List (CRL) of the CA should be
1080 used to verify if the client certificates have not been revoked. This
1082 .B TLSCACertificatePath
1083 parameter to be set. This directive is ignored with GNUtls.
1085 can be specified as one of the following keywords:
1089 No CRL checks are performed
1092 Check the CRL of the peer certificate
1095 Check the CRL for a whole certificate chain
1098 .B TLSCRLFile <filename>
1099 Specifies a file containing a Certificate Revocation List to be used
1100 for verifying that certificates have not been revoked. This directive is
1101 only valid when using GNUtls.
1102 .SH GENERAL BACKEND OPTIONS
1103 Options in this section only apply to the configuration file section
1104 for the specified backend. They are supported by every
1107 .B backend <databasetype>
1108 Mark the beginning of a backend definition. <databasetype>
1125 depending on which backend will serve the database.
1127 .SH GENERAL DATABASE OPTIONS
1128 Options in this section only apply to the configuration file section
1129 for the database in which they are defined. They are supported by every
1130 type of backend. Note that the
1134 option are mandatory for each database.
1136 .B database <databasetype>
1137 Mark the beginning of a new database instance definition. <databasetype>
1154 depending on which backend will serve the database.
1157 Controls whether the database will be used to answer
1158 queries. A database that is hidden will never be
1159 selected to answer any queries, and any suffix configured
1160 on the database will be ignored in checks for conflicts
1161 with other databases. By default, hidden is off.
1166 will automatically maintain the
1167 modifiersName, modifyTimestamp, creatorsName, and
1168 createTimestamp attributes for entries. It also controls
1169 the entryCSN and entryUUID attributes, which are needed
1170 by the syncrepl provider. By default, lastmod is on.
1172 .B limits <who> <limit> [<limit> [...]]
1173 Specify time and size limits based on who initiated an operation.
1180 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1186 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1191 matches all unauthenticated clients.
1194 matches all authenticated clients;
1197 dn pattern is assumed unless otherwise specified by qualifying
1198 the (optional) key string
1204 (which are synonyms), to require an exact match; with
1206 to require exactly one level of depth match; with
1208 to allow any level of depth match, including the exact match; with
1210 to allow any level of depth match, not including the exact match;
1212 explicitly requires the (default) match based on POSIX (''extended'')
1213 regular expression pattern.
1216 matches unbound operations; the
1219 The same behavior is obtained by using the
1226 with the optional objectClass
1232 sets the limits for any DN listed in the values of the
1238 group objectClass (default
1240 whose DN exactly matches
1243 The currently supported limits are
1248 The syntax for time limits is
1249 .BR time[.{soft|hard}]=<integer> ,
1252 is the number of seconds slapd will spend answering a search request.
1253 If no time limit is explicitly requested by the client, the
1255 limit is used; if the requested time limit exceeds the
1258 .\".I "Administrative limit exceeded"
1259 .\"error is returned.
1260 limit, the value of the limit is used instead.
1263 limit is set to the keyword
1265 the soft limit is used in either case; if it is set to the keyword
1267 no hard limit is enforced.
1268 Explicit requests for time limits smaller or equal to the
1271 If no limit specifier is set, the value is assigned to the
1277 to preserve the original behavior.
1279 The syntax for size limits is
1280 .BR size[.{soft|hard|unchecked}]=<integer> ,
1283 is the maximum number of entries slapd will return answering a search
1285 If no size limit is explicitly requested by the client, the
1287 limit is used; if the requested size limit exceeds the
1290 .\".I "Administrative limit exceeded"
1291 .\"error is returned.
1292 limit, the value of the limit is used instead.
1295 limit is set to the keyword
1297 the soft limit is used in either case; if it is set to the keyword
1299 no hard limit is enforced.
1300 Explicit requests for size limits smaller or equal to the
1305 specifier sets a limit on the number of candidates a search request is allowed
1307 The rationale behind it is that searches for non-properly indexed
1308 attributes may result in large sets of candidates, which must be
1311 to determine whether they match the search filter or not.
1314 limit provides a means to drop such operations before they are even
1316 If the selected candidates exceed the
1318 limit, the search will abort with
1319 .IR "Unwilling to perform" .
1320 If it is set to the keyword
1322 no limit is applied (the default).
1325 the search is not even performed; this can be used to disallow searches
1326 for a specific set of users.
1327 If no limit specifier is set, the value is assigned to the
1333 to preserve the original behavior.
1335 In case of no match, the global limits are used.
1336 The default values are the same of
1345 control is requested, the
1347 size limit is used by default, because the request of a specific page size
1348 is considered an explicit request for a limitation on the number
1349 of entries to be returned.
1350 However, the size limit applies to the total count of entries returned within
1351 the search, and not to a single page.
1352 Additional size limits may be enforced; the syntax is
1353 .BR size.pr={<integer>|noEstimate|unlimited} ,
1356 is the max page size if no explicit limit is set; the keyword
1358 inhibits the server from returning an estimate of the total number
1359 of entries that might be returned
1360 (note: the current implementation does not return any estimate).
1363 indicates that no limit is applied to the pagedResults control page size.
1365 .B size.prtotal={<integer>|unlimited|disabled}
1366 allows to set a limit on the total number of entries that a pagedResults
1367 control allows to return.
1368 By default it is set to the
1373 is the max number of entries that the whole search with pagedResults control
1377 to allow unlimited number of entries to be returned, e.g. to allow
1378 the use of the pagedResults control as a means to circumvent size
1379 limitations on regular searches; the keyword
1381 disables the control, i.e. no paged results can be returned.
1382 Note that the total number of entries returned when the pagedResults control
1383 is requested cannot exceed the
1385 size limit of regular searches unless extended by the
1389 The \fBlimits\fP statement is typically used to let an unlimited
1390 number of entries be returned by searches performed
1391 with the identity used by the consumer for synchronization purposes
1392 by means of the RFC 4533 LDAP Content Synchronization protocol
1393 (see \fBsyncrepl\fP for details).
1396 .B maxderefdepth <depth>
1397 Specifies the maximum number of aliases to dereference when trying to
1398 resolve an entry, used to avoid infinite alias loops. The default is 15.
1400 .B mirrormode on | off
1401 This option puts a replica database into "mirror" mode. Update
1402 operations will be accepted from any user, not just the updatedn. The
1403 database must already be configured as a syncrepl consumer
1404 before this keyword may be set. This mode also requires a
1406 (see above) to be configured.
1407 By default, mirrormode is off.
1409 .B monitoring on | off
1410 This option enables database-specific monitoring in the entry related
1411 to the current database in the "cn=Databases,cn=Monitor" subtree
1412 of the monitor database, if the monitor database is enabled.
1413 Currently, only the BDB and the HDB databases provide database-specific
1415 The default depends on the backend type.
1417 .B overlay <overlay-name>
1418 Add the specified overlay to this database. An overlay is a piece of
1419 code that intercepts database operations in order to extend or change
1420 them. Overlays are pushed onto
1421 a stack over the database, and so they will execute in the reverse
1422 of the order in which they were configured and the database itself
1423 will receive control last of all. See the
1424 .BR slapd.overlays (5)
1425 manual page for an overview of the available overlays.
1426 Note that all of the database's
1427 regular settings should be configured before any overlay settings.
1429 .B readonly on | off
1430 This option puts the database into "read-only" mode. Any attempts to
1431 modify the database will return an "unwilling to perform" error. By
1432 default, readonly is off.
1434 .B restrict <oplist>
1435 Specify a whitespace separated list of operations that are restricted.
1436 If defined inside a database specification, restrictions apply only
1437 to that database, otherwise they are global.
1438 Operations can be any of
1443 .BR extended[=<OID>] ,
1447 or the special pseudo-operations
1451 which respectively summarize read and write operations.
1459 keyword allows to indicate the OID of the specific operation
1463 Specify the distinguished name that is not subject to access control
1464 or administrative limit restrictions for operations on this database.
1465 This DN may or may not be associated with an entry. An empty root
1466 DN (the default) specifies no root access is to be granted. It is
1467 recommended that the rootdn only be specified when needed (such as
1468 when initially populating a database). If the rootdn is within
1469 a namingContext (suffix) of the database, a simple bind password
1470 may also be provided using the
1472 directive. Many optional features, including syncrepl, require the
1473 rootdn to be defined for the database.
1475 .B rootpw <password>
1476 Specify a password (or hash of the password) for the rootdn. The
1477 password can only be set if the rootdn is within the namingContext
1478 (suffix) of the database.
1479 This option accepts all RFC 2307 userPassword formats known to
1482 description) as well as cleartext.
1484 may be used to generate a hash of a password. Cleartext
1485 and \fB{CRYPT}\fP passwords are not recommended. If empty
1486 (the default), authentication of the root DN is by other means
1487 (e.g. SASL). Use of SASL is encouraged.
1489 .B suffix <dn suffix>
1490 Specify the DN suffix of queries that will be passed to this
1491 backend database. Multiple suffix lines can be given and at least one is
1492 required for each database definition.
1493 If the suffix of one database is "inside" that of another, the database
1494 with the inner suffix must come first in the configuration file.
1496 .B subordinate [advertise]
1497 Specify that the current backend database is a subordinate of another
1498 backend database. A subordinate database may have only one suffix. This
1499 option may be used to glue multiple databases into a single namingContext.
1500 If the suffix of the current database is within the namingContext of a
1501 superior database, searches against the superior database will be
1502 propagated to the subordinate as well. All of the databases
1503 associated with a single namingContext should have identical rootdns.
1504 Behavior of other LDAP operations is unaffected by this setting. In
1505 particular, it is not possible to use moddn to move an entry from
1506 one subordinate to another subordinate within the namingContext.
1508 If the optional \fBadvertise\fP flag is supplied, the naming context of
1509 this database is advertised in the root DSE. The default is to hide this
1510 database context, so that only the superior context is visible.
1517 are used on the superior database, any glued subordinates that support
1518 these tools are opened as well.
1520 Databases that are glued together should usually be configured with the
1521 same indices (assuming they support indexing), even for attributes that
1522 only exist in some of these databases. In general, all of the glued
1523 databases should be configured as similarly as possible, since the intent
1524 is to provide the appearance of a single directory.
1526 Note that the \fIsubordinate\fP functionality is implemented internally
1527 by the \fIglue\fP overlay and as such its behavior will interact with other
1528 overlays in use. By default, the glue overlay is automatically configured as
1529 the last overlay on the superior backend. Its position on the backend
1530 can be explicitly configured by setting an \fBoverlay glue\fP directive
1531 at the desired position. This explicit configuration is necessary e.g.
1532 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1533 in order to work over all of the glued databases. E.g.
1537 suffix dc=example,dc=com
1545 .B syncrepl rid=<replica ID>
1546 .B provider=ldap[s]://<hostname>[:port]
1547 .B searchbase=<base DN>
1548 .B [type=refreshOnly|refreshAndPersist]
1549 .B [interval=dd:hh:mm:ss]
1550 .B [retry=[<retry interval> <# of retries>]+]
1551 .B [filter=<filter str>]
1552 .B [scope=sub|one|base|subord]
1553 .B [attrs=<attr list>]
1555 .B [sizelimit=<limit>]
1556 .B [timelimit=<limit>]
1557 .B [schemachecking=on|off]
1558 .B [network-timeout=<seconds>]
1559 .B [timeout=<seconds>]
1560 .B [bindmethod=simple|sasl]
1562 .B [saslmech=<mech>]
1563 .B [authcid=<identity>]
1564 .B [authzid=<identity>]
1565 .B [credentials=<passwd>]
1567 .B [secprops=<properties>]
1568 .B [starttls=yes|critical]
1569 .B [tls_cert=<file>]
1571 .B [tls_cacert=<file>]
1572 .B [tls_cacertdir=<path>]
1573 .B [tls_reqcert=never|allow|try|demand]
1574 .B [tls_ciphersuite=<ciphers>]
1575 .B [tls_crlcheck=none|peer|all]
1576 .B [logbase=<base DN>]
1577 .B [logfilter=<filter str>]
1578 .B [syncdata=default|accesslog|changelog]
1580 Specify the current database as a replica which is kept up-to-date with the
1581 master content by establishing the current
1583 as a replication consumer site running a
1586 The replica content is kept synchronized to the master content using
1587 the LDAP Content Synchronization protocol. Refer to the
1588 "OpenLDAP Administrator's Guide" for detailed information on
1589 setting up a replicated
1591 directory service using the
1596 identifies the current
1598 directive within the replication consumer site.
1599 It is a non-negative integer not greater than 4095 (limited
1600 to three hexadecimal digits).
1603 specifies the replication provider site containing the master content
1604 as an LDAP URI. If <port> is not given, the standard LDAP port number
1605 (389 or 636) is used.
1609 replica is defined using a search
1610 specification as its result set. The consumer
1612 will send search requests to the provider
1614 according to the search specification. The search specification includes
1615 .BR searchbase ", " scope ", " filter ", " attrs ", " attrsonly ", " sizelimit ", "
1618 parameters as in the normal search specification.
1619 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1620 \fB(objectclass=*)\fP, while there is no default \fBsearchbase\fP. The
1621 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1622 attributes, and \fBattrsonly\fP is unset by default.
1623 The \fBsizelimit\fP and \fBtimelimit\fP only
1624 accept "unlimited" and positive integers, and both default to "unlimited".
1625 The \fBsizelimit\fP and \fBtimelimit\fP parameters define
1626 a consumer requested limitation on the number of entries that can be returned
1627 by the LDAP Content Synchronization operation; as such, it is intended
1628 to implement partial replication based on the size of the replicated database
1629 and on the time required by the synchronization.
1630 Note, however, that any provider-side limits for the replication identity
1631 will be enforced by the provider regardless of the limits requested
1632 by the LDAP Content Synchronization operation, much like for any other
1635 The LDAP Content Synchronization protocol has two operation types.
1638 operation, the next synchronization search operation
1639 is periodically rescheduled at an interval time (specified by
1641 parameter; 1 day by default)
1642 after each synchronization operation finishes.
1644 .B refreshAndPersist
1645 operation, a synchronization search remains persistent in the provider slapd.
1646 Further updates to the master replica will generate
1647 .B searchResultEntry
1648 to the consumer slapd as the search responses to the persistent
1649 synchronization search.
1651 If an error occurs during replication, the consumer will attempt to
1652 reconnect according to the
1654 parameter which is a list of the <retry interval> and <# of retries> pairs.
1655 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1656 for the first 10 times and then retry every 300 seconds for the next 3
1657 times before stop retrying. The `+' in <# of retries> means indefinite
1658 number of retries until success.
1660 The schema checking can be enforced at the LDAP Sync
1661 consumer site by turning on the
1663 parameter. The default is \fBoff\fP.
1664 Schema checking \fBon\fP means that replicated entries must have
1665 a structural objectClass, must obey to objectClass requirements
1666 in terms of required/allowed attributes, and that naming attributes
1667 and distinguished values must be present.
1668 As a consequence, schema checking should be \fBoff\fP when partial
1669 replication is used.
1673 parameter sets how long the consumer will wait to establish a
1674 network connection to the provider. Once a connection is
1677 parameter determines how long the consumer will wait for the initial
1678 Bind request to complete. The defaults for these parameters come
1686 requires the options
1690 and should only be used when adequate security services
1691 (e.g. TLS or IPSEC) are in place.
1692 .B REMEMBER: simple bind credentials must be in cleartext!
1699 Depending on the mechanism, an authentication identity and/or
1700 credentials can be specified using
1706 parameter may be used to specify an authorization identity.
1707 Specific security properties (as with the
1709 keyword above) for a SASL bind can be set with the
1711 option. A non default SASL realm can be set with the
1714 The identity used for synchronization by the consumer should be allowed
1715 to receive an unlimited number of entries in response to a search request.
1716 The provider, other than allow authentication of the syncrepl identity,
1717 should grant that identity appropriate access privileges to the data
1718 that is being replicated (\fBaccess\fP directive), and appropriate time
1720 This can be accomplished by either allowing unlimited \fBsizelimit\fP
1721 and \fBtimelimit\fP, or by setting an appropriate \fBlimits\fP statement
1722 in the consumer's configuration (see \fBsizelimit\fP and \fBlimits\fP
1727 parameter specifies use of the StartTLS extended operation
1728 to establish a TLS session before Binding to the provider. If the
1730 argument is supplied, the session will be aborted if the StartTLS request
1731 fails. Otherwise the syncrepl session continues without TLS. The
1732 tls_reqcert setting defaults to "demand" and the other TLS settings
1733 default to the same as the main slapd TLS settings.
1735 Rather than replicating whole entries, the consumer can query logs of
1736 data modifications. This mode of operation is referred to as \fIdelta
1737 syncrepl\fP. In addition to the above parameters, the
1741 parameters must be set appropriately for the log that will be used. The
1743 parameter must be set to either "accesslog" if the log conforms to the
1744 .BR slapo-accesslog (5)
1745 log format, or "changelog" if the log conforms
1746 to the obsolete \fIchangelog\fP format. If the
1748 parameter is omitted or set to "default" then the log parameters are
1753 This option is only applicable in a slave
1755 It specifies the DN permitted to update (subject to access controls)
1756 the replica. It is only needed in certain push-mode
1757 replication scenarios. Generally, this DN
1764 Specify the referral to pass back when
1766 is asked to modify a replicated local database.
1767 If specified multiple times, each url is provided.
1769 .SH DATABASE-SPECIFIC OPTIONS
1770 Each database may allow specific configuration options; they are
1771 documented separately in the backends' manual pages. See the
1772 .BR slapd.backends (5)
1773 manual page for an overview of available backends.
1776 Here is a short example of a configuration file:
1780 include SYSCONFDIR/schema/core.schema
1781 pidfile LOCALSTATEDIR/run/slapd.pid
1783 # Subtypes of "name" (e.g. "cn" and "ou") with the
1784 # option ";x-hidden" can be searched for/compared,
1785 # but are not shown. See \fBslapd.access\fP(5).
1786 attributeoptions x-hidden lang-
1787 access to attrs=name;x-hidden by * =cs
1789 # Protect passwords. See \fBslapd.access\fP(5).
1790 access to attrs=userPassword by * auth
1791 # Read access to other attributes and entries.
1792 access to * by * read
1795 suffix "dc=our-domain,dc=com"
1796 # The database directory MUST exist prior to
1797 # running slapd AND should only be accessible
1798 # by the slapd/tools. Mode 0700 recommended.
1799 directory LOCALSTATEDIR/openldap-data
1800 # Indices to maintain
1801 index objectClass eq
1802 index cn,sn,mail pres,eq,approx,sub
1804 # We serve small clients that do not handle referrals,
1805 # so handle remote lookups on their behalf.
1808 uri ldap://ldap.some-server.com/
1813 "OpenLDAP Administrator's Guide" contains a longer annotated
1814 example of a configuration file.
1815 The original ETCDIR/slapd.conf is another example.
1819 default slapd configuration file
1822 .BR slapd\-config (5),
1823 .BR slapd.access (5),
1824 .BR slapd.backends (5),
1825 .BR slapd.overlays (5),
1826 .BR slapd.plugin (5),
1827 .BR slapd.replog (5),
1838 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1839 .SH ACKNOWLEDGEMENTS
projects / openldap / blob