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 [dn[.{exact|regex}]=]<pattern> <limit> [...]
162 Specify time and size limits based on the distinguished name that
163 initiated an operation.
166 contains the DN the limits are applied to.
167 It is a distinguished name in case of
169 match, or an Extended Regex pattern in case of
172 The currently supported limits are "size" and "time".
174 The syntax for time limits is
175 .BR time[.{soft|hard}]=<integer> ,
178 is the number of seconds slapd will spend answering a search request.
179 If no time limit is explicitly requested by the client, the
181 limit is used; if the requested time limit exceedes the
183 limit, an "Unwilling to perform" is returned.
186 limit is set to zero, the soft limit is used in either case;
187 if it is set to -1, no hard limit is enforced.
188 Explicit requests for time limits smaller or equal to the
191 If no flag is set, the value is assigned to the
195 limit is set to zero, to preserve the original behavior.
197 The syntax for size limits is
198 .BR size[.{soft|hard|unchecked}]=<integer> ,
201 is the maximum number of entries slapd will return answering a search
203 If no size limit is explicitly requested by the client, the
205 limit is used; if the requested size limit exceedes the
207 limit, an "Unwilling to perform" is returned.
210 limit is set to zero, the soft limit is used in either case;
211 if it is set to -1, no hard limit is enforced.
212 Explicit requests for size limits smaller or equal to the
217 flag sets a limit on the number of candidates a search request is allowed
219 If the selected candidates exceed the
221 limit, the search will abort with "Unwilling to perform".
222 If no flag is set, the value is assigned to the
226 limit is set to zero, to preserve the original behavior.
228 In case of no match, the global limits are used.
229 The default values are the same of
235 This feature is currently exploited by the ldbm backend only.
237 .B loglevel <integer>
238 Specify the level at which debugging statements and operation
239 statistics should be syslogged (currently logged to the
241 LOG_LOCAL4 facility). Log levels are additive, and available levels
251 debug packet handling
254 heavy trace debugging
257 connection management
260 print out packets sent and received
263 search filter processing
266 configuration file processing
269 access control list processing
272 stats log connections/operations/results
275 stats log entries sent
278 print communication with shell backends
286 .B objectclass ( <oid> [NAME <name>] [DESC <description] [OBSOLETE]\
287 [SUP <oids>] [{ ABSTRACT | STRUCTURAL | AUXILIARY }] [MUST <oids>]\
290 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
291 The slapd parser extends the RFC 2252 definition by allowing string
292 forms as well as numeric OIDs to be used for the object class OID.
296 description.) Object classes are "STRUCTURAL" by default.
299 .B objectidentifier <name> { <oid> | <name>[:<suffix>] }
300 Define a string name that equates to the given OID. The string can be used
301 in place of the numeric OID in objectclass and attribute definitions. The
302 name can also be used with a suffix of the form ":xx" in which case the
303 value "oid.xx" will be used.
305 .B password-hash <hash>
306 The <hash> to use for userPassword generation. One of
319 .B password-crypt-salt-format <format>
320 Specify the format of the salt passed to
322 when generating {CRYPT} passwords.
323 This string needs to be in
325 format and may include one (and only one) %s conversion.
326 This conversion will be substituted with a string random
327 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
328 provides a two character salt and "$1$%.8s" tells some
329 versions of crypt(3) to use an MD5 algorithm and provides
330 8 random characters of salt. The default is "%s", which
331 provides 31 characters of salt.
333 .B pidfile <filename>
334 The ( absolute ) name of a file that will hold the
336 server's process ID ( see
338 ) if started without the debugging command line option.
341 Specify the referral to pass back when
343 cannot find a local database to handle a request.
344 If specified multiple times, each url is provided.
346 .B require <conditions>
347 Specify a set of conditions (separated by white space) to
348 require (default none).
349 The directive may be specified globally and/or per-database.
351 requires bind operation prior to directory operations.
353 requires session to be using LDAP version 3.
355 requires authentication prior to directory operations.
357 requires SASL authentication prior to directory operations.
359 requires strong authentication prior to directory operations.
364 conditions are currently same.
366 may be used to require no conditions (useful for clearly globally
367 set conditions within a particular database).
370 Used to specify the fully qualified domain name used for SASL processing.
372 .B sasl-realm <realm>
373 Specify SASL realm. Default is empty.
375 .B sasl-regexp <match> <replace>
376 Used by the SASL authorization mechanism to convert a SASL authenticated
377 username to an LDAP DN. When an authorization request is received, the SASL
381 are taken, when available, and combined into a SASL name of the
386 .B uid=<UID>[,cn=<REALM>][,cn=<MECH>],cn=AUTHZ
389 This SASL name is then compared against the
391 regular expression, and if the match is successful, the SASL name is
394 string. If there are wildcard strings in the
396 regular expression that are enclosed in parenthesis, e.g.
400 .B uid=(.*)\\\\+realm=.*
404 then the portion of the SASL name that matched the wildcard will be stored
405 in the numbered placeholder variable $1. If there are other wildcard strings
406 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
407 placeholders can then be used in the
413 .B cn=$1,ou=Accounts,dc=$2,dc=$4.
417 The replaced SASL name can be either a DN or an LDAP URI. If the latter, the slapd
418 server will use the URI to search its own database, and if the search returns
419 exactly one entry, the SASL name is replaced by the DN of that entry.
422 options can be given in the configuration file to allow for multiple matching
423 and replacement patterns. The matching patterns are checked in the order they
424 appear in the file, stopping at the first successful match.
427 Because the plus sign + is a character recognized by the regular expression engine,
428 and it will appear in SASL names that include a REALM, be careful to escape the
429 plus sign with a backslash \\+ to remove the character's special meaning.
432 .B sasl-secprops <properties>
433 Used to specify Cyrus SASL security properties.
436 flag (without any other properities) causes the flag properites
437 default, "noanonymous,noplain", to be cleared.
440 flag disables mechanisms susceptible to simple passive attacks.
443 flag disables mechanisms susceptible to active attacks.
446 flag disables mechanisms susceptible to passive dictionary attacks.
449 flag disables mechanisms which support anonymous login.
452 flag require forward secrecy between sessions.
455 require mechanisms which pass client credentials (and allow
456 mechanisms which can pass credentials to do so).
459 property specifies the minimum acceptable
460 .I security strength factor
461 as an integer approximate to effective key length used for
462 encryption. 0 (zero) implies no protection, 1 implies integrity
463 protection only, 56 allows DES or other weak ciphers, 112
464 allows triple DES and other strong ciphers, 128 allows RC4,
465 Blowfish and other modern strong ciphers. The default is 0.
468 property specifies the maximum acceptable
469 .I security strength factor
470 as an integer (see minssf description). The default is INT_MAX.
473 property specifies the maximum security layer receive buffer
474 size allowed. 0 disables security layers. The default is 65536.
476 .B schemacheck { on | off }
477 Turn schema checking on or off. The default is on.
479 .B security <factors>
480 Specify a set of factors (separated by white space) to require.
481 An integer value is associated with each factor and is roughly
482 equivalent of the encryption key length to require. A value
483 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
484 The directive may be specified globally and/or per-database.
486 specifies the overall security strength factor.
488 specifies the transport security strength factor.
490 specifies the TLS security strength factor.
492 specifies the SASL security strength factor.
494 specifies the overall security strength factor to require for
496 .B update_transport=<n>
497 specifies the transport security strength factor to require for
500 specifies the TLS security strength factor to require for
503 specifies the SASL security strength factor to require for
507 factor is measure of security provided by the underlying transport,
508 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
510 .B schemacheck { on | off }
511 Turn schema checking on or off. The default is on.
513 .B sizelimit <integer>
515 .B sizelimit size[.{soft|hard|unchecked}]=<integer>
516 Specify the maximum number of entries to return from a search operation.
517 The default size limit is 500.
518 The second format allows a fine grain setting of the size limits.
521 for an explanation of the different flags.
523 .B sockbuf_max_incoming <integer>
524 Specify the maximum incoming LDAP PDU size for anonymous sessions.
525 The default is 262143.
527 .B sockbuf_max_incoming_auth <integer>
528 Specify the maximum incoming LDAP PDU size for authenticated sessions.
529 The default is 4194303.
532 Specify the srvtab file in which the kerberos keys necessary for
533 authenticating clients using kerberos can be found. This option is only
534 meaningful if you are using Kerberos authentication.
537 Specify the maximum size of the primary thread pool.
540 .B timelimit <integer>
542 .B sizelimit size[.{soft|hard}]=<integer>
543 Specify the maximum number of seconds (in real time)
545 will spend answering a search request. The default time limit is 3600.
546 The second format allows a fine grain setting of the time limits.
549 for an explanation of the different flags.
553 is build with support for Transport Layer Security, there are more options
556 .B TLSCipherSuite <cipher-suite-spec>
557 Permits configuring what ciphers will be accepted and the preference order.
558 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
560 TLSCipherSuite HIGH:MEDIUM:+SSLv2
562 To check what ciphers a given spec selects, use:
564 openssl ciphers -v <cipher-suite-spec>
566 .B TLSCertificateFile <filename>
567 Specifies the file that contains the
571 .B TLSCertificateKeyFile <filename>
572 Specifies the file that contains the
574 server private key that matches the certificate stored in the
575 .B TLSCertificateFile
576 file. Currently, the private key must not be protected with a password, so
577 it is of critical importance that it is protected carefully.
579 .B TLSRandFile <filename>
580 Specifies the file to obtain random bits from when /dev/[u]random
581 is not available. Generally set to the name of the EGD/PRNGD socket.
582 The environment variable RANDFILE can also be used to specify the filename.
583 .SH GENERAL BACKEND OPTIONS
584 Options in this section only apply to the configuration file section
585 for the specified backend. They are supported by every
588 .B backend <databasetype>
589 Mark the beginning of a backend definition. <databasetype>
595 depending on which backend will serve the database.
597 .SH GENERAL DATABASE OPTIONS
598 Options in this section only apply to the configuration file section
599 for the database in which they are defined. They are supported by every
602 .B database <databasetype>
603 Mark the beginning of a new database instance definition. <databasetype>
609 depending on which backend will serve the database.
614 will automatically maintain the
615 modifiersName, modifyTimestamp, creatorsName, and
616 createTimestamp attributes for entries. By default, lastmod is on.
619 This option puts the database into "read-only" mode. Any attempts to
620 modify the database will return an "unwilling to perform" error. By
621 default, readonly is off.
623 .B replica host=<hostname>[:port] [tls=yes|critical]
624 .B [suffix=<suffix> [...]]
625 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
626 .B [saslmech=<SASL mech>] [secopts=<options>] [realm=<realm>]
627 .B [authcId=<authentication ID>] [authcId=<authentication ID>]
629 Specify a replication site for this database. Refer to the "OpenLDAP
630 Administrator's Guide" for detailed information on setting up a replicated
632 directory service. Zero or more
634 instances can be used to select the subtrees that will be replicated
635 (defaults to all the database). A
643 and should only be used when adequate security services
644 (e.g TLS or IPSEC) are in place. A
652 will use Kerberos, a kerberos instance should be given in
656 .B replogfile <filename>
657 Specify the name of the replication log file to log changes to.
658 The replication log is typically written by
664 for more information. The specified file should be located
665 in a directory with limited read/write/execute access as the replication
666 logs may contain sensitive information.
669 Specify the distinguished name that is not subject to access control
670 or administrative limit restrictions for operations on this database.
671 This DN may or may not be associated with an entry. An empty root
672 DN (the default) specifies no root access is to be granted. It is
673 recommended that the rootdn only be specified when needed (such as
674 when initially populating a database). If the rootdn is within
675 a namingContext (suffix) of the database, a simple bind password
676 may also be provided using the
681 Specify a password (or hash of the password) for the rootdn. If
682 the rootdn is not within the namingContext of the database, the
683 provided password is ignored.
684 This option accepts all RFC 2307 userPassword formats known to
687 desription) as well as cleartext.
689 may be used to generate a hash of a password. Cleartext
690 and \fB{CRYPT}\fP passwords are not recommended. If empty
691 (the default), authentication of the root DN is by other means
692 (e.g. SASL). Use of SASL is encouraged.
694 .B suffix <dn suffix>
695 Specify the DN suffix of queries that will be passed to this
696 backend database. Multiple suffix lines can be given and at least one is
697 required for each database definition.
700 This option is only applicable in a slave
702 It specifies the DN allowed to make changes to the replica (typically,
705 binds as when making changes to the replica).
708 Specify the referral to pass back when
710 is asked to modify a replicated local database.
711 If specified multiple times, each url is provided.
712 .\" .SH LDBM BACKEND-SPECIFIC OPTIONS
713 .\" Options in this category only apply to the LDBM backend. That is,
714 .\" they must follow "backend ldbm" line and come before any subsequent
715 .\" "backend" or "database" lines. The LDBM backend is a high-performance
716 .\" database that makes extensive use of indexing and caching to speed
718 .SH LDBM DATABASE-SPECIFIC OPTIONS
719 Options in this category only apply to the LDBM databases. That is,
720 they must follow "database ldbm" line and come before any subsequent
721 "backend" or "database" lines.
723 .B cachesize <integer>
724 Specify the size in entries of the in-memory cache maintained
725 by the LDBM backend database instance. The default is 1000 entries.
727 .B dbcachesize <integer>
728 Specify the size in bytes of the in-memory cache associated
729 with each open index file. If not supported by the underlying database
730 method, this option is ignored without comment. The default is 100000 bytes.
733 Specify that no database locking should be performed.
734 Enabling this option may improve performance at the expense of data security.
737 Specify that on-disk database contents should not be immediately
738 synchronized with in memory changes. Enabling this option may improve
739 performance at the expense of data security.
741 .B dbsync <frequency> <maxdelays> <delayinterval>
742 Flush dirty database buffers to disk every
746 (ie. indvidual updates are no longer written to disk). It attempts to avoid
747 syncs during periods of peak activity by waiting
749 seconds if the server is busy, repeating this delay up to
751 times before proceeding.
752 It is an attempt to provide higher write performance with some amount of data
753 security. Note that it may still be possible to get an inconsistent
754 database if the underlying engine fills its cache and writes out individual
755 pages and slapd crashes or is killed before the next sync.
759 are optional and default to
763 respectively, giving a total elapsed delay of 60 seconds before a sync
768 must be 1 or greater.
770 .B directory <directory>
771 Specify the directory where the LDBM files containing this database and
772 associated indexes live. A separate directory must be specified for
773 each database. The default is
774 .BR LOCALSTATEDIR/openldap-ldbm .
777 index {<attrlist>|default} [pres,eq,approx,sub,<special>]
778 Specify the indexes to maintain for the given attribute. If only
779 an <attr> is given, the indices specified for \fBdefault\fR
780 are maintained. A number of special index parameters may be
784 can be decomposed into
791 may be specified to allow use of this index by language subtypes.
794 may be specified to automatically maintain separate indices for each
798 may be specified to allow use of this index by named subtypes.
801 may be specified to automatically maintain separate indices for each
805 Specify the file protection mode that newly created database
806 index files should have. The default is 0600.
807 .SH SHELL DATABASE-SPECIFIC OPTIONS
808 Options in this category only apply to the SHELL backend database. That is,
809 they must follow a "database shell" line and come before any subsequent
810 "backend" or "database" lines. The Shell backend executes external programs to
811 implement operations, and is designed to make it easy to tie an existing
822 .B compare <pathname>
832 .B abandon <pathname>
833 These options specify the pathname of the command to execute in response
834 to the given LDAP operation.
836 Note that you need only supply configuration lines for those commands you
837 want the backend to handle. Operations for which a command is not
838 supplied will be refused with an "unwilling to perform" error.
839 .SH PASSWORD DATABASE-SPECIFIC OPTIONS
840 Options in this category only apply to the PASSWD backend database.
841 That is, they must follow a "database passwd" line and come before any
842 subsequent "backend" or "database" lines. The PASSWD database serves up the user
843 account information listed in the system
848 Specifies an alternate passwd file to use. The default is
851 "OpenLDAP Administrator's Guide" contains an annotated
852 example of a configuration file.
857 .BR slapd.replog (5),
864 .BR slappassword (8),
867 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
870 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
872 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob