1 .TH SLAPD.CONF 5 "26 January 2002" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
12 contains configuration information for the
14 daemon. This configuration file is also used by the
16 replication daemon and by the SLAPD tools
24 file consists of a series of global configuration options that apply to
26 as a whole (including all backends), followed by zero or more database
27 backend definitions that contain information specific to a backend
35 # comment - these options apply to every database
36 <global configuration options>
37 # first database definition & configuration options
38 database <backend 1 type>
39 <configuration options specific to backend 1>
40 # subsequent database definitions & configuration options
44 As many backend-specific sections as desired may be included. Global
45 options can be overridden in a backend (for options that appear more
46 than once, the last appearance in the
48 file is used). Blank lines and comment lines beginning with a `#'
49 character are ignored. If a line begins with white space, it is
50 considered a continuation of the previous line.
52 Arguments on configuration lines are separated by white space. If an
53 argument contains white space, the argument should be enclosed in
54 double quotes. If an argument contains a double quote (`"') or a
55 backslash character (`\\'), the character should be preceded by a
58 The specific configuration options available are discussed below in the
59 Global Configuration Options, General Backend Options, General Database
60 Options, LDBM Database-Specific Options,
61 Shell Database-Specific Options, and Password
62 Database-Specific Options sections. Refer to the "OpenLDAP
63 Administrator's Guide" for more details on the slapd configuration
65 .SH GLOBAL CONFIGURATION OPTIONS
66 Options described in this section apply to all backends, unless specifically
67 overridden in a backend definition. Arguments that should be replaced by
68 actual text are shown in brackets <>.
70 .B access to <what> [ by <who> <access> <control> ]+
71 Grant access (specified by <access>) to a set of entries and/or
72 attributes (specified by <what>) by one or more requestors (specified
74 See the "OpenLDAP's Administrator's Guide" for details.
77 Specify a set of features (separated by white space) to
80 allows acceptance of LDAPv2 bind requests.
82 allows anonymous bind creditials are not empty (e.g.
85 allows unauthenticated (anonymous) bind when DN is not empty.
87 .B argsfile <filename>
88 The ( absolute ) name of a file that will hold the
90 server's command line options
91 if started without the debugging command line option.
94 .B attributetype (\ <oid> [NAME\ <name>] [OBSOLETE]\
95 [DESC\ <description>]\
96 [SUP\ <oid>] [EQUALITY\ <oid>] [ORDERING\ <oid>]\
97 [SUBSTR\ <oid>] [SYNTAX\ <oidlen>] [SINGLE\-VALUE] [COLLECTIVE]\
98 [NO\-USER\-MODIFICATION] [USAGE\ <attributeUsage>]\ )
100 Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
101 The slapd parser extends the RFC 2252 definition by allowing string
102 forms as well as numeric OIDs to be used for the attribute OID and
103 attribute syntax OID.
106 description.) Currently the syntax name parser is case-sensitive.
107 The known syntax names are:
111 AttributeTypeDescription Audio Binary BitString Certificate CertificateList
112 CertificatePair DN DeliveryMethod DirectoryString DITContentRuleDescription
113 DITStructureRuleDescription EnhancedGuide FacsimileTelephoneNumber
114 GeneralizedTime Guide IA5String Integer MatchingRuleDescription
115 MatchingRuleUseDescription MailPreference NameAndOptionalUUID
116 NameFormDescription NumericString ObjectClassDescription OID
117 OtherMailbox OctetString PostalAddress ProtocolInformation
118 PresentationAddress PrintableString SupportedAlgorithm TelephoneNumber
119 TeletexTerminalIdentifier TelexNumber UTCTime LDAPSyntaxDescription
120 SubstringAssertion NISnetgrouptriple Bootparameter
126 .B concurrency <integer>
127 Specify a desired level of concurrency. Provided to the underlying
128 thread system as a hint. The default is not to provide any hint.
130 .B defaultsearchbase <dn>
131 Specify a default search base to use when client submits a
132 non-base search request with an empty base DN.
134 .B disallow <features>
135 Specify a set of features (separated by white space) to
136 disallow (default none).
138 disables acceptance of anonymous bind requests.
140 disables simple (bind) authentication.
142 disables Kerberos V4 (bind) authentication.
144 disables Start TLS from forcing session to anonymous status (see also
147 disables StartTLS if authenticated (see also
150 .B idletimeout <integer>
151 Specify the number of seconds to wait before forcibly closing
152 an idle client connections. A idletimeout of 0 disables this
153 feature. The default is 0.
155 .B include <filename>
156 Read additional configuration information from the given file before
157 continuing with the next line of the current file.
159 .B limits <who> <limit> [<limit> [...]]
160 Specify time and size limits based on who initiated an operation.
167 anonymous | users | [dn[.<style>]=]<pattern>
173 <style> ::= exact | base | one | subtree | children | regex | anonymous
177 is hit when a search is performed without prior binding;
179 is hit when a search is performed by a successfully bound user;
182 dn pattern is assumed unless otherwise specified by qualifying
183 the (optional) key string
189 (which are synonims), to require an exact match; with
191 to require exactly one level of depth match; with
193 to allow any level of depth match, including the exact match; with
195 to allow any level of depth match, not including the exact match;
197 explicitly requires the (default) match based on regular expression
198 pattern, as detailed in
202 matches unbound operations; the
205 The same behavior is obtained by using the
211 The currently supported limits are
216 The syntax for time limits is
217 .BR time[.{soft|hard}]=<integer> ,
220 is the number of seconds slapd will spend answering a search request.
221 If no time limit is explicitly requested by the client, the
223 limit is used; if the requested time limit exceedes the
225 limit, an "Unwilling to perform" is returned.
228 limit is set to 0 or to the keyword "soft", the soft limit is used
229 in either case; if it is set to -1 or to the keyword "none",
230 no hard limit is enforced.
231 Explicit requests for time limits smaller or equal to the
234 If no flag is set, the value is assigned to the
238 limit is set to zero, to preserve the original behavior.
240 The syntax for size limits is
241 .BR size[.{soft|hard|unchecked}]=<integer> ,
244 is the maximum number of entries slapd will return answering a search
246 If no size limit is explicitly requested by the client, the
248 limit is used; if the requested size limit exceedes the
250 limit, an "Unwilling to perform" is returned.
253 limit is set to 0 or to the keyword "soft", the soft limit is used
254 in either case; if it is set to -1 or to the keyword "none",
255 no hard limit is enforced.
256 Explicit requests for size limits smaller or equal to the
261 flag sets a limit on the number of candidates a search request is allowed
263 If the selected candidates exceed the
265 limit, the search will abort with "Unwilling to perform".
266 If it is set to -1 or to the keyword "none", no limit is applied (the default).
267 If no flag is set, the value is assigned to the
271 limit is set to zero, to preserve the original behavior.
273 In case of no match, the global limits are used.
274 The default values are the same of
280 This feature is currently exploited by the ldbm backend only.
283 .B loglevel <integer>
284 Specify the level at which debugging statements and operation
285 statistics should be syslogged (currently logged to the
287 LOG_LOCAL4 facility). Log levels are additive, and available levels
297 debug packet handling
300 heavy trace debugging
303 connection management
306 print out packets sent and received
309 search filter processing
312 configuration file processing
315 access control list processing
318 stats log connections/operations/results
321 stats log entries sent
324 print communication with shell backends
332 .B objectclass ( <oid> [NAME <name>] [DESC <description] [OBSOLETE]\
333 [SUP <oids>] [{ ABSTRACT | STRUCTURAL | AUXILIARY }] [MUST <oids>]\
336 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
337 The slapd parser extends the RFC 2252 definition by allowing string
338 forms as well as numeric OIDs to be used for the object class OID.
342 description.) Object classes are "STRUCTURAL" by default.
345 .B objectidentifier <name> { <oid> | <name>[:<suffix>] }
346 Define a string name that equates to the given OID. The string can be used
347 in place of the numeric OID in objectclass and attribute definitions. The
348 name can also be used with a suffix of the form ":xx" in which case the
349 value "oid.xx" will be used.
351 .B password-hash <hash>
352 The <hash> to use for userPassword generation. One of
362 .B password-crypt-salt-format <format>
363 Specify the format of the salt passed to
365 when generating {CRYPT} passwords.
366 This string needs to be in
368 format and may include one (and only one) %s conversion.
369 This conversion will be substituted with a string random
370 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
371 provides a two character salt and "$1$%.8s" tells some
372 versions of crypt(3) to use an MD5 algorithm and provides
373 8 random characters of salt. The default is "%s", which
374 provides 31 characters of salt.
376 .B pidfile <filename>
377 The ( absolute ) name of a file that will hold the
379 server's process ID ( see
381 ) if started without the debugging command line option.
384 Specify the referral to pass back when
386 cannot find a local database to handle a request.
387 If specified multiple times, each url is provided.
389 .B require <conditions>
390 Specify a set of conditions (separated by white space) to
391 require (default none).
392 The directive may be specified globally and/or per-database.
394 requires bind operation prior to directory operations.
396 requires session to be using LDAP version 3.
398 requires authentication prior to directory operations.
400 requires SASL authentication prior to directory operations.
402 requires strong authentication prior to directory operations.
407 conditions are currently same.
409 may be used to require no conditions (useful for clearly globally
410 set conditions within a particular database).
412 .B rootDSEfile <file>
413 Specify the name of an LDIF(5) file containing user defined attributes
414 for the root DSE. These attributes are returned in addition to the
415 attributes normally produced by slapd.
418 Used to specify the fully qualified domain name used for SASL processing.
420 .B sasl-realm <realm>
421 Specify SASL realm. Default is empty.
423 .B sasl-regexp <match> <replace>
424 Used by the SASL authorization mechanism to convert a SASL authenticated
425 username to an LDAP DN. When an authorization request is received, the SASL
429 are taken, when available, and combined into a SASL name of the
434 .B uid=<UID>[,cn=<REALM>][,cn=<MECH>],cn=AUTHZ
437 This SASL name is then compared against the
439 regular expression, and if the match is successful, the SASL name is
442 string. If there are wildcard strings in the
444 regular expression that are enclosed in parenthesis, e.g.
448 .B uid=(.*)\\\\+realm=.*
452 then the portion of the SASL name that matched the wildcard will be stored
453 in the numbered placeholder variable $1. If there are other wildcard strings
454 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
455 placeholders can then be used in the
461 .B cn=$1,ou=Accounts,dc=$2,dc=$4.
465 The replaced SASL name can be either a DN or an LDAP URI. If the latter, the slapd
466 server will use the URI to search its own database, and if the search returns
467 exactly one entry, the SASL name is replaced by the DN of that entry.
470 options can be given in the configuration file to allow for multiple matching
471 and replacement patterns. The matching patterns are checked in the order they
472 appear in the file, stopping at the first successful match.
475 Because the plus sign + is a character recognized by the regular expression engine,
476 and it will appear in SASL names that include a REALM, be careful to escape the
477 plus sign with a backslash \\+ to remove the character's special meaning.
480 .B sasl-secprops <properties>
481 Used to specify Cyrus SASL security properties.
484 flag (without any other properities) causes the flag properites
485 default, "noanonymous,noplain", to be cleared.
488 flag disables mechanisms susceptible to simple passive attacks.
491 flag disables mechanisms susceptible to active attacks.
494 flag disables mechanisms susceptible to passive dictionary attacks.
497 flag disables mechanisms which support anonymous login.
500 flag require forward secrecy between sessions.
503 require mechanisms which pass client credentials (and allow
504 mechanisms which can pass credentials to do so).
507 property specifies the minimum acceptable
508 .I security strength factor
509 as an integer approximate to effective key length used for
510 encryption. 0 (zero) implies no protection, 1 implies integrity
511 protection only, 56 allows DES or other weak ciphers, 112
512 allows triple DES and other strong ciphers, 128 allows RC4,
513 Blowfish and other modern strong ciphers. The default is 0.
516 property specifies the maximum acceptable
517 .I security strength factor
518 as an integer (see minssf description). The default is INT_MAX.
521 property specifies the maximum security layer receive buffer
522 size allowed. 0 disables security layers. The default is 65536.
524 .B security <factors>
525 Specify a set of factors (separated by white space) to require.
526 An integer value is associated with each factor and is roughly
527 equivalent of the encryption key length to require. A value
528 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
529 The directive may be specified globally and/or per-database.
531 specifies the overall security strength factor.
533 specifies the transport security strength factor.
535 specifies the TLS security strength factor.
537 specifies the SASL security strength factor.
539 specifies the overall security strength factor to require for
541 .B update_transport=<n>
542 specifies the transport security strength factor to require for
545 specifies the TLS security strength factor to require for
548 specifies the SASL security strength factor to require for
552 factor is measure of security provided by the underlying transport,
553 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
555 .B sizelimit <integer>
557 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
558 Specify the maximum number of entries to return from a search operation.
559 The default size limit is 500.
560 The second format allows a fine grain setting of the size limits.
561 Extra args can be added on the same line.
564 for an explanation of the different flags.
566 .B sockbuf_max_incoming <integer>
567 Specify the maximum incoming LDAP PDU size for anonymous sessions.
568 The default is 262143.
570 .B sockbuf_max_incoming_auth <integer>
571 Specify the maximum incoming LDAP PDU size for authenticated sessions.
572 The default is 4194303.
575 Specify the srvtab file in which the kerberos keys necessary for
576 authenticating clients using kerberos can be found. This option is only
577 meaningful if you are using Kerberos authentication.
580 Specify the maximum size of the primary thread pool.
583 .B timelimit <integer>
585 .B timelimit time[.{soft|hard}]=<integer> [...]
586 Specify the maximum number of seconds (in real time)
588 will spend answering a search request. The default time limit is 3600.
589 The second format allows a fine grain setting of the time limits.
590 Extra args can be added on the same line.
593 for an explanation of the different flags.
597 is built with support for Transport Layer Security, there are more options
600 .B TLSCipherSuite <cipher-suite-spec>
601 Permits configuring what ciphers will be accepted and the preference order.
602 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
604 TLSCipherSuite HIGH:MEDIUM:+SSLv2
606 To check what ciphers a given spec selects, use:
608 openssl ciphers -v <cipher-suite-spec>
610 .B TLSCACertificateFile <filename>
611 Specifies the file that contains certificates for all of the Certificate
616 .B TLSCertificateFile <filename>
617 Specifies the file that contains the
621 .B TLSCertificateKeyFile <filename>
622 Specifies the file that contains the
624 server private key that matches the certificate stored in the
625 .B TLSCertificateFile
626 file. Currently, the private key must not be protected with a password, so
627 it is of critical importance that it is protected carefully.
629 .B TLSRandFile <filename>
630 Specifies the file to obtain random bits from when /dev/[u]random
631 is not available. Generally set to the name of the EGD/PRNGD socket.
632 The environment variable RANDFILE can also be used to specify the filename.
634 .B TLSVerifyClient <level>
635 Specifies what checks to perform on client certificates in an
636 incoming TLS session, if any.
639 can be specified as one of the following keywords:
645 will not ask the client for a certificate.
648 The client certificate is requested. If no certificate is provided,
649 the session proceeds normally. If a bad certificate is provided,
650 it will be ignored and the session proceeds normally.
653 The client certificate is requested. If no certificate is provided,
654 the session proceeds normally. If a bad certificate is provided,
655 the session is immediately terminated.
657 .B demand | hard | true
658 These keywords are all equivalent, for compatibility reasons.
659 The client certificate is requested. If no certificate is provided,
660 or a bad certificate is provided, the session is immediately terminated.
662 Note that a valid client certificate is required in order to use the
663 SASL EXTERNAL authentication mechanism with a TLS session. As such,
666 setting must be chosen to enable SASL EXTERNAL authentication.
668 .SH GENERAL BACKEND OPTIONS
669 Options in this section only apply to the configuration file section
670 for the specified backend. They are supported by every
673 .B backend <databasetype>
674 Mark the beginning of a backend definition. <databasetype>
680 depending on which backend will serve the database.
682 .SH GENERAL DATABASE OPTIONS
683 Options in this section only apply to the configuration file section
684 for the database in which they are defined. They are supported by every
687 .B database <databasetype>
688 Mark the beginning of a new database instance definition. <databasetype>
694 depending on which backend will serve the database.
699 will automatically maintain the
700 modifiersName, modifyTimestamp, creatorsName, and
701 createTimestamp attributes for entries. By default, lastmod is on.
704 This option puts the database into "read-only" mode. Any attempts to
705 modify the database will return an "unwilling to perform" error. By
706 default, readonly is off.
708 .B replica host=<hostname>[:port] [tls=yes|critical]
709 .B [suffix=<suffix> [...]]
710 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
711 .B [saslmech=<SASL mech>] [secopts=<options>] [realm=<realm>]
712 .B [authcId=<authentication ID>] [authcId=<authentication ID>]
714 Specify a replication site for this database. Refer to the "OpenLDAP
715 Administrator's Guide" for detailed information on setting up a replicated
717 directory service. Zero or more
719 instances can be used to select the subtrees that will be replicated
720 (defaults to all the database). A
728 and should only be used when adequate security services
729 (e.g TLS or IPSEC) are in place. A
737 will use Kerberos, a kerberos instance should be given in
741 .B replogfile <filename>
742 Specify the name of the replication log file to log changes to.
743 The replication log is typically written by
749 for more information. The specified file should be located
750 in a directory with limited read/write/execute access as the replication
751 logs may contain sensitive information.
754 Specify the distinguished name that is not subject to access control
755 or administrative limit restrictions for operations on this database.
756 This DN may or may not be associated with an entry. An empty root
757 DN (the default) specifies no root access is to be granted. It is
758 recommended that the rootdn only be specified when needed (such as
759 when initially populating a database). If the rootdn is within
760 a namingContext (suffix) of the database, a simple bind password
761 may also be provided using the
766 Specify a password (or hash of the password) for the rootdn. If
767 the rootdn is not within the namingContext of the database, the
768 provided password is ignored.
769 This option accepts all RFC 2307 userPassword formats known to
772 desription) as well as cleartext.
774 may be used to generate a hash of a password. Cleartext
775 and \fB{CRYPT}\fP passwords are not recommended. If empty
776 (the default), authentication of the root DN is by other means
777 (e.g. SASL). Use of SASL is encouraged.
779 .B suffix <dn suffix>
780 Specify the DN suffix of queries that will be passed to this
781 backend database. Multiple suffix lines can be given and at least one is
782 required for each database definition.
785 Specify that the current backend database is a subordinate of another
786 backend database. A subordinate database may have only one suffix. This
787 option may bse used to glue multiple databases into a single namingContext.
788 If the suffix of the current database is within the namingContext of a
789 superior database, searches against the superior database will be
790 propagated to the subordinate as well. All of the databases
791 associated with a single namingContext should have identical rootdns.
792 Behavior of other LDAP operations is unaffected by this setting. In
793 particular, it is not possible to use moddn to move an entry from
794 one subordinate to another subordinate within the namingContext.
797 This option is only applicable in a slave
799 It specifies the DN allowed to make changes to the replica (typically,
802 binds as when making changes to the replica).
805 Specify the referral to pass back when
807 is asked to modify a replicated local database.
808 If specified multiple times, each url is provided.
809 .\" .SH LDBM BACKEND-SPECIFIC OPTIONS
810 .\" Options in this category only apply to the LDBM backend. That is,
811 .\" they must follow "backend ldbm" line and come before any subsequent
812 .\" "backend" or "database" lines. The LDBM backend is a high-performance
813 .\" database that makes extensive use of indexing and caching to speed
815 .SH LDBM DATABASE-SPECIFIC OPTIONS
816 Options in this category only apply to the LDBM databases. That is,
817 they must follow "database ldbm" line and come before any subsequent
818 "backend" or "database" lines.
820 .B cachesize <integer>
821 Specify the size in entries of the in-memory cache maintained
822 by the LDBM backend database instance. The default is 1000 entries.
824 .B dbcachesize <integer>
825 Specify the size in bytes of the in-memory cache associated
826 with each open index file. If not supported by the underlying database
827 method, this option is ignored without comment. The default is 100000 bytes.
830 Specify that no database locking should be performed.
831 Enabling this option may improve performance at the expense of data security.
832 Do NOT run any slap tools while slapd is running.
835 Specify that on-disk database contents should not be immediately
836 synchronized with in memory changes. Enabling this option may improve
837 performance at the expense of data security.
839 .B dbsync <frequency> <maxdelays> <delayinterval>
840 Flush dirty database buffers to disk every
844 (ie. indvidual updates are no longer written to disk). It attempts to avoid
845 syncs during periods of peak activity by waiting
847 seconds if the server is busy, repeating this delay up to
849 times before proceeding.
850 It is an attempt to provide higher write performance with some amount of data
851 security. Note that it may still be possible to get an inconsistent
852 database if the underlying engine fills its cache and writes out individual
853 pages and slapd crashes or is killed before the next sync.
857 are optional and default to
861 respectively, giving a total elapsed delay of 60 seconds before a sync
866 must be 1 or greater.
868 .B directory <directory>
869 Specify the directory where the LDBM files containing this database and
870 associated indexes live. A separate directory must be specified for
871 each database. The default is
872 .BR LOCALSTATEDIR/openldap-ldbm .
875 index {<attrlist>|default} [pres,eq,approx,sub,<special>]
876 Specify the indexes to maintain for the given attribute. If only
877 an <attr> is given, the indices specified for \fBdefault\fR
878 are maintained. Note that setting a default does not imply that
879 all attributes will be indexed.
881 A number of special index parameters may be
885 can be decomposed into
892 may be specified to disallow use of this index by language subtypes.
895 may be specified to disallow use of this index by named subtypes.
896 Note: changing index settings requires rebuilding indices, see
900 Specify the file protection mode that newly created database
901 index files should have. The default is 0600.
902 .SH SHELL DATABASE-SPECIFIC OPTIONS
903 Options in this category only apply to the SHELL backend database. That is,
904 they must follow a "database shell" line and come before any subsequent
905 "backend" or "database" lines. The Shell backend executes external programs to
906 implement operations, and is designed to make it easy to tie an existing
917 .B compare <pathname>
927 .B abandon <pathname>
928 These options specify the pathname of the command to execute in response
929 to the given LDAP operation.
931 Note that you need only supply configuration lines for those commands you
932 want the backend to handle. Operations for which a command is not
933 supplied will be refused with an "unwilling to perform" error.
934 .SH PASSWORD DATABASE-SPECIFIC OPTIONS
935 Options in this category only apply to the PASSWD backend database.
936 That is, they must follow a "database passwd" line and come before any
937 subsequent "backend" or "database" lines. The PASSWD database serves up the user
938 account information listed in the system
943 Specifies an alternate passwd file to use. The default is
946 "OpenLDAP Administrator's Guide" contains an annotated
947 example of a configuration file.
952 .BR slapd.replog (5),
953 .BR slapd.access (5),
960 .BR slappassword (8),
963 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
966 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
968 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob