MAN page from RedHat Other openldap-2.0.27-1.i386.rpm


Section: File Formats (5)
Updated: 28 May 2001


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




The file/etc/openldap/slapd.confcontains configuration information for theslapd(8)daemon. This configuration file is also used by theslurpd(8)replication daemon and by the SLAPD toolsslapadd(8),slapcat(8),andslapindex(8).

Theslapd.conffile consists of a series of global configuration options that apply toslapdas a whole (including all backends), followed by zero or more databasebackend definitions that contain information specific to a backendinstance.

The general format ofslapd.confis 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. Globaloptions can be overridden in a backend (for options that appear morethan once, the last appearance in theslapd.conffile is used). Blank lines and comment lines beginning with a `#'character are ignored. If a line begins with white space, it isconsidered a continuation of the previous line.

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

The specific configuration options available are discussed belowin the Global Configuration Options, General Backend Options,General Database Options, LDBM Database-Specific Options, ShellDatabase-Specific Options, and Password Database-Specific Optionssections. Refer to the "OpenLDAP Administrator's Guide" for moredetails on the slapd configuration file. 


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/orattributes (specified by <what>) by one or more requestors (specifiedby <who>).See the "OpenLDAP's Administrator's Guide" for details.
allow <features>
Specify a set of features (separated by white space) toallow (default none).tls_2_anonallows Start TLS to force session to anonymous status (see alsodisallowtls_authc).
argsfile <filename>
The ( absolute ) name of a file that will hold the slapdserver's command line optionsif started without the debugging command line option.
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>] )
Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.The slapd parser extends the RFC 2252 definition by allowing stringforms as well as numeric OIDs to be used for the attribute OID andattribute syntax OID.(See theobjectidentifierdescription.) Currently the syntax name parser is case-sensitive.The known syntax names are:
AttributeTypeDescription Audio Binary BitString Certificate CertificateListCertificatePair DN DeliveryMethod DirectoryString DITContentRuleDescriptionDITStructureRuleDescription EnhancedGuide FacsimileTelephoneNumberGeneralizedTime Guide IA5String Integer MatchingRuleDescriptionMatchingRuleUseDescription MailPreference NameAndOptionalUUIDNameFormDescription NumericString ObjectClassDescription OIDOtherMailbox OctetString PostalAddress ProtocolInformationPresentationAddress PrintableString SupportedAlgorithm TelephoneNumberTeletexTerminalIdentifier TelexNumber UTCTime LDAPSyntaxDescriptionSubstringAssertion NISnetgrouptriple Bootparameter
concurrency <integer>
Specify a desired level of concurrency. Provided to the underlyingthread system as a hint. The default is not to provide any hint.
defaultaccess { none | auth | compare | search | read | write }
Specify the default access level to grant requestors whenno access directives were provided for the database.The default behavior is to grant 'read' access. It isrecommended thataccessdirectives be used instead.
defaultsearchbase <dn>
Specify a default search base to use when client submits anon-base search request with an empty base DN.
disallow <features>
Specify a set of features (separated by white space) todisallow (default none).bind_v2disables acceptance of LDAPv2 bind requests.bind_anondisables acceptance of anonymous bind requests.bind_anon_creddisables anonymous bind creditials are not empty (e.g.when DN is empty).bind_anon_dndisables anonymous bind when DN is not empty.bind_simpledisables simple (bind) authentication.bind_krbv4disables Kerberos V4 (bind) authentication.tls_authcdisables StartTLS if authenticated (see alsoallowtls_2_anon).
idletimeout <integer>
Specify the number of seconds to wait before forcibly closingan idle client connections. A idletimeout of 0 disables thisfeature. The default is 0.
include <filename>
Read additional configuration information from the given file beforecontinuing with the next line of the current file.
loglevel <integer>
Specify the level at which debugging statements and operation statistics should be syslogged (currently logged to thesyslogd(8)LOG_LOCAL4 facility). Log levels are additive, and available levelsare:
trace function calls
debug packet handling
heavy trace debugging
connection management
print out packets sent and received
search filter processing
configuration file processing
access control list processing
stats log connections/operations/results
stats log entries sent
print communication with shell backends
entry parsing
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 2252.The slapd parser extends the RFC 2252 definition by allowing stringforms as well as numeric OIDs to be used for the object class OID.(See theobjectidentifierdescription.) 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 usedin place of the numeric OID in objectclass and attribute definitions. Thename can also be used with a suffix of the form ":xx" in which case thevalue "oid.xx" will be used.
password-hash <hash>
The <hash> to use for userPassword generation. One of{SSHA},{SHA},{SMD5},{MD5},and{CRYPT}.The default is{SSHA}.
password-crypt-salt-format <format>
Specify the format of the salt passed tocrypt(3)when generating {CRYPT} passwords. This string needs to be insprintf(3)format and may include one (and only one) %s conversion.This conversion will be substituted with a string randomcharacters from [A-Za-z0-9./]. For example, "%.2s"provides a two character salt and "$1$%.8s" tells someversions of crypt(3) to use an MD5 algorithm and provides8 random characters of salt. The default is "%s", whichprovides 31 characters of salt.
pidfile <filename>
The ( absolute ) name of a file that will hold the slapdserver's process ID ( seegetpid(2)) if started without the debugging command line option.
referral <url>
Specify the referral to pass back whenslapd(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) torequire (default none).The directive may be specified globally and/or per-database.bindrequires bind operation prior to directory operations.LDAPv3requires session to be using LDAP version 3.authcrequires authentication prior to directory operations.SASLrequires SASL authentication prior to directory operations.strongrequires strong authentication prior to directory operations.CurrentlySASLandstrongconditions are currently same.nonemay be used to require no conditions (useful for clearly globallyset conditions within a particular database).
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-secprops <properties>
Used to specify Cyrus SASL security properties.Thenoneflag (without any other properities) causes the flag properitesdefault, "noanonymous,noplain", to be cleared.Thenoplainflag disables mechanisms susceptible to simple passive attacks.Thenoactiveflag disables mechanisms susceptible to active attacks.Thenodictflag disables mechanisms susceptible to passive dictionary attacks.Thenoanonyousflag disables mechanisms which support anonymous login.Theforwardsecflag require forward secrecy between sessions.Thepasscredrequire mechanisms which pass client credentials (and allowmechanisms which can pass credentials to do so).Theminssf=<factor> property specifies the minimum acceptablesecurity strength factoras an integer approximate to effective key length used forencryption. 0 (zero) implies no protection, 1 implies integrityprotection only, 56 allows DES or other weak ciphers, 112allows triple DES and other strong ciphers, 128 allows RC4,Blowfish and other modern strong ciphers. The default is 0.Themaxssf=<factor> property specifies the maximum acceptablesecurity strength factoras an integer (see minssf description). The default is INT_MAX.Themaxbufsize=<size> property specifies the maximum security layer receive buffersize allowed. 0 disables security layers. The default is 65536.
schemacheck { on | off }
Turn schema checking on or off. The default is on.
security <factors>
Specify a set of factors (separated by white space) to require.An integer value is associated with each factor and is roughlyequivalent of the encryption key length to require. A valueof 112 is equivalent to 3DES, 128 to Blowfish, etc..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 fordirectory updates.update_transport=<n>specifies the transport security strength factor to require fordirectory updates.update_tls=<n>specifies the TLS security strength factor to require fordirectory updates.update_sasl=<n>specifies the SASL security strength factor to require fordirectory updates.Note that thetransportfactor is measure of security provided by the underlying transport,e.g. ldapi:// (and eventually IPSEC). It is not normally used.
schemacheck { on | off }
Turn schema checking on or off. The default is on.
sizelimit <integer>
Specify the maximum number of entries to return from a search operation.The default size limit is 500.
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.
srvtab <filename>
Specify the srvtab file in which the kerberos keys necessary forauthenticating clients using kerberos can be found. This option is onlymeaningful if you are using Kerberos authentication.
threads <integer>
Specify the maximum size of the primary thread pool.The default is 32.
timelimit <integer>
Specify the maximum number of seconds (in real time)slapdwill spend answering a search request. The default time limit is 3600.


Ifslapdis build with support for Transport Layer Security, there are more optionsyou 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 OpenSSL. Example:


To check what ciphers a given spec selects, use:

openssl ciphers -v <cipher-suite-spec>

TLSCertificateFile <filename>
Specifies the file that contains theslapdserver certificate.
TLSCertificateKeyFile <filename>
Specifies the file that contains theslapdserver private key that matches the certificate stored in theTLSCertificateFilefile. Currently, the private key must not be protected with a password, soit is of critical importance that it is protected carefully.
TLSRandFile <filename>
Specifies the file to obtain random bits from when /dev/[u]randomis not available. Generally set to the name of the EGD/PRNGD socket.The environment variable RANDFILE can also be used to specify the filename.


Options in this section only apply to the configuration file sectionfor the specified backend. They are supported by everytype of backend.
backend <databasetype>
Mark the beginning of a backend definition. <databasetype>should be one ofldbm,shell,orpasswddepending on which backend will serve the database.



Options in this section only apply to the configuration file sectionfor the database in which they are defined. They are supported by everytype of backend.
database <databasetype>
Mark the beginning of a new database instance definition. <databasetype>should be one ofldbm,shell,orpasswddepending on which backend will serve the database.
lastmod on | off
Controls whetherslapdwill automatically maintain the modifiersName, modifyTimestamp, creatorsName, and createTimestamp attributes for entries. By default, lastmod is on.
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. Bydefault, readonly is off.
replica host=<hostname>[:port] [tls=yes|critical][suffix=<suffix> [...]]bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>][saslmech=<SASL mech>] [secopts=<options>] [realm=<realm>][authcId=<authentication ID>] [authcId=<authentication ID>]
Specify a replication site for this database. Refer to the "OpenLDAP Administrator's Guide" for detailed information on setting up a replicatedslapddirectory service. Zero or moresuffixinstances can be used to select the subtrees that will be replicated(defaults to all the database). Abindmethodofsimplerequires the optionsbinddn andcredentials and should only be used when adequate security services (e.g TLS or IPSEC) are in place. Abindmethod ofsasl requires the optionsaslmech. If the mechanismwill use Kerberos, a kerberos instance should be given in authcId.
replogfile <filename>
Specify the name of the replication log file to log changes to. The replication log is typically written byslapd(8)and read byslurpd(8).Seeslapd.replog(5)for more information. The specified file should be locatedin a directory with limited read/write/execute access as the replicationlogs may contain sensitive information.
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 rootDN (the default) specifies no root access is to be granted. It isrecommended that the rootdn only be specified when needed (such aswhen initially populating a database). If the rootdn is withina namingContext (suffix) of the database, a simple bind passwordmay also be provided using therootpwdirective.
rootpw <password>
Specify a password (or hash of the password) for the rootdn. Ifthe rootdn is not within the namingContext of the database, theprovided password is ignored.This option accepts all RFC 2307 userPassword formats known tothe server (see password-hashdesription) as well as cleartext.slappasswd(8)may be used to generate a hash of a password. Cleartextand {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.
updatedn <dn>
This option is only applicable in a slaveslapd.It specifies the DN allowed to make changes to the replica (typically,this is the DNslurpd(8)binds as when making changes to the replica).
updateref <url>
Specify the referral to pass back whenslapd(8)is asked to modify a replicated local database.If specified multiple times, each url is provided.


Options in this category only apply to the LDBM databases.That is, they must follow "database ldbm" line and come beforeany subsequent "backend" or "database" lines.
cachesize <integer>
Specify the size in entries of the in-memory cache maintained by the LDBM backend database instance. The default is 1000 entries.
dbcachesize <integer>
Specify the size in bytes of the in-memory cache associated with each open index file. If not supported by the underlying database method, this option is ignored without comment. The default is 100000 bytes.
Specify that no database locking should be performed. Enabling this option may improve performance at the expense of data security.Do NOT run any slap tools while slapd is running.
Specify that on-disk database contents should not be immediatelysynchronized with in memory changes. Enabling this option may improveperformance at the expense of data security.
dbsync <frequency> <maxdelays> <delayinterval>
Flush dirty database buffers to disk every<seconds>seconds. Impliesdbnosync(ie. indvidual updates are no longer written to disk). It attempts to avoidsyncs during periods of peak activity by waiting<delayinterval>seconds if the server is busy, repeating this delay up to<maxdelays>times before proceeding. It is an attempt to provide higher write performance with some amount of datasecurity. Note that it may still be possible to get an inconsistent database if the underlying engine fills its cache and writes out individualpages and slapd crashes or is killed before the next sync.<maxdelays>and<delayinterval>are optional and default to12and5respectively, giving a total elapsed delay of 60 seconds before a syncwill occur.<maxdelays>may be zero, and<delayinterval>must be 1 or greater.
directory <directory>
Specify the directory where the LDBM files containing this database andassociated indexes live. A separate directory must be specified foreach database. The default is//var/run/openldap-ldbm.
index {<attrlist>|default} [pres,eq,approx,sub,<special>]
Specify the indexes to maintain for the given attribute. If only an <attr> is given, the indices specified for defaultare maintained. A number of special index parameters may bespecified.The index typesubcan be decomposed intosubinitial,subany, andsubfinalindices.The special typelangmay be specified to allow use of this index by language subtypes.The special typeautolangmay be specified to automatically maintain separate indices for eachlanguage subtypes.The special typesubtypesmay be specified to allow use of this index by named subtypes.The special typeautosubtypesmay be specified to automatically maintain separate indices for eachother subtypes.
mode <integer>
Specify the file protection mode that newly created database index files should have. The default is 0600.


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"backend" or "database" lines. The Shell backend executes external programs toimplement operations, and is designed to make it easy to tie an existingdatabase to theslapdfront-end.
bind <pathname>
unbind <pathname>
search <pathname>
compare <pathname>
modify <pathname>
modrdn <pathname>
add <pathname>
delete <pathname>
abandon <pathname>
These options specify the pathname of the command to execute in response to the given LDAP operation.

Note that you need only supply configuration lines for those commands youwant the backend to handle. Operations for which a command is notsupplied will be refused with an "unwilling to perform" error. 


Options in this category only apply to the PASSWD backend database.That is, they must follow a "database passwd" line and come before anysubsequent "backend" or "database" lines. The PASSWD database serves up the useraccount information listed in the systempasswd(5)file.
file <filename>
Specifies an alternate passwd file to use. The default is/etc/passwd.


"OpenLDAP Administrator's Guide" contains an annotatedexample of a configuration file. 





"OpenLDAP Administrator's Guide" ( 


is developed and maintained by The OpenLDAP Project ( derived from University of Michigan LDAP 3.3 Release.




This document was created byman2html,using the manual pages.