1 .TH SLAPD.CONF 5 "28 May 2001" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2001 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 Start TLS to force session to anonymous status (see also
84 .B argsfile <filename>
85 The ( absolute ) name of a file that will hold the
87 server's command line options
88 if started without the debugging command line option.
91 .B attributetype (\ <oid> [NAME\ <name>] [OBSOLETE]\
92 [DESC\ <description>]\
93 [SUP\ <oid>] [EQUALITY\ <oid>] [ORDERING\ <oid>]\
94 [SUBSTR\ <oid>] [SYNTAX\ <oidlen>] [SINGLE\-VALUE] [COLLECTIVE]\
95 [NO\-USER\-MODIFICATION] [USAGE\ <attributeUsage>]\ )
97 Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
98 The slapd parser extends the RFC 2252 definition by allowing string
99 forms as well as numeric OIDs to be used for the attribute OID and
100 attribute syntax OID.
103 description.) Currently the syntax name parser is case-sensitive.
104 The known syntax names are:
108 AttributeTypeDescription Audio Binary BitString Certificate CertificateList
109 CertificatePair DN DeliveryMethod DirectoryString DITContentRuleDescription
110 DITStructureRuleDescription EnhancedGuide FacsimileTelephoneNumber
111 GeneralizedTime Guide IA5String Integer MatchingRuleDescription
112 MatchingRuleUseDescription MailPreference NameAndOptionalUUID
113 NameFormDescription NumericString ObjectClassDescription OID
114 OtherMailbox OctetString PostalAddress ProtocolInformation
115 PresentationAddress PrintableString SupportedAlgorithm TelephoneNumber
116 TeletexTerminalIdentifier TelexNumber UTCTime LDAPSyntaxDescription
117 SubstringAssertion NISnetgrouptriple Bootparameter
123 .B concurrency <integer>
124 Specify a desired level of concurrency. Provided to the underlying
125 thread system as a hint. The default is not to provide any hint.
127 .B defaultsearchbase <dn>
128 Specify a default search base to use when client submits a
129 non-base search request with an empty base DN.
131 .B disallow <features>
132 Specify a set of features (separated by white space) to
133 disallow (default none).
135 disables acceptance of LDAPv2 bind requests.
137 disables acceptance of anonymous bind requests.
139 disables anonymous bind creditials are not empty (e.g.
142 disables anonymous bind when DN is not empty.
144 disables simple (bind) authentication.
146 disables Kerberos V4 (bind) authentication.
148 disables StartTLS if authenticated (see also
152 .B idletimeout <integer>
153 Specify the number of seconds to wait before forcibly closing
154 an idle client connections. A idletimeout of 0 disables this
155 feature. The default is 0.
157 .B include <filename>
158 Read additional configuration information from the given file before
159 continuing with the next line of the current file.
161 .B limits <who> <limit> [<limit> [...]]
162 Specify time and size limits based on who initiated an operation.
169 anonymous | users | [dn[.<style>]=]<pattern>
175 <style> ::= exact | base | one | subtree | children | regex | anonymous
179 is hit when a search is performed without prior binding;
181 is hit when a search is performed by a successfully bound user;
184 dn pattern is assumed unless otherwise specified by qualifying
185 the (optional) key string
191 (which are synonims), to require an exact match; with
193 to require exactly one level of depth match; with
195 to allow any level of depth match, including the exact match; with
197 to allow any level of depth match, not including the exact match;
199 explicitly requires the (default) match based on regular expression
200 pattern, as detailed in
204 matches unbound operations; the
207 The same behavior is obtained by using the
213 The currently supported limits are
218 The syntax for time limits is
219 .BR time[.{soft|hard}]=<integer> ,
222 is the number of seconds slapd will spend answering a search request.
223 If no time limit is explicitly requested by the client, the
225 limit is used; if the requested time limit exceedes the
227 limit, an "Unwilling to perform" is returned.
230 limit is set to 0 or to the keyword "soft", the soft limit is used
231 in either case; if it is set to -1 or to the keyword "none",
232 no hard limit is enforced.
233 Explicit requests for time limits smaller or equal to the
236 If no flag is set, the value is assigned to the
240 limit is set to zero, to preserve the original behavior.
242 The syntax for size limits is
243 .BR size[.{soft|hard|unchecked}]=<integer> ,
246 is the maximum number of entries slapd will return answering a search
248 If no size limit is explicitly requested by the client, the
250 limit is used; if the requested size limit exceedes the
252 limit, an "Unwilling to perform" is returned.
255 limit is set to 0 or to the keyword "soft", the soft limit is used
256 in either case; if it is set to -1 or to the keyword "none",
257 no hard limit is enforced.
258 Explicit requests for size limits smaller or equal to the
263 flag sets a limit on the number of candidates a search request is allowed
265 If the selected candidates exceed the
267 limit, the search will abort with "Unwilling to perform".
268 If it is set to -1 or to the keyword "none", no limit is applied (the default).
269 If no flag is set, the value is assigned to the
273 limit is set to zero, to preserve the original behavior.
275 In case of no match, the global limits are used.
276 The default values are the same of
282 This feature is currently exploited by the ldbm backend only.
285 .B loglevel <integer>
286 Specify the level at which debugging statements and operation
287 statistics should be syslogged (currently logged to the
289 LOG_LOCAL4 facility). Log levels are additive, and available levels
299 debug packet handling
302 heavy trace debugging
305 connection management
308 print out packets sent and received
311 search filter processing
314 configuration file processing
317 access control list processing
320 stats log connections/operations/results
323 stats log entries sent
326 print communication with shell backends
334 .B objectclass ( <oid> [NAME <name>] [DESC <description] [OBSOLETE]\
335 [SUP <oids>] [{ ABSTRACT | STRUCTURAL | AUXILIARY }] [MUST <oids>]\
338 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
339 The slapd parser extends the RFC 2252 definition by allowing string
340 forms as well as numeric OIDs to be used for the object class OID.
344 description.) Object classes are "STRUCTURAL" by default.
347 .B objectidentifier <name> { <oid> | <name>[:<suffix>] }
348 Define a string name that equates to the given OID. The string can be used
349 in place of the numeric OID in objectclass and attribute definitions. The
350 name can also be used with a suffix of the form ":xx" in which case the
351 value "oid.xx" will be used.
353 .B password-hash <hash>
354 The <hash> to use for userPassword generation. One of
364 .B password-crypt-salt-format <format>
365 Specify the format of the salt passed to
367 when generating {CRYPT} passwords.
368 This string needs to be in
370 format and may include one (and only one) %s conversion.
371 This conversion will be substituted with a string random
372 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
373 provides a two character salt and "$1$%.8s" tells some
374 versions of crypt(3) to use an MD5 algorithm and provides
375 8 random characters of salt. The default is "%s", which
376 provides 31 characters of salt.
378 .B pidfile <filename>
379 The ( absolute ) name of a file that will hold the
381 server's process ID ( see
383 ) if started without the debugging command line option.
386 Specify the referral to pass back when
388 cannot find a local database to handle a request.
389 If specified multiple times, each url is provided.
391 .B require <conditions>
392 Specify a set of conditions (separated by white space) to
393 require (default none).
394 The directive may be specified globally and/or per-database.
396 requires bind operation prior to directory operations.
398 requires session to be using LDAP version 3.
400 requires authentication prior to directory operations.
402 requires SASL authentication prior to directory operations.
404 requires strong authentication prior to directory operations.
409 conditions are currently same.
411 may be used to require no conditions (useful for clearly globally
412 set conditions within a particular database).
414 .B rootDSEfile <file>
415 Specify the name of an LDIF(5) file containing user defined attributes
416 for the root DSE. These attributes are returned in addition to the
417 attributes normally produced by slapd.
420 Used to specify the fully qualified domain name used for SASL processing.
422 .B sasl-realm <realm>
423 Specify SASL realm. Default is empty.
425 .B sasl-regexp <match> <replace>
426 Used by the SASL authorization mechanism to convert a SASL authenticated
427 username to an LDAP DN. When an authorization request is received, the SASL
431 are taken, when available, and combined into a SASL name of the
436 .B uid=<UID>[,cn=<REALM>][,cn=<MECH>],cn=AUTHZ
439 This SASL name is then compared against the
441 regular expression, and if the match is successful, the SASL name is
444 string. If there are wildcard strings in the
446 regular expression that are enclosed in parenthesis, e.g.
450 .B uid=(.*)\\\\+realm=.*
454 then the portion of the SASL name that matched the wildcard will be stored
455 in the numbered placeholder variable $1. If there are other wildcard strings
456 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
457 placeholders can then be used in the
463 .B cn=$1,ou=Accounts,dc=$2,dc=$4.
467 The replaced SASL name can be either a DN or an LDAP URI. If the latter, the slapd
468 server will use the URI to search its own database, and if the search returns
469 exactly one entry, the SASL name is replaced by the DN of that entry.
472 options can be given in the configuration file to allow for multiple matching
473 and replacement patterns. The matching patterns are checked in the order they
474 appear in the file, stopping at the first successful match.
477 Because the plus sign + is a character recognized by the regular expression engine,
478 and it will appear in SASL names that include a REALM, be careful to escape the
479 plus sign with a backslash \\+ to remove the character's special meaning.
482 .B sasl-secprops <properties>
483 Used to specify Cyrus SASL security properties.
486 flag (without any other properities) causes the flag properites
487 default, "noanonymous,noplain", to be cleared.
490 flag disables mechanisms susceptible to simple passive attacks.
493 flag disables mechanisms susceptible to active attacks.
496 flag disables mechanisms susceptible to passive dictionary attacks.
499 flag disables mechanisms which support anonymous login.
502 flag require forward secrecy between sessions.
505 require mechanisms which pass client credentials (and allow
506 mechanisms which can pass credentials to do so).
509 property specifies the minimum acceptable
510 .I security strength factor
511 as an integer approximate to effective key length used for
512 encryption. 0 (zero) implies no protection, 1 implies integrity
513 protection only, 56 allows DES or other weak ciphers, 112
514 allows triple DES and other strong ciphers, 128 allows RC4,
515 Blowfish and other modern strong ciphers. The default is 0.
518 property specifies the maximum acceptable
519 .I security strength factor
520 as an integer (see minssf description). The default is INT_MAX.
523 property specifies the maximum security layer receive buffer
524 size allowed. 0 disables security layers. The default is 65536.
526 .B security <factors>
527 Specify a set of factors (separated by white space) to require.
528 An integer value is associated with each factor and is roughly
529 equivalent of the encryption key length to require. A value
530 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
531 The directive may be specified globally and/or per-database.
533 specifies the overall security strength factor.
535 specifies the transport security strength factor.
537 specifies the TLS security strength factor.
539 specifies the SASL security strength factor.
541 specifies the overall security strength factor to require for
543 .B update_transport=<n>
544 specifies the transport security strength factor to require for
547 specifies the TLS security strength factor to require for
550 specifies the SASL security strength factor to require for
554 factor is measure of security provided by the underlying transport,
555 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
557 .B sizelimit <integer>
559 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
560 Specify the maximum number of entries to return from a search operation.
561 The default size limit is 500.
562 The second format allows a fine grain setting of the size limits.
563 Extra args can be added on the same line.
566 for an explanation of the different flags.
568 .B sockbuf_max_incoming <integer>
569 Specify the maximum incoming LDAP PDU size for anonymous sessions.
570 The default is 262143.
572 .B sockbuf_max_incoming_auth <integer>
573 Specify the maximum incoming LDAP PDU size for authenticated sessions.
574 The default is 4194303.
577 Specify the srvtab file in which the kerberos keys necessary for
578 authenticating clients using kerberos can be found. This option is only
579 meaningful if you are using Kerberos authentication.
582 Specify the maximum size of the primary thread pool.
585 .B timelimit <integer>
587 .B timelimit time[.{soft|hard}]=<integer> [...]
588 Specify the maximum number of seconds (in real time)
590 will spend answering a search request. The default time limit is 3600.
591 The second format allows a fine grain setting of the time limits.
592 Extra args can be added on the same line.
595 for an explanation of the different flags.
599 is build with support for Transport Layer Security, there are more options
602 .B TLSCipherSuite <cipher-suite-spec>
603 Permits configuring what ciphers will be accepted and the preference order.
604 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
606 TLSCipherSuite HIGH:MEDIUM:+SSLv2
608 To check what ciphers a given spec selects, use:
610 openssl ciphers -v <cipher-suite-spec>
612 .B TLSCertificateFile <filename>
613 Specifies the file that contains the
617 .B TLSCertificateKeyFile <filename>
618 Specifies the file that contains the
620 server private key that matches the certificate stored in the
621 .B TLSCertificateFile
622 file. Currently, the private key must not be protected with a password, so
623 it is of critical importance that it is protected carefully.
625 .B TLSRandFile <filename>
626 Specifies the file to obtain random bits from when /dev/[u]random
627 is not available. Generally set to the name of the EGD/PRNGD socket.
628 The environment variable RANDFILE can also be used to specify the filename.
629 .SH GENERAL BACKEND OPTIONS
630 Options in this section only apply to the configuration file section
631 for the specified backend. They are supported by every
634 .B backend <databasetype>
635 Mark the beginning of a backend definition. <databasetype>
641 depending on which backend will serve the database.
643 .SH GENERAL DATABASE OPTIONS
644 Options in this section only apply to the configuration file section
645 for the database in which they are defined. They are supported by every
648 .B database <databasetype>
649 Mark the beginning of a new database instance definition. <databasetype>
655 depending on which backend will serve the database.
660 will automatically maintain the
661 modifiersName, modifyTimestamp, creatorsName, and
662 createTimestamp attributes for entries. By default, lastmod is on.
665 This option puts the database into "read-only" mode. Any attempts to
666 modify the database will return an "unwilling to perform" error. By
667 default, readonly is off.
669 .B replica host=<hostname>[:port] [tls=yes|critical]
670 .B [suffix=<suffix> [...]]
671 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
672 .B [saslmech=<SASL mech>] [secopts=<options>] [realm=<realm>]
673 .B [authcId=<authentication ID>] [authcId=<authentication ID>]
675 Specify a replication site for this database. Refer to the "OpenLDAP
676 Administrator's Guide" for detailed information on setting up a replicated
678 directory service. Zero or more
680 instances can be used to select the subtrees that will be replicated
681 (defaults to all the database). A
689 and should only be used when adequate security services
690 (e.g TLS or IPSEC) are in place. A
698 will use Kerberos, a kerberos instance should be given in
702 .B replogfile <filename>
703 Specify the name of the replication log file to log changes to.
704 The replication log is typically written by
710 for more information. The specified file should be located
711 in a directory with limited read/write/execute access as the replication
712 logs may contain sensitive information.
715 Specify the distinguished name that is not subject to access control
716 or administrative limit restrictions for operations on this database.
717 This DN may or may not be associated with an entry. An empty root
718 DN (the default) specifies no root access is to be granted. It is
719 recommended that the rootdn only be specified when needed (such as
720 when initially populating a database). If the rootdn is within
721 a namingContext (suffix) of the database, a simple bind password
722 may also be provided using the
727 Specify a password (or hash of the password) for the rootdn. If
728 the rootdn is not within the namingContext of the database, the
729 provided password is ignored.
730 This option accepts all RFC 2307 userPassword formats known to
733 desription) as well as cleartext.
735 may be used to generate a hash of a password. Cleartext
736 and \fB{CRYPT}\fP passwords are not recommended. If empty
737 (the default), authentication of the root DN is by other means
738 (e.g. SASL). Use of SASL is encouraged.
740 .B suffix <dn suffix>
741 Specify the DN suffix of queries that will be passed to this
742 backend database. Multiple suffix lines can be given and at least one is
743 required for each database definition.
746 Specify that the current backend database is a subordinate of another
747 backend database. A subordinate database may have only one suffix. This
748 option may bse used to glue multiple databases into a single namingContext.
749 If the suffix of the current database is within the namingContext of a
750 superior database, searches against the superior database will be
751 propagated to the subordinate as well. All of the databases
752 associated with a single namingContext should have identical rootdns.
753 Behavior of other LDAP operations is unaffected by this setting. In
754 particular, it is not possible to use moddn to move an entry from
755 one subordinate to another subordinate within the namingContext.
758 This option is only applicable in a slave
760 It specifies the DN allowed to make changes to the replica (typically,
763 binds as when making changes to the replica).
766 Specify the referral to pass back when
768 is asked to modify a replicated local database.
769 If specified multiple times, each url is provided.
770 .\" .SH LDBM BACKEND-SPECIFIC OPTIONS
771 .\" Options in this category only apply to the LDBM backend. That is,
772 .\" they must follow "backend ldbm" line and come before any subsequent
773 .\" "backend" or "database" lines. The LDBM backend is a high-performance
774 .\" database that makes extensive use of indexing and caching to speed
776 .SH LDBM DATABASE-SPECIFIC OPTIONS
777 Options in this category only apply to the LDBM databases. That is,
778 they must follow "database ldbm" line and come before any subsequent
779 "backend" or "database" lines.
781 .B cachesize <integer>
782 Specify the size in entries of the in-memory cache maintained
783 by the LDBM backend database instance. The default is 1000 entries.
785 .B dbcachesize <integer>
786 Specify the size in bytes of the in-memory cache associated
787 with each open index file. If not supported by the underlying database
788 method, this option is ignored without comment. The default is 100000 bytes.
791 Specify that no database locking should be performed.
792 Enabling this option may improve performance at the expense of data security.
793 Do NOT run any slap tools while slapd is running.
796 Specify that on-disk database contents should not be immediately
797 synchronized with in memory changes. Enabling this option may improve
798 performance at the expense of data security.
800 .B dbsync <frequency> <maxdelays> <delayinterval>
801 Flush dirty database buffers to disk every
805 (ie. indvidual updates are no longer written to disk). It attempts to avoid
806 syncs during periods of peak activity by waiting
808 seconds if the server is busy, repeating this delay up to
810 times before proceeding.
811 It is an attempt to provide higher write performance with some amount of data
812 security. Note that it may still be possible to get an inconsistent
813 database if the underlying engine fills its cache and writes out individual
814 pages and slapd crashes or is killed before the next sync.
818 are optional and default to
822 respectively, giving a total elapsed delay of 60 seconds before a sync
827 must be 1 or greater.
829 .B directory <directory>
830 Specify the directory where the LDBM files containing this database and
831 associated indexes live. A separate directory must be specified for
832 each database. The default is
833 .BR LOCALSTATEDIR/openldap-ldbm .
836 index {<attrlist>|default} [pres,eq,approx,sub,<special>]
837 Specify the indexes to maintain for the given attribute. If only
838 an <attr> is given, the indices specified for \fBdefault\fR
839 are maintained. Note that setting a default does not imply that
840 all attributes will be indexed.
842 A number of special index parameters may be
846 can be decomposed into
853 may be specified to disallow use of this index by language subtypes.
856 may be specified to disallow use of this index by named subtypes.
859 may be specified to automatically maintain separate indices for each
860 named subtype of the attribute type.
861 Note: changing index settings requires rebuilding indices, see
865 Specify the file protection mode that newly created database
866 index files should have. The default is 0600.
867 .SH SHELL DATABASE-SPECIFIC OPTIONS
868 Options in this category only apply to the SHELL backend database. That is,
869 they must follow a "database shell" line and come before any subsequent
870 "backend" or "database" lines. The Shell backend executes external programs to
871 implement operations, and is designed to make it easy to tie an existing
882 .B compare <pathname>
892 .B abandon <pathname>
893 These options specify the pathname of the command to execute in response
894 to the given LDAP operation.
896 Note that you need only supply configuration lines for those commands you
897 want the backend to handle. Operations for which a command is not
898 supplied will be refused with an "unwilling to perform" error.
899 .SH PASSWORD DATABASE-SPECIFIC OPTIONS
900 Options in this category only apply to the PASSWD backend database.
901 That is, they must follow a "database passwd" line and come before any
902 subsequent "backend" or "database" lines. The PASSWD database serves up the user
903 account information listed in the system
908 Specifies an alternate passwd file to use. The default is
911 "OpenLDAP Administrator's Guide" contains an annotated
912 example of a configuration file.
917 .BR slapd.replog (5),
918 .BR slapd.access (5),
925 .BR slappassword (8),
928 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
931 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
933 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob