slapd.conf

title: slapd.conf(5)

text:
# slapd.conf(5)

## NAME
slapd.conf - configuration file for slapd, the stand-alone LDAP daemon

## SYNOPSIS
/etc/openldap/slapd.conf

## DESCRIPTION
The file /etc/openldap/slapd.conf contains configuration information for the slapd(8) daemon. This configuration file is also used by the SLAPD tools slapacl(8), slapadd(8), slapauth(8), slapcat(8), slapdn(8), slapindex(8), slapmodify(8), and slaptest(8).

The slapd.conf file consists of a series of global configuration options that apply to slapd as a whole (including all backends), followed by zero or more database backend definitions that contain information specific to a backend instance. The configuration options are case-insensitive; their value, on a case by case basis, may be case-sensitive.

The general format of slapd.conf is as follows:

```
    # comment - these options apply to every database

    <global configuration options>

    # first database definition & configuration options

    database <backend 1 type>

    <configuration options specific to backend 1>

    # subsequent database definitions & configuration options

    ...
```

As many backend-specific sections as desired may be included. Global options can be overridden in a backend (for options that appear more than once, the last appearance in the slapd.conf file is used).

If a line begins with white space, it is considered a continuation of the previous line. No physical line should be over 2000 bytes long.

Blank lines and comment lines beginning with a `#' character are ignored. Note: continuation lines are unwrapped before comment processing is applied.

Arguments on configuration lines are separated by white space. If an argument contains white space, the argument should be enclosed in double quotes. If an argument contains a double quote (`"') or a backslash character (`\'), the character should be preceded by a backslash character.

The specific configuration options available are discussed below in the Global Configuration Options, General Backend Options, and General Database Options. Backend-specific options are discussed in the slapd-<backend>(5) manual pages. Refer to the "OpenLDAP Administrator's Guide" for more details on the slapd configuration file.

## GLOBAL CONFIGURATION OPTIONS
Options described in this section apply to all backends, unless specifically overridden in a backend definition. Arguments that should be replaced by actual text are shown in brackets <>.

access to <what> [ by <who> <access> <control> ]+

Grant access (specified by <access>) to a set of entries and/or attributes (specified by <what>) by one or more requestors (specified by <who>). If no access controls are present, the default policy allows anyone and everyone to read anything but restricts updates to rootdn. (e.g., "access to * by * read"). The rootdn can always read and write EVERYTHING! See slapd.access(5) and the "OpenLDAP's Administrator's Guide" for details.

allow <features>

Specify a set of features (separated by white space) to allow (default none). bind_v2 allows acceptance of LDAPv2 bind requests. Note that slapd(8) does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494). bind_anon_cred allows anonymous bind when credentials are not empty (e.g. when DN is empty). bind_anon_dn allows unauthenticated (anonymous) bind when DN is not empty. update_anon allows unauthenticated (anonymous) update operations to be processed (subject to access controls and other administrative limits). proxy_authz_anon allows unauthenticated (anonymous) proxy authorization control to be processed (subject to access controls, authorization and other administrative limits).

argsfile <filename>

The (absolute) name of a file that will hold the slapd server's command line (program name and options).

attributeoptions [option-name]...

Define tagging attribute options or option tag/range prefixes. Options must not end with `-', prefixes must end with `-'. The `lang-' prefix is predefined. If you use the attributeoptions directive, `lang-' will no longer be defined and you must specify it explicitly if you want it defined. An attribute description with a tagging option is a subtype of that attribute description without the option. Except for that, options defined this way have no special semantics. Prefixes defined this way work like the `lang-' options: They define a prefix for tagging options starting with the prefix. That is, if you define the prefix `x-foo-', you can use the option `x-foo-bar'. Furthermore, in a search or compare, a prefix or range name (with a trailing `-') matches all options starting with that name, as well as the option with the range name sans the trailing `-'. That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.

RFC 4520 reserves options beginning with `x-' for private experiments. Other options should be registered with IANA, see RFC 4520 section 3.5. OpenLDAP also has the `binary' option built in, but this is a transfer option, not a tagging option.

attributetype ( <oid> [NAME <name>] [DESC <description>] [OBSOLETE] [SUP <oid>] [EQUALITY <oid>] [ORDERING <oid>] [SUBSTR <oid>] [SYNTAX <oidlen>] [SINGLE-VALUE] [COLLECTIVE] [NO-USER-MODIFICATION] [USAGE <attributeUsage>] )

Specify an attribute type using the LDAPv3 syntax defined in RFC 4512. The slapd parser extends the RFC 4512 definition by allowing string forms as well as numeric OIDs to be used for the attribute OID and attribute syntax OID. (See the objectidentifier description.)

authid-rewrite<cmd> <args>

Used by the authentication framework to convert simple user names to an LDAP DN used for authorization purposes. Its purpose is analogous to that of authz-regexp (see below). The prefix authid- is followed by a set of rules analogous to those described in slapo-rwm(5) for data rewriting (replace the rwm- prefix with authid-). authid-rewrite<cmd> and authz-regexp rules should not be intermixed.

authz-policy <policy>

Used to specify which rules to use for Proxy Authorization. Proxy authorization allows a client to authenticate to the server using one user's credentials, but specify a different identity to use for authorization and access control purposes. It essentially allows user A to login as user B, using user A's password. The none flag disables proxy authorization. This is the default setting. The from flag will use rules in the authzFrom attribute of the authorization DN. The to flag will use rules in the authzTo attribute of the authentication DN. The any flag, an alias for the deprecated value of both, will allow any of the above, whatever succeeds first (checked in to, from sequence. The all flag requires both authorizations to succeed.

The rules are mechanisms to specify which identities are allowed to perform proxy authorization. The authzFrom attribute in an entry specifies which other users are allowed to proxy login to this entry. The authzTo attribute in an entry specifies which other users this user can authorize as. Use of authzTo rules can be easily abused if users are allowed to write arbitrary values to this attribute. In general the authzTo attribute must be protected with ACLs such that only privileged users can modify it. The value of authzFrom and authzTo describes an identity or a set of identities; it can take five forms: ldap:///<base>??[<scope>]?<filter>

dn[.<dnstyle>]:<pattern>

u[.<mech>[/<realm>]]:<pattern>

group[/objectClass[/attributeType]]:<pattern>

<pattern>

<dnstyle>:={exact|onelevel|children|subtree|regex}

The first form is a valid LDAP URI where the <host>:<port>, the <attrs> and the <extensions> portions must be absent, so that the search occurs locally on either authzFrom or authzTo.

The second form is a DN. The optional dnstyle modifiers exact, onelevel, children, and subtree provide exact, onelevel, children and subtree matches, which cause <pattern> to be normalized according to the DN normalization rules. The special dnstyle modifier regex causes the <pattern> to be treated as a POSIX (''extended'') regular expression, as discussed in regex(7) and/or re_format(7). A pattern of * means any non-anonymous DN.

The third form is a SASL id. The optional fields <mech> and <realm> allow specification of a SASL mechanism, and eventually a SASL realm, for those mechanisms that support one. The need to allow the specification of a mechanism is still debated, and users are strongly discouraged to rely on this possibility.

The fourth form is a group specification. It consists of the keyword group, optionally followed by the specification of the group objectClass and attributeType. The objectClass defaults to groupOfNames. The attributeType defaults to member. The group with DN <pattern> is searched with base scope, filtered on the specified objectClass. The values of the resulting attributeType are searched for the asserted DN.

The fifth form is provided for backwards compatibility. If no identity type is provided, i.e. only <pattern> is present, an exact DN is assumed; as a consequence, <pattern> is subjected to DN normalization.

Since the interpretation of authzFrom and authzTo can impact security, users are strongly encouraged to explicitly set the type of identity specification that is being used. A subset of these rules can be used as third arg in the authz-regexp statement (see below); significantly, the URI, provided it results in exactly one entry, and the dn.exact:<dn> forms.

authz-regexp <match> <replace>

Used by the authentication framework to convert simple user names, such as provided by SASL subsystem, or extracted from certificates in case of cert-based SASL EXTERNAL, or provided within the RFC 4370 "proxied authorization" control, to an LDAP DN used for authorization purposes. Note that the resulting DN need not refer to an existing entry to be considered valid. When an authorization request is received from the SASL subsystem, the SASL USERNAME, REALM, and MECHANISM are taken, when available, and combined into a name of the form

UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth

This name is then compared against the match POSIX (''extended'') regular expression, and if the match is successful, the name is replaced with the replace string. If there are wildcard strings in the match regular expression that are enclosed in parenthesis, e.g. UID=([^,]*),CN=.*

then the portion of the name that matched the wildcard will be stored in the numbered placeholder variable $1. If there are other wildcard strings in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The placeholders can then be used in the replace string, e.g. UID=$1,OU=Accounts,DC=example,DC=com

The replaced name can be either a DN, i.e. a string prefixed by "dn:", or an LDAP URI. If the latter, the server will use the URI to search its own database(s) and, if the search returns exactly one entry, the name is replaced by the DN of that entry. The LDAP URI must have no hostport, attrs, or extensions components, but the filter is mandatory, e.g. ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)

The protocol portion of the URI must be strictly ldap. Note that this search is subject to access controls. Specifically, the authentication identity must have "auth" access in the subject. Multiple authz-regexp options can be given in the configuration file to allow for multiple matching and replacement patterns. The matching patterns are checked in the order they appear in the file, stopping at the first successful match.

concurrency <integer>

Specify a desired level of concurrency. Provided to the underlying thread system as a hint. The default is not to provide any hint. This setting is only meaningful on some platforms where there is not a one to one correspondence between user threads and kernel threads.

conn_max_pending <integer>

Specify the maximum number of pending requests for an anonymous session. If requests are submitted faster than the server can process them, they will be queued up to this limit. If the limit is exceeded, the session is closed. The default is 100.

conn_max_pending_auth <integer>

Specify the maximum number of pending requests for an authenticated session. The default is 1000.

defaultsearchbase <dn>

Specify a default search base to use when client submits a non-base search request with an empty base DN. Base scoped search requests with an empty base DN are not affected.

disallow <features>

Specify a set of features (separated by white space) to disallow (default none). bind_anon disables acceptance of anonymous bind requests. Note that this setting does not prohibit anonymous directory access (See "require authc"). bind_simple disables simple (bind) authentication. tls_2_anon disables forcing session to anonymous status (see also tls_authc) upon StartTLS operation receipt. tls_authc disallows the StartTLS operation if authenticated (see also tls_2_anon). proxy_authz_non_critical disables acceptance of the proxied authorization control (RFC4370) with criticality set to FALSE. dontusecopy_non_critical disables acceptance of the dontUseCopy control (a work in progress) with criticality set to FALSE.

ditcontentrule ( <oid> [NAME <name>] [DESC <description>] [OBSOLETE] [AUX <oids>] [MUST <oids>] [MAY <oids>] [NOT <oids>] )

Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512. The slapd parser extends the RFC 4512 definition by allowing string forms as well as numeric OIDs to be used for the attribute OID and attribute syntax OID. (See the objectidentifier description.)

gentlehup { on | off }

A SIGHUP signal will only cause a 'gentle' shutdown-attempt: Slapd will stop listening for new connections, but will not close the connections to the current clients. Future write operations return unwilling-to-perform, though. Slapd terminates when all clients have closed their connections (if they ever do), or - as before - if it receives a SIGTERM signal. This can be useful if you wish to terminate the server and start a new slapd server with another database, without disrupting the currently active clients. The default is off. You may wish to use idletimeout along with this option.

idletimeout <integer>

Specify the number of seconds to wait before forcibly closing an idle client connection. A setting of 0 disables this feature. The default is 0. You may also want to set the writetimeout option.

include <filename>

Read additional configuration information from the given file before continuing with the next line of the current file.

index_hash64 { on | off }

Use a 64 bit hash for indexing. The default is to use 32 bit hashes. These hashes are used for equality and substring indexing. The 64 bit version may be needed to avoid index collisions when the number of indexed values exceeds ~64 million. (Note that substring indexing generates multiple index values per actual attribute value.) Indices generated with 32 bit hashes are incompatible with the 64 bit version, and vice versa. Any existing databases must be fully reloaded when changing this setting. This directive is only supported on 64 bit CPUs.

index_intlen <integer>

Specify the key length for ordered integer indices. The most significant bytes of the binary integer will be used for index keys. The default value is 4, which provides exact indexing for 31 bit values. A floating point representation is used to index too large values.

index_substr_if_maxlen <integer>

Specify the maximum length for subinitial and subfinal indices. Only this many characters of an attribute value will be processed by the indexing functions; any excess characters are ignored. The default is 4.

index_substr_if_minlen <integer>

Specify the minimum length for subinitial and subfinal indices. An attribute value must have at least this many characters in order to be processed by the indexing functions. The default is 2.

index_substr_any_len <integer>

Specify the length used for subany indices. An attribute value must have at least this many characters in order to be processed. Attribute values longer than this length will be processed in segments of this length. The default is 4. The subany index will also be used in subinitial and subfinal index lookups when the filter string is longer than the index_substr_if_maxlen value.

index_substr_any_step <integer>

Specify the steps used in subany index lookups. This value sets the offset for the segments of a filter string that are processed for a subany index lookup. The default is 2. For example, with the default values, a search using this filter "cn=*abcdefgh*" would generate index lookups for "abcd", "cdef", and "efgh".

Note: Indexing support depends on the particular backend in use. Also, changing these settings will generally require deleting any indices that depend on these parameters and recreating them with slapindex(8).

ldapsyntax ( <oid> [DESC <description>] [X-SUBST <substitute-syntax>] )

Specify an LDAP syntax using the LDAPv3 syntax defined in RFC 4512. The slapd parser extends the RFC 4512 definition by allowing string forms as well as numeric OIDs to be used for the syntax OID. (See the objectidentifier description.) The slapd parser also honors the X-SUBST extension (an OpenLDAP-specific extension), which allows one to use the ldapsyntax statement to define a non-implemented syntax along with another syntax, the extension value substitute-syntax, as its temporary replacement. The substitute-syntax must be defined. This allows one to define attribute types that make use of non-implemented syntaxes using the correct syntax OID. Unless X-SUBST is used, this configuration statement would result in an error, since no handlers would be associated to the resulting syntax structure.

listener-threads <integer>

Specify the number of threads to use for the connection manager. The default is 1 and this is typically adequate for up to 16 CPU cores. The value should be set to a power of 2.

localSSF <SSF>

Specifies the Security Strength Factor (SSF) to be given local LDAP sessions, such as those to the ldapi:// listener. For a description of SSF values, see sasl-secprops's minssf option description. The default is 71.

logfile <filename>

Specify a file for recording slapd debug messages. These messages are unrelated to messages exposed by the loglevel configuration parameter. This setting only affects the slapd daemon and has no effect on the command line tools. By default these messages only go to stderr and are not recorded anywhere else. Specifying a logfile copies messages to both stderr and the logfile.

logfile-format debug|syslog-utc|syslog-localtime|rfc3339-utc

Specify the prefix format for messages written to the logfile. The debug format is the normal format used for slapd debug messages, with a timestamp in hexadecimal, followed by a thread ID. The other options are to use syslog(3) style prefixes, with timestamps either in UTC or in the local timezone. The default is debug format.

logfile-only on | off

Specify that debug messages should only go to the configured logfile, and not to stderr.

logfile-rotate <max> <Mbytes> <hours>

Specify automatic rotation for the configured logfile as the maximum number of old logfiles to retain, a maximum size in megabytes to allow a logfile to grow before rotation, and a maximum age in hours for a logfile to be used before rotation. The maximum number must be in the range 1-99. Setting Mbytes or hours to zero disables the size or age check, respectively. At least one of Mbytes or hours must be non-zero. By default no automatic rotation will be performed.

loglevel <integer> [...]

Specify the level at which debugging statements and operation statistics should be syslogged (currently logged to the syslogd(8) LOG_LOCAL4 facility). They must be considered subsystems rather than increasingly verbose log levels. Some messages with higher priority are logged regardless of the configured loglevel as soon as any logging is configured. Log levels are additive, and available levels are:

1

(0x1 trace) trace function calls

2

(0x2 packets) debug packet handling

4

(0x4 args) heavy trace debugging (function args)

8

(0x8 conns) connection management

16

(0x10 BER) print out packets sent and received

32

(0x20 filter) search filter processing

64

(0x40 config) configuration file processing

128

(0x80 ACL) access control list processing

256

(0x100 stats) connections, LDAP operations, results (recommended)

512

(0x200 stats2) stats2 log entries sent

1024

(0x400 shell) print communication with shell backends

2048

(0x800 parse) entry parsing

16384

(0x4000 sync) LDAPSync replication

32768

(0x8000 none) only messages that get logged whatever log level is set

The desired log level can be input as a single integer that combines the (ORed) desired levels, both in decimal or in hexadecimal notation, as a list of integers (that are ORed internally), or as a list of the names that are shown between parentheses, such that

```
    loglevel 129

    loglevel 0x81

    loglevel 128 1

    loglevel 0x80 0x1

    loglevel acl trace
```

are equivalent. The keyword any can be used as a shortcut to enable logging at all levels (equivalent to -1). The keyword none, or the equivalent integer representation, causes those messages that are logged regardless of the configured loglevel to be logged. In fact, if loglevel is set to 0, no logging occurs, so at least the none level is required to have high priority messages logged.

Note that the packets, BER, and parse levels are only available as debug output on stderr, and are not sent to syslog.

The loglevel defaults to stats. This level should usually also be included when using other loglevels, to help analyze the logs.

maxfilterdepth <integer>

Specify the maximum depth of nested filters in search requests. The default is 1000.

moduleload <filename> [<arguments>...]

Specify the name of a dynamically loadable module to load and any additional arguments if supported by the module. The filename may be an absolute path name or a simple filename. Non-absolute names are searched for in the directories specified by the modulepath option. This option and the modulepath option are only usable if slapd was compiled with --enable-modules.

modulepath <pathspec>

Specify a list of directories to search for loadable modules. Typically the path is colon-separated but this depends on the operating system. The default is /usr/lib/openldap, which is where the standard OpenLDAP install will place its modules.

objectclass ( <oid> [NAME <name>] [DESC <description>] [OBSOLETE] [SUP <oids>] [{ ABSTRACT | STRUCTURAL | AUXILIARY }] [MUST <oids>] [MAY <oids>] )

Specify an objectclass using the LDAPv3 syntax defined in RFC 4512. The slapd parser extends the RFC 4512 definition by allowing string forms as well as numeric OIDs to be used for the object class OID. (See the objectidentifier description.) Object classes are "STRUCTURAL" by default.

objectidentifier <name> { <oid> | <name>[:<suffix>] }

Define a string name that equates to the given OID. The string can be used in place of the numeric OID in objectclass and attribute definitions. The name can also be used with a suffix of the form ":xx" in which case the value "oid.xx" will be used.

password-hash <hash> [<hash>...]

This option configures one or more hashes to be used in generation of user passwords stored in the userPassword attribute during processing of LDAP Password Modify Extended Operations (RFC 3062). The <hash> must be one of {SSHA}, {SHA}, {SMD5}, {MD5}, {CRYPT}, and {CLEARTEXT}. The default is {SSHA}. {SHA} and {SSHA} use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.

{MD5} and {SMD5} use the MD5 algorithm (RFC 1321), the latter with a seed.

{CRYPT} uses the crypt(3).

{CLEARTEXT} indicates that the new password should be added to userPassword as clear text.

Note that this option does not alter the normal user applications handling of userPassword during LDAP Add, Modify, or other LDAP operations.

password-crypt-salt-format <format>

Specify the format of the salt passed to crypt(3) when generating {CRYPT} passwords (see password-hash) during processing of LDAP Password Modify Extended Operations (RFC 3062). This string needs to be in sprintf(3) format and may include one (and only one) %s conversion. This conversion will be substituted with a string of random characters from [A-Za-z0-9./]. For example, "%.2s" provides a two character salt and "$1$%.8s" tells some versions of crypt(3) to use an MD5 algorithm and provides 8 random characters of salt. The default is "%s", which provides 31 characters of salt.

pidfile <filename>

The (absolute) name of a file that will hold the slapd server's process ID (see getpid(2)).

pluginlog: <filename>

The ( absolute ) name of a file that will contain log messages from SLAPI plugins. See slapd.plugin(5) for details.

referral <url>

Specify the referral to pass back when slapd(8) cannot find a local database to handle a request. If specified multiple times, each url is provided.

require <conditions>

Specify a set of conditions (separated by white space) to require (default none). The directive may be specified globally and/or per-database; databases inherit global conditions, so per-database specifications are additive. bind requires bind operation prior to directory operations. LDAPv3 requires session to be using LDAP version 3. authc requires authentication prior to directory operations. SASL requires SASL authentication prior to directory operations. strong requires strong authentication prior to directory operations. The strong keyword allows protected "simple" authentication as well as SASL authentication. none may be used to require no conditions (useful to clear out globally set conditions within a particular database); it must occur first in the list of conditions.

reverse-lookup on | off

Enable/disable client name unverified reverse lookup (default is off if compiled with --enable-rlookups).

rootDSE <file>

Specify the name of an LDIF(5) file containing user defined attributes for the root DSE. These attributes are returned in addition to the attributes normally produced by slapd. The root DSE is an entry with information about the server and its capabilities, in operational attributes. It has the empty DN, and can be read with e.g.: ldapsearch -x -b "" -s base "+"

See RFC 4512 section 5.1 for details.

sasl-auxprops <plugin> [...]

Specify which auxprop plugins to use for authentication lookups. The default is empty, which just uses slapd's internal support. Usually no other auxprop plugins are needed.

sasl-auxprops-dontusecopy <attr> [...]

Specify which attribute(s) should be subject to the don't use copy control. This is necessary for some SASL mechanisms such as OTP to work in a replicated environment. The attribute "cmusaslsecretOTP" is the default value.

sasl-auxprops-dontusecopy-ignore on | off

Used to disable replication of the attribute(s) defined by sasl-auxprops-dontusecopy and instead use a local value for the attribute. This allows the SASL mechanism to continue to work if the provider is offline. This can cause replication inconsistency. Defaults to off.

sasl-host <fqdn>

Used to specify the fully qualified domain name used for SASL processing.

sasl-realm <realm>

Specify SASL realm. Default is empty.

sasl-cbinding none | tls-unique | tls-endpoint

Specify the channel-binding type, see also LDAP_OPT_X_SASL_CBINDING. Default is none.

sasl-secprops <properties>

Used to specify Cyrus SASL security properties. The none flag (without any other properties) causes the flag properties default, "noanonymous,noplain", to be cleared. The noplain flag disables mechanisms susceptible to simple passive attacks. The noactive flag disables mechanisms susceptible to active attacks. The nodict flag disables mechanisms susceptible to passive dictionary attacks. The noanonymous flag disables mechanisms which support anonymous login. The forwardsec flag require forward secrecy between sessions. The passcred require mechanisms which pass client credentials (and allow mechanisms which can pass credentials to do so). The minssf=<factor> property specifies the minimum acceptable security strength factor as an integer approximate to effective key length used for encryption. 0 (zero) implies no protection, 1 implies integrity protection only, 128 allows RC4, Blowfish and other similar ciphers, 256 will require modern ciphers. The default is 0. The maxssf=<factor> property specifies the maximum acceptable security strength factor as an integer (see minssf description). The default is INT_MAX. The maxbufsize=<size> property specifies the maximum security layer receive buffer size allowed. 0 disables security layers. The default is 65536.

schemadn <dn>

Specify the distinguished name for the subschema subentry that controls the entries on this server. The default is "cn=Subschema".

security <factors>

Specify a set of security strength factors (separated by white space) to require (see sasl-secprops's minssf option for a description of security strength factors). The directive may be specified globally and/or per-database. ssf=<n> specifies the overall security strength factor. transport=<n> specifies the transport security strength factor. tls=<n> specifies the TLS security strength factor. sasl=<n> specifies the SASL security strength factor. update_ssf=<n> specifies the overall security strength factor to require for directory updates. update_transport=<n> specifies the transport security strength factor to require for directory updates. update_tls=<n> specifies the TLS security strength factor to require for directory updates. update_sasl=<n> specifies the SASL security strength factor to require for directory updates. simple_bind=<n> specifies the security strength factor required for simple username/password authentication. Note that the transport factor is measure of security provided by the underlying transport, e.g. ldapi:// (and eventually IPSEC). It is not normally used.

serverID <integer> [<URL>]

Specify an integer ID from 0 to 4095 for this server. The ID may also be specified as a hexadecimal ID by prefixing the value with "0x". Non-zero IDs are required when using multi-provider replication and each provider must have a unique non-zero ID. Note that this requirement also applies to separate providers contributing to a glued set of databases. If the URL is provided, this directive may be specified multiple times, providing a complete list of participating servers and their IDs. The fully qualified hostname of each server should be used in the supplied URLs. The IDs are used in the "replica id" field of all CSNs generated by the specified server. The default value is zero, which is only valid for single provider replication. Example:

```
	serverID 1 ldap://ldap1.example.com
	serverID 2 ldap://ldap2.example.com
```

sizelimit {<integer>|unlimited}

sizelimit size[.{soft|hard}]=<integer> [...]

Specify the maximum number of entries to return from a search operation. The default size limit is 500. Use unlimited to specify no limits. The second format allows a fine grain setting of the size limits. If no special qualifiers are specified, both soft and hard limits are set. Extra args can be added on the same line. Additional qualifiers are available; see limits for an explanation of all of the different flags.

sockbuf_max_incoming <integer>

Specify the maximum incoming LDAP PDU size for anonymous sessions. The default is 262143.

sockbuf_max_incoming_auth <integer>

Specify the maximum incoming LDAP PDU size for authenticated sessions. The default is 4194303.

sortvals <attr> [...]

Specify a list of multi-valued attributes whose values will always be maintained in sorted order. Using this option will allow Modify, Compare, and filter evaluations on these attributes to be performed more efficiently. The resulting sort order depends on the attributes' syntax and matching rules and may not correspond to lexical order or any other recognizable order.

tcp-buffer [listener=<URL>] [{read|write}=]<size>

Specify the size of the TCP buffer. A global value for both read and write TCP buffers related to any listener is defined, unless the listener is explicitly specified, or either the read or write qualifiers are used. See tcp(7) for details. Note that some OS-es implement automatic TCP buffer tuning.

threads <integer>

Specify the maximum size of the primary thread pool. The default is 16; the minimum value is 2.

threadqueues <integer>

Specify the number of work queues to use for the primary thread pool. The default is 1 and this is typically adequate for up to 8 CPU cores. The value should not exceed the number of CPUs in the system.

timelimit {<integer>|unlimited}

timelimit time[.{soft|hard}]=<integer> [...]

Specify the maximum number of seconds (in real time) slapd will spend answering a search request. The default time limit is 3600. Use unlimited to specify no limits. The second format allows a fine grain setting of the time limits. Extra args can be added on the same line. See limits for an explanation of the different flags.

tool-threads <integer>

Specify the maximum number of threads to use in tool mode. This should not be greater than the number of CPUs in the system. The default is 1.

writetimeout <integer>

Specify the number of seconds to wait before forcibly closing a connection with an outstanding write. This allows recovery from various network hang conditions. A writetimeout of 0 disables this feature. The default is 0.

## TLS OPTIONS
If slapd is built with support for Transport Layer Security, there are more options you can specify.

TLSCipherSuite <cipher-suite-spec>

Permits configuring what ciphers will be accepted and the preference order. <cipher-suite-spec> should be a cipher specification for the TLS library in use (OpenSSL or GnuTLS). Example:

OpenSSL:

TLSCipherSuite HIGH:MEDIUM:+SSLv2

GnuTLS:

TLSCiphersuite SECURE256:!AES-128-CBC

To check what ciphers a given spec selects in OpenSSL, use:

```
	openssl ciphers -v <cipher-suite-spec>
```

With GnuTLS the available specs can be found in the manual page of gnutls-cli(1) (see the description of the option --priority).

In older versions of GnuTLS, where gnutls-cli does not support the option --priority, you can obtain the — more limited — list of ciphers by calling:

```
	gnutls-cli -l
```

TLSCACertificateFile <filename>

Specifies the file that contains certificates for all of the Certificate Authorities that slapd will recognize. The certificate for the CA that signed the server certificate must(GnuTLS)/may(OpenSSL) be included among these certificates. If the signing CA was not a top-level (root) CA, certificates for the entire sequence of CA's from the signing CA to the top-level CA should be present. Multiple certificates are simply appended to the file; the order is not significant.

TLSCACertificatePath <path>

Specifies the path of directories that contain Certificate Authority certificates in separate individual files. Usually only one of this or the TLSCACertificateFile is used. If both are specified, both locations will be used. Multiple directories may be specified, separated by a semi-colon.

TLSCertificateFile <filename>

Specifies the file that contains the slapd server certificate. When using OpenSSL that file may also contain any number of intermediate certificates after the server certificate.

TLSCertificateKeyFile <filename>

Specifies the file that contains the slapd server private key that matches the certificate stored in the TLSCertificateFile file. Currently, the private key must not be protected with a password, so it is of critical importance that it is protected carefully.

TLSDHParamFile <filename>

This directive specifies the file that contains parameters for Diffie-Hellman ephemeral key exchange. This is required in order to use a DSA certificate on the server, or an RSA certificate missing the "key encipherment" key usage. Note that setting this option may also enable Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites. Anonymous key exchanges should generally be avoided since they provide no actual client or server authentication and provide no protection against man-in-the-middle attacks. You should append "!ADH" to your cipher suites to ensure that these suites are not used.

TLSECName <name>

Specify the name of the curve(s) to use for Elliptic curve Diffie-Hellman ephemeral key exchange. This option is only used for OpenSSL. This option is not used with GnuTLS; the curves may be chosen in the GnuTLS ciphersuite specification.

TLSProtocolMin <major>[.<minor>]

Specifies minimum SSL/TLS protocol version that will be negotiated. If the server doesn't support at least that version, the SSL handshake will fail. To require TLS 1.x or higher, set this option to 3.(x+1), e.g.,

```
	TLSProtocolMin 3.2
```

would require TLS 1.1. Specifying a minimum that is higher than that supported by the OpenLDAP implementation will result in it requiring the highest level that it does support. This directive is ignored with GnuTLS.

TLSRandFile <filename>

Specifies the file to obtain random bits from when /dev/[u]random is not available. Generally set to the name of the EGD/PRNGD socket. The environment variable RANDFILE can also be used to specify the filename. This directive is ignored with GnuTLS.

TLSVerifyClient <level>

Specifies what checks to perform on client certificates in an incoming TLS session, if any. The <level> can be specified as one of the following keywords:

never

This is the default. slapd will not ask the client for a certificate.

allow

The client certificate is requested. If no certificate is provided, the session proceeds normally. If a bad certificate is provided, it will be ignored and the session proceeds normally.

try

The client certificate is requested. If no certificate is provided, the session proceeds normally. If a bad certificate is provided, the session is immediately terminated.

demand | hard | true

These keywords are all equivalent, for compatibility reasons. The client certificate is requested. If no certificate is provided, or a bad certificate is provided, the session is immediately terminated. Note that a valid client certificate is required in order to use the SASL EXTERNAL authentication mechanism with a TLS session. As such, a non-default TLSVerifyClient setting must be chosen to enable SASL EXTERNAL authentication.

TLSCRLCheck <level>

Specifies if the Certificate Revocation List (CRL) of the CA should be used to verify if the client certificates have not been revoked. This requires TLSCACertificatePath parameter to be set. This directive is ignored with GnuTLS. <level> can be specified as one of the following keywords:

none

No CRL checks are performed

peer

Check the CRL of the peer certificate

all

Check the CRL for a whole certificate chain

TLSCRLFile <filename>

Specifies a file containing a Certificate Revocation List to be used for verifying that certificates have not been revoked. This directive is only valid when using GnuTLS.

## GENERAL BACKEND OPTIONS
Options in this section only apply to the configuration file section of all instances of the specified backend. All backends may support this class of options, but currently only back-mdb does.

backend <databasetype>

Mark the beginning of a backend definition. <databasetype> should be one of asyncmeta, config, dnssrv, ldap, ldif, mdb, meta, monitor, null, passwd, perl, relay, sock, sql, or wt. At present, only back-mdb implements any options of this type, so this setting is not needed for any other backends.

## GENERAL DATABASE OPTIONS
Options in this section only apply to the configuration file section for the database in which they are defined. They are supported by every type of backend. Note that the database and at least one suffix option are mandatory for each database.

database <databasetype>

Mark the beginning of a new database instance definition. <databasetype> should be one of asyncmeta, config, dnssrv, ldap, ldif, mdb, meta, monitor, null, passwd, perl, relay, sock, sql, or wt, depending on which backend will serve the database. LDAP operations, even subtree searches, normally access only one database. That can be changed by gluing databases together with the subordinate keyword. Access controls and some overlays can also involve multiple databases.

add_content_acl on | off

Controls whether Add operations will perform ACL checks on the content of the entry being added. This check is off by default. See the slapd.access(5) manual page for more details on ACL requirements for Add operations.

extra_attrs <attrlist>

Lists what attributes need to be added to search requests. Local storage backends return the entire entry to the frontend. The frontend takes care of only returning the requested attributes that are allowed by ACLs. However, features like access checking and so may need specific attributes that are not automatically returned by remote storage backends, like proxy backends and so on. <attrlist> is a list of attributes that are needed for internal purposes and thus always need to be collected, even when not explicitly requested by clients.

hidden on | off

Controls whether the database will be used to answer queries. A database that is hidden will never be selected to answer any queries, and any suffix configured on the database will be ignored in checks for conflicts with other databases. By default, hidden is off.

lastmod on | off

Controls whether slapd will automatically maintain the modifiersName, modifyTimestamp, creatorsName, and createTimestamp attributes for entries. It also controls the entryCSN and entryUUID attributes, which are needed by the syncrepl provider. By default, lastmod is on.

lastbind on | off

Controls whether slapd will automatically maintain the pwdLastSuccess attribute for entries. By default, lastbind is off. On a replication consumer the pwdLastSuccess attribute will be forwarded to the provider assuming updateref setting and chain overlay are appropriately configured.

lastbind-precision <integer>

If lastbind is enabled, specifies how frequently pwdLastSuccess will be updated. More than integer seconds must have passed since the last successful bind. In a replicated environment with frequent bind activity it may be useful to set this to a large value.

limits <selector> <limit> [<limit> [...]]

Specify time and size limits based on the operation's initiator or base DN. The argument <selector> can be any of

anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>

with <dnspec> ::= dn[.<type>][.<style>]

<type> ::= self | this

<style> ::= exact | base | onelevel | subtree | children | regex | anonymous

DN type self is the default and means the bound user, while this means the base DN of the operation. The term anonymous matches all unauthenticated clients. The term users matches all authenticated clients; otherwise an exact dn pattern is assumed unless otherwise specified by qualifying the (optional) key string dn with exact or base (which are synonyms), to require an exact match; with onelevel, to require exactly one level of depth match; with subtree, to allow any level of depth match, including the exact match; with children, to allow any level of depth match, not including the exact match; regex explicitly requires the (default) match based on POSIX (''extended'') regular expression pattern. Finally, anonymous matches unbound operations; the pattern field is ignored. The same behavior is obtained by using the anonymous form of the <selector> clause. The term group, with the optional objectClass oc and attributeType at fields, followed by pattern, sets the limits for any DN listed in the values of the at attribute (default member) of the oc group objectClass (default groupOfNames) whose DN exactly matches pattern. The currently supported limits are size and time.

The syntax for time limits is time[.{soft|hard}]=<integer>, where integer is the number of seconds slapd will spend answering a search request. If no time limit is explicitly requested by the client, the soft limit is used; if the requested time limit exceeds the hard limit, the value of the limit is used instead. If the hard limit is set to the keyword soft, the soft limit is used in either case; if it is set to the keyword unlimited, no hard limit is enforced. Explicit requests for time limits smaller or equal to the hard limit are honored. If no limit specifier is set, the value is assigned to the soft limit, and the hard limit is set to soft, to preserve the original behavior.

The syntax for size limits is size[.{soft|hard|unchecked}]=<integer>, where integer is the maximum number of entries slapd will return answering a search request. If no size limit is explicitly requested by the client, the soft limit is used; if the requested size limit exceeds the hard limit, the value of the limit is used instead. If the hard limit is set to the keyword soft, the soft limit is used in either case; if it is set to the keyword unlimited, no hard limit is enforced. Explicit requests for size limits smaller or equal to the hard limit are honored. The unchecked specifier sets a limit on the number of candidates a search request is allowed to examine. The rationale behind it is that searches for non-properly indexed attributes may result in large sets of candidates, which must be examined by slapd(8) to determine whether they match the search filter or not. The unchecked limit provides a means to drop such operations before they are even started. If the selected candidates exceed the unchecked limit, the search will abort with Unwilling to perform. If it is set to the keyword unlimited, no limit is applied (the default). If it is set to disabled, the search is not even performed; this can be used to disallow searches for a specific set of users. If no limit specifier is set, the value is assigned to the soft limit, and the hard limit is set to soft, to preserve the original behavior.

In case of no match, the global limits are used. The default values are the same as for sizelimit and timelimit; no limit is set on unchecked.

If pagedResults control is requested, the hard size limit is used by default, because the request of a specific page size is considered an explicit request for a limitation on the number of entries to be returned. However, the size limit applies to the total count of entries returned within the search, and not to a single page. Additional size limits may be enforced; the syntax is size.pr={<integer>|noEstimate|unlimited}, where integer is the max page size if no explicit limit is set; the keyword noEstimate inhibits the server from returning an estimate of the total number of entries that might be returned (note: the current implementation does not return any estimate). The keyword unlimited indicates that no limit is applied to the pagedResults control page size. The syntax size.prtotal={<integer>|hard|unlimited|disabled} allows one to set a limit on the total number of entries that the pagedResults control will return. By default it is set to the hard limit which will use the size.hard value. When set, integer is the max number of entries that the whole search with pagedResults control can return. Use unlimited to allow unlimited number of entries to be returned, e.g. to allow the use of the pagedResults control as a means to circumvent size limitations on regular searches; the keyword disabled disables the control, i.e. no paged results can be returned. Note that the total number of entries returned when the pagedResults control is requested cannot exceed the hard size limit of regular searches unless extended by the prtotal switch.

The limits statement is typically used to let an unlimited number of entries be returned by searches performed with the identity used by the consumer for synchronization purposes by means of the RFC 4533 LDAP Content Synchronization protocol (see syncrepl for details).

When using subordinate databases, it is necessary for any limits that are to be applied across the parent and its subordinates to be defined in both the parent and its subordinates. Otherwise the settings on the subordinate databases are not honored.

maxderefdepth <depth>

Specifies the maximum number of aliases to dereference when trying to resolve an entry, used to avoid infinite alias loops. The default is 15.

multiprovider on | off

This option puts a consumer database into Multi-Provider mode. Update operations will be accepted from any user, not just the updatedn. The database must already be configured as a syncrepl consumer before this keyword may be set. This mode also requires a serverID (see above) to be configured. By default, multiprovider is off.

monitoring on | off

This option enables database-specific monitoring in the entry related to the current database in the "cn=Databases,cn=Monitor" subtree of the monitor database, if the monitor database is enabled. Currently, only the MDB database provides database-specific monitoring. If monitoring is supported by the backend it defaults to on, otherwise off.

overlay <overlay-name>

Add the specified overlay to this database. An overlay is a piece of code that intercepts database operations in order to extend or change them. Overlays are pushed onto a stack over the database, and so they will execute in the reverse of the order in which they were configured and the database itself will receive control last of all. See the slapd.overlays(5) manual page for an overview of the available overlays. Note that all of the database's regular settings should be configured before any overlay settings.

readonly on | off

This option puts the database into "read-only" mode. Any attempts to modify the database will return an "unwilling to perform" error. By default, readonly is off.

restrict <oplist>

Specify a whitespace separated list of operations that are restricted. If defined inside a database specification, restrictions apply only to that database, otherwise they are global. Operations can be any of add, bind, compare, delete, extended[=<OID>], modify, rename, search, or the special pseudo-operations read and write, which respectively summarize read and write operations. The use of restrict write is equivalent to readonly on (see above). The extended keyword allows one to indicate the OID of the specific operation to be restricted.

rootdn <dn>

Specify the distinguished name that is not subject to access control or administrative limit restrictions for operations on this database. This DN may or may not be associated with an entry. An empty root DN (the default) specifies no root access is to be granted. It is recommended that the rootdn only be specified when needed (such as when initially populating a database). If the rootdn is within a namingContext (suffix) of the database, a simple bind password may also be provided using the rootpw directive. Many optional features, including syncrepl, require the rootdn to be defined for the database.

rootpw <password>

Specify a password (or hash of the password) for the rootdn. The password can only be set if the rootdn is within the namingContext (suffix) of the database. This option accepts all RFC 2307 userPassword formats known to the server (see password-hash description) as well as cleartext. slappasswd(8) may be used to generate a hash of a password. Cleartext and {CRYPT} passwords are not recommended. If empty (the default), authentication of the root DN is by other means (e.g. SASL). Use of SASL is encouraged.

suffix <dn suffix>

Specify the DN suffix of queries that will be passed to this backend database. Multiple suffix lines can be given and at least one is required for each database definition. If the suffix of one database is "inside" that of another, the database with the inner suffix must come first in the configuration file. You may also want to glue such databases together with the subordinate keyword.

subordinate [advertise]

Specify that the current backend database is a subordinate of another backend database. A subordinate database may have only one suffix. This option may be used to glue multiple databases into a single namingContext. If the suffix of the current database is within the namingContext of a superior database, searches against the superior database will be propagated to the subordinate as well. All of the databases associated with a single namingContext should have identical rootdns. Behavior of other LDAP operations is unaffected by this setting. In particular, it is not possible to use moddn to move an entry from one subordinate to another subordinate within the namingContext. If the optional advertise flag is supplied, the naming context of this database is advertised in the root DSE. The default is to hide this database context, so that only the superior context is visible.

If the slap tools slapcat(8), slapadd(8), slapmodify(8), or slapindex(8) are used on the superior database, any glued subordinates that support these tools are opened as well.

Databases that are glued together should usually be configured with the same indices (assuming they support indexing), even for attributes that only exist in some of these databases. In general, all of the glued databases should be configured as similarly as possible, since the intent is to provide the appearance of a single directory.

Note that the subordinate functionality is implemented internally by the glue overlay and as such its behavior will interact with other overlays in use. By default, the glue overlay is automatically configured as the last overlay on the superior backend. Its position on the backend can be explicitly configured by setting an overlay glue directive at the desired position. This explicit configuration is necessary e.g. when using the syncprov overlay, which needs to follow glue in order to work over all of the glued databases. E.g.

```
	database mdb
	suffix dc=example,dc=com
	...
	overlay glue
	overlay syncprov
```

sync_use_subentry

Store the syncrepl contextCSN in a subentry instead of the context entry of the database. The subentry's RDN will be "cn=ldapsync". By default the contextCSN is stored in the context entry.

syncrepl rid=<replica ID> provider=ldap[s]://<hostname>[:port] searchbase=<base DN> [type=refreshOnly|refreshAndPersist] [interval=dd:hh:mm:ss] [retry=[<retry interval> <# of retries>]+] [filter=<filter str>] [scope=sub|one|base|subord] [attrs=<attr list>] [exattrs=<attr list>] [attrsonly] [sizelimit=<limit>] [timelimit=<limit>] [schemachecking=on|off] [network-timeout=<seconds>] [timeout=<seconds>] [tcp-user-timeout=<milliseconds>] [bindmethod=simple|sasl] [binddn=<dn>] [saslmech=<mech>] [authcid=<identity>] [authzid=<identity>] [credentials=<passwd>] [realm=<realm>] [secprops=<properties>] [keepalive=<idle>:<probes>:<interval>] [starttls=yes|critical] [tls_cert=<file>] [tls_key=<file>] [tls_cacert=<file>] [tls_cacertdir=<path>] [tls_reqcert=never|allow|try|demand] [tls_reqsan=never|allow|try|demand] [tls_cipher_suite=<ciphers>] [tls_ecname=<names>] [tls_crlcheck=none|peer|all] [tls_protocol_min=<major>[.<minor>]] [suffixmassage=<real DN>] [logbase=<base DN>] [logfilter=<filter str>] [syncdata=default|accesslog|changelog] [lazycommit]

Specify the current database as a consumer which is kept up-to-date with the provider content by establishing the current slapd(8) as a replication consumer site running a syncrepl replication engine. The consumer content is kept synchronized to the provider content using the LDAP Content Synchronization protocol. Refer to the "OpenLDAP Administrator's Guide" for detailed information on setting up a replicated slapd directory service using the syncrepl replication engine. rid identifies the current syncrepl directive within the replication consumer site. It is a non-negative integer not greater than 999 (limited to three decimal digits).

provider specifies the replication provider site containing the provider content as an LDAP URI. If <port> is not given, the standard LDAP port number (389 or 636) is used.

The content of the syncrepl consumer is defined using a search specification as its result set. The consumer slapd will send search requests to the provider slapd according to the search specification. The search specification includes searchbase, scope, filter, attrs, attrsonly, sizelimit, and timelimit parameters as in the normal search specification. The exattrs option may also be used to specify attributes that should be omitted from incoming entries. The scope defaults to sub, the filter defaults to (objectclass=*), and there is no default searchbase. The attrs list defaults to "*,+" to return all user and operational attributes, and attrsonly and exattrs are unset by default. The sizelimit and timelimit only accept "unlimited" and positive integers, and both default to "unlimited". The sizelimit and timelimit parameters define a consumer requested limitation on the number of entries that can be returned by the LDAP Content Synchronization operation; these should be left unchanged from the default otherwise replication may never succeed. Note, however, that any provider-side limits for the replication identity will be enforced by the provider regardless of the limits requested by the LDAP Content Synchronization operation, much like for any other search operation.

The LDAP Content Synchronization protocol has two operation types. In the refreshOnly operation, the next synchronization search operation is periodically rescheduled at an interval time (specified by interval parameter; 1 day by default) after each synchronization operation finishes. In the refreshAndPersist operation, a synchronization search remains persistent in the provider slapd. Further updates to the provider will generate searchResultEntry to the consumer slapd as the search responses to the persistent synchronization search. If the initial search fails due to an error, the next synchronization search operation is periodically rescheduled at an interval time (specified by interval parameter; 1 day by default)

If an error occurs during replication, the consumer will attempt to reconnect according to the retry parameter which is a list of the <retry interval> and <# of retries> pairs. For example, retry="60 10 300 3" lets the consumer retry every 60 seconds for the first 10 times and then retry every 300 seconds for the next 3 times before stop retrying. The `+' in <# of retries> means indefinite number of retries until success. If no retry is specified, by default syncrepl retries every hour forever.

The schema checking can be enforced at the LDAP Sync consumer site by turning on the schemachecking parameter. The default is off. Schema checking on means that replicated entries must have a structural objectClass, must obey to objectClass requirements in terms of required/allowed attributes, and that naming attributes and distinguished values must be present. As a consequence, schema checking should be off when partial replication is used.

The network-timeout parameter sets how long the consumer will wait to establish a network connection to the provider. Once a connection is established, the timeout parameter determines how long the consumer will wait for the initial Bind request to complete. The defaults for these parameters come from ldap.conf(5). The tcp-user-timeout parameter, if non-zero, corresponds to the TCP_USER_TIMEOUT set on the target connections, overriding the operating system setting. Only some systems support the customization of this parameter, it is ignored otherwise and system-wide settings are used.

A bindmethod of simple requires the options binddn and credentials and should only be used when adequate security services (e.g. TLS or IPSEC) are in place. REMEMBER: simple bind credentials must be in cleartext! A bindmethod of sasl requires the option saslmech. Depending on the mechanism, an authentication identity and/or credentials can be specified using authcid and credentials. The authzid parameter may be used to specify an authorization identity. Specific security properties (as with the sasl-secprops keyword above) for a SASL bind can be set with the secprops option. A non default SASL realm can be set with the realm option. The identity used for synchronization by the consumer should be allowed to receive an unlimited number of entries in response to a search request. The provider, other than allowing authentication of the syncrepl identity, should grant that identity appropriate access privileges to the data that is being replicated (access directive), and appropriate time and size limits. This can be accomplished by either allowing unlimited sizelimit and timelimit, or by setting an appropriate limits statement in the consumer's configuration (see sizelimit and limits for details).

The keepalive parameter sets the values of idle, probes, and interval used to check whether a socket is alive; idle is the number of seconds a connection needs to remain idle before TCP starts sending keepalive probes; probes is the maximum number of keepalive probes TCP should send before dropping the connection; interval is interval in seconds between individual keepalive probes. Only some systems support the customization of these values; the keepalive parameter is ignored otherwise, and system-wide settings are used.

The starttls parameter specifies use of the StartTLS extended operation to establish a TLS session before Binding to the provider. If the critical argument is supplied, the session will be aborted if the StartTLS request fails. Otherwise the syncrepl session continues without TLS. The tls_reqcert setting defaults to "demand", the tls_reqsan setting defaults to "allow", and the other TLS settings default to the same as the main slapd TLS settings.

The suffixmassage parameter allows the consumer to pull entries from a remote directory whose DN suffix differs from the local directory. The portion of the remote entries' DNs that matches the searchbase will be replaced with the suffixmassage DN.

Rather than replicating whole entries, the consumer can query logs of data modifications. This mode of operation is referred to as delta syncrepl. In addition to the above parameters, the logbase and logfilter parameters must be set appropriately for the log that will be used. The syncdata parameter must be set to either "accesslog" if the log conforms to the slapo-accesslog(5) log format, or "changelog" if the log conforms to the obsolete changelog format. If the syncdata parameter is omitted or set to "default" then the log parameters are ignored. If multiprovider is being used, the same logbase database must be configured on all of the providers.

The lazycommit parameter tells the underlying database that it can store changes without performing a full flush after each change. This may improve performance for the consumer, while sacrificing safety or durability.

updatedn <dn>

This option is only applicable in a replica database. It specifies the DN permitted to update (subject to access controls) the replica. It is only needed in certain push-mode replication scenarios. Generally, this DN should not be the same as the rootdn used at the provider.

updateref <url>

Specify the referral to pass back when slapd(8) is asked to modify a replicated local database. If specified multiple times, each url is provided.

## DATABASE-SPECIFIC OPTIONS
Each database may allow specific configuration options; they are documented separately in the backends' manual pages. See the slapd.backends(5) manual page for an overview of available backends.

## EXAMPLES
Here is a short example of a configuration file:

```
include   /etc/openldap/schema/core.schema
pidfile   /var/run/slapd.pid
# Subtypes of "name" (e.g. "cn" and "ou") with the
# option ";x-hidden" can be searched for/compared,
# but are not shown.  See slapd.access(5).
attributeoptions x-hidden lang-
access to attrs=name;x-hidden by * =cs
# Protect passwords.  See slapd.access(5).
access    to attrs=userPassword  by * auth
# Read access to other attributes and entries.
access    to *  by * read
database  mdb
suffix    "dc=our-domain,dc=com"
# The database directory MUST exist prior to
# running slapd AND should only be accessible
# by the slapd/tools. Mode 0700 recommended.
directory /var/lib/ldap/bases
# Indices to maintain
index     objectClass  eq
index     cn,sn,mail   pres,eq,approx,sub
# We serve small clients that do not handle referrals,
# so handle remote lookups on their behalf.
database  ldap
suffix    ""
uri       ldap://ldap.some-server.com/
lastmod   off
```

"OpenLDAP Administrator's Guide" contains a longer annotated example of a configuration file. The original /etc/openldap/slapd.conf is another example.

## FILES
/etc/openldap/slapd.conf

default slapd configuration file

## SEE ALSO
ldap(3), gnutls-cli(1), slapd-config(5), slapd.access(5), slapd.backends(5), slapd.overlays(5), slapd.plugin(5), slapd(8), slapacl(8), slapadd(8), slapauth(8), slapcat(8), slapdn(8), slapindex(8), slapmodify(8), slappasswd(8), slaptest(8).

"OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)

## ACKNOWLEDGEMENTS
OpenLDAP Software is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>. OpenLDAP Software is derived from the University of Michigan LDAP 3.3 Release.


slapd.overlays

package: openldap-servers

title: slapd.overlays(5)

text:
# slapd.overlays(5)

## NAME
slapd.overlays - overlays for slapd, the stand-alone LDAP daemon

## DESCRIPTION
The slapd(8) daemon can use a variety of different overlays to alter or extend the normal behavior of a database backend. Overlays may be compiled statically into slapd, or when module support is enabled, they may be dynamically loaded. Most of the overlays are only allowed to be configured on individual databases, but some may also be configured globally.

Configuration options for each overlay are documented separately in the corresponding slapo-<overlay>(5) manual pages.

accesslog

Access Logging. This overlay can record accesses to a given backend database on another database.

auditlog

Audit Logging. This overlay records changes on a given backend database to an LDIF log file. By default it is not built.

autoca

Automatic Certificate Authority overlay. This overlay can generate X.509 certificate/key pairs for entries in the directory if slapd is linked to OpenSSL. By default it is not built.

chain

Chaining. This overlay allows automatic referral chasing when a referral would have been returned, either when configured by the server or when requested by the client.

collect

Collective Attributes. This overlay implements RFC 3671 collective attributes; these attributes share common values over all the members of the collection as inherited from an ancestor entry.

constraint

Constraint. This overlay enforces a regular expression constraint on all values of specified attributes. It is used to enforce a more rigorous syntax when the underlying attribute syntax is too general.

dds

Dynamic Directory Services. This overlay supports dynamic objects, which have a limited life after which they expire and are automatically deleted.

deref

Dereference Control. This overlay implements the draft Dereference control. The overlay can be used with any backend or globally for all backends.

dyngroup

Dynamic Group. This is a demo overlay which extends the Compare operation to detect members of a dynamic group. It has no effect on any other operations.

dynlist

Dynamic List. This overlay allows expansion of dynamic groups and more.

homedir

Home Directory Provisioning. This overlay manages creation/deletion of home directories for LDAP-based Unix accounts.

memberof

MemberOf. This overlay maintains automatic reverse group membership values, typically stored in an attribute called memberOf. This overlay is deprecated and should be replaced with dynlist.

otp

OATH One-Time Password module. This module allows time-based one-time password, AKA "authenticator-style", and HMAC-based one-time password authentication to be used in conjunction with a standard LDAP password for two factor authentication.

pbind

Proxybind. This overlay forwards simple bind requests on a local database to a remote LDAP server.

pcache

Proxycache. This overlay allows caching of LDAP search requests in a local database. It is most often used with the slapd-ldap(5) or slapd-meta(5) backends.

ppolicy

Password Policy. This overlay provides a variety of password control mechanisms, e.g. password aging, password reuse and duplication control, mandatory password resets, etc.

refint

Referential Integrity. This overlay can be used with a backend database such as slapd-mdb(5) to maintain the cohesiveness of a schema which utilizes reference attributes.

remoteauth

Remote Authentication. This overlay delegates authentication requests to remote directories.

retcode

Return Code. This overlay is useful to test the behavior of clients when server-generated erroneous and/or unusual responses occur.

rwm

Rewrite/remap. This overlay is experimental. It performs basic DN/data rewrite and objectClass/attributeType mapping.

sssvlv

Server Side Sorting and Virtual List Views. This overlay implements the RFC2891 server-side sorting control and virtual list view controls, and replaces the RFC2696 paged-results implementation to ensure it works with the sorting technique.

syncprov

Syncrepl Provider. This overlay implements the provider-side support for syncrepl replication, including persistent search functionality.

translucent

Translucent Proxy. This overlay can be used with a backend database such as slapd-mdb(5) to create a "translucent proxy". Content of entries retrieved from a remote LDAP server can be partially overridden by the database.

unique

Attribute Uniqueness. This overlay can be used with a backend database such as slapd-mdb(5) to enforce the uniqueness of some or all attributes within a subtree.

valsort

Value Sorting. This overlay can be used to enforce a specific order for the values of an attribute when it is returned in a search.

## FILES
/etc/openldap/slapd.conf

default slapd configuration file

/etc/openldap/slapd.d

default slapd configuration directory

## SEE ALSO
ldap(3), slapo-accesslog(5), slapo-auditlog(5), slapo-autoca(5), slapo-chain(5), slapo-collect(5), slapo-constraint(5), slapo-dds(5), slapo-deref(5), slapo-dyngroup(5), slapo-dynlist(5), slapo-memberof(5), slapo-pbind(5), slapo-pcache(5), slapo-ppolicy(5), slapo-refint(5), slapo-remoteauth(5), slapo-retcode(5), slapo-rwm(5), slapo-sssvlv(5), slapo-syncprov(5), slapo-translucent(5), slapo-unique(5). slapo-valsort(5). slapd-config(5), slapd.conf(5), slapd.backends(5), slapd(8). "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)

## ACKNOWLEDGEMENTS
OpenLDAP Software is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>. OpenLDAP Software is derived from the University of Michigan LDAP 3.3 Release.

branch: sisyphus


slapd.plugin

title: slapd.plugin(5)

text:
# slapd.plugin(5)

## NAME
slapd.plugin - plugin configuration for slapd, the stand-alone LDAP daemon

## SYNOPSIS
/etc/openldap/slapd.conf

## DESCRIPTION
The slapd.conf(5) file contains configuration information for the slapd(8) daemon. This configuration file is also used by the SLAPD tools slapadd(8), slapcat(8), slapmodify(8), and slapindex(8).

The slapd.conf file consists of a series of global configuration options that apply to slapd as a whole (including all backends), followed by zero or more database backend definitions that contain information specific to a backend instance.

The general format of slapd.conf is as follows:

```
    # comment - these options apply to every database

    <global configuration options>

    # first database definition & configuration options

    database    <backend 1 type>

    <configuration options specific to backend 1>

    # subsequent database definitions & configuration options

    ...
```

If slapd is compiled with --enable-slapi, support for plugins according to Netscape's Directory Server Plug-Ins. Version 4 of the API is currently implemented, with some extensions from version 5.

Both global and database specific data may contain plugin information. Plugins associated with a specific database are called before global plugins. This manpage details the slapd(8) configuration statements that affect the loading of SLAPI plugins.

Arguments that should be replaced by actual text are shown in brackets <>.

The structure of the plugin directives is

plugin <type> <lib_path> <init_function> [<arguments>]

Load a plugin of the specified type for the current database.

The <type> can be one of preoperation, that is executed before processing the operation for the specified database, postoperation, that is executed after the operation for the specified database has been processed, extendedop, that is used when executing an extended operation, or object. The latter is used for miscellaneous types such as ACL, computed attribute and search filter rewriter plugins.

The <libpath> argument specifies the path to the plugin loadable object; if a relative path is given, the object is looked for according to the underlying dynamic loading package (libtool's ltdl is used).

The <init_function> argument specifies what symbol must be called when the plugin is first loaded. This function should register the functions provided by the plugin for the desired operations. It should be noted that it is this init function, not the plugin type specified as the first argument, that determines when and for what operations the plugin will be invoked. The optional <arguments> list is passed to the init function.

pluginlog <file>

Specify an alternative path for the plugin log file (default is /var/lib/errors).

modulepath <pathspec>

This statement sets the module load path for dynamically loadable backends, as described in slapd.conf(5); however, since both the dynamically loadable backends and the SLAPI plugins use the same underlying library (libtool's ltdl) its value also affects the plugin search path. In general the search path is made of colon-separated paths; usually the user-defined path is searched first; then the value of the LTDL_LIBRARY_PATH environment variable, if defined, is used; finally, the system-specific dynamic load path is attempted (e.g. on Linux the value of the environment variable LD_LIBRARY_PATH). Please carefully read the documentation of ltdl because its behavior is very platform dependent.

## FILES
/etc/openldap/slapd.conf

default slapd configuration file

/var/lib/errors

default plugin log file

## SEE ALSO
slapd(8),

"OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)

## ACKNOWLEDGEMENTS
OpenLDAP Software is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>. OpenLDAP Software is derived from the University of Michigan LDAP 3.3 Release.


slapo-accesslog

title: slapo-accesslog(5)

summary: Access Logging overlay to slapd

text:
# slapo-accesslog(5)

## NAME
slapo-accesslog - Access Logging overlay to slapd

## SYNOPSIS
/etc/openldap/slapd.conf

## DESCRIPTION
The Access Logging overlay can be used to record all accesses to a given backend database on another database. This allows all of the activity on a given database to be reviewed using arbitrary LDAP queries, instead of just logging to local flat text files. Configuration options are available for selecting a subset of operation types to log, and to automatically prune older log records from the logging database. Log records are stored with audit schema (see below) to assure their readability whether viewed as LDIF or in raw form.

## CONFIGURATION
These slapd.conf options apply to the Access Logging overlay. They should appear after the overlay directive.

logdb <suffix>

Specify the suffix of a database to be used for storing the log records. The specified database must be defined elsewhere in the configuration and must support an ordered return of results such as slapd-mdb(5) The access controls on the log database should prevent general access. The suffix entry of the log database will be created automatically by this overlay. The log entries will be generated as the immediate children of the suffix entry.

logops <operations>

Specify which types of operations to log. The valid operation types are abandon, add, bind, compare, delete, extended, modify, modrdn, search, and unbind. Aliases for common sets of operations are also available:

writes

add, delete, modify, modrdn

reads

compare, search

session

abandon, bind, unbind

all

all operations

logbase <operations> <baseDN>

Specify a set of operations that will only be logged if they occur under a specific subtree of the database. The operation types are as above for the logops setting, and delimited by a '|' character.

logold <filter>

Specify a filter for matching against Deleted and Modified entries. If the entry matches the filter, the old contents of the entry will be logged along with the current request.

logoldattr <attr> ...

Specify a list of attributes whose old contents are always logged in Modify and ModRDN requests that match any of the filters configured in logold. Usually only the contents of attributes that were actually modified will be logged; by default no old attributes are logged for ModRDN requests.

logpurge <age> <interval>

Specify the maximum age for log entries to be retained in the database, and how often to scan the database for old entries. Both the age and interval are specified as a time span in days, hours, minutes, and seconds. The time format is [ddd+]hh:mm[:ss] i.e., the days and seconds components are optional but hours and minutes are required. Except for days, which can be up to 5 digits, each numeric field must be exactly two digits. For example

logpurge 2+00:00 1+00:00

would specify that the log database should be scanned every day for old entries, and entries older than two days should be deleted. When using a log database that supports ordered indexing on generalizedTime attributes, specifying an eq index on the reqStart attribute will greatly benefit the performance of the purge operation.

logsuccess TRUE | FALSE

If set to TRUE then log records will only be generated for successful requests, i.e., requests that produce a result code of 0 (LDAP_SUCCESS). If FALSE, log records are generated for all requests whether they succeed or not. The default is FALSE.

## EXAMPLES

```
	database mdb
	suffix dc=example,dc=com
	...
	overlay accesslog
	logdb cn=log
	logops writes reads
	logbase search|compare ou=testing,dc=example,dc=com
	logold (objectclass=person)
	database mdb
	suffix cn=log
	...
	index reqStart eq
	access to *
	  by dn.base="cn=admin,dc=example,dc=com" read
```

## SCHEMA
The accesslog overlay utilizes the "audit" schema described herein. This schema is specifically designed for accesslog auditing and is not intended to be used otherwise. It is also noted that the schema described here is a work in progress, and hence subject to change without notice. The schema is loaded automatically by the overlay.

The schema includes a number of object classes and associated attribute types as described below.

The root entry of the underlying accesslog database makes use of the auditContainer class which is as follows:

( 1.3.6.1.4.1.4203.666.11.5.2.0

NAME 'auditContainer'

DESC 'AuditLog container'

SUP top STRUCTURAL

MAY ( cn $ reqStart $ reqEnd ) )

There is a basic auditObject class from which two additional classes, auditReadObject and auditWriteObject are derived. Object classes for each type of LDAP operation are further derived from these classes. This object class hierarchy is designed to allow flexible yet efficient searches of the log based on either a specific operation type's class, or on more general classifications. The definition of the auditObject class is as follows:

( 1.3.6.1.4.1.4203.666.11.5.2.1

NAME 'auditObject'

DESC 'OpenLDAP request auditing'

SUP top STRUCTURAL

MUST ( reqStart $ reqType $ reqSession )

MAY ( reqDN $ reqAuthzID $ reqControls $ reqRespControls $

reqEnd $ reqResult $ reqMessage $ reqReferral $ reqEntryUUID ) )

Note that all of the OIDs used in the logging schema currently reside under the OpenLDAP Experimental branch. It is anticipated that they will migrate to a Standard branch in the future.

An overview of the attributes follows: reqStart and reqEnd provide the start and end time of the operation, respectively. They use generalizedTime syntax. The reqStart attribute is also used as the RDN for each log entry.

The reqType attribute is a simple string containing the type of operation being logged, e.g. add, delete, search, etc. For extended operations, the type also includes the OID of the extended operation, e.g. extended(1.1.1.1)

The reqSession attribute is an implementation-specific identifier that is common to all the operations associated with the same LDAP session. Currently this is slapd's internal connection ID, stored in decimal.

The reqDN attribute is the distinguishedName of the target of the operation. E.g., for a Bind request, this is the Bind DN. For an Add request, this is the DN of the entry being added. For a Search request, this is the base DN of the search.

The reqAuthzID attribute is the distinguishedName of the user that performed the operation. This will usually be the same name as was established at the start of a session by a Bind request (if any) but may be altered in various circumstances.

The reqControls and reqRespControls attributes carry any controls sent by the client on the request and returned by the server in the response, respectively. The attribute values are just uninterpreted octet strings.

The reqResult attribute is the numeric LDAP result code of the operation, indicating either success or a particular LDAP error code. An error code may be accompanied by a text error message which will be recorded in the reqMessage attribute.

The reqReferral attribute carries any referrals that were returned with the result of the request.

The reqEntryUUID attribute records the entryUUID attribute of the entry operated on, for an Add request, this is the entryUUID of the newly created entry.

Operation-specific classes are defined with additional attributes to carry all of the relevant parameters associated with the operation:

( 1.3.6.1.4.1.4203.666.11.5.2.4

NAME 'auditAbandon'

DESC 'Abandon operation'

SUP auditObject STRUCTURAL

MUST reqId )

For the Abandon operation the reqId attribute contains the message ID of the request that was abandoned.

( 1.3.6.1.4.1.4203.666.11.5.2.5

NAME 'auditAdd'

DESC 'Add operation'

SUP auditWriteObject STRUCTURAL

MUST reqMod )

The Add class inherits from the auditWriteObject class. The Add and Modify classes are very similar. The reqMod attribute carries all of the attributes of the original entry being added. (Or in the case of a Modify operation, all of the modifications being performed.) The values are formatted as

attribute:<+|-|=|#> [ value]

Where '+' indicates an Add of a value, '-' for Delete, '=' for Replace, and '#' for Increment. In an Add operation, all of the reqMod values will have the '+' designator.

( 1.3.6.1.4.1.4203.666.11.5.2.6

NAME 'auditBind'

DESC 'Bind operation'

SUP auditObject STRUCTURAL

MUST ( reqVersion $ reqMethod ) )

The Bind class includes the reqVersion attribute which contains the LDAP protocol version specified in the Bind as well as the reqMethod attribute which contains the Bind Method used in the Bind. This will be the string SIMPLE for LDAP Simple Binds or SASL(<mech>) for SASL Binds. Note that unless configured as a global overlay, only Simple Binds using DNs that reside in the current database will be logged.

( 1.3.6.1.4.1.4203.666.11.5.2.7

NAME 'auditCompare'

DESC 'Compare operation'

SUP auditObject STRUCTURAL

MUST reqAssertion )

For the Compare operation the reqAssertion attribute carries the Attribute Value Assertion used in the compare request.

( 1.3.6.1.4.1.4203.666.11.5.2.8

NAME 'auditDelete'

DESC 'Delete operation'

SUP auditWriteObject STRUCTURAL

MAY reqOld )

The Delete operation needs no further parameters. However, the reqOld attribute may optionally be used to record the contents of the entry prior to its deletion. The values are formatted as

attribute: value

The reqOld attribute is only populated if the entry being deleted matches the configured logold filter.

( 1.3.6.1.4.1.4203.666.11.5.2.9

NAME 'auditModify'

DESC 'Modify operation'

SUP auditWriteObject STRUCTURAL

MAY ( reqOld $ reqMod ) )

The Modify operation contains a description of modifications in the reqMod attribute, which was already described above in the Add operation. It may optionally contain the previous contents of any modified attributes in the reqOld attribute, using the same format as described above for the Delete operation. The reqOld attribute is only populated if the entry being modified matches the configured logold filter.

( 1.3.6.1.4.1.4203.666.11.5.2.10

NAME 'auditModRDN'

DESC 'ModRDN operation'

SUP auditWriteObject STRUCTURAL

MUST ( reqNewRDN $ reqDeleteOldRDN )

MAY ( reqNewSuperior $ reqMod $ reqOld ) )

The ModRDN class uses the reqNewRDN attribute to carry the new RDN of the request. The reqDeleteOldRDN attribute is a Boolean value showing TRUE if the old RDN was deleted from the entry, or FALSE if the old RDN was preserved. The reqNewSuperior attribute carries the DN of the new parent entry if the request specified the new parent. The reqOld attribute is only populated if the entry being modified matches the configured logold filter and contains attributes in the logoldattr list.

( 1.3.6.1.4.1.4203.666.11.5.2.11

NAME 'auditSearch'

DESC 'Search operation'

SUP auditReadObject STRUCTURAL

MUST ( reqScope $ reqDerefAliases $ reqAttrsOnly )

MAY ( reqFilter $ reqAttr $ reqEntries $ reqSizeLimit $

reqTimeLimit ) )

For the Search class the reqScope attribute contains the scope of the original search request, using the values specified for the LDAP URL format. I.e. base, one, sub, or subord. The reqDerefAliases attribute is one of never, finding, searching, or always, denoting how aliases will be processed during the search. The reqAttrsOnly attribute is a Boolean value showing TRUE if only attribute names were requested, or FALSE if attributes and their values were requested. The reqFilter attribute carries the filter used in the search request. The reqAttr attribute lists the requested attributes if specific attributes were requested. The reqEntries attribute is the integer count of how many entries were returned by this search request. The reqSizeLimit and reqTimeLimit attributes indicate what limits were requested on the search operation.

( 1.3.6.1.4.1.4203.666.11.5.2.12

NAME 'auditExtended'

DESC 'Extended operation'

SUP auditObject STRUCTURAL

MAY reqData )

The Extended class represents an LDAP Extended Operation. As noted above, the actual OID of the operation is included in the reqType attribute of the parent class. If any optional data was provided with the request, it will be contained in the reqData attribute as an uninterpreted octet string.

## NOTES
The Access Log implemented by this overlay may be used for a variety of other tasks, e.g. as a ChangeLog for a replication mechanism, as well as for security/audit logging purposes.

## FILES
/etc/openldap/slapd.conf

default slapd configuration file

## SEE ALSO
slapd.conf(5), slapd-config(5).

## ACKNOWLEDGEMENTS
This module was written in 2005 by Howard Chu of Symas Corporation.


slapo-allop

title: slapo-allop(5)

summary: All Operational Attributes overlay

text:
# slapo-allop(5)

## NAME
slapo-allop - All Operational Attributes overlay

## SYNOPSIS
ETCDIR/slapd.conf

## DESCRIPTION
The All Operational Attributes overlay is designed to allow slapd to interoperate with dumb clients that expect all attributes, including operational ones, to be returned when "*" or an empty attribute list is requested, as opposed to RFC2251 and RFC3673.

## CONFIGURATION
These slapd.conf options apply to the All Operational overlay. They should appear after the overlay directive and before any subsequent database directive.

allop-URI <ldapURI>

Specify the base and the scope of search operations that trigger the overlay. By default, it is "ldap:///??base", i.e. it only applies to the rootDSE. This requires the overlay to be instantiated as global.

## EXAMPLES
default behavior: only affects requests to the rootDSE

```
        # global

        overlay         allop
```

affects all requests

```
        # global

        overlay         allop

        allop-URI       "ldap:///??sub"
```

affects only requests directed to the suffix of a database

```
        # per database

        database        mdb

        suffix          "dc=example,dc=com"

        # database specific directives ...

        overlay         allop

        allop-URI       "ldap:///dc=example,dc=com??base"
```

## FILES
ETCDIR/slapd.conf

default slapd configuration file

## SEE ALSO
slapd.conf(5).

## ACKNOWLEDGEMENTS
This module was written in 2005 by Pierangelo Masarati for SysNet s.n.c.


slapo-auditlog

title: slapo-auditlog(5)

summary: Audit Logging overlay to slapd

text:
# slapo-auditlog(5)

## NAME
slapo-auditlog - Audit Logging overlay to slapd

## SYNOPSIS
/etc/openldap/slapd.conf

/etc/openldap/slapd.d

## DESCRIPTION
The Audit Logging overlay can be used to record all changes on a given backend database to a specified log file. Changes are logged as standard LDIF, with an additional comment header providing six fields of information about the change. A second comment header is added at the end of the operation to note the termination of the change.

For Add and Modify operations the identity comes from the modifiersName associated with the operation. This is usually the same as the requestor's identity, but may be set by other overlays to reflect other values.

## CONFIGURATION
This slapd.conf option applies to the Audit Logging overlay. It should appear after the overlay directive.

auditlog <filename>

Specify the fully qualified path for the log file.

olcAuditlogFile <filename>

For use with cn=config

## COMMENT FIELD INFORMATION
The first field is the operation type.

The second field is the timestamp of the operation in seconds since epoch.

The third field is the suffix of the database.

The fourth field is the recorded modifiersName.

The fifth field is the originating IP address and port.

The sixth field is the connection number. A connection number of -1 indicates an internal slapd operation.

## EXAMPLE
The following LDIF could be used to add this overlay to cn=config (adjust to suit)

```
dn: olcOverlay=auditlog,olcDatabase={1}mdb,cn=config
changetype: add
objectClass: olcOverlayConfig
objectClass: olcAuditLogConfig
olcOverlay: auditlog
olcAuditlogFile: /tmp/auditlog.ldif
```

## EXAMPLE CHANGELOG

```
# modify 1614223245 dc=example,dc=com cn=admin,dc=example,dc=com IP=[::1]:47270 conn=1002
dn: uid=joepublic,ou=people,dc=example,dc=com
changetype: modify
replace: displayName
displayName: Joe Public
-
replace: entryCSN
entryCSN: 20210225032045.045229Z#000000#001#000000
-
replace: modifiersName
modifiersName: cn=admin,dc=example,dc=com
-
replace: modifyTimestamp
modifyTimestamp: 20210225032045Z
-
# end modify 1614223245
```

## FILES
/etc/openldap/slapd.conf

default slapd configuration file

/etc/openldap/slapd.d

default slapd configuration directory

## SEE ALSO
slapd.conf(5), slapd-config(5).


slapo-autoca

title: slapo-autoca(5)

text:
# slapo-autoca(5)

## NAME
slapo-autoca - Automatic Certificate Authority overlay to slapd

## SYNOPSIS
/etc/openldap/slapd.conf

## DESCRIPTION
The Automatic CA overlay generates X.509 certificate/key pairs for entries in the directory. The DN of a generated certificate is identical to the DN of the entry containing it. On startup it looks for a CA certificate and key in the suffix entry of the database which it will use to sign all subsequently generated certificates. A new CA certificate and key will be generated and stored in the suffix entry if none already exists. The CA certificate is stored in the cACertificate;binary attribute of the suffix entry, and the private key is stored in the cAPrivateKey;binary attribute of the suffix entry. These attributes may be overwritten if some other CA certificate/key pair is desired for use.

Certificates for users and servers are generated on demand using a Search request returning only the userCertificate;binary and userPrivateKey;binary attributes. Any Search for anything besides exactly these two attributes is ignored by the overlay. Note that these values are stored in ASN.1 DER form in the directory so the ";binary" attribute option is mandatory.

Entries that do not belong to selected objectClasses will be ignored by the overlay. By default, entries of objectClass person will be treated as users, and entries of objectClass ipHost will be treated as servers. There are slight differences in the set of X.509V3 certificate extensions added to the certificate between users and servers.

The CA's private key is stored in a cAPrivateKey attribute, and user and server private keys are stored in the userPrivateKey attribute. The private key values are encoded in PKCS#8 format. It is essential that access to these attributes be properly secured with ACLs. Both of these attributes inherit from the pKCS8PrivateKey attribute, so it is sufficient to use a single ACL rule like

```
        access to attrs=pKCS8PrivateKey by self ssf=128 write
```

at the beginning of the rules.

Currently there is no automated management for expiration or revocation. Obsolete certificates and keys must be manually removed by deleting an entry's userCertificate and userPrivateKey attributes.

## CONFIGURATION
These slapd.conf options apply to the Automatic CA overlay. They should appear after the overlay directive.

userClass <objectClass>

Specify the objectClass to be treated as user entries.

serverClass <objectClass>

Specify the objectClass to be treated as server entries.

userKeybits <integer>

Specify the size of the private key to use for user certificates. The default is 2048 and the minimum is 512.

serverKeybits <integer>

Specify the size of the private key to use for server certificates. The default is 2048 and the minimum is 512.

caKeybits <integer>

Specify the size of the private key to use for the CA certificate. The default is 2048 and the minimum is 512.

userDays <integer>

Specify the duration for a user certificate's validity. The default is 365, 1 year.

serverDays <integer>

Specify the duration for a server certificate's validity. The default is 1826, 5 years.

caDays <integer>

Specify the duration for the CA certificate's validity. The default is 3652, 10 years.

localDN <DN>

Specify the DN of an entry that represents this server. Requests to generate a certificate/key pair for this DN will also install the certificate and key into slapd's TLS settings in cn=config for immediate use.

## EXAMPLES

```
  database mdb

  ...

  overlay autoca

  caKeybits 4096
```

## FILES
/etc/openldap/slapd.conf

default slapd configuration file

## SEE ALSO
slapd.conf(5), slapd-config(5).

## AUTHOR
Howard Chu


slapo-autogroup

title: slapo-autogroup(5)

text:
# slapo-autogroup(5)

## NAME
slapo-autogroup - automatic updates of group memberships which meet the requirements of any filter contained in the group definition.

## SYNOPSIS
In slapd.conf:

...

include ETCDIR/schema/dyngroup.schema

...

moduleload autogroup.so

...

database ...

...

overlay autogroup

autogroup-attrset groupOfURLs memberURL member

## DESCRIPTION
The autogroup overlay to slapd(8) allows automated updates of group memberships which meet the requirements of any filter contained in the group definition. The filters are built from LDAP URI-valued attributes. Any time an object is added/deleted/updated, it is tested for compliance with the filters, and its membership is accordingly updated. For searches and compares, it behaves like a static group. If the attribute part of the URI is filled, the group entry is populated by the values of this attribute in the entries resulting from the search.

Note that filters that use attributes that are themselves dynamically computed may not work consistently, and should be avoided.

## CONFIGURATION
Either slapd.conf(5) or the cn=config methodology of slapd-config(5) may be used for configuring autogroup. Both syntaxes are provided here for convenience:

autogroup-attrset <group-oc> <URL-ad> <member-ad>

olcAutoGroupAttrSet: <group-oc> <URL-ad> <member-ad>

This defines the objectclass-attribute-URI mappings defining the automatically managed groups, and may appear multiple times. The value <group-oc> is the name of the objectClass that represents the group.

The value <URL-ad> is the name of the attributeDescription that contains the URI that is converted to the filters. If no URI is present, there will be no members in that group. It must be a subtype of labeledURI.

The value <member-ad> is the name of the attributeDescription that specifies the member attribute. User modification of this attribute is disabled for consistency.

autogroup-memberof-ad <memberof-ad>

olcAutoGroupMemberOfAd <memberof-ad>

This defines the attribute that is used by the memberOf overlay to store the names of groups that an entry is member of; it must be DN-valued. It should be set to the same value as memberof-memberof-ad. It defaults to 'memberOf'.

## EXAMPLES
As above in SYNOPSIS, or with memberof:

...

include ETCDIR/schema/dyngroup.schema

include ETCDIR/schema/memberof.schema

...

moduleload autogroup.so

moduleload memberof.so

...

database ...

...

overlay memberof

memberof-memberof-ad foo

...

overlay autogroup

autogroup-attrset groupOfURLs memberURL member

autogroup-memberof-ad foo

## CAVEATS
As with static groups, update operations on groups with a large number of members may be slow. If the attribute part of the URI is specified, modify and delete operations are more difficult to handle. In these cases the overlay will try to detect if groups have been modified and then simply refresh them. This can cause performance hits if the search specified by the URI deals with a significant number of entries.

## BACKWARD COMPATIBILITY
The autogroup overlay has been reworked with the 2.5 release to use a consistent namespace as with other overlays. As a side-effect the following cn=config parameters are deprecated and will be removed in a future release:

•

olcAGattrSet is replaced with olcAutoGroupAttrSet

•

olcAGmemberOfAd is replaced with olcAutoGroupMemberOfAd

•

olcAutomaticGroups is replaced with olcAutoGroupConfig

## ACKNOWLEDGEMENTS
This module was originally written in 2007 by Michał Szulczyński. Further enhancements were contributed by Howard Chu, Raphael Ouazana, Norbert Pueschel, and Christian Manal. Manpage updates provided by Emily Backes.

## SEE ALSO
slapd.conf(5), slapd(8).

## Copyrights
Copyright 1998-2026 The OpenLDAP Foundation. Portions Copyright © 2007 Michał Szulczyński. All rights reserved.