1 .TH SLAPD.CONF 5 "28 April 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, and General Database
60 Options. Backend-specific options are discussed in the
62 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
63 details on the slapd configuration file.
64 .SH GLOBAL CONFIGURATION OPTIONS
65 Options described in this section apply to all backends, unless specifically
66 overridden in a backend definition. Arguments that should be replaced by
67 actual text are shown in brackets <>.
69 .B access to <what> [ by <who> <access> <control> ]+
70 Grant access (specified by <access>) to a set of entries and/or
71 attributes (specified by <what>) by one or more requestors (specified
73 See the "OpenLDAP's Administrator's Guide" for details.
76 Specify a set of features (separated by white space) to
79 allows acceptance of LDAPv2 bind requests.
81 allows anonymous bind when credentials are not empty (e.g.
84 allows unauthenticated (anonymous) bind when DN is not empty.
86 .B argsfile <filename>
87 The ( absolute ) name of a file that will hold the
89 server's command line options
90 if started without the debugging command line option.
93 .B attributetype (\ <oid> [NAME\ <name>] [OBSOLETE]\
94 [DESC\ <description>]\
95 [SUP\ <oid>] [EQUALITY\ <oid>] [ORDERING\ <oid>]\
96 [SUBSTR\ <oid>] [SYNTAX\ <oidlen>] [SINGLE\-VALUE] [COLLECTIVE]\
97 [NO\-USER\-MODIFICATION] [USAGE\ <attributeUsage>]\ )
99 Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
100 The slapd parser extends the RFC 2252 definition by allowing string
101 forms as well as numeric OIDs to be used for the attribute OID and
102 attribute syntax OID.
105 description.) Currently the syntax name parser is case-sensitive.
106 The known syntax names are:
110 AttributeTypeDescription Audio Binary BitString Certificate CertificateList
111 CertificatePair DN DeliveryMethod DirectoryString DITContentRuleDescription
112 DITStructureRuleDescription EnhancedGuide FacsimileTelephoneNumber
113 GeneralizedTime Guide IA5String Integer MatchingRuleDescription
114 MatchingRuleUseDescription MailPreference NameAndOptionalUUID
115 NameFormDescription NumericString ObjectClassDescription OID
116 OtherMailbox OctetString PostalAddress ProtocolInformation
117 PresentationAddress PrintableString SupportedAlgorithm TelephoneNumber
118 TeletexTerminalIdentifier TelexNumber UTCTime LDAPSyntaxDescription
119 SubstringAssertion NISnetgrouptriple Bootparameter
125 .B concurrency <integer>
126 Specify a desired level of concurrency. Provided to the underlying
127 thread system as a hint. The default is not to provide any hint.
129 .\".B debug <subsys> <level>
130 .\"Specify a logging level for a particular subsystem. The subsystems include
132 .\"a global level for all subsystems,
136 .\"the backend databases,
138 .\"the entry cache manager,
140 .\"the config file reader,
142 .\"the connection manager,
144 .\"the Cyrus SASL library interface,
146 .\"the search filter processor,
148 .\"the DN normalization library,
150 .\"the database indexer,
152 .\"the ASN.1 BER library,
154 .\"the dynamic module loader,
156 .\"the LDAP operation processors,
158 .\"the SASL authentication subsystem,
160 .\"the schema processor, and
162 .\"the TLS library interface. This is not an exhaustive list; there are many
163 .\"other subsystems and more are added over time.
165 .\"The levels are, in order of decreasing priority:
166 .\".B emergency, alert, critical, error, warning, notice, information, entry,
167 .\".B args, results, detail1, detail2
168 .\"An integer may be used instead, with 0 corresponding to
174 .\"level logs function entry points,
176 .\"adds function call parameters, and
178 .\"adds the function results to the logs.
183 .\"levels add even more low level detail from individual functions.
185 .B defaultsearchbase <dn>
186 Specify a default search base to use when client submits a
187 non-base search request with an empty base DN.
189 .B disallow <features>
190 Specify a set of features (separated by white space) to
191 disallow (default none).
193 disables acceptance of anonymous bind requests.
195 disables simple (bind) authentication.
197 disables Kerberos V4 (bind) authentication.
199 disables Start TLS from forcing session to anonymous status (see also
202 disables StartTLS if authenticated (see also
205 .B idletimeout <integer>
206 Specify the number of seconds to wait before forcibly closing
207 an idle client connection. A idletimeout of 0 disables this
208 feature. The default is 0.
210 .B include <filename>
211 Read additional configuration information from the given file before
212 continuing with the next line of the current file.
214 .B limits <who> <limit> [<limit> [...]]
215 Specify time and size limits based on who initiated an operation.
222 anonymous | users | [dn[.<style>]=]<pattern>
228 <style> ::= exact | base | one | subtree | children | regex | anonymous
232 is hit when a search is performed without prior binding;
234 is hit when a search is performed by a successfully bound user;
237 dn pattern is assumed unless otherwise specified by qualifying
238 the (optional) key string
244 (which are synonims), to require an exact match; with
246 to require exactly one level of depth match; with
248 to allow any level of depth match, including the exact match; with
250 to allow any level of depth match, not including the exact match;
252 explicitly requires the (default) match based on regular expression
253 pattern, as detailed in
257 matches unbound operations; the
260 The same behavior is obtained by using the
266 The currently supported limits are
271 The syntax for time limits is
272 .BR time[.{soft|hard}]=<integer> ,
275 is the number of seconds slapd will spend answering a search request.
276 If no time limit is explicitly requested by the client, the
278 limit is used; if the requested time limit exceedes the
280 limit, an "Unwilling to perform" is returned.
283 limit is set to 0 or to the keyword "soft", the soft limit is used
284 in either case; if it is set to -1 or to the keyword "none",
285 no hard limit is enforced.
286 Explicit requests for time limits smaller or equal to the
289 If no flag is set, the value is assigned to the
293 limit is set to zero, to preserve the original behavior.
295 The syntax for size limits is
296 .BR size[.{soft|hard|unchecked}]=<integer> ,
299 is the maximum number of entries slapd will return answering a search
301 If no size limit is explicitly requested by the client, the
303 limit is used; if the requested size limit exceedes the
305 limit, an "Unwilling to perform" is returned.
308 limit is set to 0 or to the keyword "soft", the soft limit is used
309 in either case; if it is set to -1 or to the keyword "none",
310 no hard limit is enforced.
311 Explicit requests for size limits smaller or equal to the
316 flag sets a limit on the number of candidates a search request is allowed
318 If the selected candidates exceed the
320 limit, the search will abort with "Unwilling to perform".
321 If it is set to -1 or to the keyword "none", no limit is applied (the default).
322 If no flag is set, the value is assigned to the
326 limit is set to zero, to preserve the original behavior.
328 In case of no match, the global limits are used.
329 The default values are the same of
337 .\".B logfile <filename>
338 .\"Specify a file for recording debug log messages. By default these messages
339 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
340 .\"copies messages to both stderr and the logfile.
342 .B loglevel <integer>
343 Specify the level at which debugging statements and operation
344 statistics should be syslogged (currently logged to the
346 LOG_LOCAL4 facility). Log levels are additive, and available levels
356 debug packet handling
359 heavy trace debugging
362 connection management
365 print out packets sent and received
368 search filter processing
371 configuration file processing
374 access control list processing
377 stats log connections/operations/results
380 stats log entries sent
383 print communication with shell backends
391 .B moduleload <filename>
392 Specify the name of a dynamically loadable module to load. The filename
393 may be an absolute path name or a simple filename. Non-absolute names
394 are searched for in the directories specified by the
396 option. This option and the
398 option are only usable if slapd was compiled with --enable-modules.
400 .B modulepath <pathspec>
401 Specify a list of directories to search for loadable modules. Typically
402 the path is colon-separated but this depends on the operating system.
404 .B objectclass ( <oid> [NAME <name>] [DESC <description] [OBSOLETE]\
405 [SUP <oids>] [{ ABSTRACT | STRUCTURAL | AUXILIARY }] [MUST <oids>]\
408 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
409 The slapd parser extends the RFC 2252 definition by allowing string
410 forms as well as numeric OIDs to be used for the object class OID.
414 description.) Object classes are "STRUCTURAL" by default.
417 .B objectidentifier <name> { <oid> | <name>[:<suffix>] }
418 Define a string name that equates to the given OID. The string can be used
419 in place of the numeric OID in objectclass and attribute definitions. The
420 name can also be used with a suffix of the form ":xx" in which case the
421 value "oid.xx" will be used.
423 .B password-hash <hash>
424 This option sets the hash to be used in generation of user
425 passwords, stored in userPassword, during processing of
426 LDAP Password Modify Extended Operations (RFC 3052).
427 The <hash> must be one of
437 Note that this option does not alter the normal user applications
438 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
440 .B password\-crypt\-salt\-format <format>
441 Specify the format of the salt passed to
443 when generating {CRYPT} passwords (see
445 during processing of LDAP Password Modify Extended Operations (RFC 3062).
447 This string needs to be in
449 format and may include one (and only one) %s conversion.
450 This conversion will be substituted with a string random
451 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
452 provides a two character salt and "$1$%.8s" tells some
453 versions of crypt(3) to use an MD5 algorithm and provides
454 8 random characters of salt. The default is "%s", which
455 provides 31 characters of salt.
457 .B pidfile <filename>
458 The ( absolute ) name of a file that will hold the
460 server's process ID ( see
462 ) if started without the debugging command line option.
465 Specify the referral to pass back when
467 cannot find a local database to handle a request.
468 If specified multiple times, each url is provided.
470 .B require <conditions>
471 Specify a set of conditions (separated by white space) to
472 require (default none).
473 The directive may be specified globally and/or per-database.
475 requires bind operation prior to directory operations.
477 requires session to be using LDAP version 3.
479 requires authentication prior to directory operations.
481 requires SASL authentication prior to directory operations.
483 requires strong authentication prior to directory operations.
488 conditions are currently same.
490 may be used to require no conditions (useful for clearly globally
491 set conditions within a particular database).
493 .B reverse-lookup on | off
494 Enable/disable client name reverse lookup (default is
496 if compiled with --enable-rlookups).
499 Specify the name of an LDIF(5) file containing user defined attributes
500 for the root DSE. These attributes are returned in addition to the
501 attributes normally produced by slapd.
504 Used to specify the fully qualified domain name used for SASL processing.
506 .B sasl-realm <realm>
507 Specify SASL realm. Default is empty.
509 .B sasl-regexp <match> <replace>
510 Used by the SASL authorization mechanism to convert a SASL authenticated
511 username to an LDAP DN. When an authorization request is received, the SASL
515 are taken, when available, and combined into a SASL name of the
520 .B uid=<username>[,cn=<realm>],cn=<mechanism>,cn=auth
523 This SASL name is then compared against the
525 regular expression, and if the match is successful, the SASL name is
528 string. If there are wildcard strings in the
530 regular expression that are enclosed in parenthesis, e.g.
538 then the portion of the SASL name that matched the wildcard will be stored
539 in the numbered placeholder variable $1. If there are other wildcard strings
540 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
541 placeholders can then be used in the
547 .B cn=$1,ou=Accounts,dc=$2,dc=$4.
551 The replaced SASL name can be either a DN or an LDAP URI. If the latter, the slapd
552 server will use the URI to search its own database, and if the search returns
553 exactly one entry, the SASL name is replaced by the DN of that entry.
556 options can be given in the configuration file to allow for multiple matching
557 and replacement patterns. The matching patterns are checked in the order they
558 appear in the file, stopping at the first successful match.
561 .\"Because the plus sign + is a character recognized by the regular expression engine,
562 .\"and it will appear in SASL names that include a REALM, be careful to escape the
563 .\"plus sign with a backslash \\+ to remove the character's special meaning.
566 .B sasl-secprops <properties>
567 Used to specify Cyrus SASL security properties.
570 flag (without any other properities) causes the flag properites
571 default, "noanonymous,noplain", to be cleared.
574 flag disables mechanisms susceptible to simple passive attacks.
577 flag disables mechanisms susceptible to active attacks.
580 flag disables mechanisms susceptible to passive dictionary attacks.
583 flag disables mechanisms which support anonymous login.
586 flag require forward secrecy between sessions.
589 require mechanisms which pass client credentials (and allow
590 mechanisms which can pass credentials to do so).
593 property specifies the minimum acceptable
594 .I security strength factor
595 as an integer approximate to effective key length used for
596 encryption. 0 (zero) implies no protection, 1 implies integrity
597 protection only, 56 allows DES or other weak ciphers, 112
598 allows triple DES and other strong ciphers, 128 allows RC4,
599 Blowfish and other modern strong ciphers. The default is 0.
602 property specifies the maximum acceptable
603 .I security strength factor
604 as an integer (see minssf description). The default is INT_MAX.
607 property specifies the maximum security layer receive buffer
608 size allowed. 0 disables security layers. The default is 65536.
610 .B security <factors>
611 Specify a set of factors (separated by white space) to require.
612 An integer value is associated with each factor and is roughly
613 equivalent of the encryption key length to require. A value
614 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
615 The directive may be specified globally and/or per-database.
617 specifies the overall security strength factor.
619 specifies the transport security strength factor.
621 specifies the TLS security strength factor.
623 specifies the SASL security strength factor.
625 specifies the overall security strength factor to require for
627 .B update_transport=<n>
628 specifies the transport security strength factor to require for
631 specifies the TLS security strength factor to require for
634 specifies the SASL security strength factor to require for
638 factor is measure of security provided by the underlying transport,
639 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
641 .B sizelimit <integer>
643 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
644 Specify the maximum number of entries to return from a search operation.
645 The default size limit is 500.
646 The second format allows a fine grain setting of the size limits.
647 Extra args can be added on the same line.
650 for an explanation of the different flags.
652 .B sockbuf_max_incoming <integer>
653 Specify the maximum incoming LDAP PDU size for anonymous sessions.
654 The default is 262143.
656 .B sockbuf_max_incoming_auth <integer>
657 Specify the maximum incoming LDAP PDU size for authenticated sessions.
658 The default is 4194303.
661 Specify the srvtab file in which the kerberos keys necessary for
662 authenticating clients using kerberos can be found. This option is only
663 meaningful if you are using Kerberos authentication.
666 Specify the maximum size of the primary thread pool.
669 .B timelimit <integer>
671 .B timelimit time[.{soft|hard}]=<integer> [...]
672 Specify the maximum number of seconds (in real time)
674 will spend answering a search request. The default time limit is 3600.
675 The second format allows a fine grain setting of the time limits.
676 Extra args can be added on the same line.
679 for an explanation of the different flags.
681 .B ucdata-path <path>
682 Specify the path to the directory containing the Unicode character
683 tables. The default path is LOCALSTATEDIR/ucdata.
687 is built with support for Transport Layer Security, there are more options
690 .B TLSCipherSuite <cipher-suite-spec>
691 Permits configuring what ciphers will be accepted and the preference order.
692 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
694 TLSCipherSuite HIGH:MEDIUM:+SSLv2
696 To check what ciphers a given spec selects, use:
698 openssl ciphers -v <cipher-suite-spec>
700 .B TLSCACertificateFile <filename>
701 Specifies the file that contains certificates for all of the Certificate
706 .B TLSCACertificatePath <path>
707 Specifies the path of a directory that contains Certificate Authority
708 certificates in separate individual files. Usually only one of this
709 or the TLSCACertificateFile is used.
711 .B TLSCertificateFile <filename>
712 Specifies the file that contains the
716 .B TLSCertificateKeyFile <filename>
717 Specifies the file that contains the
719 server private key that matches the certificate stored in the
720 .B TLSCertificateFile
721 file. Currently, the private key must not be protected with a password, so
722 it is of critical importance that it is protected carefully.
724 .B TLSRandFile <filename>
725 Specifies the file to obtain random bits from when /dev/[u]random
726 is not available. Generally set to the name of the EGD/PRNGD socket.
727 The environment variable RANDFILE can also be used to specify the filename.
729 .B TLSVerifyClient <level>
730 Specifies what checks to perform on client certificates in an
731 incoming TLS session, if any.
734 can be specified as one of the following keywords:
740 will not ask the client for a certificate.
743 The client certificate is requested. If no certificate is provided,
744 the session proceeds normally. If a bad certificate is provided,
745 it will be ignored and the session proceeds normally.
748 The client certificate is requested. If no certificate is provided,
749 the session proceeds normally. If a bad certificate is provided,
750 the session is immediately terminated.
752 .B demand | hard | true
753 These keywords are all equivalent, for compatibility reasons.
754 The client certificate is requested. If no certificate is provided,
755 or a bad certificate is provided, the session is immediately terminated.
757 Note that a valid client certificate is required in order to use the
758 SASL EXTERNAL authentication mechanism with a TLS session. As such,
761 setting must be chosen to enable SASL EXTERNAL authentication.
763 .SH GENERAL BACKEND OPTIONS
764 Options in this section only apply to the configuration file section
765 for the specified backend. They are supported by every
768 .B backend <databasetype>
769 Mark the beginning of a backend definition. <databasetype>
784 depending on which backend will serve the database.
786 .SH GENERAL DATABASE OPTIONS
787 Options in this section only apply to the configuration file section
788 for the database in which they are defined. They are supported by every
789 type of backend. Note that the
793 option are mandatory for each database.
795 .B database <databasetype>
796 Mark the beginning of a new database instance definition. <databasetype>
811 depending on which backend will serve the database.
816 will automatically maintain the
817 modifiersName, modifyTimestamp, creatorsName, and
818 createTimestamp attributes for entries. By default, lastmod is on.
820 .B maxderefdepth <depth>
821 Specifies the maximum number of aliases to dereference when trying to
822 resolve an entry, used to avoid inifinite alias loops. The default is 1.
825 This option puts the database into "read-only" mode. Any attempts to
826 modify the database will return an "unwilling to perform" error. By
827 default, readonly is off.
829 .B replica host=<hostname>[:port] [tls=yes|critical]
830 .B [suffix=<suffix> [...]]
831 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
832 .B [saslmech=<SASL mech>] [secopts=<options>] [realm=<realm>]
833 .B [authcId=<authentication ID>] [authcId=<authentication ID>]
834 .B [attr[!]=<attr list>]
836 Specify a replication site for this database. Refer to the "OpenLDAP
837 Administrator's Guide" for detailed information on setting up a replicated
839 directory service. Zero or more
841 instances can be used to select the subtrees that will be replicated
842 (defaults to all the database). A
850 and should only be used when adequate security services
851 (e.g TLS or IPSEC) are in place. A
859 will use Kerberos, a kerberos instance should be given in
863 can be given after the
865 keyword to allow the selective replication of the listed attributes only;
868 mark is used, the list is considered exclusive, i.e. the listed attributes
870 If an objectClass is listed, all the related attributes
871 are (are not) replicated.
874 .B replogfile <filename>
875 Specify the name of the replication log file to log changes to.
876 The replication log is typically written by
882 for more information. The specified file should be located
883 in a directory with limited read/write/execute access as the replication
884 logs may contain sensitive information.
887 Specify the distinguished name that is not subject to access control
888 or administrative limit restrictions for operations on this database.
889 This DN may or may not be associated with an entry. An empty root
890 DN (the default) specifies no root access is to be granted. It is
891 recommended that the rootdn only be specified when needed (such as
892 when initially populating a database). If the rootdn is within
893 a namingContext (suffix) of the database, a simple bind password
894 may also be provided using the
899 Specify a password (or hash of the password) for the rootdn. If
900 the rootdn is not within the namingContext of the database, the
901 provided password is ignored.
902 This option accepts all RFC 2307 userPassword formats known to
905 desription) as well as cleartext.
907 may be used to generate a hash of a password. Cleartext
908 and \fB{CRYPT}\fP passwords are not recommended. If empty
909 (the default), authentication of the root DN is by other means
910 (e.g. SASL). Use of SASL is encouraged.
912 .B suffix <dn suffix>
913 Specify the DN suffix of queries that will be passed to this
914 backend database. Multiple suffix lines can be given and at least one is
915 required for each database definition.
917 .B suffixalias <alias> <aliased suffix>
918 Specify an alternate suffix that may be used to reference an already defined
919 database suffix. Operations specifying DNs residing under the alias
920 will execute as if they had specified the aliased suffix.
923 Specify that the current backend database is a subordinate of another
924 backend database. A subordinate database may have only one suffix. This
925 option may be used to glue multiple databases into a single namingContext.
926 If the suffix of the current database is within the namingContext of a
927 superior database, searches against the superior database will be
928 propagated to the subordinate as well. All of the databases
929 associated with a single namingContext should have identical rootdns.
930 Behavior of other LDAP operations is unaffected by this setting. In
931 particular, it is not possible to use moddn to move an entry from
932 one subordinate to another subordinate within the namingContext.
935 This option is only applicable in a slave
937 It specifies the DN allowed to make changes to the replica (typically,
940 binds as when making changes to the replica).
943 Specify the referral to pass back when
945 is asked to modify a replicated local database.
946 If specified multiple times, each url is provided.
947 .SH DATABASE-SPECIFIC OPTIONS
948 Each database may allow specific configuration options; they will be
949 documented separately in the
950 .B slapd-<backend>(5)
951 manual pakges since most of these databases are very specific
954 "OpenLDAP Administrator's Guide" contains an annotated
955 example of a configuration file.
964 .BR slapd-passwd (5),
969 .BR slapd.replog (5),
970 .BR slapd.access (5),
976 .BR slappassword (8),
979 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
982 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
984 is derived from University of Michigan LDAP 3.3 Release.