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. Blank lines and comment lines beginning with
58 a `#' character are ignored. Note: continuation lines are unwrapped
59 before comment processing is applied.
61 Arguments on configuration lines are separated by white space. If an
62 argument contains white space, the argument should be enclosed in
63 double quotes. If an argument contains a double quote (`"') or a
64 backslash character (`\\'), the character should be preceded by a
67 The specific configuration options available are discussed below in the
68 Global Configuration Options, General Backend Options, and General Database
69 Options. Backend-specific options are discussed in the
71 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
72 details on the slapd configuration file.
73 .SH GLOBAL CONFIGURATION OPTIONS
74 Options described in this section apply to all backends, unless specifically
75 overridden in a backend definition. Arguments that should be replaced by
76 actual text are shown in brackets <>.
78 .B access to <what> "[ by <who> <access> <control> ]+"
79 Grant access (specified by <access>) to a set of entries and/or
80 attributes (specified by <what>) by one or more requestors (specified
82 If no access controls are present, the default policy
83 allows anyone and everyone to read anything but restricts
84 updates to rootdn. (e.g., "access to * by * read").
85 The rootdn can always read and write EVERYTHING!
88 and the "OpenLDAP's Administrator's Guide" for details.
91 Specify a set of features (separated by white space) to
94 allows acceptance of LDAPv2 bind requests. Note that
96 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
98 allows anonymous bind when credentials are not empty (e.g.
101 allows unauthenticated (anonymous) bind when DN is not empty.
103 allows unauthenticated (anonymous) update operations to be processed
104 (subject to access controls and other administrative limits).
106 allows unauthenticated (anonymous) proxy authorization control to be processed
107 (subject to access controls, authorization and other administrative limits).
109 .B argsfile <filename>
110 The ( absolute ) name of a file that will hold the
112 server's command line options
113 if started without the debugging command line option.
115 .B attributeoptions [option-name]...
116 Define tagging attribute options or option tag/range prefixes.
117 Options must not end with `-', prefixes must end with `-'.
118 The `lang-' prefix is predefined.
121 directive, `lang-' will no longer be defined and you must specify it
122 explicitly if you want it defined.
124 An attribute description with a tagging option is a subtype of that
125 attribute description without the option.
126 Except for that, options defined this way have no special semantics.
127 Prefixes defined this way work like the `lang-' options:
128 They define a prefix for tagging options starting with the prefix.
129 That is, if you define the prefix `x-foo-', you can use the option
131 Furthermore, in a search or compare, a prefix or range name (with
132 a trailing `-') matches all options starting with that name, as well
133 as the option with the range name sans the trailing `-'.
134 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
136 RFC 4520 reserves options beginning with `x-' for private experiments.
137 Other options should be registered with IANA, see RFC 4520 section 3.5.
138 OpenLDAP also has the `binary' option built in, but this is a transfer
139 option, not a tagging option.
142 .B attributetype "(\ <oid>\
144 [DESC\ <description>]\
153 [NO\-USER\-MODIFICATION]\
154 [USAGE\ <attributeUsage>]\ )"
156 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
157 The slapd parser extends the RFC 4512 definition by allowing string
158 forms as well as numeric OIDs to be used for the attribute OID and
159 attribute syntax OID.
165 .B authz-policy <policy>
166 Used to specify which rules to use for Proxy Authorization. Proxy
167 authorization allows a client to authenticate to the server using one
168 user's credentials, but specify a different identity to use for authorization
169 and access control purposes. It essentially allows user A to login as user
170 B, using user A's password.
173 flag disables proxy authorization. This is the default setting.
176 flag will use rules in the
178 attribute of the authorization DN.
181 flag will use rules in the
183 attribute of the authentication DN.
186 flag, an alias for the deprecated value of
188 will allow any of the above, whatever succeeds first (checked in
194 flag requires both authorizations to succeed.
197 The rules are mechanisms to specify which identities are allowed
198 to perform proxy authorization.
201 attribute in an entry specifies which other users
202 are allowed to proxy login to this entry. The
205 an entry specifies which other users this user can authorize as. Use of
208 abused if users are allowed to write arbitrary values to this attribute.
211 attribute must be protected with ACLs such that
212 only privileged users can modify it.
219 or a set of identities; it can take three forms:
222 .B ldap:///<base>??[<scope>]?<filter>
225 .B dn[.<dnstyle>]:<pattern>
228 .B u[<mech>[<realm>]]:<pattern>
231 .B group[/objectClass[/attributeType]]:<pattern>
238 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
241 The first form is a valid LDAP
249 portions must be absent, so that the search occurs locally on either
255 with the optional style modifiers
261 for exact, onelevel, children and subtree matches, which cause
263 to be normalized according to the DN normalization rules, or the special
265 style, which causes the
267 to be treated as a POSIX (''extended'') regular expression, as
274 means any non-anonymous DN.
275 The third form is a SASL
277 with the optional fields
281 that allow to specify a SASL
283 and eventually a SASL
285 for those mechanisms that support one.
286 The need to allow the specification of a mechanism is still debated,
287 and users are strongly discouraged to rely on this possibility.
288 The fourth form is a group specification, consisting of the keyword
290 optionally followed by the specification of the group
296 is searched with base scope, and in case of match, the values of the
299 are searched for the asserted DN.
300 For backwards compatibility, if no identity type is provided, i.e. only
304 is assumed; as a consequence,
306 is subjected to DN normalization.
307 Since the interpretation of
311 can impact security, users are strongly encouraged
312 to explicitly set the type of identity specification that is being used.
313 A subset of these rules can be used as third arg in the
315 statement (see below); significantly, the
322 .B authz-regexp <match> <replace>
323 Used by the authentication framework to convert simple user names,
324 such as provided by SASL subsystem, to an LDAP DN used for
325 authorization purposes. Note that the resultant DN need not refer
326 to an existing entry to be considered valid. When an authorization
327 request is received from the SASL subsystem, the SASL
332 are taken, when available, and combined into a name of the form
336 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
339 This name is then compared against the
341 POSIX (''extended'') regular expression, and if the match is successful,
342 the name is replaced with the
344 string. If there are wildcard strings in the
346 regular expression that are enclosed in parenthesis, e.g.
352 then the portion of the name that matched the wildcard will be stored
353 in the numbered placeholder variable $1. If there are other wildcard strings
354 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
355 placeholders can then be used in the
360 .B UID=$1,OU=Accounts,DC=example,DC=com
363 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
365 If the latter, the server will use the URI to search its own database(s)
366 and, if the search returns exactly one entry, the name is
367 replaced by the DN of that entry. The LDAP URI must have no
368 hostport, attrs, or extensions components, but the filter is mandatory,
372 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
375 The protocol portion of the URI must be strictly
380 options can be given in the configuration file to allow for multiple matching
381 and replacement patterns. The matching patterns are checked in the order they
382 appear in the file, stopping at the first successful match.
385 .\"Because the plus sign + is a character recognized by the regular expression engine,
386 .\"and it will appear in names that include a REALM, be careful to escape the
387 .\"plus sign with a backslash \\+ to remove the character's special meaning.
390 .B concurrency <integer>
391 Specify a desired level of concurrency. Provided to the underlying
392 thread system as a hint. The default is not to provide any hint.
394 .B conn_max_pending <integer>
395 Specify the maximum number of pending requests for an anonymous session.
396 If requests are submitted faster than the server can process them, they
397 will be queued up to this limit. If the limit is exceeded, the session
398 is closed. The default is 100.
400 .B conn_max_pending_auth <integer>
401 Specify the maximum number of pending requests for an authenticated session.
404 .B defaultsearchbase <dn>
405 Specify a default search base to use when client submits a
406 non-base search request with an empty base DN.
407 Base scoped search requests with an empty base DN are not affected.
409 .B disallow <features>
410 Specify a set of features (separated by white space) to
411 disallow (default none).
413 disables acceptance of anonymous bind requests. Note that this setting
414 does not prohibit anonymous directory access (See "require authc").
416 disables simple (bind) authentication.
418 disables forcing session to anonymous status (see also
420 upon StartTLS operation receipt.
422 disallows the StartTLS operation if authenticated (see also
426 .B ditcontentrule "(\ <oid>\
428 [DESC\ <description>]\
435 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
436 The slapd parser extends the RFC 4512 definition by allowing string
437 forms as well as numeric OIDs to be used for the attribute OID and
438 attribute syntax OID.
444 .B gentlehup { on | off }
445 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
447 will stop listening for new connections, but will not close the
448 connections to the current clients. Future write operations return
449 unwilling-to-perform, though. Slapd terminates when all clients
450 have closed their connections (if they ever do), or \- as before \-
451 if it receives a SIGTERM signal. This can be useful if you wish to
452 terminate the server and start a new
455 .B with another database,
456 without disrupting the currently active clients.
457 The default is off. You may wish to use
459 along with this option.
461 .B idletimeout <integer>
462 Specify the number of seconds to wait before forcibly closing
463 an idle client connection. A idletimeout of 0 disables this
464 feature. The default is 0.
466 .B include <filename>
467 Read additional configuration information from the given file before
468 continuing with the next line of the current file.
470 .B index_substr_if_minlen <integer>
471 Specify the minimum length for subinitial and subfinal indices. An
472 attribute value must have at least this many characters in order to be
473 processed by the indexing functions. The default is 2.
475 .B index_substr_if_maxlen <integer>
476 Specify the maximum length for subinitial and subfinal indices. Only
477 this many characters of an attribute value will be processed by the
478 indexing functions; any excess characters are ignored. The default is 4.
480 .B index_substr_any_len <integer>
481 Specify the length used for subany indices. An attribute value must have
482 at least this many characters in order to be processed. Attribute values
483 longer than this length will be processed in segments of this length. The
484 default is 4. The subany index will also be used in subinitial and
485 subfinal index lookups when the filter string is longer than the
486 .I index_substr_if_maxlen
489 .B index_substr_any_step <integer>
490 Specify the steps used in subany index lookups. This value sets the offset
491 for the segments of a filter string that are processed for a subany index
492 lookup. The default is 2. For example, with the default values, a search
493 using this filter "cn=*abcdefgh*" would generate index lookups for
494 "abcd", "cdef", and "efgh".
496 .\"-- NEW_LOGGING option --
498 .\".B logfile <filename>
499 .\"Specify a file for recording debug log messages. By default these messages
500 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
501 .\"copies messages to both stderr and the logfile.
504 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
505 such as those to the ldapi:// listener. For a description of SSF values,
509 option description. The default is 71.
511 .B loglevel <integer> [...]
512 Specify the level at which debugging statements and operation
513 statistics should be syslogged (currently logged to the
515 LOG_LOCAL4 facility).
516 They must be considered subsystems rather than increasingly verbose
518 Some messages with higher priority are logged regardless
519 of the configured loglevel as soon as some logging is configured,
520 otherwise anything is logged at all.
521 Log levels are additive, and available levels are:
532 debug packet handling
536 heavy trace debugging (function args)
540 connection management
544 print out packets sent and received
548 search filter processing
552 configuration file processing
556 access control list processing
560 stats log connections/operations/results
564 stats log entries sent
568 print communication with shell backends
580 \"data indexing (unused)
588 only messages that get logged whatever log level is set
591 The desired log level can be input as a single integer that combines
592 the (ORed) desired levels, both in decimal or in hexadecimal notation,
593 as a list of integers (that are ORed internally),
594 or as a list of the names that are shown between brackets, such that
607 can be used as a shortcut to enable logging at all levels (equivalent to -1).
610 or the equivalent integer representation, causes those messages
611 that are logged regardless of the configured loglevel to be logged.
612 In fact, if no loglevel (or a 0 level) is defined, no logging occurs,
615 level is required to have high priority messages logged.
618 .B moduleload <filename>
619 Specify the name of a dynamically loadable module to load. The filename
620 may be an absolute path name or a simple filename. Non-absolute names
621 are searched for in the directories specified by the
623 option. This option and the
625 option are only usable if slapd was compiled with --enable-modules.
627 .B modulepath <pathspec>
628 Specify a list of directories to search for loadable modules. Typically
629 the path is colon-separated but this depends on the operating system.
632 .B objectclass "(\ <oid>\
634 [DESC\ <description>]\
637 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
638 [MUST\ <oids>] [MAY\ <oids>] )"
640 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
641 The slapd parser extends the RFC 4512 definition by allowing string
642 forms as well as numeric OIDs to be used for the object class OID.
646 description.) Object classes are "STRUCTURAL" by default.
649 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
650 Define a string name that equates to the given OID. The string can be used
651 in place of the numeric OID in objectclass and attribute definitions. The
652 name can also be used with a suffix of the form ":xx" in which case the
653 value "oid.xx" will be used.
655 .B password-hash <hash> [<hash>...]
656 This option configures one or more hashes to be used in generation of user
657 passwords stored in the userPassword attribute during processing of
658 LDAP Password Modify Extended Operations (RFC 3062).
659 The <hash> must be one of
673 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
678 use the MD5 algorithm (RFC 1321), the latter with a seed.
685 indicates that the new password should be
686 added to userPassword as clear text.
688 Note that this option does not alter the normal user applications
689 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
691 .B password\-crypt\-salt\-format <format>
692 Specify the format of the salt passed to
694 when generating {CRYPT} passwords (see
696 during processing of LDAP Password Modify Extended Operations (RFC 3062).
698 This string needs to be in
700 format and may include one (and only one) %s conversion.
701 This conversion will be substituted with a string of random
702 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
703 provides a two character salt and "$1$%.8s" tells some
704 versions of crypt(3) to use an MD5 algorithm and provides
705 8 random characters of salt. The default is "%s", which
706 provides 31 characters of salt.
708 .B pidfile <filename>
709 The ( absolute ) name of a file that will hold the
711 server's process ID ( see
713 ) if started without the debugging command line option.
716 Specify the referral to pass back when
718 cannot find a local database to handle a request.
719 If specified multiple times, each url is provided.
722 The ( absolute ) name of a file that will hold the
724 server's command line options
725 if started without the debugging command line option.
726 If it appears after a
728 directive, the args file is specific to the
730 instance that handles that replication log.
733 The ( absolute ) name of a file that will hold the
735 server's process ID ( see
737 ) if started without the debugging command line option.
738 If it appears after a
740 directive, the pid file is specific to the
742 instance that handles that replication log.
744 .B replicationinterval
745 The number of seconds
747 waits before checking the replogfile for changes.
748 If it appears after a
750 directive, the replication interval is specific to the
752 instance that handles that replication log.
754 .B require <conditions>
755 Specify a set of conditions (separated by white space) to
756 require (default none).
757 The directive may be specified globally and/or per-database;
758 databases inherit global conditions, so per-database specifications
761 requires bind operation prior to directory operations.
763 requires session to be using LDAP version 3.
765 requires authentication prior to directory operations.
767 requires SASL authentication prior to directory operations.
769 requires strong authentication prior to directory operations.
770 The strong keyword allows protected "simple" authentication
771 as well as SASL authentication.
773 may be used to require no conditions (useful to clear out globally
774 set conditions within a particular database); it must occur first
775 in the list of conditions.
777 .B reverse-lookup on | off
778 Enable/disable client name unverified reverse lookup (default is
780 if compiled with --enable-rlookups).
783 Specify the name of an LDIF(5) file containing user defined attributes
784 for the root DSE. These attributes are returned in addition to the
785 attributes normally produced by slapd.
788 Used to specify the fully qualified domain name used for SASL processing.
790 .B sasl-realm <realm>
791 Specify SASL realm. Default is empty.
793 .B sasl-secprops <properties>
794 Used to specify Cyrus SASL security properties.
797 flag (without any other properties) causes the flag properties
798 default, "noanonymous,noplain", to be cleared.
801 flag disables mechanisms susceptible to simple passive attacks.
804 flag disables mechanisms susceptible to active attacks.
807 flag disables mechanisms susceptible to passive dictionary attacks.
810 flag disables mechanisms which support anonymous login.
813 flag require forward secrecy between sessions.
816 require mechanisms which pass client credentials (and allow
817 mechanisms which can pass credentials to do so).
820 property specifies the minimum acceptable
821 .I security strength factor
822 as an integer approximate to effective key length used for
823 encryption. 0 (zero) implies no protection, 1 implies integrity
824 protection only, 56 allows DES or other weak ciphers, 112
825 allows triple DES and other strong ciphers, 128 allows RC4,
826 Blowfish and other modern strong ciphers. The default is 0.
829 property specifies the maximum acceptable
830 .I security strength factor
831 as an integer (see minssf description). The default is INT_MAX.
834 property specifies the maximum security layer receive buffer
835 size allowed. 0 disables security layers. The default is 65536.
838 Specify the distinguished name for the subschema subentry that
839 controls the entries on this server. The default is "cn=Subschema".
841 .B security <factors>
842 Specify a set of security strength factors (separated by white space)
846 option for a description of security strength factors).
847 The directive may be specified globally and/or per-database.
849 specifies the overall security strength factor.
851 specifies the transport security strength factor.
853 specifies the TLS security strength factor.
855 specifies the SASL security strength factor.
857 specifies the overall security strength factor to require for
859 .B update_transport=<n>
860 specifies the transport security strength factor to require for
863 specifies the TLS security strength factor to require for
866 specifies the SASL security strength factor to require for
869 specifies the security strength factor required for
871 username/password authentication.
874 factor is measure of security provided by the underlying transport,
875 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
877 .B sizelimit {<integer>|unlimited}
879 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
880 Specify the maximum number of entries to return from a search operation.
881 The default size limit is 500.
884 to specify no limits.
885 The second format allows a fine grain setting of the size limits.
886 Extra args can be added on the same line.
889 for an explanation of the different flags.
891 .B sockbuf_max_incoming <integer>
892 Specify the maximum incoming LDAP PDU size for anonymous sessions.
893 The default is 262143.
895 .B sockbuf_max_incoming_auth <integer>
896 Specify the maximum incoming LDAP PDU size for authenticated sessions.
897 The default is 4194303.
900 Specify the maximum size of the primary thread pool.
901 The default is 16; the minimum value is 2.
903 .B timelimit {<integer>|unlimited}
905 .B timelimit time[.{soft|hard}]=<integer> [...]
906 Specify the maximum number of seconds (in real time)
908 will spend answering a search request. The default time limit is 3600.
911 to specify no limits.
912 The second format allows a fine grain setting of the time limits.
913 Extra args can be added on the same line.
916 for an explanation of the different flags.
918 .B tool-threads <integer>
919 Specify the maximum number of threads to use in tool mode.
920 This should not be greater than the number of CPUs in the system.
922 .\"ucdata-path is obsolete / ignored...
924 .\".B ucdata-path <path>
925 .\"Specify the path to the directory containing the Unicode character
926 .\"tables. The default path is DATADIR/ucdata.
930 is built with support for Transport Layer Security, there are more options
933 .B TLSCipherSuite <cipher-suite-spec>
934 Permits configuring what ciphers will be accepted and the preference order.
935 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
937 TLSCipherSuite HIGH:MEDIUM:+SSLv2
939 To check what ciphers a given spec selects, use:
941 openssl ciphers -v <cipher-suite-spec>
943 .B TLSCACertificateFile <filename>
944 Specifies the file that contains certificates for all of the Certificate
949 .B TLSCACertificatePath <path>
950 Specifies the path of a directory that contains Certificate Authority
951 certificates in separate individual files. Usually only one of this
952 or the TLSCACertificateFile is used.
954 .B TLSCertificateFile <filename>
955 Specifies the file that contains the
959 .B TLSCertificateKeyFile <filename>
960 Specifies the file that contains the
962 server private key that matches the certificate stored in the
963 .B TLSCertificateFile
964 file. Currently, the private key must not be protected with a password, so
965 it is of critical importance that it is protected carefully.
967 .B TLSDHParamFile <filename>
968 This directive specifies the file that contains parameters for Diffie-Hellman
969 ephemeral key exchange. This is required in order to use a DSA certificate on
970 the server. If multiple sets of parameters are present in the file, all of
971 them will be processed. Note that setting this option may also enable
972 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
973 You should append "!ADH" to your cipher suites if you have changed them
974 from the default, otherwise no certificate exchanges or verification will
977 .B TLSRandFile <filename>
978 Specifies the file to obtain random bits from when /dev/[u]random
979 is not available. Generally set to the name of the EGD/PRNGD socket.
980 The environment variable RANDFILE can also be used to specify the filename.
982 .B TLSVerifyClient <level>
983 Specifies what checks to perform on client certificates in an
984 incoming TLS session, if any.
987 can be specified as one of the following keywords:
993 will not ask the client for a certificate.
996 The client certificate is requested. If no certificate is provided,
997 the session proceeds normally. If a bad certificate is provided,
998 it will be ignored and the session proceeds normally.
1001 The client certificate is requested. If no certificate is provided,
1002 the session proceeds normally. If a bad certificate is provided,
1003 the session is immediately terminated.
1005 .B demand | hard | true
1006 These keywords are all equivalent, for compatibility reasons.
1007 The client certificate is requested. If no certificate is provided,
1008 or a bad certificate is provided, the session is immediately terminated.
1010 Note that a valid client certificate is required in order to use the
1011 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1014 setting must be chosen to enable SASL EXTERNAL authentication.
1017 .B TLSCRLCheck <level>
1018 Specifies if the Certificate Revocation List (CRL) of the CA should be
1019 used to verify if the client certificates have not been revoked. This
1021 .B TLSCACertificatePath
1022 parameter to be set.
1024 can be specified as one of the following keywords:
1028 No CRL checks are performed
1031 Check the CRL of the peer certificate
1034 Check the CRL for a whole certificate chain
1036 .SH GENERAL BACKEND OPTIONS
1037 Options in this section only apply to the configuration file section
1038 for the specified backend. They are supported by every
1041 .B backend <databasetype>
1042 Mark the beginning of a backend definition. <databasetype>
1060 depending on which backend will serve the database.
1062 .SH GENERAL DATABASE OPTIONS
1063 Options in this section only apply to the configuration file section
1064 for the database in which they are defined. They are supported by every
1065 type of backend. Note that the
1069 option are mandatory for each database.
1071 .B database <databasetype>
1072 Mark the beginning of a new database instance definition. <databasetype>
1090 depending on which backend will serve the database.
1095 will automatically maintain the
1096 modifiersName, modifyTimestamp, creatorsName, and
1097 createTimestamp attributes for entries. By default, lastmod is on.
1099 .B limits <who> <limit> [<limit> [...]]
1100 Specify time and size limits based on who initiated an operation.
1107 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1113 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1118 matches all unauthenticated clients.
1121 matches all authenticated clients;
1124 dn pattern is assumed unless otherwise specified by qualifying
1125 the (optional) key string
1131 (which are synonyms), to require an exact match; with
1133 to require exactly one level of depth match; with
1135 to allow any level of depth match, including the exact match; with
1137 to allow any level of depth match, not including the exact match;
1139 explicitly requires the (default) match based on POSIX (''extended'')
1140 regular expression pattern.
1143 matches unbound operations; the
1146 The same behavior is obtained by using the
1153 with the optional objectClass
1159 sets the limits for any DN listed in the values of the
1165 group objectClass (default
1167 whose DN exactly matches
1170 The currently supported limits are
1175 The syntax for time limits is
1176 .BR time[.{soft|hard}]=<integer> ,
1179 is the number of seconds slapd will spend answering a search request.
1180 If no time limit is explicitly requested by the client, the
1182 limit is used; if the requested time limit exceeds the
1185 .\".I "Administrative limit exceeded"
1186 .\"error is returned.
1187 limit, the value of the limit is used instead.
1190 limit is set to the keyword
1192 the soft limit is used in either case; if it is set to the keyword
1194 no hard limit is enforced.
1195 Explicit requests for time limits smaller or equal to the
1198 If no limit specifier is set, the value is assigned to the
1204 to preserve the original behavior.
1206 The syntax for size limits is
1207 .BR size[.{soft|hard|unchecked}]=<integer> ,
1210 is the maximum number of entries slapd will return answering a search
1212 If no size limit is explicitly requested by the client, the
1214 limit is used; if the requested size limit exceeds the
1217 .\".I "Administrative limit exceeded"
1218 .\"error is returned.
1219 limit, the value of the limit is used instead.
1222 limit is set to the keyword
1224 the soft limit is used in either case; if it is set to the keyword
1226 no hard limit is enforced.
1227 Explicit requests for size limits smaller or equal to the
1232 specifier sets a limit on the number of candidates a search request is allowed
1234 The rationale behind it is that searches for non-properly indexed
1235 attributes may result in large sets of candidates, which must be
1238 to determine whether they match the search filter or not.
1241 limit provides a means to drop such operations before they are even
1243 If the selected candidates exceed the
1245 limit, the search will abort with
1246 .IR "Unwilling to perform" .
1247 If it is set to the keyword
1249 no limit is applied (the default).
1252 the search is not even performed; this can be used to disallow searches
1253 for a specific set of users.
1254 If no limit specifier is set, the value is assigned to the
1260 to preserve the original behavior.
1262 In case of no match, the global limits are used.
1263 The default values are the same of
1272 control is requested, the
1274 size limit is used by default, because the request of a specific page size
1275 is considered an explicit request for a limitation on the number
1276 of entries to be returned.
1277 However, the size limit applies to the total count of entries returned within
1278 the search, and not to a single page.
1279 Additional size limits may be enforced; the syntax is
1280 .BR size.pr={<integer>|noEstimate|unlimited} ,
1283 is the max page size if no explicit limit is set; the keyword
1285 inhibits the server from returning an estimate of the total number
1286 of entries that might be returned
1287 (note: the current implementation does not return any estimate).
1290 indicates that no limit is applied to the pagedResults control page size.
1292 .B size.prtotal={<integer>|unlimited|disabled}
1293 allows to set a limit on the total number of entries that a pagedResults
1294 control allows to return.
1295 By default it is set to the
1300 is the max number of entries that the whole search with pagedResults control
1304 to allow unlimited number of entries to be returned, e.g. to allow
1305 the use of the pagedResults control as a means to circumvent size
1306 limitations on regular searches; the keyword
1308 disables the control, i.e. no paged results can be returned.
1309 Note that the total number of entries returned when the pagedResults control
1310 is requested cannot exceed the
1312 size limit of regular searches unless extended by the
1317 .B maxderefdepth <depth>
1318 Specifies the maximum number of aliases to dereference when trying to
1319 resolve an entry, used to avoid infinite alias loops. The default is 1.
1321 .B mirrormode on | off
1322 This option puts a replica database into "mirror" mode. Update
1323 operations will be accepted from any user, not just the updatedn. The
1324 database must already be configured as a slurpd or syncrepl consumer
1325 before this keyword may be set. This mode must be used with extreme
1326 care, as it does not offer any consistency guarantees.
1327 By default, mirrormode is off.
1329 .B overlay <overlay-name>
1330 Add the specified overlay to this database. An overlay is a piece of
1331 code that intercepts database operations in order to extend or change
1332 them. Overlays are pushed onto
1333 a stack over the database, and so they will execute in the reverse
1334 of the order in which they were configured and the database itself
1335 will receive control last of all.
1337 .B readonly on | off
1338 This option puts the database into "read-only" mode. Any attempts to
1339 modify the database will return an "unwilling to perform" error. By
1340 default, readonly is off.
1343 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1344 .B [starttls=yes|critical]
1345 .B [suffix=<suffix> [...]]
1346 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1347 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1348 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1349 .B [attrs[!]=<attr list>]
1351 Specify a replication site for this database. Refer to the "OpenLDAP
1352 Administrator's Guide" for detailed information on setting up a replicated
1354 directory service. Zero or more
1356 instances can be used to select the subtrees that will be replicated
1357 (defaults to all the database).
1359 is deprecated in favor of the
1363 allows the replica LDAP server to be specified as an LDAP URI.
1368 requires the options
1372 and should only be used when adequate security services
1373 (e.g TLS or IPSEC) are in place. A
1379 Specific security properties (as with the
1381 keyword above) for a SASL bind can be set with the
1383 option. A non-default SASL realm can be set with the
1388 will use Kerberos, a kerberos instance should be given in
1392 can be given after the
1394 keyword to allow the selective replication of the listed attributes only;
1397 mark is used, the list is considered exclusive, i.e. the listed attributes
1399 If an objectClass is listed, all the related attributes
1400 are (are not) replicated.
1403 .B replogfile <filename>
1404 Specify the name of the replication log file to log changes to.
1405 The replication log is typically written by
1410 .BR slapd.replog (5)
1411 for more information. The specified file should be located
1412 in a directory with limited read/write/execute access as the replication
1413 logs may contain sensitive information.
1415 .B restrict <oplist>
1416 Specify a whitespace separated list of operations that are restricted.
1417 If defined inside a database specification, restrictions apply only
1418 to that database, otherwise they are global.
1419 Operations can be any of
1424 .BR extended[=<OID>] ,
1428 or the special pseudo-operations
1432 which respectively summarize read and write operations.
1440 keyword allows to indicate the OID of the specific operation
1444 Specify the distinguished name that is not subject to access control
1445 or administrative limit restrictions for operations on this database.
1446 This DN may or may not be associated with an entry. An empty root
1447 DN (the default) specifies no root access is to be granted. It is
1448 recommended that the rootdn only be specified when needed (such as
1449 when initially populating a database). If the rootdn is within
1450 a namingContext (suffix) of the database, a simple bind password
1451 may also be provided using the
1453 directive. Note that the rootdn is always needed when using syncrepl.
1455 .B rootpw <password>
1456 Specify a password (or hash of the password) for the rootdn. The
1457 password can only be set if the rootdn is within the namingContext
1458 (suffix) of the database.
1459 This option accepts all RFC 2307 userPassword formats known to
1462 description) as well as cleartext.
1464 may be used to generate a hash of a password. Cleartext
1465 and \fB{CRYPT}\fP passwords are not recommended. If empty
1466 (the default), authentication of the root DN is by other means
1467 (e.g. SASL). Use of SASL is encouraged.
1469 .B suffix <dn suffix>
1470 Specify the DN suffix of queries that will be passed to this
1471 backend database. Multiple suffix lines can be given and at least one is
1472 required for each database definition.
1473 If the suffix of one database is "inside" that of another, the database
1474 with the inner suffix must come first in the configuration file.
1476 .B subordinate [advertise]
1477 Specify that the current backend database is a subordinate of another
1478 backend database. A subordinate database may have only one suffix. This
1479 option may be used to glue multiple databases into a single namingContext.
1480 If the suffix of the current database is within the namingContext of a
1481 superior database, searches against the superior database will be
1482 propagated to the subordinate as well. All of the databases
1483 associated with a single namingContext should have identical rootdns.
1484 Behavior of other LDAP operations is unaffected by this setting. In
1485 particular, it is not possible to use moddn to move an entry from
1486 one subordinate to another subordinate within the namingContext.
1488 If the optional \fBadvertise\fP flag is supplied, the naming context of
1489 this database is advertised in the root DSE. The default is to hide this
1490 database context, so that only the superior context is visible.
1497 are used on the superior database, any glued subordinates that support
1498 these tools are opened as well.
1500 Databases that are glued together should usually be configured with the
1501 same indices (assuming they support indexing), even for attributes that
1502 only exist in some of these databases. In general, all of the glued
1503 databases should be configured as similarly as possible, since the intent
1504 is to provide the appearance of a single directory.
1506 Note that the \fIsubordinate\fP functionality is implemented internally
1507 by the \fIglue\fP overlay and as such its behavior will interact with other
1508 overlays in use. By default, the glue overlay is automatically configured as
1509 the last overlay on the superior backend. Its position on the backend
1510 can be explicitly configured by setting an \fBoverlay glue\fP directive
1511 at the desired position. This explicit configuration is necessary e.g.
1512 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1513 in order to work over all of the glued databases. E.g.
1517 suffix dc=example,dc=com
1525 .B syncrepl rid=<replica ID>
1526 .B provider=ldap[s]://<hostname>[:port]
1527 .B searchbase=<base DN>
1528 .B [type=refreshOnly|refreshAndPersist]
1529 .B [interval=dd:hh:mm:ss]
1530 .B [retry=[<retry interval> <# of retries>]+]
1531 .B [filter=<filter str>]
1532 .B [scope=sub|one|base|subord]
1533 .B [attrs=<attr list>]
1535 .B [sizelimit=<limit>]
1536 .B [timelimit=<limit>]
1537 .B [schemachecking=on|off]
1538 .B [bindmethod=simple|sasl]
1540 .B [saslmech=<mech>]
1541 .B [authcid=<identity>]
1542 .B [authzid=<identity>]
1543 .B [credentials=<passwd>]
1545 .B [secprops=<properties>]
1546 .B [starttls=yes|critical]
1547 .B [tls_cert=<file>]
1549 .B [tls_cacert=<file>]
1550 .B [tls_cacertdir=<path>]
1551 .B [tls_reqcert=never|allow|try|demand]
1552 .B [tls_ciphersuite=<ciphers>]
1553 .B [tls_crlcheck=none|peer|all]
1554 .B [logbase=<base DN>]
1555 .B [logfilter=<filter str>]
1556 .B [syncdata=default|accesslog|changelog]
1558 Specify the current database as a replica which is kept up-to-date with the
1559 master content by establishing the current
1561 as a replication consumer site running a
1564 The replica content is kept synchronized to the master content using
1565 the LDAP Content Synchronization protocol. Refer to the
1566 "OpenLDAP Administrator's Guide" for detailed information on
1567 setting up a replicated
1569 directory service using the
1573 identifies the current
1575 directive within the replication consumer site.
1576 It is a non-negative integer having no more than three digits.
1578 specifies the replication provider site containing the master content
1579 as an LDAP URI. If <port> is not given, the standard LDAP port number
1580 (389 or 636) is used. The content of the
1582 replica is defined using a search
1583 specification as its result set. The consumer
1585 will send search requests to the provider
1587 according to the search specification. The search specification includes
1588 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1591 parameters as in the normal search specification.
1592 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1593 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1594 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1595 attributes, and \fBattrsonly\fP is unset by default.
1596 The \fBsizelimit\fP and \fBtimelimit\fP only
1597 accept "unlimited" and positive integers, and both default to "unlimited".
1598 The LDAP Content Synchronization protocol has two operation types.
1601 operation, the next synchronization search operation
1602 is periodically rescheduled at an interval time (specified by
1604 parameter; 1 day by default)
1605 after each synchronization operation finishes.
1607 .B refreshAndPersist
1608 operation, a synchronization search remains persistent in the provider slapd.
1609 Further updates to the master replica will generate
1610 .B searchResultEntry
1611 to the consumer slapd as the search responses to the persistent
1612 synchronization search.
1613 If an error occurs during replication, the consumer will attempt to
1614 reconnect according to the
1616 parameter which is a list of the <retry interval> and <# of retries> pairs.
1617 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1618 for the first 10 times and then retry every 300 seconds for the next 3
1619 times before stop retrying. The `+' in <# of retries> means indefinite
1620 number of retries until success.
1621 The schema checking can be enforced at the LDAP Sync
1622 consumer site by turning on the
1624 parameter. The default is off.
1629 requires the options
1633 and should only be used when adequate security services
1634 (e.g. TLS or IPSEC) are in place.
1641 Depending on the mechanism, an authentication identity and/or
1642 credentials can be specified using
1648 parameter may be used to specify an authorization identity.
1649 Specific security properties (as with the
1651 keyword above) for a SASL bind can be set with the
1653 option. A non default SASL realm can be set with the
1659 parameter specifies use of the StartTLS extended operation
1660 to establish a TLS session before Binding to the provider. If the
1662 argument is supplied, the session will be aborted if the StartTLS request
1663 fails. Otherwise the syncrepl session continues without TLS. Note that the
1664 main slapd TLS settings are not used by the syncrepl engine;
1665 by default the TLS parameters from ETCDIR/ldap.conf will be used.
1666 TLS settings may be specified here, in which case the ldap.conf settings
1667 will be completely ignored.
1669 Rather than replicating whole entries, the consumer can query logs of
1670 data modifications. This mode of operation is referred to as \fIdelta
1671 syncrepl\fP. In addition to the above parameters, the
1675 parameters must be set appropriately for the log that will be used. The
1677 parameter must be set to either "accesslog" if the log conforms to the
1678 .BR slapo-accesslog (5)
1679 log format, or "changelog" if the log conforms
1680 to the obsolete \fIchangelog\fP format. If the
1682 parameter is omitted or set to "default" then the log parameters are
1687 This option is only applicable in a slave
1688 database updated using
1690 It specifies the DN permitted to update (subject to access controls)
1691 the replica (typically, this is the DN
1693 binds to update the replica). Generally, this DN
1700 Specify the referral to pass back when
1702 is asked to modify a replicated local database.
1703 If specified multiple times, each url is provided.
1705 .SH DATABASE-SPECIFIC OPTIONS
1706 Each database may allow specific configuration options; they are
1707 documented separately in the backends' manual pages.
1709 The following backends can be compiled into slapd.
1710 They are documented in the
1711 .BR slapd-<backend> (5)
1715 This is the recommended primary backend for a normal slapd database.
1716 It takes care to configure it properly.
1717 It uses the transactional database interface of the Sleepycat Berkeley
1718 DB (BDB) package to store data.
1721 This backend is used to manage the configuration of slapd run-time.
1724 This backend is experimental.
1725 It serves up referrals based upon SRV resource records held in the
1729 This is a variant of the BDB backend that uses a hierarchical database
1730 layout which supports subtree renames.
1733 This backend acts as a proxy to forward incoming requests to another
1737 This is an easy-to-configure but obsolete database backend. It
1738 does not offer the data durability features of the BDB and HDB
1739 backends and hence is deprecated in favor of these robust backends.
1740 LDBM uses lightweight non-transactional DB interfaces,
1741 such as those providing by GDBM or Berkeley DB, to store data.
1744 This database uses the filesystem to build the tree structure
1745 of the database, using plain ascii files to store data.
1746 Its usage should be limited to very simple databases, where performance
1747 is not a requirement.
1750 This backend performs basic LDAP proxying with respect to a set of
1751 remote LDAP servers. It is an enhancement of the ldap backend.
1754 This backend provides information about the running status of the slapd
1758 Operations in this backend succeed but do nothing.
1761 This backend is provided for demonstration purposes only.
1762 It serves up user account information from the system
1767 This backend embeds a
1769 interpreter into slapd.
1770 It runs Perl subroutines to implement LDAP operations.
1773 This backend is experimental.
1774 It redirects LDAP operations to another database
1775 in the same server, based on the naming context of the request.
1776 Its use requires the
1780 for details) to rewrite the naming context of the request.
1781 It is primarily intended to implement virtual views on databases
1782 that actually store data.
1785 This backend executes external programs to implement LDAP operations.
1786 It is primarily intended to be used in prototypes.
1789 This backend is experimental.
1790 It services LDAP requests from an SQL database.
1792 The following overlays can be compiled into slapd.
1793 They are documented in the
1794 .BR slapo-<overlay> (5)
1799 This overlay can record accesses to a given backend database on another
1804 This overlay records changes on a given backend database to an LDIF log
1806 By default it is not built.
1810 This overlay allows automatic referral chasing when a referral would
1811 have been returned, either when configured by the server or when
1812 requested by the client.
1816 This overlay allows selected operations to be denied, similar to the
1817 \fBrestrict\fP option.
1821 This is a demo overlay which extends the Compare operation to detect
1822 members of a dynamic group.
1823 It has no effect on any other operations.
1827 This overlay allows expansion of dynamic groups and more.
1831 This overlay maintains a service entry in the database with the DN,
1832 modification type, modifiersName and modifyTimestamp of the last write
1833 operation performed on that database.
1837 This overlay allows caching of LDAP search requests in a local database.
1838 It is most often used with the ldap or meta backends.
1842 This overlay provides a variety of password control mechanisms,
1843 e.g. password aging, password reuse and duplication control, mandatory
1844 password resets, etc.
1847 Referential Integrity.
1848 This overlay can be used with a backend database such as
1850 to maintain the cohesiveness of a schema which utilizes reference
1855 This overlay is useful to test the behavior of clients when
1856 server-generated erroneous and/or unusual responses occur.
1860 This overlay is experimental.
1861 It performs basic DN/data rewrite and
1862 objectClass/attributeType mapping.
1866 This overlay implements the provider-side support for
1868 replication, including persistent search functionality.
1872 This overlay can be used with a backend database such as
1874 to create a "translucent proxy".
1875 Content of entries retrieved from a remote LDAP server can be partially
1876 overridden by the database.
1879 Attribute Uniqueness.
1880 This overlay can be used with a backend database such as
1882 to enforce the uniqueness of some or all attributes within a subtree.
1885 Here is a short example of a configuration file:
1889 include SYSCONFDIR/schema/core.schema
1890 pidfile LOCALSTATEDIR/slapd.pid
1892 # Subtypes of "name" (e.g. "cn" and "ou") with the
1893 # option ";x-hidden" can be searched for/compared,
1894 # but are not shown. See \fBslapd.access\fP(5).
1895 attributeoptions x-hidden lang-
1896 access to attrs=name;x-hidden by * =cs
1898 # Protect passwords. See \fBslapd.access\fP(5).
1899 access to attrs=userPassword by * auth
1900 # Read access to other attributes and entries.
1901 access to * by * read
1904 suffix "dc=our-domain,dc=com"
1905 # The database directory MUST exist prior to
1906 # running slapd AND should only be accessible
1907 # by the slapd/tools. Mode 0700 recommended.
1908 directory LOCALSTATEDIR/openldap-data
1909 # Indices to maintain
1910 index objectClass eq
1911 index cn,sn,mail pres,eq,approx,sub
1913 # We serve small clients that do not handle referrals,
1914 # so handle remote lookups on their behalf.
1917 uri ldap://ldap.some-server.com/
1922 "OpenLDAP Administrator's Guide" contains a longer annotated
1923 example of a configuration file.
1924 The original ETCDIR/slapd.conf is another example.
1928 default slapd configuration file
1932 .BR slapd\-dnssrv (5),
1934 .BR slapd\-ldap (5),
1935 .BR slapd\-ldbm (5),
1936 .BR slapd\-ldif (5),
1937 .BR slapd\-meta (5),
1938 .BR slapd\-monitor (5),
1939 .BR slapd\-null (5),
1940 .BR slapd\-passwd (5),
1941 .BR slapd\-perl (5),
1942 .BR slapd\-relay (5),
1943 .BR slapd\-shell (5),
1945 .BR slapd.access (5),
1946 .BR slapd.plugin (5),
1947 .BR slapd.replog (5),
1959 Known overlays are documented in
1960 .BR slapo\-accesslog (5),
1961 .BR slapo\-auditlog (5),
1962 .BR slapo\-chain (5),
1963 .BR slapo\-dynlist (5),
1964 .BR slapo\-lastmod (5),
1965 .BR slapo\-pcache (5),
1966 .BR slapo\-ppolicy (5),
1967 .BR slapo\-refint (5),
1968 .BR slapo\-retcode (5),
1970 .BR slapo\-syncprov (5),
1971 .BR slapo\-translucent (5),
1972 .BR slapo\-unique (5).
1974 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1975 .SH ACKNOWLEDGEMENTS
1977 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1979 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob