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 .B argsfile <filename>
107 The ( absolute ) name of a file that will hold the
109 server's command line options
110 if started without the debugging command line option.
112 .B attributeoptions [option-name]...
113 Define tagging attribute options or option tag/range prefixes.
114 Options must not end with `-', prefixes must end with `-'.
115 The `lang-' prefix is predefined.
118 directive, `lang-' will no longer be defined and you must specify it
119 explicitly if you want it defined.
121 An attribute description with a tagging option is a subtype of that
122 attribute description without the option.
123 Except for that, options defined this way have no special semantics.
124 Prefixes defined this way work like the `lang-' options:
125 They define a prefix for tagging options starting with the prefix.
126 That is, if you define the prefix `x-foo-', you can use the option
128 Furthermore, in a search or compare, a prefix or range name (with
129 a trailing `-') matches all options starting with that name, as well
130 as the option with the range name sans the trailing `-'.
131 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
133 RFC 2251 reserves options beginning with `x-' for private experiments.
134 Other options should be registered with IANA, see RFC 3383 section 3.4.
135 OpenLDAP also has the `binary' option built in, but this is a transfer
136 option, not a tagging option.
139 .B attributetype "(\ <oid>\
141 [DESC\ <description>]\
150 [NO\-USER\-MODIFICATION]\
151 [USAGE\ <attributeUsage>]\ )"
153 Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
154 The slapd parser extends the RFC 2252 definition by allowing string
155 forms as well as numeric OIDs to be used for the attribute OID and
156 attribute syntax OID.
162 .B authz-policy <policy>
163 Used to specify which rules to use for Proxy Authorization. Proxy
164 authorization allows a client to authenticate to the server using one
165 user's credentials, but specify a different identity to use for authorization
166 and access control purposes. It essentially allows user A to login as user
167 B, using user A's password.
170 flag disables proxy authorization. This is the default setting.
173 flag will use rules in the
175 attribute of the authorization DN.
178 flag will use rules in the
180 attribute of the authentication DN.
183 flag, an alias for the deprecated value of
185 will allow any of the above, whatever succeeds first (checked in
191 flag requires both authorizations to succeed.
194 The rules are mechanisms to specify which identities are allowed
195 to perform proxy authorization.
198 attribute in an entry specifies which other users
199 are allowed to proxy login to this entry. The
202 an entry specifies which other users this user can authorize as. Use of
205 abused if users are allowed to write arbitrary values to this attribute.
208 attribute must be protected with ACLs such that
209 only privileged users can modify it.
216 or a set of identities; it can take three forms:
219 .B ldap:///<base>??[<scope>]?<filter>
222 .B dn[.<dnstyle>]:<pattern>
225 .B u[<mech>[<realm>]]:<pattern>
228 .B group[/objectClass[/attributeType]]:<pattern>
235 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
238 The first form is a valid LDAP
246 portions must be absent, so that the search occurs locally on either
252 with the optional style modifiers
258 for exact, onelevel, children and subtree matches, which cause
260 to be normalized according to the DN normalization rules, or the special
262 style, which causes the
264 to be treated as a POSIX (''extended'') regular expression, as
271 means any non-anonymous DN.
272 The third form is a SASL
274 with the optional fields
278 that allow to specify a SASL
280 and eventually a SASL
282 for those mechanisms that support one.
283 The need to allow the specification of a mechanism is still debated,
284 and users are strongly discouraged to rely on this possibility.
285 The fourth form is a group specification, consisting of the keyword
287 optionally followed by the specification of the group
293 is searched with base scope, and in case of match, the values of the
296 are searched for the asserted DN.
297 For backwards compatibility, if no identity type is provided, i.e. only
301 is assumed; as a consequence,
303 is subjected to DN normalization.
304 Since the interpretation of
308 can impact security, users are strongly encouraged
309 to explicitly set the type of identity specification that is being used.
310 A subset of these rules can be used as third arg in the
312 statement (see below); significantly, the
319 .B authz-regexp <match> <replace>
320 Used by the authentication framework to convert simple user names,
321 such as provided by SASL subsystem, to an LDAP DN used for
322 authorization purposes. Note that the resultant DN need not refer
323 to an existing entry to be considered valid. When an authorization
324 request is received from the SASL subsystem, the SASL
329 are taken, when available, and combined into a name of the form
333 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
336 This name is then compared against the
338 POSIX (''extended'') regular expression, and if the match is successful,
339 the name is replaced with the
341 string. If there are wildcard strings in the
343 regular expression that are enclosed in parenthesis, e.g.
349 then the portion of the name that matched the wildcard will be stored
350 in the numbered placeholder variable $1. If there are other wildcard strings
351 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
352 placeholders can then be used in the
357 .B UID=$1,OU=Accounts,DC=example,DC=com
360 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
362 If the latter, the server will use the URI to search its own database(s)
363 and, if the search returns exactly one entry, the name is
364 replaced by the DN of that entry. The LDAP URI must have no
365 hostport, attrs, or extensions components, but the filter is mandatory,
369 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
372 The protocol portion of the URI must be strictly
377 options can be given in the configuration file to allow for multiple matching
378 and replacement patterns. The matching patterns are checked in the order they
379 appear in the file, stopping at the first successful match.
382 .\"Because the plus sign + is a character recognized by the regular expression engine,
383 .\"and it will appear in names that include a REALM, be careful to escape the
384 .\"plus sign with a backslash \\+ to remove the character's special meaning.
387 .B concurrency <integer>
388 Specify a desired level of concurrency. Provided to the underlying
389 thread system as a hint. The default is not to provide any hint.
391 .B conn_max_pending <integer>
392 Specify the maximum number of pending requests for an anonymous session.
393 If requests are submitted faster than the server can process them, they
394 will be queued up to this limit. If the limit is exceeded, the session
395 is closed. The default is 100.
397 .B conn_max_pending_auth <integer>
398 Specify the maximum number of pending requests for an authenticated session.
401 .B defaultsearchbase <dn>
402 Specify a default search base to use when client submits a
403 non-base search request with an empty base DN.
404 Base scoped search requests with an empty base DN are not affected.
406 .B disallow <features>
407 Specify a set of features (separated by white space) to
408 disallow (default none).
410 disables acceptance of anonymous bind requests. Note that this setting
411 does not prohibit anonymous directory access (See "require authc").
413 disables simple (bind) authentication.
415 disables forcing session to anonymous status (see also
416 .BR tls_authc ) upon StartTLS operation receipt.
418 dissallow the StartTLS operation if authenticated (see also
422 .B ditcontentrule "(\ <oid>\
424 [DESC\ <description>]\
431 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
432 The slapd parser extends the RFC 2252 definition by allowing string
433 forms as well as numeric OIDs to be used for the attribute OID and
434 attribute syntax OID.
440 .B gentlehup { on | off }
441 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
443 will stop listening for new connections, but will not close the
444 connections to the current clients. Future write operations return
445 unwilling-to-perform, though. Slapd terminates when all clients
446 have closed their connections (if they ever do), or \- as before \-
447 if it receives a SIGTERM signal. This can be useful if you wish to
448 terminate the server and start a new
451 .B with another database,
452 without disrupting the currently active clients.
453 The default is off. You may wish to use
455 along with this option.
457 .B idletimeout <integer>
458 Specify the number of seconds to wait before forcibly closing
459 an idle client connection. A idletimeout of 0 disables this
460 feature. The default is 0.
462 .B include <filename>
463 Read additional configuration information from the given file before
464 continuing with the next line of the current file.
466 .B index_substr_if_minlen <integer>
467 Specify the minimum length for subinitial and subfinal indices. An
468 attribute value must have at least this many characters in order to be
469 processed by the indexing functions. The default is 2.
471 .B index_substr_if_maxlen <integer>
472 Specify the maximum length for subinitial and subfinal indices. Only
473 this many characters of an attribute value will be processed by the
474 indexing functions; any excess characters are ignored. The default is 4.
476 .B index_substr_any_len <integer>
477 Specify the length used for subany indices. An attribute value must have
478 at least this many characters in order to be processed. Attribute values
479 longer than this length will be processed in segments of this length. The
480 default is 4. The subany index will also be used in subinitial and
481 subfinal index lookups when the filter string is longer than the
482 .I index_substr_if_maxlen
485 .B index_substr_any_step <integer>
486 Specify the steps used in subany index lookups. This value sets the offset
487 for the segments of a filter string that are processed for a subany index
488 lookup. The default is 2. For example, with the default values, a search
489 using this filter "cn=*abcdefgh*" would generate index lookups for
490 "abcd", "cdef", and "efgh".
492 .\"-- NEW_LOGGING option --
494 .\".B logfile <filename>
495 .\"Specify a file for recording debug log messages. By default these messages
496 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
497 .\"copies messages to both stderr and the logfile.
500 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
501 such as those to the ldapi:// listener. For a description of SSF values,
505 option description. The default is 71.
507 .B loglevel <integer> [...]
508 Specify the level at which debugging statements and operation
509 statistics should be syslogged (currently logged to the
511 LOG_LOCAL4 facility).
512 They must be considered subsystems rather than increasingly verbose
514 Some messages with higher priority are logged regardless
515 of the configured loglevel as soon as some logging is configured,
516 otherwise anything is logged at all.
517 Log levels are additive, and available levels are:
528 debug packet handling
532 heavy trace debugging (function args)
536 connection management
540 print out packets sent and received
544 search filter processing
548 configuration file processing
552 access control list processing
556 stats log connections/operations/results
560 stats log entries sent
564 print communication with shell backends
576 data indexing (unused)
584 only messages that get logged whatever log level is set
587 The desired log level can be input as a single integer that combines
588 the (ORed) desired levels, both in decimal or in hexadecimal notation,
589 as a list of integers (that are ORed internally),
590 or as a list of the names that are shown between brackets, such that
603 can be used as a shortcut to enable logging at all levels (equivalent to -1).
606 or the equivalent integer representation, causes those messages
607 that are logged regardless of the configured loglevel to be logged.
608 In fact, if no loglevel (or a 0 level) is defined, no logging occurs,
611 level is required to have high priority messages logged.
614 .B moduleload <filename>
615 Specify the name of a dynamically loadable module to load. The filename
616 may be an absolute path name or a simple filename. Non-absolute names
617 are searched for in the directories specified by the
619 option. This option and the
621 option are only usable if slapd was compiled with --enable-modules.
623 .B modulepath <pathspec>
624 Specify a list of directories to search for loadable modules. Typically
625 the path is colon-separated but this depends on the operating system.
628 .B objectclass "(\ <oid>\
630 [DESC\ <description>]\
633 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
634 [MUST\ <oids>] [MAY\ <oids>] )"
636 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
637 The slapd parser extends the RFC 2252 definition by allowing string
638 forms as well as numeric OIDs to be used for the object class OID.
642 description.) Object classes are "STRUCTURAL" by default.
645 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
646 Define a string name that equates to the given OID. The string can be used
647 in place of the numeric OID in objectclass and attribute definitions. The
648 name can also be used with a suffix of the form ":xx" in which case the
649 value "oid.xx" will be used.
651 .B password-hash <hash> [<hash>...]
652 This option configures one or more hashes to be used in generation of user
653 passwords stored in the userPassword attribute during processing of
654 LDAP Password Modify Extended Operations (RFC 3062).
655 The <hash> must be one of
669 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
674 use the MD5 algorithm (RFC 1321), the latter with a seed.
681 indicates that the new password should be
682 added to userPassword as clear text.
684 Note that this option does not alter the normal user applications
685 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
687 .B password\-crypt\-salt\-format <format>
688 Specify the format of the salt passed to
690 when generating {CRYPT} passwords (see
692 during processing of LDAP Password Modify Extended Operations (RFC 3062).
694 This string needs to be in
696 format and may include one (and only one) %s conversion.
697 This conversion will be substituted with a string of random
698 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
699 provides a two character salt and "$1$%.8s" tells some
700 versions of crypt(3) to use an MD5 algorithm and provides
701 8 random characters of salt. The default is "%s", which
702 provides 31 characters of salt.
704 .B pidfile <filename>
705 The ( absolute ) name of a file that will hold the
707 server's process ID ( see
709 ) if started without the debugging command line option.
712 Specify the referral to pass back when
714 cannot find a local database to handle a request.
715 If specified multiple times, each url is provided.
718 The ( absolute ) name of a file that will hold the
720 server's command line options
721 if started without the debugging command line option.
724 The ( absolute ) name of a file that will hold the
726 server's process ID ( see
728 ) if started without the debugging command line option.
730 .B replicationinterval
731 The number of seconds
733 waits before checking the replogfile for changes.
735 .B require <conditions>
736 Specify a set of conditions (separated by white space) to
737 require (default none).
738 The directive may be specified globally and/or per-database.
740 requires bind operation prior to directory operations.
742 requires session to be using LDAP version 3.
744 requires authentication prior to directory operations.
746 requires SASL authentication prior to directory operations.
748 requires strong authentication prior to directory operations.
749 The strong keyword allows protected "simple" authentication
750 as well as SASL authentication.
752 may be used to require no conditions (useful for clearly globally
753 set conditions within a particular database).
755 .B reverse-lookup on | off
756 Enable/disable client name unverified reverse lookup (default is
758 if compiled with --enable-rlookups).
761 Specify the name of an LDIF(5) file containing user defined attributes
762 for the root DSE. These attributes are returned in addition to the
763 attributes normally produced by slapd.
766 Used to specify the fully qualified domain name used for SASL processing.
768 .B sasl-realm <realm>
769 Specify SASL realm. Default is empty.
771 .B sasl-secprops <properties>
772 Used to specify Cyrus SASL security properties.
775 flag (without any other properties) causes the flag properties
776 default, "noanonymous,noplain", to be cleared.
779 flag disables mechanisms susceptible to simple passive attacks.
782 flag disables mechanisms susceptible to active attacks.
785 flag disables mechanisms susceptible to passive dictionary attacks.
788 flag disables mechanisms which support anonymous login.
791 flag require forward secrecy between sessions.
794 require mechanisms which pass client credentials (and allow
795 mechanisms which can pass credentials to do so).
798 property specifies the minimum acceptable
799 .I security strength factor
800 as an integer approximate to effective key length used for
801 encryption. 0 (zero) implies no protection, 1 implies integrity
802 protection only, 56 allows DES or other weak ciphers, 112
803 allows triple DES and other strong ciphers, 128 allows RC4,
804 Blowfish and other modern strong ciphers. The default is 0.
807 property specifies the maximum acceptable
808 .I security strength factor
809 as an integer (see minssf description). The default is INT_MAX.
812 property specifies the maximum security layer receive buffer
813 size allowed. 0 disables security layers. The default is 65536.
816 Specify the distinguished name for the subschema subentry that
817 controls the entries on this server. The default is "cn=Subschema".
819 .B security <factors>
820 Specify a set of security strength factors (separated by white space)
824 option for a description of security strength factors).
825 The directive may be specified globally and/or per-database.
827 specifies the overall security strength factor.
829 specifies the transport security strength factor.
831 specifies the TLS security strength factor.
833 specifies the SASL security strength factor.
835 specifies the overall security strength factor to require for
837 .B update_transport=<n>
838 specifies the transport security strength factor to require for
841 specifies the TLS security strength factor to require for
844 specifies the SASL security strength factor to require for
847 specifies the security strength factor required for
849 username/password authentication.
852 factor is measure of security provided by the underlying transport,
853 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
855 .B sizelimit {<integer>|unlimited}
857 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
858 Specify the maximum number of entries to return from a search operation.
859 The default size limit is 500.
862 to specify no limits.
863 The second format allows a fine grain setting of the size limits.
864 Extra args can be added on the same line.
867 for an explanation of the different flags.
869 .B sockbuf_max_incoming <integer>
870 Specify the maximum incoming LDAP PDU size for anonymous sessions.
871 The default is 262143.
873 .B sockbuf_max_incoming_auth <integer>
874 Specify the maximum incoming LDAP PDU size for authenticated sessions.
875 The default is 4194303.
878 Specify the maximum size of the primary thread pool.
879 The default is 16; the minimum value is 2.
881 .B timelimit {<integer>|unlimited}
883 .B timelimit time[.{soft|hard}]=<integer> [...]
884 Specify the maximum number of seconds (in real time)
886 will spend answering a search request. The default time limit is 3600.
889 to specify no limits.
890 The second format allows a fine grain setting of the time limits.
891 Extra args can be added on the same line.
894 for an explanation of the different flags.
896 .B tool-threads <integer>
897 Specify the maximum number of threads to use in tool mode.
898 This should not be greater than the number of CPUs in the system.
900 .\"ucdata-path is obsolete / ignored...
902 .\".B ucdata-path <path>
903 .\"Specify the path to the directory containing the Unicode character
904 .\"tables. The default path is DATADIR/ucdata.
908 is built with support for Transport Layer Security, there are more options
911 .B TLSCipherSuite <cipher-suite-spec>
912 Permits configuring what ciphers will be accepted and the preference order.
913 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
915 TLSCipherSuite HIGH:MEDIUM:+SSLv2
917 To check what ciphers a given spec selects, use:
919 openssl ciphers -v <cipher-suite-spec>
921 .B TLSCACertificateFile <filename>
922 Specifies the file that contains certificates for all of the Certificate
927 .B TLSCACertificatePath <path>
928 Specifies the path of a directory that contains Certificate Authority
929 certificates in separate individual files. Usually only one of this
930 or the TLSCACertificateFile is used.
932 .B TLSCertificateFile <filename>
933 Specifies the file that contains the
937 .B TLSCertificateKeyFile <filename>
938 Specifies the file that contains the
940 server private key that matches the certificate stored in the
941 .B TLSCertificateFile
942 file. Currently, the private key must not be protected with a password, so
943 it is of critical importance that it is protected carefully.
945 .B TLSDHParamFile <filename>
946 This directive specifies the file that contains parameters for Diffie-Hellman
947 ephemeral key exchange. This is required in order to use a DSA certificate on
948 the server. If multiple sets of parameters are present in the file, all of
949 them will be processed. Note that setting this option may also enable
950 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
951 You should append "!ADH" to your cipher suites if you have changed them
952 from the default, otherwise no certificate exchanges or verification will
955 .B TLSRandFile <filename>
956 Specifies the file to obtain random bits from when /dev/[u]random
957 is not available. Generally set to the name of the EGD/PRNGD socket.
958 The environment variable RANDFILE can also be used to specify the filename.
960 .B TLSVerifyClient <level>
961 Specifies what checks to perform on client certificates in an
962 incoming TLS session, if any.
965 can be specified as one of the following keywords:
971 will not ask the client for a certificate.
974 The client certificate is requested. If no certificate is provided,
975 the session proceeds normally. If a bad certificate is provided,
976 it will be ignored and the session proceeds normally.
979 The client certificate is requested. If no certificate is provided,
980 the session proceeds normally. If a bad certificate is provided,
981 the session is immediately terminated.
983 .B demand | hard | true
984 These keywords are all equivalent, for compatibility reasons.
985 The client certificate is requested. If no certificate is provided,
986 or a bad certificate is provided, the session is immediately terminated.
988 Note that a valid client certificate is required in order to use the
989 SASL EXTERNAL authentication mechanism with a TLS session. As such,
992 setting must be chosen to enable SASL EXTERNAL authentication.
995 .B TLSCRLCheck <level>
996 Specifies if the Certificate Revocation List (CRL) of the CA should be
997 used to verify if the client certificates have not been revoked. This
999 .B TLSCACertificatePath
1000 parameter to be set.
1002 can be specified as one of the following keywords:
1006 No CRL checks are performed
1009 Check the CRL of the peer certificate
1012 Check the CRL for a whole certificate chain
1014 .SH GENERAL BACKEND OPTIONS
1015 Options in this section only apply to the configuration file section
1016 for the specified backend. They are supported by every
1019 .B backend <databasetype>
1020 Mark the beginning of a backend definition. <databasetype>
1038 depending on which backend will serve the database.
1040 .SH GENERAL DATABASE OPTIONS
1041 Options in this section only apply to the configuration file section
1042 for the database in which they are defined. They are supported by every
1043 type of backend. Note that the
1047 option are mandatory for each database.
1049 .B database <databasetype>
1050 Mark the beginning of a new database instance definition. <databasetype>
1068 depending on which backend will serve the database.
1073 will automatically maintain the
1074 modifiersName, modifyTimestamp, creatorsName, and
1075 createTimestamp attributes for entries. By default, lastmod is on.
1077 .B limits <who> <limit> [<limit> [...]]
1078 Specify time and size limits based on who initiated an operation.
1085 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1091 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1096 matches all unauthenticated clients.
1099 matches all authenticated clients;
1102 dn pattern is assumed unless otherwise specified by qualifying
1103 the (optional) key string
1109 (which are synonyms), to require an exact match; with
1111 to require exactly one level of depth match; with
1113 to allow any level of depth match, including the exact match; with
1115 to allow any level of depth match, not including the exact match;
1117 explicitly requires the (default) match based on POSIX (''extended'')
1118 regular expression pattern.
1121 matches unbound operations; the
1124 The same behavior is obtained by using the
1131 with the optional objectClass
1137 sets the limits for any DN listed in the values of the
1143 group objectClass (default
1145 whose DN exactly matches
1148 The currently supported limits are
1153 The syntax for time limits is
1154 .BR time[.{soft|hard}]=<integer> ,
1157 is the number of seconds slapd will spend answering a search request.
1158 If no time limit is explicitly requested by the client, the
1160 limit is used; if the requested time limit exceeds the
1163 .\".I "Administrative limit exceeded"
1164 .\"error is returned.
1165 limit, the value of the limit is used instead.
1168 limit is set to the keyword
1170 the soft limit is used in either case; if it is set to the keyword
1172 no hard limit is enforced.
1173 Explicit requests for time limits smaller or equal to the
1176 If no limit specifier is set, the value is assigned to the
1182 to preserve the original behavior.
1184 The syntax for size limits is
1185 .BR size[.{soft|hard|unchecked}]=<integer> ,
1188 is the maximum number of entries slapd will return answering a search
1190 If no size limit is explicitly requested by the client, the
1192 limit is used; if the requested size limit exceeds the
1195 .\".I "Administrative limit exceeded"
1196 .\"error is returned.
1197 limit, the value of the limit is used instead.
1200 limit is set to the keyword
1202 the soft limit is used in either case; if it is set to the keyword
1204 no hard limit is enforced.
1205 Explicit requests for size limits smaller or equal to the
1210 specifier sets a limit on the number of candidates a search request is allowed
1212 The rationale behind it is that searches for non-properly indexed
1213 attributes may result in large sets of candidates, which must be
1216 to determine whether they match the search filter or not.
1219 limit provides a means to drop such operations before they are even
1221 If the selected candidates exceed the
1223 limit, the search will abort with
1224 .IR "Unwilling to perform" .
1225 If it is set to the keyword
1227 no limit is applied (the default).
1230 the search is not even performed; this can be used to disallow searches
1231 for a specific set of users.
1232 If no limit specifier is set, the value is assigned to the
1238 to preserve the original behavior.
1240 In case of no match, the global limits are used.
1241 The default values are the same of
1250 control is requested, the
1252 size limit is used by default, because the request of a specific page size
1253 is considered an explicit request for a limitation on the number
1254 of entries to be returned.
1255 However, the size limit applies to the total count of entries returned within
1256 the search, and not to a single page.
1257 Additional size limits may be enforced; the syntax is
1258 .BR size.pr={<integer>|noEstimate|unlimited} ,
1261 is the max page size if no explicit limit is set; the keyword
1263 inhibits the server from returning an estimate of the total number
1264 of entries that might be returned
1265 (note: the current implementation does not return any estimate).
1268 indicates that no limit is applied to the pagedResults control page size.
1270 .B size.prtotal={<integer>|unlimited|disabled}
1271 allows to set a limit on the total number of entries that a pagedResults
1272 control allows to return.
1273 By default it is set to the
1278 is the max number of entries that the whole search with pagedResults control
1282 to allow unlimited number of entries to be returned, e.g. to allow
1283 the use of the pagedResults control as a means to circumvent size
1284 limitations on regular searches; the keyword
1286 disables the control, i.e. no paged results can be returned.
1287 Note that the total number of entries returned when the pagedResults control
1288 is requested cannot exceed the
1290 size limit of regular searches unless extended by the
1295 .B maxderefdepth <depth>
1296 Specifies the maximum number of aliases to dereference when trying to
1297 resolve an entry, used to avoid infinite alias loops. The default is 1.
1299 .B overlay <overlay-name>
1300 Add the specified overlay to this database. An overlay is a piece of
1301 code that intercepts database operations in order to extend or change
1302 them. Overlays are pushed onto
1303 a stack over the database, and so they will execute in the reverse
1304 of the order in which they were configured and the database itself
1305 will receive control last of all.
1307 .B readonly on | off
1308 This option puts the database into "read-only" mode. Any attempts to
1309 modify the database will return an "unwilling to perform" error. By
1310 default, readonly is off.
1313 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1314 .B [starttls=yes|critical]
1315 .B [suffix=<suffix> [...]]
1316 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1317 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1318 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1319 .B [attr[!]=<attr list>]
1321 Specify a replication site for this database. Refer to the "OpenLDAP
1322 Administrator's Guide" for detailed information on setting up a replicated
1324 directory service. Zero or more
1326 instances can be used to select the subtrees that will be replicated
1327 (defaults to all the database).
1329 is deprecated in favor of the
1333 allows the replica LDAP server to be specified as an LDAP URI.
1338 requires the options
1342 and should only be used when adequate security services
1343 (e.g TLS or IPSEC) are in place. A
1349 Specific security properties (as with the
1351 keyword above) for a SASL bind can be set with the
1353 option. A non-default SASL realm can be set with the
1358 will use Kerberos, a kerberos instance should be given in
1362 can be given after the
1364 keyword to allow the selective replication of the listed attributes only;
1367 mark is used, the list is considered exclusive, i.e. the listed attributes
1369 If an objectClass is listed, all the related attributes
1370 are (are not) replicated.
1373 .B replogfile <filename>
1374 Specify the name of the replication log file to log changes to.
1375 The replication log is typically written by
1380 .BR slapd.replog (5)
1381 for more information. The specified file should be located
1382 in a directory with limited read/write/execute access as the replication
1383 logs may contain sensitive information.
1385 .B restrict <oplist>
1386 Specify a whitespace separated list of operations that are restricted.
1387 If defined inside a database specification, restrictions apply only
1388 to that database, otherwise they are global.
1389 Operations can be any of
1394 .BR extended[=<OID>] ,
1398 or the special pseudo-operations
1402 which respectively summarize read and write operations.
1410 keyword allows to indicate the OID of the specific operation
1414 Specify the distinguished name that is not subject to access control
1415 or administrative limit restrictions for operations on this database.
1416 This DN may or may not be associated with an entry. An empty root
1417 DN (the default) specifies no root access is to be granted. It is
1418 recommended that the rootdn only be specified when needed (such as
1419 when initially populating a database). If the rootdn is within
1420 a namingContext (suffix) of the database, a simple bind password
1421 may also be provided using the
1423 directive. Note that the rootdn is always needed when using syncrepl.
1425 .B rootpw <password>
1426 Specify a password (or hash of the password) for the rootdn. The
1427 password can only be set if the rootdn is within the namingContext
1428 (suffix) of the database.
1429 This option accepts all RFC 2307 userPassword formats known to
1432 description) as well as cleartext.
1434 may be used to generate a hash of a password. Cleartext
1435 and \fB{CRYPT}\fP passwords are not recommended. If empty
1436 (the default), authentication of the root DN is by other means
1437 (e.g. SASL). Use of SASL is encouraged.
1439 .B suffix <dn suffix>
1440 Specify the DN suffix of queries that will be passed to this
1441 backend database. Multiple suffix lines can be given and at least one is
1442 required for each database definition.
1443 If the suffix of one database is "inside" that of another, the database
1444 with the inner suffix must come first in the configuration file.
1446 .B subordinate [advertise]
1447 Specify that the current backend database is a subordinate of another
1448 backend database. A subordinate database may have only one suffix. This
1449 option may be used to glue multiple databases into a single namingContext.
1450 If the suffix of the current database is within the namingContext of a
1451 superior database, searches against the superior database will be
1452 propagated to the subordinate as well. All of the databases
1453 associated with a single namingContext should have identical rootdns.
1454 Behavior of other LDAP operations is unaffected by this setting. In
1455 particular, it is not possible to use moddn to move an entry from
1456 one subordinate to another subordinate within the namingContext.
1458 If the optional \fBadvertise\fP flag is supplied, the naming context of
1459 this database is advertised in the root DSE. The default is to hide this
1460 database context, so that only the superior context is visible.
1467 are used on the superior database, any glued subordinates that support
1468 these tools are opened as well.
1470 Databases that are glued together should usually be configured with the
1471 same indices (assuming they support indexing), even for attributes that
1472 only exist in some of these databases. In general, all of the glued
1473 databases should be configured as similarly as possible, since the intent
1474 is to provide the appearance of a single directory.
1476 Note that the \fIsubordinate\fP functionality is implemented internally
1477 by the \fIglue\fP overlay and as such its behavior will interact with other
1478 overlays in use. By default, the glue overlay is automatically configured as
1479 the last overlay on the superior backend. Its position on the backend
1480 can be explicitly configured by setting an \fBoverlay glue\fP directive
1481 at the desired position. This explicit configuration is necessary e.g.
1482 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1483 in order to work over all of the glued databases. E.g.
1487 suffix dc=example,dc=com
1495 .B syncrepl rid=<replica ID>
1496 .B provider=ldap[s]://<hostname>[:port]
1497 .B [type=refreshOnly|refreshAndPersist]
1498 .B [interval=dd:hh:mm:ss]
1499 .B [retry=[<retry interval> <# of retries>]+]
1500 .B [searchbase=<base DN>]
1501 .B [filter=<filter str>]
1502 .B [scope=sub|one|base]
1503 .B [attrs=<attr list>]
1505 .B [sizelimit=<limit>]
1506 .B [timelimit=<limit>]
1507 .B [schemachecking=on|off]
1508 .B [starttls=yes|critical]
1509 .B [bindmethod=simple|sasl]
1511 .B [saslmech=<mech>]
1512 .B [authcid=<identity>]
1513 .B [authzid=<identity>]
1514 .B [credentials=<passwd>]
1516 .B [secprops=<properties>]
1517 .B [logbase=<base DN>]
1518 .B [logfilter=<filter str>]
1519 .B [syncdata=default|accesslog|changelog]
1521 Specify the current database as a replica which is kept up-to-date with the
1522 master content by establishing the current
1524 as a replication consumer site running a
1527 The replica content is kept synchronized to the master content using
1528 the LDAP Content Synchronization protocol. Refer to the
1529 "OpenLDAP Administrator's Guide" for detailed information on
1530 setting up a replicated
1532 directory service using the
1536 identifies the current
1538 directive within the replication consumer site.
1539 It is a non-negative integer having no more than three digits.
1541 specifies the replication provider site containing the master content
1542 as an LDAP URI. If <port> is not given, the standard LDAP port number
1543 (389 or 636) is used. The content of the
1545 replica is defined using a search
1546 specification as its result set. The consumer
1548 will send search requests to the provider
1550 according to the search specification. The search specification includes
1551 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1554 parameters as in the normal search specification.
1555 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1556 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1557 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1558 attributes, and \fBattrsonly\fP is unset by default.
1559 The \fBsizelimit\fP and \fBtimelimit\fP only
1560 accept "unlimited" and positive integers, and both default to "unlimited".
1561 The LDAP Content Synchronization protocol has two operation types.
1564 operation, the next synchronization search operation
1565 is periodically rescheduled at an interval time (specified by
1567 parameter; 1 day by default)
1568 after each synchronization operation finishes.
1570 .B refreshAndPersist
1571 operation, a synchronization search remains persistent in the provider slapd.
1572 Further updates to the master replica will generate
1573 .B searchResultEntry
1574 to the consumer slapd as the search responses to the persistent
1575 synchronization search.
1576 If an error occurs during replication, the consumer will attempt to
1577 reconnect according to the
1579 parameter which is a list of the <retry interval> and <# of retries> pairs.
1580 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1581 for the first 10 times and then retry every 300 seconds for the next 3
1582 times before stop retrying. The `+' in <# of retries> means indefinite
1583 number of retries until success.
1584 The schema checking can be enforced at the LDAP Sync
1585 consumer site by turning on the
1587 parameter. The default is off.
1590 parameter specifies use of the StartTLS extended operation
1591 to establish a TLS session before Binding to the provider. If the
1593 argument is supplied, the session will be aborted if the StartTLS request
1594 fails. Otherwise the syncrepl session continues without TLS.
1599 requires the options
1603 and should only be used when adequate security services
1604 (e.g. TLS or IPSEC) are in place.
1611 Depending on the mechanism, an authentication identity and/or
1612 credentials can be specified using
1618 parameter may be used to specify an authorization identity.
1619 Specific security properties (as with the
1621 keyword above) for a SASL bind can be set with the
1623 option. A non default SASL realm can be set with the
1627 Rather than replicating whole entries, the consumer can query logs of
1628 data modifications. This mode of operation is referred to as \fIdelta
1629 syncrepl\fP. In addition to the above parameters, the
1633 parameters must be set appropriately for the log that will be used. The
1635 parameter must be set to either "accesslog" if the log conforms to the
1636 .BR slapo-accesslog (5)
1637 log format, or "changelog" if the log conforms
1638 to the obsolete \fIchangelog\fP format. If the
1640 parameter is omitted or set to "default" then the log parameters are
1645 This option is only applicable in a slave
1646 database updated using
1648 It specifies the DN permitted to update (subject to access controls)
1649 the replica (typically, this is the DN
1651 binds to update the replica). Generally, this DN
1658 Specify the referral to pass back when
1660 is asked to modify a replicated local database.
1661 If specified multiple times, each url is provided.
1663 .SH DATABASE-SPECIFIC OPTIONS
1664 Each database may allow specific configuration options; they are
1665 documented separately in the backends' manual pages.
1667 The following backends can be compiled into slapd.
1668 They are documented in the
1669 .BR slapd-<backend> (5)
1673 This is the recommended primary backend for a normal slapd database.
1674 It takes care to configure it properly.
1675 It uses the transactional database interface of the Sleepycat Berkeley
1676 DB (BDB) package to store data.
1679 This backend is used to manage the configuration of slapd run-time.
1682 This backend is experimental.
1683 It serves up referrals based upon SRV resource records held in the
1687 This is a variant of the BDB backend that uses a hierarchical database
1688 layout which supports subtree renames.
1691 This backend acts as a proxy to forward incoming requests to another
1695 This is an easy-to-configure but obsolete database backend. It
1696 does not offer the data durability features of the BDB and HDB
1697 backends and hence is deprecated in favor of these robust backends.
1698 LDBM uses lightweight non-transactional DB interfaces,
1699 such as those providing by GDBM or Berkeley DB, to store data.
1702 This database uses the filesystem to build the tree structure
1703 of the database, using plain ascii files to store data.
1704 Its usage should be limited to very simple databases, where performance
1705 is not a requirement.
1708 This backend performs basic LDAP proxying with respect to a set of
1709 remote LDAP servers. It is an enhancement of the ldap backend.
1712 This backend provides information about the running status of the slapd
1716 Operations in this backend succeed but do nothing.
1719 This backend is provided for demonstration purposes only.
1720 It serves up user account information from the system
1725 This backend embeds a
1727 interpreter into slapd.
1728 It runs Perl subroutines to implement LDAP operations.
1731 This backend is experimental.
1732 It redirects LDAP operations to another database
1733 in the same server, based on the naming context of the request.
1734 Its use requires the
1738 for details) to rewrite the naming context of the request.
1739 It is primarily intended to implement virtual views on databases
1740 that actually store data.
1743 This backend executes external programs to implement LDAP operations.
1744 It is primarily intended to be used in prototypes.
1747 This backend is experimental.
1748 It services LDAP requests from an SQL database.
1750 The following overlays can be compiled into slapd.
1751 They are documented in the
1752 .BR slapo-<overlay> (5)
1757 This overlay can record accesses to a given backend database on another
1762 This overlay records changes on a given backend database to an LDIF log
1764 By default it is not built.
1768 This overlay allows automatic referral chasing when a referral would
1769 have been returned, either when configured by the server or when
1770 requested by the client.
1774 This overlay allows selected operations to be denied, similar to the
1775 \fBrestrict\fP option.
1779 This is a demo overlay which extends the Compare operation to detect
1780 members of a dynamic group.
1781 It has no effect on any other operations.
1785 This overlay allows expansion of dynamic groups and more.
1789 This overlay maintains a service entry in the database with the DN,
1790 modification type, modifiersName and modifyTimestamp of the last write
1791 operation performed on that database.
1795 This overlay allows caching of LDAP search requests in a local database.
1796 It is most often used with the ldap or meta backends.
1800 This overlay provides a variety of password control mechanisms,
1801 e.g. password aging, password reuse and duplication control, mandatory
1802 password resets, etc.
1805 Referential Integrity.
1806 This overlay can be used with a backend database such as
1808 to maintain the cohesiveness of a schema which utilizes reference
1813 This overlay is useful to test the behavior of clients when
1814 server-generated erroneous and/or unusual responses occur.
1818 This overlay is experimental.
1819 It performs basic DN/data rewrite and
1820 objectClass/attributeType mapping.
1824 This overlay implements the provider-side support for
1826 replication, including persistent search functionality.
1830 This overlay can be used with a backend database such as
1832 to create a "translucent proxy".
1833 Content of entries retrieved from a remote LDAP server can be partially
1834 overridden by the database.
1837 Attribute Uniqueness.
1838 This overlay can be used with a backend database such as
1840 to enforce the uniqueness of some or all attributes within a subtree.
1843 Here is a short example of a configuration file:
1847 include SYSCONFDIR/schema/core.schema
1848 pidfile LOCALSTATEDIR/slapd.pid
1850 # Subtypes of "name" (e.g. "cn" and "ou") with the
1851 # option ";x-hidden" can be searched for/compared,
1852 # but are not shown. See \fBslapd.access\fP(5).
1853 attributeoptions x-hidden lang-
1854 access to attr=name;x-hidden by * =cs
1856 # Protect passwords. See \fBslapd.access\fP(5).
1857 access to attrs=userPassword by * auth
1858 # Read access to other attributes and entries.
1859 access to * by * read
1862 suffix "dc=our-domain,dc=com"
1863 # The database directory MUST exist prior to
1864 # running slapd AND should only be accessible
1865 # by the slapd/tools. Mode 0700 recommended.
1866 directory LOCALSTATEDIR/openldap-data
1867 # Indices to maintain
1868 index objectClass eq
1869 index cn,sn,mail pres,eq,approx,sub
1871 # We serve small clients that do not handle referrals,
1872 # so handle remote lookups on their behalf.
1875 uri ldap://ldap.some-server.com/
1880 "OpenLDAP Administrator's Guide" contains a longer annotated
1881 example of a configuration file.
1882 The original ETCDIR/slapd.conf is another example.
1886 default slapd configuration file
1890 .BR slapd\-dnssrv (5),
1892 .BR slapd\-ldap (5),
1893 .BR slapd\-ldbm (5),
1894 .BR slapd\-ldif (5),
1895 .BR slapd\-meta (5),
1896 .BR slapd\-monitor (5),
1897 .BR slapd\-null (5),
1898 .BR slapd\-passwd (5),
1899 .BR slapd\-perl (5),
1900 .BR slapd\-relay (5),
1901 .BR slapd\-shell (5),
1903 .BR slapd.access (5),
1904 .BR slapd.plugin (5),
1905 .BR slapd.replog (5),
1917 Known overlays are documented in
1918 .BR slapo\-accesslog (5),
1919 .BR slapo\-auditlog (5),
1920 .BR slapo\-chain (5),
1921 .BR slapo\-dynlist (5),
1922 .BR slapo\-lastmod (5),
1923 .BR slapo\-pcache (5),
1924 .BR slapo\-ppolicy (5),
1925 .BR slapo\-refint (5),
1926 .BR slapo\-retcode (5),
1928 .BR slapo\-syncprov (5),
1929 .BR slapo\-translucent (5),
1930 .BR slapo\-unique (5).
1932 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1933 .SH ACKNOWLEDGEMENTS
1935 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1937 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob