-.TH SLAPD.CONF 5 "5 August 1999" "OpenLDAP LDVERSION"
-.\" $OpenLDAP$
-.\" Copyright 1998-1999 The OpenLDAP Foundation All Rights Reserved.
+.TH SLAPD.CONF 5 "28 May 2001" "OpenLDAP LDVERSION"
+.\" Copyright 1998-2001 The OpenLDAP Foundation All Rights Reserved.
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
+.\" $OpenLDAP$
.SH NAME
slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
.SH SYNOPSIS
backslash character.
.LP
The specific configuration options available are discussed below in the
-Global Configuration Options, General Backend Options, LDBM
-Backend-Specific Options, Shell Backend-Specific Options, and Password
-Backend-Specific Options sections. Refer to "The SLAPD and SLURPD
+Global Configuration Options, General Backend Options, General Database
+Options, LDBM Database-Specific Options,
+Shell Database-Specific Options, and Password
+Database-Specific Options sections. Refer to the "OpenLDAP
Administrator's Guide" for more details on the slapd configuration
file.
.SH GLOBAL CONFIGURATION OPTIONS
overridden in a backend definition. Arguments that should be replaced by
actual text are shown in brackets <>.
.TP
-.B
-access to <what> [ by <who> <access> <control> ]+
+.B 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>).
-See Developer's FAQ (http://www.openldap.org/faq/) for details.
+See the "OpenLDAP's Administrator's Guide" for details.
.TP
-.B
-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>] )
+.B allow <features>
+Specify a set of features (separated by white space) to
+allow (default none).
+.B tls_2_anon
+allows Start TLS to force session to anonymous status (see also
+.B disallow
+.BR tls_authc ).
+.TP
+.B argsfile <filename>
+The ( absolute ) name of a file that will hold the
+.B slapd
+server's command line options
+if started without the debugging command line option.
+.HP
+.hy 0
+.B attributetype (\ <oid> [NAME\ <name>] [OBSOLETE]\
+ [DESC\ <description>]\
+ [SUP\ <oid>] [EQUALITY\ <oid>] [ORDERING\ <oid>]\
+ [SUBSTR\ <oid>] [SYNTAX\ <oidlen>] [SINGLE\-VALUE] [COLLECTIVE]\
+ [NO\-USER\-MODIFICATION] [USAGE\ <attributeUsage>]\ )
+.RS
Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
-This is the preferred format for attribute type definitions. The slapd
-parser extends the RFC 2252 definition by allowing string forms as well
-as numeric OIDs to be used for the attribute OID and attribute syntax OID.
+The slapd parser extends the RFC 2252 definition by allowing string
+forms as well as numeric OIDs to be used for the attribute OID and
+attribute syntax OID.
(See the
.B objectidentifier
description.) Currently the syntax name parser is case-sensitive.
.PD
.RE
.RE
-.TP
-.B
-attribute[type] <name> [<name2>] { bin | ces | cis | tel | dn }
-Associate a syntax with an attribute name. This directive is deprecated
-in favor of the one above. By default, an
-attribute is assumed to have syntax
-.BR cis .
-An optional alternate name can be
-given for an attribute. The possible syntaxes and their meanings are:
-.RS
-.RS
-.PD 0
-.TP
-.B bin
-binary
-.TP
-.B ces
-case exact string
-.TP
-.B cis
-case ignore string
-.TP
-.B tel
-telephone number string
-.TP
-.B dn
-distinguished name
-.PD
-.RE
.RE
.TP
-.B
-defaultaccess { none | auth | compare | search | read | write }
-Specify the default access level to grant requestors when
-no access directives were provided for the database.
-The default behavior is to grant 'read' access. It is
-recommended that
-.B access
-directives be used instead.
+.B 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.
+.TP
+.B defaultsearchbase <dn>
+Specify a default search base to use when client submits a
+non-base search request with an empty base DN.
+.TP
+.B disallow <features>
+Specify a set of features (separated by white space) to
+disallow (default none).
+.B bind_v2
+disables acceptance of LDAPv2 bind requests.
+.B bind_anon
+disables acceptance of anonymous bind requests.
+.B bind_anon_cred
+disables anonymous bind creditials are not empty (e.g.
+when DN is empty).
+.B bind_anon_dn
+disables anonymous bind when DN is not empty.
+.B bind_simple
+disables simple (bind) authentication.
+.B bind_krbv4
+disables Kerberos V4 (bind) authentication.
+.B tls_authc
+disables StartTLS if authenticated (see also
+.B allow
+.BR tls_2_anon ).
.TP
.B idletimeout <integer>
Specify the number of seconds to wait before forcibly closing
Read additional configuration information from the given file before
continuing with the next line of the current file.
.TP
-.B pidfile <filename>
-The ( absolute ) name of a file that will hold the
-.B slapd
-server's process ID ( see
-.BR getpid (2)
-) if started without the debugging command line option.
-.TP
-.B argsfile <filename>
-The ( absolute ) name of a file that will hold the
-.B slapd
-server's command line options
-if started without the debugging command line option.
-.TP
-.B
-locale { <locale-name> | on | off }
-Obey <locale-name>'s character classification and case conversion; i.e. the
-.BR locale (5)
-LC_CTYPE category. See
-.BR locale (5)
-for details about locales. "on" takes the locale from the environment,
-typically $LANG or $LC_CTYPE, and will only work properly if slapd will
-run with the same environment variables as when the database was
-generated. "off" (the default setting) resets to the initial "C" locale.
-.TP
.B loglevel <integer>
Specify the level at which debugging statements and operation
statistics should be syslogged (currently logged to the
.PD
.RE
.RE
-.TP
-.B
-objectclass ( <oid> [NAME <name>] [DESC <description] [OBSOLETE] \
-[SUP <oids>] [{ ABSTRACT | STRUCTURAL | AUXILIARY }] [MUST <oids>] \
-[MAY <oids>] )
+.HP
+.B objectclass ( <oid> [NAME <name>] [DESC <description] [OBSOLETE]\
+ [SUP <oids>] [{ ABSTRACT | STRUCTURAL | AUXILIARY }] [MUST <oids>]\
+ [MAY <oids>] )
+.RS
Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
-This is the preferred format for object class definitions. The slapd
-parser extends the RFC 2252 definition by allowing string forms as well
-as numeric OIDs to be used for the object class OID. (See the
+The slapd parser extends the RFC 2252 definition by allowing string
+forms as well as numeric OIDs to be used for the object class OID.
+(See the
.B
objectidentifier
-description.) Object classes are "STRUCTURAL" by default.
-.TP
-.B
-objectclass <name> requires <attrs> allows <attrs>
-Define the schema rules for the object class named <name>. These are
-used in conjunction with the schemacheck option. This directive is
-deprecated in favor of the one above.
+description.) Object classes are "STRUCTURAL" by default.
+.RE
.TP
.B objectidentifier <name> { <oid> | <name>[:<suffix>] }
Define a string name that equates to the given OID. The string can be used
name can also be used with a suffix of the form ":xx" in which case the
value "oid.xx" will be used.
.TP
+.B password-hash <hash>
+The <hash> to use for userPassword generation. One of
+.BR {SSHA} ,
+.BR {SHA} ,
+.BR {SMD5} ,
+.BR {MD5} ,
+.BR {CRYPT} ,
+.BR {KERBEROS} ,
+.BR {SASL} ,
+and
+.BR {UNIX} .
+The default is
+.BR {SSHA} .
+.TP
+.B password-crypt-salt-format <format>
+Specify the format of the salt passed to
+.BR crypt (3)
+when generating {CRYPT} passwords.
+This string needs to be in
+.BR sprintf (3)
+format and may include one (and only one) %s conversion.
+This conversion will be substituted with a string 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.
+.TP
+.B pidfile <filename>
+The ( absolute ) name of a file that will hold the
+.B slapd
+server's process ID ( see
+.BR getpid (2)
+) if started without the debugging command line option.
+.TP
.B referral <url>
Specify the referral to pass back when
.BR slapd (8)
cannot find a local database to handle a request.
If specified multiple times, each url is provided.
.TP
+.B 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.
+.B bind
+requires bind operation prior to directory operations.
+.B LDAPv3
+requires session to be using LDAP version 3.
+.B authc
+requires authentication prior to directory operations.
+.B SASL
+requires SASL authentication prior to directory operations.
+.B strong
+requires strong authentication prior to directory operations.
+Currently
+.B SASL
+and
+.B strong
+conditions are currently same.
+.B none
+may be used to require no conditions (useful for clearly globally
+set conditions within a particular database).
+.TP
+.B sasl-host <fqdn>
+Used to specify the fully qualified domain name used for SASL processing.
+.TP
+.B sasl-realm <realm>
+Specify SASL realm. Default is empty.
+.TP
+.B sasl-regexp <match> <replace>
+Used by the SASL authorization mechanism to convert a SASL authenticated
+username to an LDAP DN. When an authorization request is received, the SASL
+.B USERNAME, REALM,
+and
+.B MECHANISM
+are taken, when available, and combined into a SASL name of the
+form
+.RS
+.RS
+.TP
+.B uid=<UID>[,cn=<REALM>][,cn=<MECH>],cn=AUTHZ
+
+.RE
+This SASL name is then compared against the
+.B match
+regular expression, and if the match is successful, the SASL name is
+replaced with the
+.B replace
+string. If there are wildcard strings in the
+.B match
+regular expression that are enclosed in parenthesis, e.g.
+.RS
+.RS
+.TP
+.B uid=(.*)\\\\+realm=.*
+
+.RE
+.RE
+then the portion of the SASL 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
+.B replace
+string, e.g.
+.RS
+.RS
+.TP
+.B cn=$1,ou=Accounts,dc=$2,dc=$4.
+
+.RE
+.RE
+The replaced SASL name can be either a DN or an LDAP URI. If the latter, the slapd
+server will use the URI to search its own database, and if the search returns
+exactly one entry, the SASL name is replaced by the DN of that entry.
+Multiple
+.B sasl-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.
+.LP
+.B Caution:
+Because the plus sign + is a character recognized by the regular expression engine,
+and it will appear in SASL names that include a REALM, be careful to escape the
+plus sign with a backslash \\+ to remove the character's special meaning.
+.RE
+.TP
+.B sasl-secprops <properties>
+Used to specify Cyrus SASL security properties.
+The
+.B none
+flag (without any other properities) causes the flag properites
+default, "noanonymous,noplain", to be cleared.
+The
+.B noplain
+flag disables mechanisms susceptible to simple passive attacks.
+The
+.B noactive
+flag disables mechanisms susceptible to active attacks.
+The
+.B nodict
+flag disables mechanisms susceptible to passive dictionary attacks.
+The
+.B noanonyous
+flag disables mechanisms which support anonymous login.
+The
+.B forwardsec
+flag require forward secrecy between sessions.
+The
+.B passcred
+require mechanisms which pass client credentials (and allow
+mechanisms which can pass credentials to do so).
+The
+.B minssf=<factor>
+property specifies the minimum acceptable
+.I security strength factor
+as an integer approximate to effective key length used for
+encryption. 0 (zero) implies no protection, 1 implies integrity
+protection only, 56 allows DES or other weak ciphers, 112
+allows triple DES and other strong ciphers, 128 allows RC4,
+Blowfish and other modern strong ciphers. The default is 0.
+The
+.B maxssf=<factor>
+property specifies the maximum acceptable
+.I security strength factor
+as an integer (see minssf description). The default is INT_MAX.
+The
+.B maxbufsize=<size>
+property specifies the maximum security layer receive buffer
+size allowed. 0 disables security layers. The default is 65536.
+.TP
+.B schemacheck { on | off }
+Turn schema checking on or off. The default is on.
+.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..
+The directive may be specified globally and/or per-database.
+.B ssf=<n>
+specifies the overall security strength factor.
+.B transport=<n>
+specifies the transport security strength factor.
+.B tls=<n>
+specifies the TLS security strength factor.
+.B sasl=<n>
+specifies the SASL security strength factor.
+.B update_ssf=<n>
+specifies the overall security strength factor to require for
+directory updates.
+.B update_transport=<n>
+specifies the transport security strength factor to require for
+directory updates.
+.B update_tls=<n>
+specifies the TLS security strength factor to require for
+directory updates.
+.B update_sasl=<n>
+specifies the SASL security strength factor to require for
+directory updates.
+Note that the
+.B transport
+factor is measure of security provided by the underlying transport,
+e.g. ldapi:// (and eventually IPSEC). It is not normally used.
+.TP
.B schemacheck { on | off }
Turn schema checking on or off. The default is on.
.TP
Specify the maximum number of entries to return from a search operation.
The default size limit is 500.
.TP
+.B sockbuf_max_incoming <integer>
+Specify the maximum incoming LDAP PDU size for anonymous sessions.
+The default is 262143.
+.TP
+.B sockbuf_max_incoming_auth <integer>
+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 32.
+.TP
.B timelimit <integer>
Specify the maximum number of seconds (in real time)
.B slapd
.B TLSCertificateFile
file. Currently, the private key must not be protected with a password, so
it is of critical importance that it is protected carefully.
+.TP
+.B 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.
.SH GENERAL BACKEND OPTIONS
Options in this section only apply to the configuration file section
-for the backend in which they are defined. They are supported by every
+for the specified backend. They are supported by every
+type of backend.
+.TP
+.B backend <databasetype>
+Mark the beginning of a backend definition. <databasetype>
+should be one of
+.B ldbm,
+.B shell,
+or
+.B passwd
+depending on which backend will serve the database.
+
+.SH 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.
.TP
.B database <databasetype>
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.
-.TP
-.B
-replica host=<hostname>[:port] "binddn=<DN>" bindmethod=simple |
-.B
-kerberos [credentials=<password>] [srvtab=<filename>]
-.br
-Specify a replication site for this database. Refer to "The SLAPD and
-SLURPD Administrator's Guide" for detailed information on setting up
-a replicated
+.HP
+.B replica host=<hostname>[:port] [tls=yes|critical]
+.B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
+.B [saslmech=<SASL mech>] [secopts=<options>] [realm=<realm>]
+.B [authcId=<authentication ID>] [authcId=<authentication ID>]
+.RS
+Specify a replication site for this database. Refer to the "OpenLDAP
+Administrator's Guide" for detailed information on setting up a replicated
.B slapd
-directory service.
+directory service. A
+.B bindmethod
+of
+.B simple
+requires the options
+.B binddn
+and
+.B credentials
+and should only be used when adequate security services
+(e.g TLS or IPSEC) are in place. A
+.B bindmethod
+of
+.B sasl
+requires the option
+.B saslmech.
+If the
+.B mechanism
+will use Kerberos, a kerberos instance should be given in
+.B authcId.
+.RE
.TP
.B replogfile <filename>
Specify the name of the replication log file to log changes to.
.BR slurpd (8).
See
.BR slapd.replog (5)
-for more information.
+for more information. The specified file should be located
+in a directory with limited read/write/execute access as the replication
+logs may contain sensitive information.
.TP
.B rootdn <dn>
-Specify the DN of an entry that is not subject to access control
+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
+.B rootpw
+directive.
.TP
.B rootpw <password>
-Specify a password (or hash of the password) for the rootdn.
+Specify a password (or hash of the password) for the rootdn. If
+the rootdn is not within the namingContext of the database, the
+provided password is ignored.
This option accepts all RFC 2307 userPassword formats known to
-the server including \fB{SSHA}\fP, \fB{SHA}\fP, \fB{SMD5}\fP,
-\fB{MD5}\fP, \fB{CRYPT}\fP, and cleartext schemes. Cleartext
-passwords are not recommended.
+the server (see
+.B password-hash
+desription) as well as cleartext.
+.BR slappasswd (8)
+may be used to generate a hash of a password. Cleartext
+and \fB{CRYPT}\fP 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.
.TP
.B suffix <dn suffix>
Specify the DN suffix of queries that will be passed to this
.BR slapd (8)
is asked to modify a replicated local database.
If specified multiple times, each url is provided.
-.SH LDBM BACKEND-SPECIFIC OPTIONS
-Options in this category only apply to the LDBM backend database. That is,
-they must follow a "database ldbm" line and come before any subsequent
-"database" lines. The LDBM backend is a high-performance database that
-makes extensive use of indexing and caching to speed data access.
+.\" .SH LDBM BACKEND-SPECIFIC OPTIONS
+.\" Options in this category only apply to the LDBM backend. That is,
+.\" they must follow "backend ldbm" line and come before any subsequent
+.\" "backend" or "database" lines. The LDBM backend is a high-performance
+.\" database that makes extensive use of indexing and caching to speed
+.\" data access.
+.SH LDBM DATABASE-SPECIFIC OPTIONS
+Options in this category only apply to the LDBM databases. That is,
+they must follow "database ldbm" line and come before any subsequent
+"backend" or "database" lines.
.TP
.B cachesize <integer>
Specify the size in entries of the in-memory cache maintained
Specify the directory where the LDBM files containing this database and
associated indexes live. A separate directory must be specified for
each database. The default is
-.B /usr/tmp.
+.BR LOCALSTATEDIR/openldap-ldbm .
.TP
.B
-index { <attrlist> | default } [ pres,eq,approx,sub,none ]
+index {<attrlist>|default} [pres,eq,approx,sub,<special>]
Specify the indexes to maintain for the given attribute. If only
-an <attr> is given, all possible indexes are maintained.
+an <attr> is given, the indices specified for \fBdefault\fR
+are maintained. A number of special index parameters may be
+specified.
+The index type
+.B sub
+can be decomposed into
+.BR subinitial ,
+.BR subany ,\ and
+.B subfinal
+indices.
+The special type
+.B lang
+may be specified to allow use of this index by language subtypes.
+The special type
+.B autolang
+may be specified to automatically maintain separate indices for each
+language subtypes.
+The special type
+.B subtypes
+may be specified to allow use of this index by named subtypes.
+The special type
+.B autosubtypes
+may be specified to automatically maintain separate indices for each
+other subtypes.
.TP
.B mode <integer>
Specify the file protection mode that newly created database
index files should have. The default is 0600.
-.SH SHELL BACKEND-SPECIFIC OPTIONS
+.SH SHELL DATABASE-SPECIFIC OPTIONS
Options in this category only apply to the SHELL backend database. That is,
they must follow a "database shell" line and come before any subsequent
-"database" lines. The Shell backend executes external programs to
+"backend" or "database" lines. The Shell backend executes external programs to
implement operations, and is designed to make it easy to tie an existing
database to the
.B slapd
.TP
.B abandon <pathname>
These options specify the pathname of the command to execute in response
-to the given LDAP operation. The command given should understand and
-follow the input/output conventions described in Appendix B of "The SLAPD
-and SLURPD Administrator's Guide."
+to the given LDAP operation.
.LP
Note that you need only supply configuration lines for those commands you
want the backend to handle. Operations for which a command is not
supplied will be refused with an "unwilling to perform" error.
-.SH PASSWORD BACKEND-SPECIFIC OPTIONS
+.SH PASSWORD DATABASE-SPECIFIC OPTIONS
Options in this category only apply to the PASSWD backend database.
That is, they must follow a "database passwd" line and come before any
-subsequent "database" lines. The PASSWD database serves up the user
+subsequent "backend" or "database" lines. The PASSWD database serves up the user
account information listed in the system
.BR passwd (5)
file.
Specifies an alternate passwd file to use. The default is
.B /etc/passwd.
.SH EXAMPLE
-"The SLAPD and SLURPD Administrator's Guide" contains an annotated
+"OpenLDAP Administrator's Guide" contains an annotated
example of a configuration file.
.SH FILES
ETCDIR/slapd.conf
.BR slapadd (8),
.BR slapcat (8),
.BR slapindex (8),
+.BR slappassword (8),
.BR slurpd (8),
.LP
-"The SLAPD and SLURPD Administrator's Guide"
+"OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
.SH ACKNOWLEDGEMENTS
.B OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
projects / openldap / blobdiff