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 2251 reserves options beginning with `x-' for private experiments.
137 Other options should be registered with IANA, see RFC 3383 section 3.4.
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 2252.
157 The slapd parser extends the RFC 2252 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.
415 disables simple (bind) authentication.
417 disables forcing session to anonymous status (see also
418 .BR tls_authc ) upon StartTLS operation receipt.
420 dissallow the StartTLS operation if authenticated (see also
424 .B ditcontentrule "(\ <oid>\
426 [DESC\ <description>]\
433 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
434 The slapd parser extends the RFC 2252 definition by allowing string
435 forms as well as numeric OIDs to be used for the attribute OID and
436 attribute syntax OID.
442 .B gentlehup { on | off }
443 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
445 will stop listening for new connections, but will not close the
446 connections to the current clients. Future write operations return
447 unwilling-to-perform, though. Slapd terminates when all clients
448 have closed their connections (if they ever do), or \- as before \-
449 if it receives a SIGTERM signal. This can be useful if you wish to
450 terminate the server and start a new
453 .B with another database,
454 without disrupting the currently active clients.
455 The default is off. You may wish to use
457 along with this option.
459 .B idletimeout <integer>
460 Specify the number of seconds to wait before forcibly closing
461 an idle client connection. A idletimeout of 0 disables this
462 feature. The default is 0.
464 .B include <filename>
465 Read additional configuration information from the given file before
466 continuing with the next line of the current file.
468 .B index_substr_if_minlen <integer>
469 Specify the minimum length for subinitial and subfinal indices. An
470 attribute value must have at least this many characters in order to be
471 processed by the indexing functions. The default is 2.
473 .B index_substr_if_maxlen <integer>
474 Specify the maximum length for subinitial and subfinal indices. Only
475 this many characters of an attribute value will be processed by the
476 indexing functions; any excess characters are ignored. The default is 4.
478 .B index_substr_any_len <integer>
479 Specify the length used for subany indices. An attribute value must have
480 at least this many characters in order to be processed. Attribute values
481 longer than this length will be processed in segments of this length. The
482 default is 4. The subany index will also be used in subinitial and
483 subfinal index lookups when the filter string is longer than the
484 .I index_substr_if_maxlen
487 .B index_substr_any_step <integer>
488 Specify the steps used in subany index lookups. This value sets the offset
489 for the segments of a filter string that are processed for a subany index
490 lookup. The default is 2. For example, with the default values, a search
491 using this filter "cn=*abcdefgh*" would generate index lookups for
492 "abcd", "cdef", and "efgh".
494 .\"-- NEW_LOGGING option --
496 .\".B logfile <filename>
497 .\"Specify a file for recording debug log messages. By default these messages
498 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
499 .\"copies messages to both stderr and the logfile.
502 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
503 such as those to the ldapi:// listener. For a description of SSF values,
507 option description. The default is 71.
509 .B loglevel <integer> [...]
510 Specify the level at which debugging statements and operation
511 statistics should be syslogged (currently logged to the
513 LOG_LOCAL4 facility).
514 They must be considered subsystems rather than increasingly verbose
516 Some messages with higher priority are logged regardless
517 of the configured loglevel as soon as some logging is configured,
518 otherwise anything is logged at all.
519 Log levels are additive, and available levels are:
530 debug packet handling
534 heavy trace debugging (function args)
538 connection management
542 print out packets sent and received
546 search filter processing
550 configuration file processing
554 access control list processing
558 stats log connections/operations/results
562 stats log entries sent
566 print communication with shell backends
578 \"data indexing (unused)
586 only messages that get logged whatever log level is set
589 The desired log level can be input as a single integer that combines
590 the (ORed) desired levels, both in decimal or in hexadecimal notation,
591 as a list of integers (that are ORed internally),
592 or as a list of the names that are shown between brackets, such that
605 can be used as a shortcut to enable logging at all levels (equivalent to -1).
608 or the equivalent integer representation, causes those messages
609 that are logged regardless of the configured loglevel to be logged.
610 In fact, if no loglevel (or a 0 level) is defined, no logging occurs,
613 level is required to have high priority messages logged.
616 .B moduleload <filename>
617 Specify the name of a dynamically loadable module to load. The filename
618 may be an absolute path name or a simple filename. Non-absolute names
619 are searched for in the directories specified by the
621 option. This option and the
623 option are only usable if slapd was compiled with --enable-modules.
625 .B modulepath <pathspec>
626 Specify a list of directories to search for loadable modules. Typically
627 the path is colon-separated but this depends on the operating system.
630 .B objectclass "(\ <oid>\
632 [DESC\ <description>]\
635 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
636 [MUST\ <oids>] [MAY\ <oids>] )"
638 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
639 The slapd parser extends the RFC 2252 definition by allowing string
640 forms as well as numeric OIDs to be used for the object class OID.
644 description.) Object classes are "STRUCTURAL" by default.
647 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
648 Define a string name that equates to the given OID. The string can be used
649 in place of the numeric OID in objectclass and attribute definitions. The
650 name can also be used with a suffix of the form ":xx" in which case the
651 value "oid.xx" will be used.
653 .B password-hash <hash> [<hash>...]
654 This option configures one or more hashes to be used in generation of user
655 passwords stored in the userPassword attribute during processing of
656 LDAP Password Modify Extended Operations (RFC 3062).
657 The <hash> must be one of
671 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
676 use the MD5 algorithm (RFC 1321), the latter with a seed.
683 indicates that the new password should be
684 added to userPassword as clear text.
686 Note that this option does not alter the normal user applications
687 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
689 .B password\-crypt\-salt\-format <format>
690 Specify the format of the salt passed to
692 when generating {CRYPT} passwords (see
694 during processing of LDAP Password Modify Extended Operations (RFC 3062).
696 This string needs to be in
698 format and may include one (and only one) %s conversion.
699 This conversion will be substituted with a string of random
700 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
701 provides a two character salt and "$1$%.8s" tells some
702 versions of crypt(3) to use an MD5 algorithm and provides
703 8 random characters of salt. The default is "%s", which
704 provides 31 characters of salt.
706 .B pidfile <filename>
707 The ( absolute ) name of a file that will hold the
709 server's process ID ( see
711 ) if started without the debugging command line option.
714 Specify the referral to pass back when
716 cannot find a local database to handle a request.
717 If specified multiple times, each url is provided.
720 The ( absolute ) name of a file that will hold the
722 server's command line options
723 if started without the debugging command line option.
724 If it appears after a
726 directive, the args file is specific to the
728 instance that handles that replication log.
731 The ( absolute ) name of a file that will hold the
733 server's process ID ( see
735 ) if started without the debugging command line option.
736 If it appears after a
738 directive, the pid file is specific to the
740 instance that handles that replication log.
742 .B replicationinterval
743 The number of seconds
745 waits before checking the replogfile for changes.
746 If it appears after a
748 directive, the replication interval is specific to the
750 instance that handles that replication log.
752 .B require <conditions>
753 Specify a set of conditions (separated by white space) to
754 require (default none).
755 The directive may be specified globally and/or per-database.
757 requires bind operation prior to directory operations.
759 requires session to be using LDAP version 3.
761 requires authentication prior to directory operations.
763 requires SASL authentication prior to directory operations.
765 requires strong authentication prior to directory operations.
766 The strong keyword allows protected "simple" authentication
767 as well as SASL authentication.
769 may be used to require no conditions (useful for clearly globally
770 set conditions within a particular database).
772 .B reverse-lookup on | off
773 Enable/disable client name unverified reverse lookup (default is
775 if compiled with --enable-rlookups).
778 Specify the name of an LDIF(5) file containing user defined attributes
779 for the root DSE. These attributes are returned in addition to the
780 attributes normally produced by slapd.
783 Used to specify the fully qualified domain name used for SASL processing.
785 .B sasl-realm <realm>
786 Specify SASL realm. Default is empty.
788 .B sasl-secprops <properties>
789 Used to specify Cyrus SASL security properties.
792 flag (without any other properties) causes the flag properties
793 default, "noanonymous,noplain", to be cleared.
796 flag disables mechanisms susceptible to simple passive attacks.
799 flag disables mechanisms susceptible to active attacks.
802 flag disables mechanisms susceptible to passive dictionary attacks.
805 flag disables mechanisms which support anonymous login.
808 flag require forward secrecy between sessions.
811 require mechanisms which pass client credentials (and allow
812 mechanisms which can pass credentials to do so).
815 property specifies the minimum acceptable
816 .I security strength factor
817 as an integer approximate to effective key length used for
818 encryption. 0 (zero) implies no protection, 1 implies integrity
819 protection only, 56 allows DES or other weak ciphers, 112
820 allows triple DES and other strong ciphers, 128 allows RC4,
821 Blowfish and other modern strong ciphers. The default is 0.
824 property specifies the maximum acceptable
825 .I security strength factor
826 as an integer (see minssf description). The default is INT_MAX.
829 property specifies the maximum security layer receive buffer
830 size allowed. 0 disables security layers. The default is 65536.
833 Specify the distinguished name for the subschema subentry that
834 controls the entries on this server. The default is "cn=Subschema".
836 .B security <factors>
837 Specify a set of security strength factors (separated by white space)
841 option for a description of security strength factors).
842 The directive may be specified globally and/or per-database.
844 specifies the overall security strength factor.
846 specifies the transport security strength factor.
848 specifies the TLS security strength factor.
850 specifies the SASL security strength factor.
852 specifies the overall security strength factor to require for
854 .B update_transport=<n>
855 specifies the transport security strength factor to require for
858 specifies the TLS security strength factor to require for
861 specifies the SASL security strength factor to require for
864 specifies the security strength factor required for
866 username/password authentication.
869 factor is measure of security provided by the underlying transport,
870 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
872 .B sizelimit {<integer>|unlimited}
874 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
875 Specify the maximum number of entries to return from a search operation.
876 The default size limit is 500.
879 to specify no limits.
880 The second format allows a fine grain setting of the size limits.
881 Extra args can be added on the same line.
884 for an explanation of the different flags.
886 .B sockbuf_max_incoming <integer>
887 Specify the maximum incoming LDAP PDU size for anonymous sessions.
888 The default is 262143.
890 .B sockbuf_max_incoming_auth <integer>
891 Specify the maximum incoming LDAP PDU size for authenticated sessions.
892 The default is 4194303.
895 Specify the maximum size of the primary thread pool.
898 .B timelimit {<integer>|unlimited}
900 .B timelimit time[.{soft|hard}]=<integer> [...]
901 Specify the maximum number of seconds (in real time)
903 will spend answering a search request. The default time limit is 3600.
906 to specify no limits.
907 The second format allows a fine grain setting of the time limits.
908 Extra args can be added on the same line.
911 for an explanation of the different flags.
913 .B tool-threads <integer>
914 Specify the maximum number of threads to use in tool mode.
915 This should not be greater than the number of CPUs in the system.
917 .\"ucdata-path is obsolete / ignored...
919 .\".B ucdata-path <path>
920 .\"Specify the path to the directory containing the Unicode character
921 .\"tables. The default path is DATADIR/ucdata.
925 is built with support for Transport Layer Security, there are more options
928 .B TLSCipherSuite <cipher-suite-spec>
929 Permits configuring what ciphers will be accepted and the preference order.
930 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
932 TLSCipherSuite HIGH:MEDIUM:+SSLv2
934 To check what ciphers a given spec selects, use:
936 openssl ciphers -v <cipher-suite-spec>
938 .B TLSCACertificateFile <filename>
939 Specifies the file that contains certificates for all of the Certificate
944 .B TLSCACertificatePath <path>
945 Specifies the path of a directory that contains Certificate Authority
946 certificates in separate individual files. Usually only one of this
947 or the TLSCACertificateFile is used.
949 .B TLSCertificateFile <filename>
950 Specifies the file that contains the
954 .B TLSCertificateKeyFile <filename>
955 Specifies the file that contains the
957 server private key that matches the certificate stored in the
958 .B TLSCertificateFile
959 file. Currently, the private key must not be protected with a password, so
960 it is of critical importance that it is protected carefully.
962 .B TLSDHParamFile <filename>
963 This directive specifies the file that contains parameters for Diffie-Hellman
964 ephemeral key exchange. This is required in order to use a DSA certificate on
965 the server. If multiple sets of parameters are present in the file, all of
966 them will be processed. Note that setting this option may also enable
967 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
968 You should append "!ADH" to your cipher suites if you have changed them
969 from the default, otherwise no certificate exchanges or verification will
972 .B TLSRandFile <filename>
973 Specifies the file to obtain random bits from when /dev/[u]random
974 is not available. Generally set to the name of the EGD/PRNGD socket.
975 The environment variable RANDFILE can also be used to specify the filename.
977 .B TLSVerifyClient <level>
978 Specifies what checks to perform on client certificates in an
979 incoming TLS session, if any.
982 can be specified as one of the following keywords:
988 will not ask the client for a certificate.
991 The client certificate is requested. If no certificate is provided,
992 the session proceeds normally. If a bad certificate is provided,
993 it will be ignored and the session proceeds normally.
996 The client certificate is requested. If no certificate is provided,
997 the session proceeds normally. If a bad certificate is provided,
998 the session is immediately terminated.
1000 .B demand | hard | true
1001 These keywords are all equivalent, for compatibility reasons.
1002 The client certificate is requested. If no certificate is provided,
1003 or a bad certificate is provided, the session is immediately terminated.
1005 Note that a valid client certificate is required in order to use the
1006 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1009 setting must be chosen to enable SASL EXTERNAL authentication.
1012 .B TLSCRLCheck <level>
1013 Specifies if the Certificate Revocation List (CRL) of the CA should be
1014 used to verify if the client certificates have not been revoked. This
1016 .B TLSCACertificatePath
1017 parameter to be set.
1019 can be specified as one of the following keywords:
1023 No CRL checks are performed
1026 Check the CRL of the peer certificate
1029 Check the CRL for a whole certificate chain
1031 .SH GENERAL BACKEND OPTIONS
1032 Options in this section only apply to the configuration file section
1033 for the specified backend. They are supported by every
1036 .B backend <databasetype>
1037 Mark the beginning of a backend definition. <databasetype>
1055 depending on which backend will serve the database.
1057 .SH GENERAL DATABASE OPTIONS
1058 Options in this section only apply to the configuration file section
1059 for the database in which they are defined. They are supported by every
1060 type of backend. Note that the
1064 option are mandatory for each database.
1066 .B database <databasetype>
1067 Mark the beginning of a new database instance definition. <databasetype>
1085 depending on which backend will serve the database.
1090 will automatically maintain the
1091 modifiersName, modifyTimestamp, creatorsName, and
1092 createTimestamp attributes for entries. By default, lastmod is on.
1094 .B limits <who> <limit> [<limit> [...]]
1095 Specify time and size limits based on who initiated an operation.
1102 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1108 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1113 matches all unauthenticated clients.
1116 matches all authenticated clients;
1119 dn pattern is assumed unless otherwise specified by qualifying
1120 the (optional) key string
1126 (which are synonyms), to require an exact match; with
1128 to require exactly one level of depth match; with
1130 to allow any level of depth match, including the exact match; with
1132 to allow any level of depth match, not including the exact match;
1134 explicitly requires the (default) match based on POSIX (''extended'')
1135 regular expression pattern.
1138 matches unbound operations; the
1141 The same behavior is obtained by using the
1148 with the optional objectClass
1154 sets the limits for any DN listed in the values of the
1160 group objectClass (default
1162 whose DN exactly matches
1165 The currently supported limits are
1170 The syntax for time limits is
1171 .BR time[.{soft|hard}]=<integer> ,
1174 is the number of seconds slapd will spend answering a search request.
1175 If no time limit is explicitly requested by the client, the
1177 limit is used; if the requested time limit exceeds the
1180 .\".I "Administrative limit exceeded"
1181 .\"error is returned.
1182 limit, the value of the limit is used instead.
1185 limit is set to the keyword
1187 the soft limit is used in either case; if it is set to the keyword
1189 no hard limit is enforced.
1190 Explicit requests for time limits smaller or equal to the
1193 If no limit specifier is set, the value is assigned to the
1199 to preserve the original behavior.
1201 The syntax for size limits is
1202 .BR size[.{soft|hard|unchecked}]=<integer> ,
1205 is the maximum number of entries slapd will return answering a search
1207 If no size limit is explicitly requested by the client, the
1209 limit is used; if the requested size limit exceeds the
1212 .\".I "Administrative limit exceeded"
1213 .\"error is returned.
1214 limit, the value of the limit is used instead.
1217 limit is set to the keyword
1219 the soft limit is used in either case; if it is set to the keyword
1221 no hard limit is enforced.
1222 Explicit requests for size limits smaller or equal to the
1227 specifier sets a limit on the number of candidates a search request is allowed
1229 The rationale behind it is that searches for non-properly indexed
1230 attributes may result in large sets of candidates, which must be
1233 to determine whether they match the search filter or not.
1236 limit provides a means to drop such operations before they are even
1238 If the selected candidates exceed the
1240 limit, the search will abort with
1241 .IR "Unwilling to perform" .
1242 If it is set to the keyword
1244 no limit is applied (the default).
1247 the search is not even performed; this can be used to disallow searches
1248 for a specific set of users.
1249 If no limit specifier is set, the value is assigned to the
1255 to preserve the original behavior.
1257 In case of no match, the global limits are used.
1258 The default values are the same of
1267 control is requested, the
1269 size limit is used by default, because the request of a specific page size
1270 is considered an explicit request for a limitation on the number
1271 of entries to be returned.
1272 However, the size limit applies to the total count of entries returned within
1273 the search, and not to a single page.
1274 Additional size limits may be enforced; the syntax is
1275 .BR size.pr={<integer>|noEstimate|unlimited} ,
1278 is the max page size if no explicit limit is set; the keyword
1280 inhibits the server from returning an estimate of the total number
1281 of entries that might be returned
1282 (note: the current implementation does not return any estimate).
1285 indicates that no limit is applied to the pagedResults control page size.
1287 .B size.prtotal={<integer>|unlimited|disabled}
1288 allows to set a limit on the total number of entries that a pagedResults
1289 control allows to return.
1290 By default it is set to the
1295 is the max number of entries that the whole search with pagedResults control
1299 to allow unlimited number of entries to be returned, e.g. to allow
1300 the use of the pagedResults control as a means to circumvent size
1301 limitations on regular searches; the keyword
1303 disables the control, i.e. no paged results can be returned.
1304 Note that the total number of entries returned when the pagedResults control
1305 is requested cannot exceed the
1307 size limit of regular searches unless extended by the
1312 .B maxderefdepth <depth>
1313 Specifies the maximum number of aliases to dereference when trying to
1314 resolve an entry, used to avoid infinite alias loops. The default is 1.
1316 .B overlay <overlay-name>
1317 Add the specified overlay to this database. An overlay is a piece of
1318 code that intercepts database operations in order to extend or change
1319 them. Overlays are pushed onto
1320 a stack over the database, and so they will execute in the reverse
1321 of the order in which they were configured and the database itself
1322 will receive control last of all.
1324 .B readonly on | off
1325 This option puts the database into "read-only" mode. Any attempts to
1326 modify the database will return an "unwilling to perform" error. By
1327 default, readonly is off.
1330 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1331 .B [starttls=yes|critical]
1332 .B [suffix=<suffix> [...]]
1333 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1334 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1335 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1336 .B [attrs[!]=<attr list>]
1338 Specify a replication site for this database. Refer to the "OpenLDAP
1339 Administrator's Guide" for detailed information on setting up a replicated
1341 directory service. Zero or more
1343 instances can be used to select the subtrees that will be replicated
1344 (defaults to all the database).
1346 is deprecated in favor of the
1350 allows the replica LDAP server to be specified as an LDAP URI.
1355 requires the options
1359 and should only be used when adequate security services
1360 (e.g TLS or IPSEC) are in place. A
1366 Specific security properties (as with the
1368 keyword above) for a SASL bind can be set with the
1370 option. A non-default SASL realm can be set with the
1375 will use Kerberos, a kerberos instance should be given in
1379 can be given after the
1381 keyword to allow the selective replication of the listed attributes only;
1384 mark is used, the list is considered exclusive, i.e. the listed attributes
1386 If an objectClass is listed, all the related attributes
1387 are (are not) replicated.
1390 .B replogfile <filename>
1391 Specify the name of the replication log file to log changes to.
1392 The replication log is typically written by
1397 .BR slapd.replog (5)
1398 for more information. The specified file should be located
1399 in a directory with limited read/write/execute access as the replication
1400 logs may contain sensitive information.
1402 .B restrict <oplist>
1403 Specify a whitespace separated list of operations that are restricted.
1404 If defined inside a database specification, restrictions apply only
1405 to that database, otherwise they are global.
1406 Operations can be any of
1411 .BR extended[=<OID>] ,
1415 or the special pseudo-operations
1419 which respectively summarize read and write operations.
1427 keyword allows to indicate the OID of the specific operation
1431 Specify the distinguished name that is not subject to access control
1432 or administrative limit restrictions for operations on this database.
1433 This DN may or may not be associated with an entry. An empty root
1434 DN (the default) specifies no root access is to be granted. It is
1435 recommended that the rootdn only be specified when needed (such as
1436 when initially populating a database). If the rootdn is within
1437 a namingContext (suffix) of the database, a simple bind password
1438 may also be provided using the
1440 directive. Note that the rootdn is always needed when using syncrepl.
1442 .B rootpw <password>
1443 Specify a password (or hash of the password) for the rootdn. The
1444 password can only be set if the rootdn is within the namingContext
1445 (suffix) of the database.
1446 This option accepts all RFC 2307 userPassword formats known to
1449 description) as well as cleartext.
1451 may be used to generate a hash of a password. Cleartext
1452 and \fB{CRYPT}\fP passwords are not recommended. If empty
1453 (the default), authentication of the root DN is by other means
1454 (e.g. SASL). Use of SASL is encouraged.
1456 .B suffix <dn suffix>
1457 Specify the DN suffix of queries that will be passed to this
1458 backend database. Multiple suffix lines can be given and at least one is
1459 required for each database definition.
1460 If the suffix of one database is "inside" that of another, the database
1461 with the inner suffix must come first in the configuration file.
1463 .B subordinate [advertise]
1464 Specify that the current backend database is a subordinate of another
1465 backend database. A subordinate database may have only one suffix. This
1466 option may be used to glue multiple databases into a single namingContext.
1467 If the suffix of the current database is within the namingContext of a
1468 superior database, searches against the superior database will be
1469 propagated to the subordinate as well. All of the databases
1470 associated with a single namingContext should have identical rootdns.
1471 Behavior of other LDAP operations is unaffected by this setting. In
1472 particular, it is not possible to use moddn to move an entry from
1473 one subordinate to another subordinate within the namingContext.
1475 If the optional \fBadvertise\fP flag is supplied, the naming context of
1476 this database is advertised in the root DSE. The default is to hide this
1477 database context, so that only the superior context is visible.
1484 are used on the superior database, any glued subordinates that support
1485 these tools are opened as well.
1487 Databases that are glued together should usually be configured with the
1488 same indices (assuming they support indexing), even for attributes that
1489 only exist in some of these databases. In general, all of the glued
1490 databases should be configured as similarly as possible, since the intent
1491 is to provide the appearance of a single directory.
1493 Note that the \fIsubordinate\fP functionality is implemented internally
1494 by the \fIglue\fP overlay and as such its behavior will interact with other
1495 overlays in use. By default, the glue overlay is automatically configured as
1496 the last overlay on the superior backend. Its position on the backend
1497 can be explicitly configured by setting an \fBoverlay glue\fP directive
1498 at the desired position. This explicit configuration is necessary e.g.
1499 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1500 in order to work over all of the glued databases. E.g.
1504 suffix dc=example,dc=com
1512 .B syncrepl rid=<replica ID>
1513 .B provider=ldap[s]://<hostname>[:port]
1514 .B [type=refreshOnly|refreshAndPersist]
1515 .B [interval=dd:hh:mm:ss]
1516 .B [retry=[<retry interval> <# of retries>]+]
1517 .B [searchbase=<base DN>]
1518 .B [filter=<filter str>]
1519 .B [scope=sub|one|base]
1520 .B [attrs=<attr list>]
1522 .B [sizelimit=<limit>]
1523 .B [timelimit=<limit>]
1524 .B [schemachecking=on|off]
1525 .B [starttls=yes|critical]
1526 .B [bindmethod=simple|sasl]
1528 .B [saslmech=<mech>]
1529 .B [authcid=<identity>]
1530 .B [authzid=<identity>]
1531 .B [credentials=<passwd>]
1533 .B [secprops=<properties>]
1534 .B [logbase=<base DN>]
1535 .B [logfilter=<filter str>]
1536 .B [syncdata=default|accesslog|changelog]
1538 Specify the current database as a replica which is kept up-to-date with the
1539 master content by establishing the current
1541 as a replication consumer site running a
1544 The replica content is kept synchronized to the master content using
1545 the LDAP Content Synchronization protocol. Refer to the
1546 "OpenLDAP Administrator's Guide" for detailed information on
1547 setting up a replicated
1549 directory service using the
1553 identifies the current
1555 directive within the replication consumer site.
1556 It is a non-negative integer having no more than three digits.
1558 specifies the replication provider site containing the master content
1559 as an LDAP URI. If <port> is not given, the standard LDAP port number
1560 (389 or 636) is used. The content of the
1562 replica is defined using a search
1563 specification as its result set. The consumer
1565 will send search requests to the provider
1567 according to the search specification. The search specification includes
1568 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1571 parameters as in the normal search specification.
1572 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1573 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1574 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1575 attributes, and \fBattrsonly\fP is unset by default.
1576 The \fBsizelimit\fP and \fBtimelimit\fP only
1577 accept "unlimited" and positive integers, and both default to "unlimited".
1578 The LDAP Content Synchronization protocol has two operation types.
1581 operation, the next synchronization search operation
1582 is periodically rescheduled at an interval time (specified by
1584 parameter; 1 day by default)
1585 after each synchronization operation finishes.
1587 .B refreshAndPersist
1588 operation, a synchronization search remains persistent in the provider slapd.
1589 Further updates to the master replica will generate
1590 .B searchResultEntry
1591 to the consumer slapd as the search responses to the persistent
1592 synchronization search.
1593 If an error occurs during replication, the consumer will attempt to
1594 reconnect according to the
1596 parameter which is a list of the <retry interval> and <# of retries> pairs.
1597 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1598 for the first 10 times and then retry every 300 seconds for the next 3
1599 times before stop retrying. The `+' in <# of retries> means indefinite
1600 number of retries until success.
1601 The schema checking can be enforced at the LDAP Sync
1602 consumer site by turning on the
1604 parameter. The default is off.
1607 parameter specifies use of the StartTLS extended operation
1608 to establish a TLS session before Binding to the provider. If the
1610 argument is supplied, the session will be aborted if the StartTLS request
1611 fails. Otherwise the syncrepl session continues without TLS.
1616 requires the options
1620 and should only be used when adequate security services
1621 (e.g. TLS or IPSEC) are in place.
1628 Depending on the mechanism, an authentication identity and/or
1629 credentials can be specified using
1635 parameter may be used to specify an authorization identity.
1636 Specific security properties (as with the
1638 keyword above) for a SASL bind can be set with the
1640 option. A non default SASL realm can be set with the
1644 Rather than replicating whole entries, the consumer can query logs of
1645 data modifications. This mode of operation is referred to as \fIdelta
1646 syncrepl\fP. In addition to the above parameters, the
1650 parameters must be set appropriately for the log that will be used. The
1652 parameter must be set to either "accesslog" if the log conforms to the
1653 .BR slapo-accesslog (5)
1654 log format, or "changelog" if the log conforms
1655 to the obsolete \fIchangelog\fP format. If the
1657 parameter is omitted or set to "default" then the log parameters are
1662 This option is only applicable in a slave
1663 database updated using
1665 It specifies the DN permitted to update (subject to access controls)
1666 the replica (typically, this is the DN
1668 binds to update the replica). Generally, this DN
1675 Specify the referral to pass back when
1677 is asked to modify a replicated local database.
1678 If specified multiple times, each url is provided.
1680 .SH DATABASE-SPECIFIC OPTIONS
1681 Each database may allow specific configuration options; they are
1682 documented separately in the backends' manual pages.
1684 The following backends can be compiled into slapd.
1685 They are documented in the
1686 .BR slapd-<backend> (5)
1690 This is the recommended primary backend for a normal slapd database.
1691 It takes care to configure it properly.
1692 It uses the transactional database interface of the Sleepycat Berkeley
1693 DB (BDB) package to store data.
1696 This backend is used to manage the configuration of slapd run-time.
1699 This backend is experimental.
1700 It serves up referrals based upon SRV resource records held in the
1704 This is a variant of the BDB backend that uses a hierarchical database
1705 layout which supports subtree renames.
1708 This backend acts as a proxy to forward incoming requests to another
1712 This is an easy-to-configure but obsolete database backend. It
1713 does not offer the data durability features of the BDB and HDB
1714 backends and hence is deprecated in favor of these robust backends.
1715 LDBM uses lightweight non-transactional DB interfaces,
1716 such as those providing by GDBM or Berkeley DB, to store data.
1719 This database uses the filesystem to build the tree structure
1720 of the database, using plain ascii files to store data.
1721 Its usage should be limited to very simple databases, where performance
1722 is not a requirement.
1725 This backend performs basic LDAP proxying with respect to a set of
1726 remote LDAP servers. It is an enhancement of the ldap backend.
1729 This backend provides information about the running status of the slapd
1733 Operations in this backend succeed but do nothing.
1736 This backend is provided for demonstration purposes only.
1737 It serves up user account information from the system
1742 This backend embeds a
1744 interpreter into slapd.
1745 It runs Perl subroutines to implement LDAP operations.
1748 This backend is experimental.
1749 It redirects LDAP operations to another database
1750 in the same server, based on the naming context of the request.
1751 Its use requires the
1755 for details) to rewrite the naming context of the request.
1756 It is primarily intended to implement virtual views on databases
1757 that actually store data.
1760 This backend executes external programs to implement LDAP operations.
1761 It is primarily intended to be used in prototypes.
1764 This backend is experimental.
1765 It services LDAP requests from an SQL database.
1767 The following overlays can be compiled into slapd.
1768 They are documented in the
1769 .BR slapo-<overlay> (5)
1774 This overlay can record accesses to a given backend database on another
1779 This overlay records changes on a given backend database to an LDIF log
1781 By default it is not built.
1785 This overlay allows automatic referral chasing when a referral would
1786 have been returned, either when configured by the server or when
1787 requested by the client.
1791 This overlay allows selected operations to be denied, similar to the
1792 \fBrestrict\fP option.
1796 This is a demo overlay which extends the Compare operation to detect
1797 members of a dynamic group.
1798 It has no effect on any other operations.
1802 This overlay allows expansion of dynamic groups and more.
1806 This overlay maintains a service entry in the database with the DN,
1807 modification type, modifiersName and modifyTimestamp of the last write
1808 operation performed on that database.
1812 This overlay allows caching of LDAP search requests in a local database.
1813 It is most often used with the ldap or meta backends.
1817 This overlay provides a variety of password control mechanisms,
1818 e.g. password aging, password reuse and duplication control, mandatory
1819 password resets, etc.
1822 Referential Integrity.
1823 This overlay can be used with a backend database such as
1825 to maintain the cohesiveness of a schema which utilizes reference
1830 This overlay is useful to test the behavior of clients when
1831 server-generated erroneous and/or unusual responses occur.
1835 This overlay is experimental.
1836 It performs basic DN/data rewrite and
1837 objectClass/attributeType mapping.
1841 This overlay implements the provider-side support for
1843 replication, including persistent search functionality.
1847 This overlay can be used with a backend database such as
1849 to create a "translucent proxy".
1850 Content of entries retrieved from a remote LDAP server can be partially
1851 overridden by the database.
1854 Attribute Uniqueness.
1855 This overlay can be used with a backend database such as
1857 to enforce the uniqueness of some or all attributes within a subtree.
1860 Here is a short example of a configuration file:
1864 include SYSCONFDIR/schema/core.schema
1865 pidfile LOCALSTATEDIR/slapd.pid
1867 # Subtypes of "name" (e.g. "cn" and "ou") with the
1868 # option ";x-hidden" can be searched for/compared,
1869 # but are not shown. See \fBslapd.access\fP(5).
1870 attributeoptions x-hidden lang-
1871 access to attrs=name;x-hidden by * =cs
1873 # Protect passwords. See \fBslapd.access\fP(5).
1874 access to attrs=userPassword by * auth
1875 # Read access to other attributes and entries.
1876 access to * by * read
1879 suffix "dc=our-domain,dc=com"
1880 # The database directory MUST exist prior to
1881 # running slapd AND should only be accessible
1882 # by the slapd/tools. Mode 0700 recommended.
1883 directory LOCALSTATEDIR/openldap-data
1884 # Indices to maintain
1885 index objectClass eq
1886 index cn,sn,mail pres,eq,approx,sub
1888 # We serve small clients that do not handle referrals,
1889 # so handle remote lookups on their behalf.
1892 uri ldap://ldap.some-server.com/
1897 "OpenLDAP Administrator's Guide" contains a longer annotated
1898 example of a configuration file.
1899 The original ETCDIR/slapd.conf is another example.
1903 default slapd configuration file
1907 .BR slapd\-dnssrv (5),
1909 .BR slapd\-ldap (5),
1910 .BR slapd\-ldbm (5),
1911 .BR slapd\-ldif (5),
1912 .BR slapd\-meta (5),
1913 .BR slapd\-monitor (5),
1914 .BR slapd\-null (5),
1915 .BR slapd\-passwd (5),
1916 .BR slapd\-perl (5),
1917 .BR slapd\-relay (5),
1918 .BR slapd\-shell (5),
1920 .BR slapd.access (5),
1921 .BR slapd.plugin (5),
1922 .BR slapd.replog (5),
1934 Known overlays are documented in
1935 .BR slapo\-accesslog (5),
1936 .BR slapo\-auditlog (5),
1937 .BR slapo\-chain (5),
1938 .BR slapo\-dynlist (5),
1939 .BR slapo\-lastmod (5),
1940 .BR slapo\-pcache (5),
1941 .BR slapo\-ppolicy (5),
1942 .BR slapo\-refint (5),
1943 .BR slapo\-retcode (5),
1945 .BR slapo\-syncprov (5),
1946 .BR slapo\-translucent (5),
1947 .BR slapo\-unique (5).
1949 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1950 .SH ACKNOWLEDGEMENTS
1952 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1954 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob