1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2006 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
28 file consists of a series of global configuration options that apply to
30 as a whole (including all backends), followed by zero or more database
31 backend definitions that contain information specific to a backend
33 The configuration options are case-insensitive;
34 their value, on a case by case basis, may be case-sensitive.
41 # comment - these options apply to every database
42 <global configuration options>
43 # first database definition & configuration options
44 database <backend 1 type>
45 <configuration options specific to backend 1>
46 # subsequent database definitions & configuration options
50 As many backend-specific sections as desired may be included. Global
51 options can be overridden in a backend (for options that appear more
52 than once, the last appearance in the
56 If a line begins with white space, it is considered a continuation
57 of the previous line. No physical line should be over 2000 bytes
60 Blank lines and comment lines beginning with
61 a `#' character are ignored. Note: continuation lines are unwrapped
62 before comment processing is applied.
64 Arguments on configuration lines are separated by white space. If an
65 argument contains white space, the argument should be enclosed in
66 double quotes. If an argument contains a double quote (`"') or a
67 backslash character (`\\'), the character should be preceded by a
70 The specific configuration options available are discussed below in the
71 Global Configuration Options, General Backend Options, and General Database
72 Options. Backend-specific options are discussed in the
74 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
75 details on the slapd configuration file.
76 .SH GLOBAL CONFIGURATION OPTIONS
77 Options described in this section apply to all backends, unless specifically
78 overridden in a backend definition. Arguments that should be replaced by
79 actual text are shown in brackets <>.
81 .B access to <what> "[ by <who> <access> <control> ]+"
82 Grant access (specified by <access>) to a set of entries and/or
83 attributes (specified by <what>) by one or more requestors (specified
85 If no access controls are present, the default policy
86 allows anyone and everyone to read anything but restricts
87 updates to rootdn. (e.g., "access to * by * read").
88 The rootdn can always read and write EVERYTHING!
91 and the "OpenLDAP's Administrator's Guide" for details.
94 Specify a set of features (separated by white space) to
97 allows acceptance of LDAPv2 bind requests. Note that
99 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
101 allows anonymous bind when credentials are not empty (e.g.
104 allows unauthenticated (anonymous) bind when DN is not empty.
106 allows unauthenticated (anonymous) update operations to be processed
107 (subject to access controls and other administrative limits).
109 allows unauthenticated (anonymous) proxy authorization control to be processed
110 (subject to access controls, authorization and other administrative limits).
112 .B argsfile <filename>
113 The ( absolute ) name of a file that will hold the
115 server's command line options
116 if started without the debugging command line option.
118 .B attributeoptions [option-name]...
119 Define tagging attribute options or option tag/range prefixes.
120 Options must not end with `-', prefixes must end with `-'.
121 The `lang-' prefix is predefined.
124 directive, `lang-' will no longer be defined and you must specify it
125 explicitly if you want it defined.
127 An attribute description with a tagging option is a subtype of that
128 attribute description without the option.
129 Except for that, options defined this way have no special semantics.
130 Prefixes defined this way work like the `lang-' options:
131 They define a prefix for tagging options starting with the prefix.
132 That is, if you define the prefix `x-foo-', you can use the option
134 Furthermore, in a search or compare, a prefix or range name (with
135 a trailing `-') matches all options starting with that name, as well
136 as the option with the range name sans the trailing `-'.
137 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
139 RFC 4520 reserves options beginning with `x-' for private experiments.
140 Other options should be registered with IANA, see RFC 4520 section 3.5.
141 OpenLDAP also has the `binary' option built in, but this is a transfer
142 option, not a tagging option.
145 .B attributetype "(\ <oid>\
147 [DESC\ <description>]\
156 [NO\-USER\-MODIFICATION]\
157 [USAGE\ <attributeUsage>]\ )"
159 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
160 The slapd parser extends the RFC 4512 definition by allowing string
161 forms as well as numeric OIDs to be used for the attribute OID and
162 attribute syntax OID.
168 .B authz-policy <policy>
169 Used to specify which rules to use for Proxy Authorization. Proxy
170 authorization allows a client to authenticate to the server using one
171 user's credentials, but specify a different identity to use for authorization
172 and access control purposes. It essentially allows user A to login as user
173 B, using user A's password.
176 flag disables proxy authorization. This is the default setting.
179 flag will use rules in the
181 attribute of the authorization DN.
184 flag will use rules in the
186 attribute of the authentication DN.
189 flag, an alias for the deprecated value of
191 will allow any of the above, whatever succeeds first (checked in
197 flag requires both authorizations to succeed.
200 The rules are mechanisms to specify which identities are allowed
201 to perform proxy authorization.
204 attribute in an entry specifies which other users
205 are allowed to proxy login to this entry. The
208 an entry specifies which other users this user can authorize as. Use of
211 abused if users are allowed to write arbitrary values to this attribute.
214 attribute must be protected with ACLs such that
215 only privileged users can modify it.
222 or a set of identities; it can take five forms:
225 .B ldap:///<base>??[<scope>]?<filter>
228 .B dn[.<dnstyle>]:<pattern>
231 .B u[<mech>[<realm>]]:<pattern>
234 .B group[/objectClass[/attributeType]]:<pattern>
241 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
244 The first form is a valid LDAP
252 portions must be absent, so that the search occurs locally on either
258 with the optional style modifiers
264 for exact, onelevel, children and subtree matches, which cause
266 to be normalized according to the DN normalization rules, or the special
268 style, which causes the
270 to be treated as a POSIX (''extended'') regular expression, as
277 means any non-anonymous DN.
278 The third form is a SASL
280 with the optional fields
284 that allow to specify a SASL
286 and eventually a SASL
288 for those mechanisms that support one.
289 The need to allow the specification of a mechanism is still debated,
290 and users are strongly discouraged to rely on this possibility.
291 The fourth form is a group specification, consisting of the keyword
293 optionally followed by the specification of the group
299 is searched with base scope, and in case of match, the values of the
302 are searched for the asserted DN.
303 For backwards compatibility, if no identity type is provided, i.e. only
307 is assumed; as a consequence,
309 is subjected to DN normalization.
310 Since the interpretation of
314 can impact security, users are strongly encouraged
315 to explicitly set the type of identity specification that is being used.
316 A subset of these rules can be used as third arg in the
318 statement (see below); significantly, the
325 .B authz-regexp <match> <replace>
326 Used by the authentication framework to convert simple user names,
327 such as provided by SASL subsystem, to an LDAP DN used for
328 authorization purposes. Note that the resultant DN need not refer
329 to an existing entry to be considered valid. When an authorization
330 request is received from the SASL subsystem, the SASL
335 are taken, when available, and combined into a name of the form
339 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
342 This name is then compared against the
344 POSIX (''extended'') regular expression, and if the match is successful,
345 the name is replaced with the
347 string. If there are wildcard strings in the
349 regular expression that are enclosed in parenthesis, e.g.
355 then the portion of the name that matched the wildcard will be stored
356 in the numbered placeholder variable $1. If there are other wildcard strings
357 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
358 placeholders can then be used in the
363 .B UID=$1,OU=Accounts,DC=example,DC=com
366 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
368 If the latter, the server will use the URI to search its own database(s)
369 and, if the search returns exactly one entry, the name is
370 replaced by the DN of that entry. The LDAP URI must have no
371 hostport, attrs, or extensions components, but the filter is mandatory,
375 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
378 The protocol portion of the URI must be strictly
380 Note that this search is subject to access controls. Specifically,
381 the authentication identity must have "auth" access in the subject.
385 options can be given in the configuration file to allow for multiple matching
386 and replacement patterns. The matching patterns are checked in the order they
387 appear in the file, stopping at the first successful match.
390 .\"Because the plus sign + is a character recognized by the regular expression engine,
391 .\"and it will appear in names that include a REALM, be careful to escape the
392 .\"plus sign with a backslash \\+ to remove the character's special meaning.
395 .B concurrency <integer>
396 Specify a desired level of concurrency. Provided to the underlying
397 thread system as a hint. The default is not to provide any hint.
399 .B conn_max_pending <integer>
400 Specify the maximum number of pending requests for an anonymous session.
401 If requests are submitted faster than the server can process them, they
402 will be queued up to this limit. If the limit is exceeded, the session
403 is closed. The default is 100.
405 .B conn_max_pending_auth <integer>
406 Specify the maximum number of pending requests for an authenticated session.
409 .B defaultsearchbase <dn>
410 Specify a default search base to use when client submits a
411 non-base search request with an empty base DN.
412 Base scoped search requests with an empty base DN are not affected.
414 .B disallow <features>
415 Specify a set of features (separated by white space) to
416 disallow (default none).
418 disables acceptance of anonymous bind requests. Note that this setting
419 does not prohibit anonymous directory access (See "require authc").
421 disables simple (bind) authentication.
423 disables forcing session to anonymous status (see also
425 upon StartTLS operation receipt.
427 disallows the StartTLS operation if authenticated (see also
431 .B ditcontentrule "(\ <oid>\
433 [DESC\ <description>]\
440 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
441 The slapd parser extends the RFC 4512 definition by allowing string
442 forms as well as numeric OIDs to be used for the attribute OID and
443 attribute syntax OID.
449 .B gentlehup { on | off }
450 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
452 will stop listening for new connections, but will not close the
453 connections to the current clients. Future write operations return
454 unwilling-to-perform, though. Slapd terminates when all clients
455 have closed their connections (if they ever do), or \- as before \-
456 if it receives a SIGTERM signal. This can be useful if you wish to
457 terminate the server and start a new
460 .B with another database,
461 without disrupting the currently active clients.
462 The default is off. You may wish to use
464 along with this option.
466 .B idletimeout <integer>
467 Specify the number of seconds to wait before forcibly closing
468 an idle client connection. A idletimeout of 0 disables this
469 feature. The default is 0.
471 .B include <filename>
472 Read additional configuration information from the given file before
473 continuing with the next line of the current file.
475 .B index_substr_if_minlen <integer>
476 Specify the minimum length for subinitial and subfinal indices. An
477 attribute value must have at least this many characters in order to be
478 processed by the indexing functions. The default is 2.
480 .B index_substr_if_maxlen <integer>
481 Specify the maximum length for subinitial and subfinal indices. Only
482 this many characters of an attribute value will be processed by the
483 indexing functions; any excess characters are ignored. The default is 4.
485 .B index_substr_any_len <integer>
486 Specify the length used for subany indices. An attribute value must have
487 at least this many characters in order to be processed. Attribute values
488 longer than this length will be processed in segments of this length. The
489 default is 4. The subany index will also be used in subinitial and
490 subfinal index lookups when the filter string is longer than the
491 .I index_substr_if_maxlen
494 .B index_substr_any_step <integer>
495 Specify the steps used in subany index lookups. This value sets the offset
496 for the segments of a filter string that are processed for a subany index
497 lookup. The default is 2. For example, with the default values, a search
498 using this filter "cn=*abcdefgh*" would generate index lookups for
499 "abcd", "cdef", and "efgh".
501 .\"-- NEW_LOGGING option --
503 .\".B logfile <filename>
504 .\"Specify a file for recording debug log messages. By default these messages
505 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
506 .\"copies messages to both stderr and the logfile.
509 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
510 such as those to the ldapi:// listener. For a description of SSF values,
514 option description. The default is 71.
516 .B loglevel <integer> [...]
517 Specify the level at which debugging statements and operation
518 statistics should be syslogged (currently logged to the
520 LOG_LOCAL4 facility).
521 They must be considered subsystems rather than increasingly verbose
523 Some messages with higher priority are logged regardless
524 of the configured loglevel as soon as some logging is configured,
525 otherwise anything is logged at all.
526 Log levels are additive, and available levels are:
537 debug packet handling
541 heavy trace debugging (function args)
545 connection management
549 print out packets sent and received
553 search filter processing
557 configuration file processing
561 access control list processing
565 stats log connections/operations/results
569 stats log entries sent
573 print communication with shell backends
585 \"data indexing (unused)
593 only messages that get logged whatever log level is set
596 The desired log level can be input as a single integer that combines
597 the (ORed) desired levels, both in decimal or in hexadecimal notation,
598 as a list of integers (that are ORed internally),
599 or as a list of the names that are shown between brackets, such that
612 can be used as a shortcut to enable logging at all levels (equivalent to -1).
615 or the equivalent integer representation, causes those messages
616 that are logged regardless of the configured loglevel to be logged.
617 In fact, if no loglevel (or a 0 level) is defined, no logging occurs,
620 level is required to have high priority messages logged.
623 .B moduleload <filename>
624 Specify the name of a dynamically loadable module to load. The filename
625 may be an absolute path name or a simple filename. Non-absolute names
626 are searched for in the directories specified by the
628 option. This option and the
630 option are only usable if slapd was compiled with --enable-modules.
632 .B modulepath <pathspec>
633 Specify a list of directories to search for loadable modules. Typically
634 the path is colon-separated but this depends on the operating system.
637 .B objectclass "(\ <oid>\
639 [DESC\ <description>]\
642 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
643 [MUST\ <oids>] [MAY\ <oids>] )"
645 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
646 The slapd parser extends the RFC 4512 definition by allowing string
647 forms as well as numeric OIDs to be used for the object class OID.
651 description.) Object classes are "STRUCTURAL" by default.
654 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
655 Define a string name that equates to the given OID. The string can be used
656 in place of the numeric OID in objectclass and attribute definitions. The
657 name can also be used with a suffix of the form ":xx" in which case the
658 value "oid.xx" will be used.
660 .B password-hash <hash> [<hash>...]
661 This option configures one or more hashes to be used in generation of user
662 passwords stored in the userPassword attribute during processing of
663 LDAP Password Modify Extended Operations (RFC 3062).
664 The <hash> must be one of
678 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
683 use the MD5 algorithm (RFC 1321), the latter with a seed.
690 indicates that the new password should be
691 added to userPassword as clear text.
693 Note that this option does not alter the normal user applications
694 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
696 .B password\-crypt\-salt\-format <format>
697 Specify the format of the salt passed to
699 when generating {CRYPT} passwords (see
701 during processing of LDAP Password Modify Extended Operations (RFC 3062).
703 This string needs to be in
705 format and may include one (and only one) %s conversion.
706 This conversion will be substituted with a string of random
707 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
708 provides a two character salt and "$1$%.8s" tells some
709 versions of crypt(3) to use an MD5 algorithm and provides
710 8 random characters of salt. The default is "%s", which
711 provides 31 characters of salt.
713 .B pidfile <filename>
714 The ( absolute ) name of a file that will hold the
716 server's process ID ( see
718 ) if started without the debugging command line option.
721 Specify the referral to pass back when
723 cannot find a local database to handle a request.
724 If specified multiple times, each url is provided.
727 The ( absolute ) name of a file that will hold the
729 server's command line options
730 if started without the debugging command line option.
731 If it appears after a
733 directive, the args file is specific to the
735 instance that handles that replication log.
738 The ( absolute ) name of a file that will hold the
740 server's process ID ( see
742 ) if started without the debugging command line option.
743 If it appears after a
745 directive, the pid file is specific to the
747 instance that handles that replication log.
749 .B replicationinterval
750 The number of seconds
752 waits before checking the replogfile for changes.
753 If it appears after a
755 directive, the replication interval is specific to the
757 instance that handles that replication log.
759 .B require <conditions>
760 Specify a set of conditions (separated by white space) to
761 require (default none).
762 The directive may be specified globally and/or per-database;
763 databases inherit global conditions, so per-database specifications
766 requires bind operation prior to directory operations.
768 requires session to be using LDAP version 3.
770 requires authentication prior to directory operations.
772 requires SASL authentication prior to directory operations.
774 requires strong authentication prior to directory operations.
775 The strong keyword allows protected "simple" authentication
776 as well as SASL authentication.
778 may be used to require no conditions (useful to clear out globally
779 set conditions within a particular database); it must occur first
780 in the list of conditions.
782 .B reverse-lookup on | off
783 Enable/disable client name unverified reverse lookup (default is
785 if compiled with --enable-rlookups).
788 Specify the name of an LDIF(5) file containing user defined attributes
789 for the root DSE. These attributes are returned in addition to the
790 attributes normally produced by slapd.
793 Used to specify the fully qualified domain name used for SASL processing.
795 .B sasl-realm <realm>
796 Specify SASL realm. Default is empty.
798 .B sasl-secprops <properties>
799 Used to specify Cyrus SASL security properties.
802 flag (without any other properties) causes the flag properties
803 default, "noanonymous,noplain", to be cleared.
806 flag disables mechanisms susceptible to simple passive attacks.
809 flag disables mechanisms susceptible to active attacks.
812 flag disables mechanisms susceptible to passive dictionary attacks.
815 flag disables mechanisms which support anonymous login.
818 flag require forward secrecy between sessions.
821 require mechanisms which pass client credentials (and allow
822 mechanisms which can pass credentials to do so).
825 property specifies the minimum acceptable
826 .I security strength factor
827 as an integer approximate to effective key length used for
828 encryption. 0 (zero) implies no protection, 1 implies integrity
829 protection only, 56 allows DES or other weak ciphers, 112
830 allows triple DES and other strong ciphers, 128 allows RC4,
831 Blowfish and other modern strong ciphers. The default is 0.
834 property specifies the maximum acceptable
835 .I security strength factor
836 as an integer (see minssf description). The default is INT_MAX.
839 property specifies the maximum security layer receive buffer
840 size allowed. 0 disables security layers. The default is 65536.
843 Specify the distinguished name for the subschema subentry that
844 controls the entries on this server. The default is "cn=Subschema".
846 .B security <factors>
847 Specify a set of security strength factors (separated by white space)
851 option for a description of security strength factors).
852 The directive may be specified globally and/or per-database.
854 specifies the overall security strength factor.
856 specifies the transport security strength factor.
858 specifies the TLS security strength factor.
860 specifies the SASL security strength factor.
862 specifies the overall security strength factor to require for
864 .B update_transport=<n>
865 specifies the transport security strength factor to require for
868 specifies the TLS security strength factor to require for
871 specifies the SASL security strength factor to require for
874 specifies the security strength factor required for
876 username/password authentication.
879 factor is measure of security provided by the underlying transport,
880 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
882 .B sizelimit {<integer>|unlimited}
884 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
885 Specify the maximum number of entries to return from a search operation.
886 The default size limit is 500.
889 to specify no limits.
890 The second format allows a fine grain setting of the size limits.
891 Extra args can be added on the same line.
894 for an explanation of the different flags.
896 .B sockbuf_max_incoming <integer>
897 Specify the maximum incoming LDAP PDU size for anonymous sessions.
898 The default is 262143.
900 .B sockbuf_max_incoming_auth <integer>
901 Specify the maximum incoming LDAP PDU size for authenticated sessions.
902 The default is 4194303.
905 Specify the maximum size of the primary thread pool.
906 The default is 16; the minimum value is 2.
908 .B timelimit {<integer>|unlimited}
910 .B timelimit time[.{soft|hard}]=<integer> [...]
911 Specify the maximum number of seconds (in real time)
913 will spend answering a search request. The default time limit is 3600.
916 to specify no limits.
917 The second format allows a fine grain setting of the time limits.
918 Extra args can be added on the same line.
921 for an explanation of the different flags.
923 .B tool-threads <integer>
924 Specify the maximum number of threads to use in tool mode.
925 This should not be greater than the number of CPUs in the system.
927 .\"ucdata-path is obsolete / ignored...
929 .\".B ucdata-path <path>
930 .\"Specify the path to the directory containing the Unicode character
931 .\"tables. The default path is DATADIR/ucdata.
935 is built with support for Transport Layer Security, there are more options
938 .B TLSCipherSuite <cipher-suite-spec>
939 Permits configuring what ciphers will be accepted and the preference order.
940 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
942 TLSCipherSuite HIGH:MEDIUM:+SSLv2
944 To check what ciphers a given spec selects, use:
946 openssl ciphers -v <cipher-suite-spec>
948 .B TLSCACertificateFile <filename>
949 Specifies the file that contains certificates for all of the Certificate
954 .B TLSCACertificatePath <path>
955 Specifies the path of a directory that contains Certificate Authority
956 certificates in separate individual files. Usually only one of this
957 or the TLSCACertificateFile is used.
959 .B TLSCertificateFile <filename>
960 Specifies the file that contains the
964 .B TLSCertificateKeyFile <filename>
965 Specifies the file that contains the
967 server private key that matches the certificate stored in the
968 .B TLSCertificateFile
969 file. Currently, the private key must not be protected with a password, so
970 it is of critical importance that it is protected carefully.
972 .B TLSDHParamFile <filename>
973 This directive specifies the file that contains parameters for Diffie-Hellman
974 ephemeral key exchange. This is required in order to use a DSA certificate on
975 the server. If multiple sets of parameters are present in the file, all of
976 them will be processed. Note that setting this option may also enable
977 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
978 You should append "!ADH" to your cipher suites if you have changed them
979 from the default, otherwise no certificate exchanges or verification will
982 .B TLSRandFile <filename>
983 Specifies the file to obtain random bits from when /dev/[u]random
984 is not available. Generally set to the name of the EGD/PRNGD socket.
985 The environment variable RANDFILE can also be used to specify the filename.
987 .B TLSVerifyClient <level>
988 Specifies what checks to perform on client certificates in an
989 incoming TLS session, if any.
992 can be specified as one of the following keywords:
998 will not ask the client for a certificate.
1001 The client certificate is requested. If no certificate is provided,
1002 the session proceeds normally. If a bad certificate is provided,
1003 it will be ignored and the session proceeds normally.
1006 The client certificate is requested. If no certificate is provided,
1007 the session proceeds normally. If a bad certificate is provided,
1008 the session is immediately terminated.
1010 .B demand | hard | true
1011 These keywords are all equivalent, for compatibility reasons.
1012 The client certificate is requested. If no certificate is provided,
1013 or a bad certificate is provided, the session is immediately terminated.
1015 Note that a valid client certificate is required in order to use the
1016 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1019 setting must be chosen to enable SASL EXTERNAL authentication.
1022 .B TLSCRLCheck <level>
1023 Specifies if the Certificate Revocation List (CRL) of the CA should be
1024 used to verify if the client certificates have not been revoked. This
1026 .B TLSCACertificatePath
1027 parameter to be set.
1029 can be specified as one of the following keywords:
1033 No CRL checks are performed
1036 Check the CRL of the peer certificate
1039 Check the CRL for a whole certificate chain
1041 .SH GENERAL BACKEND OPTIONS
1042 Options in this section only apply to the configuration file section
1043 for the specified backend. They are supported by every
1046 .B backend <databasetype>
1047 Mark the beginning of a backend definition. <databasetype>
1065 depending on which backend will serve the database.
1067 .SH GENERAL DATABASE OPTIONS
1068 Options in this section only apply to the configuration file section
1069 for the database in which they are defined. They are supported by every
1070 type of backend. Note that the
1074 option are mandatory for each database.
1076 .B database <databasetype>
1077 Mark the beginning of a new database instance definition. <databasetype>
1095 depending on which backend will serve the database.
1100 will automatically maintain the
1101 modifiersName, modifyTimestamp, creatorsName, and
1102 createTimestamp attributes for entries. It also controls
1103 the entryCSN and entryUUID attributes, which are needed
1104 by the syncrepl provider. By default, lastmod is on.
1106 .B limits <who> <limit> [<limit> [...]]
1107 Specify time and size limits based on who initiated an operation.
1114 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1120 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1125 matches all unauthenticated clients.
1128 matches all authenticated clients;
1131 dn pattern is assumed unless otherwise specified by qualifying
1132 the (optional) key string
1138 (which are synonyms), to require an exact match; with
1140 to require exactly one level of depth match; with
1142 to allow any level of depth match, including the exact match; with
1144 to allow any level of depth match, not including the exact match;
1146 explicitly requires the (default) match based on POSIX (''extended'')
1147 regular expression pattern.
1150 matches unbound operations; the
1153 The same behavior is obtained by using the
1160 with the optional objectClass
1166 sets the limits for any DN listed in the values of the
1172 group objectClass (default
1174 whose DN exactly matches
1177 The currently supported limits are
1182 The syntax for time limits is
1183 .BR time[.{soft|hard}]=<integer> ,
1186 is the number of seconds slapd will spend answering a search request.
1187 If no time limit is explicitly requested by the client, the
1189 limit is used; if the requested time limit exceeds the
1192 .\".I "Administrative limit exceeded"
1193 .\"error is returned.
1194 limit, the value of the limit is used instead.
1197 limit is set to the keyword
1199 the soft limit is used in either case; if it is set to the keyword
1201 no hard limit is enforced.
1202 Explicit requests for time limits smaller or equal to the
1205 If no limit specifier is set, the value is assigned to the
1211 to preserve the original behavior.
1213 The syntax for size limits is
1214 .BR size[.{soft|hard|unchecked}]=<integer> ,
1217 is the maximum number of entries slapd will return answering a search
1219 If no size limit is explicitly requested by the client, the
1221 limit is used; if the requested size limit exceeds the
1224 .\".I "Administrative limit exceeded"
1225 .\"error is returned.
1226 limit, the value of the limit is used instead.
1229 limit is set to the keyword
1231 the soft limit is used in either case; if it is set to the keyword
1233 no hard limit is enforced.
1234 Explicit requests for size limits smaller or equal to the
1239 specifier sets a limit on the number of candidates a search request is allowed
1241 The rationale behind it is that searches for non-properly indexed
1242 attributes may result in large sets of candidates, which must be
1245 to determine whether they match the search filter or not.
1248 limit provides a means to drop such operations before they are even
1250 If the selected candidates exceed the
1252 limit, the search will abort with
1253 .IR "Unwilling to perform" .
1254 If it is set to the keyword
1256 no limit is applied (the default).
1259 the search is not even performed; this can be used to disallow searches
1260 for a specific set of users.
1261 If no limit specifier is set, the value is assigned to the
1267 to preserve the original behavior.
1269 In case of no match, the global limits are used.
1270 The default values are the same of
1279 control is requested, the
1281 size limit is used by default, because the request of a specific page size
1282 is considered an explicit request for a limitation on the number
1283 of entries to be returned.
1284 However, the size limit applies to the total count of entries returned within
1285 the search, and not to a single page.
1286 Additional size limits may be enforced; the syntax is
1287 .BR size.pr={<integer>|noEstimate|unlimited} ,
1290 is the max page size if no explicit limit is set; the keyword
1292 inhibits the server from returning an estimate of the total number
1293 of entries that might be returned
1294 (note: the current implementation does not return any estimate).
1297 indicates that no limit is applied to the pagedResults control page size.
1299 .B size.prtotal={<integer>|unlimited|disabled}
1300 allows to set a limit on the total number of entries that a pagedResults
1301 control allows to return.
1302 By default it is set to the
1307 is the max number of entries that the whole search with pagedResults control
1311 to allow unlimited number of entries to be returned, e.g. to allow
1312 the use of the pagedResults control as a means to circumvent size
1313 limitations on regular searches; the keyword
1315 disables the control, i.e. no paged results can be returned.
1316 Note that the total number of entries returned when the pagedResults control
1317 is requested cannot exceed the
1319 size limit of regular searches unless extended by the
1324 .B maxderefdepth <depth>
1325 Specifies the maximum number of aliases to dereference when trying to
1326 resolve an entry, used to avoid infinite alias loops. The default is 1.
1328 .B mirrormode on | off
1329 This option puts a replica database into "mirror" mode. Update
1330 operations will be accepted from any user, not just the updatedn. The
1331 database must already be configured as a slurpd or syncrepl consumer
1332 before this keyword may be set. This mode must be used with extreme
1333 care, as it does not offer any consistency guarantees. This feature
1334 is intended to be used with an external frontend that guarantees that
1335 writes are only directed to a single master, switching to an alternate
1336 server only if the original master goes down.
1337 By default, mirrormode is off.
1339 .B overlay <overlay-name>
1340 Add the specified overlay to this database. An overlay is a piece of
1341 code that intercepts database operations in order to extend or change
1342 them. Overlays are pushed onto
1343 a stack over the database, and so they will execute in the reverse
1344 of the order in which they were configured and the database itself
1345 will receive control last of all.
1347 .B readonly on | off
1348 This option puts the database into "read-only" mode. Any attempts to
1349 modify the database will return an "unwilling to perform" error. By
1350 default, readonly is off.
1353 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1354 .B [starttls=yes|critical]
1355 .B [suffix=<suffix> [...]]
1356 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1357 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1358 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1359 .B [attrs[!]=<attr list>]
1361 Specify a replication site for this database. Refer to the "OpenLDAP
1362 Administrator's Guide" for detailed information on setting up a replicated
1364 directory service. Zero or more
1366 instances can be used to select the subtrees that will be replicated
1367 (defaults to all the database).
1369 is deprecated in favor of the
1373 allows the replica LDAP server to be specified as an LDAP URI.
1378 requires the options
1382 and should only be used when adequate security services
1383 (e.g TLS or IPSEC) are in place. A
1389 Specific security properties (as with the
1391 keyword above) for a SASL bind can be set with the
1393 option. A non-default SASL realm can be set with the
1398 will use Kerberos, a kerberos instance should be given in
1402 can be given after the
1404 keyword to allow the selective replication of the listed attributes only;
1407 mark is used, the list is considered exclusive, i.e. the listed attributes
1409 If an objectClass is listed, all the related attributes
1410 are (are not) replicated.
1413 .B replogfile <filename>
1414 Specify the name of the replication log file to log changes to.
1415 The replication log is typically written by
1420 .BR slapd.replog (5)
1421 for more information. The specified file should be located
1422 in a directory with limited read/write/execute access as the replication
1423 logs may contain sensitive information.
1425 .B restrict <oplist>
1426 Specify a whitespace separated list of operations that are restricted.
1427 If defined inside a database specification, restrictions apply only
1428 to that database, otherwise they are global.
1429 Operations can be any of
1434 .BR extended[=<OID>] ,
1438 or the special pseudo-operations
1442 which respectively summarize read and write operations.
1450 keyword allows to indicate the OID of the specific operation
1454 Specify the distinguished name that is not subject to access control
1455 or administrative limit restrictions for operations on this database.
1456 This DN may or may not be associated with an entry. An empty root
1457 DN (the default) specifies no root access is to be granted. It is
1458 recommended that the rootdn only be specified when needed (such as
1459 when initially populating a database). If the rootdn is within
1460 a namingContext (suffix) of the database, a simple bind password
1461 may also be provided using the
1463 directive. Note that the rootdn is always needed when using syncrepl.
1465 .B rootpw <password>
1466 Specify a password (or hash of the password) for the rootdn. The
1467 password can only be set if the rootdn is within the namingContext
1468 (suffix) of the database.
1469 This option accepts all RFC 2307 userPassword formats known to
1472 description) as well as cleartext.
1474 may be used to generate a hash of a password. Cleartext
1475 and \fB{CRYPT}\fP passwords are not recommended. If empty
1476 (the default), authentication of the root DN is by other means
1477 (e.g. SASL). Use of SASL is encouraged.
1479 .B suffix <dn suffix>
1480 Specify the DN suffix of queries that will be passed to this
1481 backend database. Multiple suffix lines can be given and at least one is
1482 required for each database definition.
1483 If the suffix of one database is "inside" that of another, the database
1484 with the inner suffix must come first in the configuration file.
1486 .B subordinate [advertise]
1487 Specify that the current backend database is a subordinate of another
1488 backend database. A subordinate database may have only one suffix. This
1489 option may be used to glue multiple databases into a single namingContext.
1490 If the suffix of the current database is within the namingContext of a
1491 superior database, searches against the superior database will be
1492 propagated to the subordinate as well. All of the databases
1493 associated with a single namingContext should have identical rootdns.
1494 Behavior of other LDAP operations is unaffected by this setting. In
1495 particular, it is not possible to use moddn to move an entry from
1496 one subordinate to another subordinate within the namingContext.
1498 If the optional \fBadvertise\fP flag is supplied, the naming context of
1499 this database is advertised in the root DSE. The default is to hide this
1500 database context, so that only the superior context is visible.
1507 are used on the superior database, any glued subordinates that support
1508 these tools are opened as well.
1510 Databases that are glued together should usually be configured with the
1511 same indices (assuming they support indexing), even for attributes that
1512 only exist in some of these databases. In general, all of the glued
1513 databases should be configured as similarly as possible, since the intent
1514 is to provide the appearance of a single directory.
1516 Note that the \fIsubordinate\fP functionality is implemented internally
1517 by the \fIglue\fP overlay and as such its behavior will interact with other
1518 overlays in use. By default, the glue overlay is automatically configured as
1519 the last overlay on the superior backend. Its position on the backend
1520 can be explicitly configured by setting an \fBoverlay glue\fP directive
1521 at the desired position. This explicit configuration is necessary e.g.
1522 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1523 in order to work over all of the glued databases. E.g.
1527 suffix dc=example,dc=com
1535 .B syncrepl rid=<replica ID>
1536 .B provider=ldap[s]://<hostname>[:port]
1537 .B searchbase=<base DN>
1538 .B [type=refreshOnly|refreshAndPersist]
1539 .B [interval=dd:hh:mm:ss]
1540 .B [retry=[<retry interval> <# of retries>]+]
1541 .B [filter=<filter str>]
1542 .B [scope=sub|one|base|subord]
1543 .B [attrs=<attr list>]
1545 .B [sizelimit=<limit>]
1546 .B [timelimit=<limit>]
1547 .B [schemachecking=on|off]
1548 .B [bindmethod=simple|sasl]
1550 .B [saslmech=<mech>]
1551 .B [authcid=<identity>]
1552 .B [authzid=<identity>]
1553 .B [credentials=<passwd>]
1555 .B [secprops=<properties>]
1556 .B [starttls=yes|critical]
1557 .B [tls_cert=<file>]
1559 .B [tls_cacert=<file>]
1560 .B [tls_cacertdir=<path>]
1561 .B [tls_reqcert=never|allow|try|demand]
1562 .B [tls_ciphersuite=<ciphers>]
1563 .B [tls_crlcheck=none|peer|all]
1564 .B [logbase=<base DN>]
1565 .B [logfilter=<filter str>]
1566 .B [syncdata=default|accesslog|changelog]
1568 Specify the current database as a replica which is kept up-to-date with the
1569 master content by establishing the current
1571 as a replication consumer site running a
1574 The replica content is kept synchronized to the master content using
1575 the LDAP Content Synchronization protocol. Refer to the
1576 "OpenLDAP Administrator's Guide" for detailed information on
1577 setting up a replicated
1579 directory service using the
1584 identifies the current
1586 directive within the replication consumer site.
1587 It is a non-negative integer having no more than three digits.
1590 specifies the replication provider site containing the master content
1591 as an LDAP URI. If <port> is not given, the standard LDAP port number
1592 (389 or 636) is used.
1596 replica is defined using a search
1597 specification as its result set. The consumer
1599 will send search requests to the provider
1601 according to the search specification. The search specification includes
1602 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1605 parameters as in the normal search specification.
1606 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1607 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1608 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1609 attributes, and \fBattrsonly\fP is unset by default.
1610 The \fBsizelimit\fP and \fBtimelimit\fP only
1611 accept "unlimited" and positive integers, and both default to "unlimited".
1612 Note, however, that any provider-side limits for the replication identity
1613 will be enforced by the provider regardless of the limits requested
1614 by the LDAP Content Synchronization operation, much like for any other
1617 The LDAP Content Synchronization protocol has two operation types.
1620 operation, the next synchronization search operation
1621 is periodically rescheduled at an interval time (specified by
1623 parameter; 1 day by default)
1624 after each synchronization operation finishes.
1626 .B refreshAndPersist
1627 operation, a synchronization search remains persistent in the provider slapd.
1628 Further updates to the master replica will generate
1629 .B searchResultEntry
1630 to the consumer slapd as the search responses to the persistent
1631 synchronization search.
1633 If an error occurs during replication, the consumer will attempt to
1634 reconnect according to the
1636 parameter which is a list of the <retry interval> and <# of retries> pairs.
1637 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1638 for the first 10 times and then retry every 300 seconds for the next 3
1639 times before stop retrying. The `+' in <# of retries> means indefinite
1640 number of retries until success.
1642 The schema checking can be enforced at the LDAP Sync
1643 consumer site by turning on the
1645 parameter. The default is off.
1651 requires the options
1655 and should only be used when adequate security services
1656 (e.g. TLS or IPSEC) are in place.
1663 Depending on the mechanism, an authentication identity and/or
1664 credentials can be specified using
1670 parameter may be used to specify an authorization identity.
1671 Specific security properties (as with the
1673 keyword above) for a SASL bind can be set with the
1675 option. A non default SASL realm can be set with the
1678 The provider, other than allow authentication of the syncrepl identity,
1679 should grant that identity appropriate access privileges to the data
1680 that is being replicated (\fBaccess\fP directive), and appropriate time
1681 and size limits (\fBlimits\fP directive).
1686 parameter specifies use of the StartTLS extended operation
1687 to establish a TLS session before Binding to the provider. If the
1689 argument is supplied, the session will be aborted if the StartTLS request
1690 fails. Otherwise the syncrepl session continues without TLS. Note that the
1691 main slapd TLS settings are not used by the syncrepl engine;
1692 by default the TLS parameters from ETCDIR/ldap.conf will be used.
1693 TLS settings may be specified here, in which case the ldap.conf settings
1694 will be completely ignored.
1696 Rather than replicating whole entries, the consumer can query logs of
1697 data modifications. This mode of operation is referred to as \fIdelta
1698 syncrepl\fP. In addition to the above parameters, the
1702 parameters must be set appropriately for the log that will be used. The
1704 parameter must be set to either "accesslog" if the log conforms to the
1705 .BR slapo-accesslog (5)
1706 log format, or "changelog" if the log conforms
1707 to the obsolete \fIchangelog\fP format. If the
1709 parameter is omitted or set to "default" then the log parameters are
1714 This option is only applicable in a slave
1715 database updated using
1717 It specifies the DN permitted to update (subject to access controls)
1718 the replica (typically, this is the DN
1720 binds to update the replica). Generally, this DN
1727 Specify the referral to pass back when
1729 is asked to modify a replicated local database.
1730 If specified multiple times, each url is provided.
1732 .SH DATABASE-SPECIFIC OPTIONS
1733 Each database may allow specific configuration options; they are
1734 documented separately in the backends' manual pages.
1736 The following backends can be compiled into slapd.
1737 They are documented in the
1738 .BR slapd-<backend> (5)
1742 This is the recommended primary backend for a normal slapd database.
1743 It takes care to configure it properly.
1744 It uses the transactional database interface of the Sleepycat Berkeley
1745 DB (BDB) package to store data.
1748 This backend is used to manage the configuration of slapd run-time.
1751 This backend is experimental.
1752 It serves up referrals based upon SRV resource records held in the
1756 This is a variant of the BDB backend that uses a hierarchical database
1757 layout which supports subtree renames.
1760 This backend acts as a proxy to forward incoming requests to another
1764 This is an easy-to-configure but obsolete database backend. It
1765 does not offer the data durability features of the BDB and HDB
1766 backends and hence is deprecated in favor of these robust backends.
1767 LDBM uses lightweight non-transactional DB interfaces,
1768 such as those providing by GDBM or Berkeley DB, to store data.
1771 This database uses the filesystem to build the tree structure
1772 of the database, using plain ascii files to store data.
1773 Its usage should be limited to very simple databases, where performance
1774 is not a requirement.
1777 This backend performs basic LDAP proxying with respect to a set of
1778 remote LDAP servers. It is an enhancement of the ldap backend.
1781 This backend provides information about the running status of the slapd
1785 Operations in this backend succeed but do nothing.
1788 This backend is provided for demonstration purposes only.
1789 It serves up user account information from the system
1794 This backend embeds a
1796 interpreter into slapd.
1797 It runs Perl subroutines to implement LDAP operations.
1800 This backend is experimental.
1801 It redirects LDAP operations to another database
1802 in the same server, based on the naming context of the request.
1803 Its use requires the
1807 for details) to rewrite the naming context of the request.
1808 It is primarily intended to implement virtual views on databases
1809 that actually store data.
1812 This backend executes external programs to implement LDAP operations.
1813 It is primarily intended to be used in prototypes.
1816 This backend is experimental.
1817 It services LDAP requests from an SQL database.
1819 The following overlays can be compiled into slapd.
1820 They are documented in the
1821 .BR slapo-<overlay> (5)
1826 This overlay can record accesses to a given backend database on another
1831 This overlay records changes on a given backend database to an LDIF log
1833 By default it is not built.
1837 This overlay allows automatic referral chasing when a referral would
1838 have been returned, either when configured by the server or when
1839 requested by the client.
1843 This overlay allows selected operations to be denied, similar to the
1844 \fBrestrict\fP option.
1848 This is a demo overlay which extends the Compare operation to detect
1849 members of a dynamic group.
1850 It has no effect on any other operations.
1854 This overlay allows expansion of dynamic groups and more.
1858 This overlay maintains a service entry in the database with the DN,
1859 modification type, modifiersName and modifyTimestamp of the last write
1860 operation performed on that database.
1864 This overlay allows caching of LDAP search requests in a local database.
1865 It is most often used with the ldap or meta backends.
1869 This overlay provides a variety of password control mechanisms,
1870 e.g. password aging, password reuse and duplication control, mandatory
1871 password resets, etc.
1874 Referential Integrity.
1875 This overlay can be used with a backend database such as
1877 to maintain the cohesiveness of a schema which utilizes reference
1882 This overlay is useful to test the behavior of clients when
1883 server-generated erroneous and/or unusual responses occur.
1887 This overlay is experimental.
1888 It performs basic DN/data rewrite and
1889 objectClass/attributeType mapping.
1893 This overlay implements the provider-side support for
1895 replication, including persistent search functionality.
1899 This overlay can be used with a backend database such as
1901 to create a "translucent proxy".
1902 Content of entries retrieved from a remote LDAP server can be partially
1903 overridden by the database.
1906 Attribute Uniqueness.
1907 This overlay can be used with a backend database such as
1909 to enforce the uniqueness of some or all attributes within a subtree.
1912 Here is a short example of a configuration file:
1916 include SYSCONFDIR/schema/core.schema
1917 pidfile LOCALSTATEDIR/slapd.pid
1919 # Subtypes of "name" (e.g. "cn" and "ou") with the
1920 # option ";x-hidden" can be searched for/compared,
1921 # but are not shown. See \fBslapd.access\fP(5).
1922 attributeoptions x-hidden lang-
1923 access to attrs=name;x-hidden by * =cs
1925 # Protect passwords. See \fBslapd.access\fP(5).
1926 access to attrs=userPassword by * auth
1927 # Read access to other attributes and entries.
1928 access to * by * read
1931 suffix "dc=our-domain,dc=com"
1932 # The database directory MUST exist prior to
1933 # running slapd AND should only be accessible
1934 # by the slapd/tools. Mode 0700 recommended.
1935 directory LOCALSTATEDIR/openldap-data
1936 # Indices to maintain
1937 index objectClass eq
1938 index cn,sn,mail pres,eq,approx,sub
1940 # We serve small clients that do not handle referrals,
1941 # so handle remote lookups on their behalf.
1944 uri ldap://ldap.some-server.com/
1949 "OpenLDAP Administrator's Guide" contains a longer annotated
1950 example of a configuration file.
1951 The original ETCDIR/slapd.conf is another example.
1955 default slapd configuration file
1959 .BR slapd\-dnssrv (5),
1961 .BR slapd\-ldap (5),
1962 .BR slapd\-ldbm (5),
1963 .BR slapd\-ldif (5),
1964 .BR slapd\-meta (5),
1965 .BR slapd\-monitor (5),
1966 .BR slapd\-null (5),
1967 .BR slapd\-passwd (5),
1968 .BR slapd\-perl (5),
1969 .BR slapd\-relay (5),
1970 .BR slapd\-shell (5),
1972 .BR slapd.access (5),
1973 .BR slapd.plugin (5),
1974 .BR slapd.replog (5),
1986 Known overlays are documented in
1987 .BR slapo\-accesslog (5),
1988 .BR slapo\-auditlog (5),
1989 .BR slapo\-chain (5),
1990 .BR slapo\-dynlist (5),
1991 .BR slapo\-lastmod (5),
1992 .BR slapo\-pcache (5),
1993 .BR slapo\-ppolicy (5),
1994 .BR slapo\-refint (5),
1995 .BR slapo\-retcode (5),
1997 .BR slapo\-syncprov (5),
1998 .BR slapo\-translucent (5),
1999 .BR slapo\-unique (5).
2001 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
2002 .SH ACKNOWLEDGEMENTS
2004 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
2006 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob