.TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
-.\" Copyright 1998-2004 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2005 The OpenLDAP Foundation All Rights Reserved.
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
.\" $OpenLDAP$
.SH NAME
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.
.LP
The general format of
.B slapd.conf
.LP
If a line begins with white space, it is considered a continuation
of the previous line. Blank lines and comment lines beginning with
-a `#' character are ignored. (Note: continuation lines are unwrapped
-before comment processing is applied.)
+a `#' character are ignored. Note: continuation lines are unwrapped
+before comment processing is applied.
.LP
Arguments on configuration lines are separated by white space. If an
argument contains white space, the argument should be enclosed in
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
.BR slapd.access (5)
and the "OpenLDAP's Administrator's Guide" for details.
.I <pattern>
to be normalized according to the DN normalization rules, or the special
.I regex
-style, which causes
+style, which causes the
.I <pattern>
-to be compiled according to
-.BR regex (7).
+to be treated as a POSIX (''extended'') regular expression, as
+discussed in
+.BR regex (7)
+and/or
+.BR re_format (7).
A pattern of
.I *
means any non-anonymous DN.
.RE
This name is then compared against the
.B match
-regular expression, and if the match is successful, the name is
-replaced with the
+POSIX (''extended'') regular expression, and if the match is successful,
+the name is replaced with the
.B replace
string. If there are wildcard strings in the
.B match
.B UID=$1,OU=Accounts,DC=example,DC=com
.RE
-The replaced name can be either a DN or an LDAP URI. If the
-latter, the server will use the URI to search its own database(s)
+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, e.g.
+hostport, attrs, or extensions components, but the filter is mandatory,
+e.g.
.RS
.TP
.B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
.RE
+The protocol portion of the URI must be strictly
+.BR ldap .
+
Multiple
.B authz-regexp
options can be given in the configuration file to allow for multiple matching
.B conn_max_pending_auth <integer>
Specify the maximum number of pending requests for an authenticated session.
The default is 1000.
-.\"-- NEW_LOGGING option --
-.\".TP
-.\".B debug <subsys> <level>
-.\"Specify a logging level for a particular subsystem. The subsystems include
-.\".B global
-.\"a global level for all subsystems,
-.\".B acl
-.\"the ACL engine,
-.\".B backend
-.\"the backend databases,
-.\".B cache
-.\"the entry cache manager,
-.\".B config
-.\"the config file reader,
-.\".B connection
-.\"the connection manager,
-.\".B cyrus
-.\"the Cyrus SASL library interface,
-.\".B filter
-.\"the search filter processor,
-.\".B getdn
-.\"the DN normalization library,
-.\".B index
-.\"the database indexer,
-.\".B liblber
-.\"the ASN.1 BER library,
-.\".B module
-.\"the dynamic module loader,
-.\".B operation
-.\"the LDAP operation processors,
-.\".B sasl
-.\"the SASL authentication subsystem,
-.\".B schema
-.\"the schema processor, and
-.\".B tls
-.\"the TLS library interface. This is not an exhaustive list; there are many
-.\"other subsystems and more are added over time.
-.\"
-.\"The levels are, in order of decreasing priority:
-.\".B emergency, alert, critical, error, warning, notice, information, entry,
-.\".B args, results, detail1, detail2
-.\"An integer may be used instead, with 0 corresponding to
-.\".B emergency
-.\"up to 11 for
-.\".BR detail2 .
-.\"The
-.\".B entry
-.\"level logs function entry points,
-.\".B args
-.\"adds function call parameters, and
-.\".B results
-.\"adds the function results to the logs.
-.\"The
-.\".B detail1
-.\"and
-.\".B detail2
-.\"levels add even more low level detail from individual functions.
.TP
.B defaultsearchbase <dn>
Specify a default search base to use when client submits a
disables acceptance of anonymous bind requests.
.B bind_simple
disables simple (bind) authentication.
-.B bind_krbv4
-disables Kerberos V4 (bind) authentication.
.B tls_2_anon
disables Start TLS from forcing session to anonymous status (see also
.BR tls_authc ).
.B include <filename>
Read additional configuration information from the given file before
continuing with the next line of the current file.
+.TP
+.B 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.
+.TP
+.B 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.
+.TP
+.B 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
+.I index_substr_if_maxlen
+value.
+.TP
+.B 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".
+
.\"-- NEW_LOGGING option --
.\".TP
.\".B logfile <filename>
.\"only go to stderr and are not recorded anywhere else. Specifying a logfile
.\"copies messages to both stderr and the logfile.
.TP
+.B 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
+.BR sasl-secprops 's
+.B minssf
+option description. The default is 71.
+.TP
.B loglevel <integer> [...]
Specify the level at which debugging statements and operation
statistics should be syslogged (currently logged to the
controls the entries on this server. The default is "cn=Subschema".
.TP
.B security <factors>
-Specify a set of factors (separated by white space) to require.
-An integer value is associated with each factor and is roughly
-equivalent of the encryption key length to require. A value
-of 112 is equivalent to 3DES, 128 to Blowfish, etc..
+Specify a set of security strength factors (separated by white space)
+to require (see
+.BR sasl-secprops 's
+.B minssf
+option for a description of security strength factors).
The directive may be specified globally and/or per-database.
.B ssf=<n>
specifies the overall security strength factor.
Specify the maximum incoming LDAP PDU size for authenticated sessions.
The default is 4194303.
.TP
-.B srvtab <filename>
-Specify the srvtab file in which the kerberos keys necessary for
-authenticating clients using kerberos can be found. This option is only
-meaningful if you are using Kerberos authentication.
-.TP
.B threads <integer>
Specify the maximum size of the primary thread pool.
The default is 16.
.B TLSVerifyClient
setting must be chosen to enable SASL EXTERNAL authentication.
.RE
+.TP
+.B 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
+.B TLSCACertificatePath
+parameter to be set.
+.B <level>
+can be specified as one of the following keywords:
+.RS
+.TP
+.B none
+No CRL checks are performed
+.TP
+.B peer
+Check the CRL of the peer certificate
+.TP
+.B all
+Check the CRL for a whole certificate chain
+.RE
.SH GENERAL BACKEND OPTIONS
Options in this section only apply to the configuration file section
for the specified backend. They are supported by every
Mark the beginning of a backend definition. <databasetype>
should be one of
.BR bdb ,
+.BR config ,
.BR dnssrv ,
+.BR hdb ,
.BR ldap ,
.BR ldbm ,
+.BR ldif ,
.BR meta ,
.BR monitor ,
.BR null ,
.BR perl ,
.BR relay ,
.BR shell ,
-.BR sql ,
or
-.BR tcl ,
+.BR sql ,
depending on which backend will serve the database.
.SH GENERAL DATABASE OPTIONS
Mark the beginning of a new database instance definition. <databasetype>
should be one of
.BR bdb ,
+.BR config ,
.BR dnssrv ,
+.BR hdb ,
.BR ldap ,
.BR ldbm ,
+.BR ldif ,
.BR meta ,
.BR monitor ,
.BR null ,
.BR perl ,
.BR relay ,
.BR shell ,
-.BR sql ,
or
-.BR tcl ,
+.BR sql ,
depending on which backend will serve the database.
.TP
.B lastmod on | off
.BR children ,
to allow any level of depth match, not including the exact match;
.BR regex
-explicitly requires the (default) match based on regular expression
-pattern, as detailed in
-.BR regex (7).
+explicitly requires the (default) match based on POSIX (''extended'')
+regular expression pattern.
Finally,
.B anonymous
matches unbound operations; the
.BR 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 indicized
+The rationale behind it is that searches for non-properly indexed
attributes may result in large sets of candidates, which must be
examined by
.BR slapd (8)
to determine whether they match the search filter or not.
The
-.B unckeched
+.B unchecked
limit provides a means to drop such operations before they are even
started.
If the selected candidates exceed the
a namingContext (suffix) of the database, a simple bind password
may also be provided using the
.B rootpw
-directive.
+directive. Note that the rootdn is always needed when using syncrepl.
.TP
.B rootpw <password>
Specify a password (or hash of the password) for the rootdn. The
If the suffix of one database is "inside" that of another, the database
with the inner suffix must come first in the configuration file.
.TP
-.B subordinate
+.B subordinate [advertise]
Specify that the current backend database is a subordinate of another
-backend database. A subordinate database may have only one suffix. This
+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
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 \fBadvertise\fP 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
+.BR slapcat (8),
+.BR slapadd (8),
+or
+.BR 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 \fIsubordinate\fP functionality is implemented internally
+by the \fIglue\fP 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 \fBoverlay glue\fP directive
+at the desired position. This explicit configuration is necessary e.g.
+when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
+in order to work over all of the glued databases. E.g.
+.RS
+.nf
+ database bdb
+ suffix dc=example,dc=com
+ ...
+ overlay glue
+ overlay syncprov
+.fi
+.RE
.HP
.hy 0
.B syncrepl rid=<replica ID>
.B provider=ldap[s]://<hostname>[:port]
.B [type=refreshOnly|refreshAndPersist]
.B [interval=dd:hh:mm:ss]
+.B [retry=[<retry interval> <# of retries>]+]
.B [searchbase=<base DN>]
.B [filter=<filter str>]
.B [scope=sub|one|base]
.B [sizelimit=<limit>]
.B [timelimit=<limit>]
.B [schemachecking=on|off]
-.B [updatedn=<dn>]
+.B [starttls=yes|critical]
.B [bindmethod=simple|sasl]
.B [binddn=<dn>]
.B [saslmech=<mech>]
.B [credentials=<passwd>]
.B [realm=<realm>]
.B [secprops=<properties>]
+.B [logbase=<base DN>]
+.B [logfilter=<filter str>]
+.B [syncdata=default|accesslog|changelog]
.RS
Specify the current database as a replica which is kept up-to-date with the
master content by establishing the current
Further updates to the master replica will generate
.B searchResultEntry
to the consumer slapd as the search responses to the persistent
-synchronization search. If the connection is lost, the consumer will
-attempt to reconnect at an interval time (specified by
-.B interval
-parameter; 60 seconds by default) until the session is re-established.
+synchronization search.
+If an error occurs during replication, the consumer will attempt to
+reconnect according to the
+.B 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.
The schema checking can be enforced at the LDAP Sync
consumer site by turning on the
.B schemachecking
parameter. The default is off.
The
-.B updatedn
-parameter specifies the DN in the consumer site
-which is allowed to make changes to the replica.
-The DN should have read/write access to the replica database.
-Generally, this DN
-.I should not
-be the same as the
-.B rootdn
-of the master database.
+.B starttls
+parameter specifies use of the StartTLS extended operation
+to establish a TLS session before Binding to the provider. If the
+.B critical
+argument is supplied, the session will be aborted if the StartTLS request
+fails. Otherwise the syncrepl session continues without TLS.
A
.B bindmethod
of
option. A non default SASL realm can be set with the
.B realm
option.
+
+Rather than replicating whole entries, the consumer can query logs of
+data modifications. This mode of operation is referred to as \fIdelta
+syncrepl\fP. In addition to the above parameters, the
+.B logbase
+and
+.B logfilter
+parameters must be set appropriately for the log that will be used. The
+.B syncdata
+parameter must be set to either "accesslog" if the log conforms to the
+.BR slapo-accesslog (5)
+log format, or "changelog" if the log conforms
+to the obsolete \fIchangelog\fP format. If the
+.B syncdata
+parameter is omitted or set to "default" then the log parameters are
+ignored.
.RE
.TP
.B updatedn <dn>
it properly.
It uses the Sleepycat Berkeley DB (BDB) package to store data.
.TP
-.B ldbm
-This is the database backend which is easiest to configure.
-However, it does not offer the data durability features of the BDB
-backend.
-It uses Berkeley DB or GDBM to store data.
+.B config
+This backend is used to manage the configuration of slapd run-time.
.TP
.B dnssrv
This backend is experimental.
It serves up referrals based upon SRV resource records held in the
Domain Name System.
.TP
+.B hdb
+This is a variant of the BDB backend that uses a hierarchical database
+layout which supports subtree renames.
+.TP
.B ldap
This backend acts as a proxy to forward incoming requests to another
LDAP server.
.TP
+.B ldbm
+This is the database backend which is easiest to configure.
+However, it does not offer the data durability features of the BDB
+backend.
+It uses Berkeley DB or GDBM to store data.
+.TP
+.B ldif
+This database uses the filesystem to build the tree structure
+of the database, using plain ascii files to store data.
+Its usage should be limited to very simple databases, where performances
+are not a requirement.
+.TP
.B meta
This backend performs basic LDAP proxying with respect to a set of
remote LDAP servers. It is an enhancement of the ldap backend. The
It runs Perl subroutines to implement LDAP operations.
.TP
.B relay
-This backend redirects LDAP operations to another database
+This backend is experimental.
+It redirects LDAP operations to another database
in the same server, based on the naming context of the request.
Its use requires the
.B rwm
.B sql
This backend is experimental.
It services LDAP requests from an SQL database.
+.SH OVERLAYS
+The following overlays can be compiled into slapd.
+They are documented in the
+.BR slapo-<overlay> (5)
+manual pages.
.TP
-.B tcl
-This backend is experimental.
-It embeds a
-.BR Tcl (3tcl)
-interpreter into slapd.
-It runs Tcl commands to implement LDAP operations.
+.B accesslog
+Access Logging.
+This overlay can record accesses to a given backend database on another
+database.
+.TP
+.B auditlog
+Audit Logging.
+This overlay records changes on a given backend database to an LDIF log
+file.
+By default it is not built.
+.TP
+.B chain
+Chaining.
+This overlay allows automatic referral chasing when a referral would
+have been returned.
+.TP
+.B denyop
+Deny Operation.
+This overlay allows selected operations to be denied, similar to the
+\fBrestrict\fP option.
+.TP
+.B 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.
+.TP
+.B dynlist
+Dynamic List.
+This overlay allows expansion of dynamic groups and more.
+.TP
+.B lastmod
+Last Modification.
+This overlay maintains a service entry in the database with the DN,
+modification type, modifiersName and modifyTimestamp of the last write
+operation performed on that database.
+.TP
+.B pcache
+Proxycache.
+This overlay allows caching of LDAP search requests in a local database.
+.TP
+.B 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.
+.TP
+.B refint
+Referential Integrity.
+This overlay can be used with a backend database such as
+.BR slapd-bdb (5)
+to maintain the cohesiveness of a schema which utilizes reference
+attributes.
+.TP
+.B retcode
+Return Code.
+This overlay is useful to test the behavior of clients when
+server-generated erroneous and/or unusual responses occur.
+.TP
+.B rwm
+Rewrite/remap.
+This overlay is experimental.
+It performs basic DN/data rewrite and
+objectClass/attributeType mapping.
+.TP
+.B syncprov
+Syncrepl Provider.
+This overlay implements the provider-side support for
+.B syncrepl
+replication, including persistent search functionality.
+.TP
+.B translucent
+Translucent Proxy.
+This overlay can be used with a backend database such as
+.BR slapd-bdb (5)
+to create a "translucent proxy".
+Content of entries retrieved from a remote LDAP server can be partially
+overridden by the database.
+.TP
+.B unique
+Attribute Uniqueness.
+This overlay can be used with a backend database such as
+.BR slapd-bdb (5)
+to enforce the uniqueness of some or all attributes within a subtree.
.SH EXAMPLES
.LP
Here is a short example of a configuration file:
attributeoptions x-hidden lang-
access to attr=name;x-hidden by * =cs
+# Protect passwords. See \fBslapd.access\fP(5).
+access to attrs=userPassword by * auth
+# Read access to other attributes and entries.
+access to * by * read
+
database bdb
suffix "dc=our-domain,dc=com"
# The database directory MUST exist prior to
.BR ldap (3),
.BR slapd\-bdb (5),
.BR slapd\-dnssrv (5),
+.BR slapd\-hdb (5),
.BR slapd\-ldap (5),
.BR slapd\-ldbm (5),
+.BR slapd\-ldif (5),
.BR slapd\-meta (5),
.BR slapd\-monitor (5),
.BR slapd\-null (5),
.BR slapd\-relay (5),
.BR slapd\-shell (5),
.BR slapd\-sql (5),
-.BR slapd\-tcl (5),
.BR slapd.access (5),
.BR slapd.plugin (5),
.BR slapd.replog (5),
.BR slurpd (8).
Known overlays are documented in
+.BR slapo\-accesslog (5),
+.BR slapo\-auditlog (5),
+.BR slapo\-chain (5),
+.BR slapo\-dynlist (5),
.BR slapo\-lastmod (5),
.BR slapo\-pcache (5),
.BR slapo\-ppolicy (5),
.BR slapo\-refint (5),
+.BR slapo\-retcode (5),
.BR slapo\-rwm (5),
+.BR slapo\-syncprov (5),
+.BR slapo\-translucent (5),
.BR slapo\-unique (5).
.LP
"OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
projects / openldap / blobdiff