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 connection. 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 This option sets the hash to be used in generation of user
353 passwords, stored in userPassword, during processing of
354 LDAP Password Modify Extended Operations (RFC 3052).
355 The <hash> must be one of
365 Note that this option does not alter the normal user applications
366 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
368 .B password\-crypt\-salt\-format <format>
369 Specify the format of the salt passed to
371 when generating {CRYPT} passwords (see
373 during processing of LDAP Password Modify Extended Operations (RFC 3062).
375 This string needs to be in
377 format and may include one (and only one) %s conversion.
378 This conversion will be substituted with a string random
379 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
380 provides a two character salt and "$1$%.8s" tells some
381 versions of crypt(3) to use an MD5 algorithm and provides
382 8 random characters of salt. The default is "%s", which
383 provides 31 characters of salt.
385 .B pidfile <filename>
386 The ( absolute ) name of a file that will hold the
388 server's process ID ( see
390 ) if started without the debugging command line option.
393 Specify the referral to pass back when
395 cannot find a local database to handle a request.
396 If specified multiple times, each url is provided.
398 .B require <conditions>
399 Specify a set of conditions (separated by white space) to
400 require (default none).
401 The directive may be specified globally and/or per-database.
403 requires bind operation prior to directory operations.
405 requires session to be using LDAP version 3.
407 requires authentication prior to directory operations.
409 requires SASL authentication prior to directory operations.
411 requires strong authentication prior to directory operations.
416 conditions are currently same.
418 may be used to require no conditions (useful for clearly globally
419 set conditions within a particular database).
422 Specify the name of an LDIF(5) file containing user defined attributes
423 for the root DSE. These attributes are returned in addition to the
424 attributes normally produced by slapd.
427 Used to specify the fully qualified domain name used for SASL processing.
429 .B sasl-realm <realm>
430 Specify SASL realm. Default is empty.
432 .B sasl-regexp <match> <replace>
433 Used by the SASL authorization mechanism to convert a SASL authenticated
434 username to an LDAP DN. When an authorization request is received, the SASL
438 are taken, when available, and combined into a SASL name of the
443 .B uid=<UID>[,cn=<REALM>][,cn=<MECH>],cn=AUTHZ
446 This SASL name is then compared against the
448 regular expression, and if the match is successful, the SASL name is
451 string. If there are wildcard strings in the
453 regular expression that are enclosed in parenthesis, e.g.
457 .B uid=(.*)\\\\+realm=.*
461 then the portion of the SASL name that matched the wildcard will be stored
462 in the numbered placeholder variable $1. If there are other wildcard strings
463 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
464 placeholders can then be used in the
470 .B cn=$1,ou=Accounts,dc=$2,dc=$4.
474 The replaced SASL name can be either a DN or an LDAP URI. If the latter, the slapd
475 server will use the URI to search its own database, and if the search returns
476 exactly one entry, the SASL name is replaced by the DN of that entry.
479 options can be given in the configuration file to allow for multiple matching
480 and replacement patterns. The matching patterns are checked in the order they
481 appear in the file, stopping at the first successful match.
484 Because the plus sign + is a character recognized by the regular expression engine,
485 and it will appear in SASL names that include a REALM, be careful to escape the
486 plus sign with a backslash \\+ to remove the character's special meaning.
489 .B sasl-secprops <properties>
490 Used to specify Cyrus SASL security properties.
493 flag (without any other properities) causes the flag properites
494 default, "noanonymous,noplain", to be cleared.
497 flag disables mechanisms susceptible to simple passive attacks.
500 flag disables mechanisms susceptible to active attacks.
503 flag disables mechanisms susceptible to passive dictionary attacks.
506 flag disables mechanisms which support anonymous login.
509 flag require forward secrecy between sessions.
512 require mechanisms which pass client credentials (and allow
513 mechanisms which can pass credentials to do so).
516 property specifies the minimum acceptable
517 .I security strength factor
518 as an integer approximate to effective key length used for
519 encryption. 0 (zero) implies no protection, 1 implies integrity
520 protection only, 56 allows DES or other weak ciphers, 112
521 allows triple DES and other strong ciphers, 128 allows RC4,
522 Blowfish and other modern strong ciphers. The default is 0.
525 property specifies the maximum acceptable
526 .I security strength factor
527 as an integer (see minssf description). The default is INT_MAX.
530 property specifies the maximum security layer receive buffer
531 size allowed. 0 disables security layers. The default is 65536.
533 .B security <factors>
534 Specify a set of factors (separated by white space) to require.
535 An integer value is associated with each factor and is roughly
536 equivalent of the encryption key length to require. A value
537 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
538 The directive may be specified globally and/or per-database.
540 specifies the overall security strength factor.
542 specifies the transport security strength factor.
544 specifies the TLS security strength factor.
546 specifies the SASL security strength factor.
548 specifies the overall security strength factor to require for
550 .B update_transport=<n>
551 specifies the transport security strength factor to require for
554 specifies the TLS security strength factor to require for
557 specifies the SASL security strength factor to require for
561 factor is measure of security provided by the underlying transport,
562 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
564 .B sizelimit <integer>
566 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
567 Specify the maximum number of entries to return from a search operation.
568 The default size limit is 500.
569 The second format allows a fine grain setting of the size limits.
570 Extra args can be added on the same line.
573 for an explanation of the different flags.
575 .B sockbuf_max_incoming <integer>
576 Specify the maximum incoming LDAP PDU size for anonymous sessions.
577 The default is 262143.
579 .B sockbuf_max_incoming_auth <integer>
580 Specify the maximum incoming LDAP PDU size for authenticated sessions.
581 The default is 4194303.
584 Specify the srvtab file in which the kerberos keys necessary for
585 authenticating clients using kerberos can be found. This option is only
586 meaningful if you are using Kerberos authentication.
589 Specify the maximum size of the primary thread pool.
592 .B timelimit <integer>
594 .B timelimit time[.{soft|hard}]=<integer> [...]
595 Specify the maximum number of seconds (in real time)
597 will spend answering a search request. The default time limit is 3600.
598 The second format allows a fine grain setting of the time limits.
599 Extra args can be added on the same line.
602 for an explanation of the different flags.
606 is built with support for Transport Layer Security, there are more options
609 .B TLSCipherSuite <cipher-suite-spec>
610 Permits configuring what ciphers will be accepted and the preference order.
611 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
613 TLSCipherSuite HIGH:MEDIUM:+SSLv2
615 To check what ciphers a given spec selects, use:
617 openssl ciphers -v <cipher-suite-spec>
619 .B TLSCACertificateFile <filename>
620 Specifies the file that contains certificates for all of the Certificate
625 .B TLSCertificateFile <filename>
626 Specifies the file that contains the
630 .B TLSCertificateKeyFile <filename>
631 Specifies the file that contains the
633 server private key that matches the certificate stored in the
634 .B TLSCertificateFile
635 file. Currently, the private key must not be protected with a password, so
636 it is of critical importance that it is protected carefully.
638 .B TLSRandFile <filename>
639 Specifies the file to obtain random bits from when /dev/[u]random
640 is not available. Generally set to the name of the EGD/PRNGD socket.
641 The environment variable RANDFILE can also be used to specify the filename.
643 .B TLSVerifyClient <level>
644 Specifies what checks to perform on client certificates in an
645 incoming TLS session, if any.
648 can be specified as one of the following keywords:
654 will not ask the client for a certificate.
657 The client certificate is requested. If no certificate is provided,
658 the session proceeds normally. If a bad certificate is provided,
659 it will be ignored and the session proceeds normally.
662 The client certificate is requested. If no certificate is provided,
663 the session proceeds normally. If a bad certificate is provided,
664 the session is immediately terminated.
666 .B demand | hard | true
667 These keywords are all equivalent, for compatibility reasons.
668 The client certificate is requested. If no certificate is provided,
669 or a bad certificate is provided, the session is immediately terminated.
671 Note that a valid client certificate is required in order to use the
672 SASL EXTERNAL authentication mechanism with a TLS session. As such,
675 setting must be chosen to enable SASL EXTERNAL authentication.
677 .SH GENERAL BACKEND OPTIONS
678 Options in this section only apply to the configuration file section
679 for the specified backend. They are supported by every
682 .B backend <databasetype>
683 Mark the beginning of a backend definition. <databasetype>
689 depending on which backend will serve the database.
691 .SH GENERAL DATABASE OPTIONS
692 Options in this section only apply to the configuration file section
693 for the database in which they are defined. They are supported by every
696 .B database <databasetype>
697 Mark the beginning of a new database instance definition. <databasetype>
704 depending on which backend will serve the database.
709 will automatically maintain the
710 modifiersName, modifyTimestamp, creatorsName, and
711 createTimestamp attributes for entries. By default, lastmod is on.
714 This option puts the database into "read-only" mode. Any attempts to
715 modify the database will return an "unwilling to perform" error. By
716 default, readonly is off.
718 .B replica host=<hostname>[:port] [tls=yes|critical]
719 .B [suffix=<suffix> [...]]
720 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
721 .B [saslmech=<SASL mech>] [secopts=<options>] [realm=<realm>]
722 .B [authcId=<authentication ID>] [authcId=<authentication ID>]
723 .B [attr[!]=<attr list>]
725 Specify a replication site for this database. Refer to the "OpenLDAP
726 Administrator's Guide" for detailed information on setting up a replicated
728 directory service. Zero or more
730 instances can be used to select the subtrees that will be replicated
731 (defaults to all the database). A
739 and should only be used when adequate security services
740 (e.g TLS or IPSEC) are in place. A
748 will use Kerberos, a kerberos instance should be given in
752 can be given after the
754 keyword to allow the selective replication of the listed attributes only;
757 mark is used, the list is considered exclusive, i.e. the listed attributes
759 If an objectClass is listed, all the related attributes
760 are (are not) replicated.
763 .B replogfile <filename>
764 Specify the name of the replication log file to log changes to.
765 The replication log is typically written by
771 for more information. The specified file should be located
772 in a directory with limited read/write/execute access as the replication
773 logs may contain sensitive information.
776 Specify the distinguished name that is not subject to access control
777 or administrative limit restrictions for operations on this database.
778 This DN may or may not be associated with an entry. An empty root
779 DN (the default) specifies no root access is to be granted. It is
780 recommended that the rootdn only be specified when needed (such as
781 when initially populating a database). If the rootdn is within
782 a namingContext (suffix) of the database, a simple bind password
783 may also be provided using the
788 Specify a password (or hash of the password) for the rootdn. If
789 the rootdn is not within the namingContext of the database, the
790 provided password is ignored.
791 This option accepts all RFC 2307 userPassword formats known to
794 desription) as well as cleartext.
796 may be used to generate a hash of a password. Cleartext
797 and \fB{CRYPT}\fP passwords are not recommended. If empty
798 (the default), authentication of the root DN is by other means
799 (e.g. SASL). Use of SASL is encouraged.
801 .B suffix <dn suffix>
802 Specify the DN suffix of queries that will be passed to this
803 backend database. Multiple suffix lines can be given and at least one is
804 required for each database definition.
807 Specify that the current backend database is a subordinate of another
808 backend database. A subordinate database may have only one suffix. This
809 option may bse used to glue multiple databases into a single namingContext.
810 If the suffix of the current database is within the namingContext of a
811 superior database, searches against the superior database will be
812 propagated to the subordinate as well. All of the databases
813 associated with a single namingContext should have identical rootdns.
814 Behavior of other LDAP operations is unaffected by this setting. In
815 particular, it is not possible to use moddn to move an entry from
816 one subordinate to another subordinate within the namingContext.
819 This option is only applicable in a slave
821 It specifies the DN allowed to make changes to the replica (typically,
824 binds as when making changes to the replica).
827 Specify the referral to pass back when
829 is asked to modify a replicated local database.
830 If specified multiple times, each url is provided.
831 .\" .SH LDBM BACKEND-SPECIFIC OPTIONS
832 .\" Options in this category only apply to the LDBM backend. That is,
833 .\" they must follow "backend ldbm" line and come before any subsequent
834 .\" "backend" or "database" lines. The LDBM backend is a high-performance
835 .\" database that makes extensive use of indexing and caching to speed
837 .SH BDB DATABASE-SPECIFIC OPTIONS
838 Options in this category only apply to the BDB databases. That is,
839 they must follow "database bdb" line and come before any subsequent
840 "backend" or "database" lines.
841 .SH LDBM DATABASE-SPECIFIC OPTIONS
842 Options in this category only apply to the LDBM databases. That is,
843 they must follow "database ldbm" line and come before any subsequent
844 "backend" or "database" lines.
846 .B cachesize <integer>
847 Specify the size in entries of the in-memory cache maintained
848 by the LDBM backend database instance. The default is 1000 entries.
850 .B dbcachesize <integer>
851 Specify the size in bytes of the in-memory cache associated
852 with each open index file. If not supported by the underlying database
853 method, this option is ignored without comment. The default is 100000 bytes.
856 Specify that no database locking should be performed.
857 Enabling this option may improve performance at the expense of data security.
858 Do NOT run any slap tools while slapd is running.
861 Specify that on-disk database contents should not be immediately
862 synchronized with in memory changes. Enabling this option may improve
863 performance at the expense of data security.
865 .B dbsync <frequency> <maxdelays> <delayinterval>
866 Flush dirty database buffers to disk every
870 (ie. indvidual updates are no longer written to disk). It attempts to avoid
871 syncs during periods of peak activity by waiting
873 seconds if the server is busy, repeating this delay up to
875 times before proceeding.
876 It is an attempt to provide higher write performance with some amount of data
877 security. Note that it may still be possible to get an inconsistent
878 database if the underlying engine fills its cache and writes out individual
879 pages and slapd crashes or is killed before the next sync.
883 are optional and default to
887 respectively, giving a total elapsed delay of 60 seconds before a sync
892 must be 1 or greater.
894 .B directory <directory>
895 Specify the directory where the LDBM files containing this database and
896 associated indexes live. A separate directory must be specified for
897 each database. The default is
898 .BR LOCALSTATEDIR/openldap-data .
901 index {<attrlist>|default} [pres,eq,approx,sub,<special>]
902 Specify the indexes to maintain for the given attribute (or
903 list of attributes). Some attributes only support a subset
904 of indexes. If only an <attr> is given, the indices specified
905 for \fBdefault\fR are maintained. Note that setting a default
906 does not imply that all attributes will be indexed.
908 A number of special index parameters may be
912 can be decomposed into
919 may be specified to disallow use of this index by language subtypes.
922 may be specified to disallow use of this index by named subtypes.
923 Note: changing index settings requires rebuilding indices, see
927 Specify the file protection mode that newly created database
928 index files should have. The default is 0600.
929 .SH SHELL DATABASE-SPECIFIC OPTIONS
930 Options in this category only apply to the SHELL backend database. That is,
931 they must follow a "database shell" line and come before any subsequent
932 "backend" or "database" lines. The Shell backend executes external programs to
933 implement operations, and is designed to make it easy to tie an existing
944 .B compare <pathname>
954 .B abandon <pathname>
955 These options specify the pathname of the command to execute in response
956 to the given LDAP operation.
958 Note that you need only supply configuration lines for those commands you
959 want the backend to handle. Operations for which a command is not
960 supplied will be refused with an "unwilling to perform" error.
961 .SH PASSWORD DATABASE-SPECIFIC OPTIONS
962 Options in this category only apply to the PASSWD backend database.
963 That is, they must follow a "database passwd" line and come before any
964 subsequent "backend" or "database" lines. The PASSWD database serves up the user
965 account information listed in the system
970 Specifies an alternate passwd file to use. The default is
973 "OpenLDAP Administrator's Guide" contains an annotated
974 example of a configuration file.
979 .BR slapd.replog (5),
980 .BR slapd.access (5),
987 .BR slappassword (8),
990 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
993 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
995 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob