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 allow 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.
412 disables simple (bind) authentication.
414 disables forcing session to anonymous status (see also
415 .BR tls_authc ) upon StartTLS operation receipt.
417 dissallow the StartTLS operation if authenticated (see also
421 .B ditcontentrule "(\ <oid>\
423 [DESC\ <description>]\
430 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
431 The slapd parser extends the RFC 2252 definition by allowing string
432 forms as well as numeric OIDs to be used for the attribute OID and
433 attribute syntax OID.
439 .B gentlehup { on | off }
440 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
442 will stop listening for new connections, but will not close the
443 connections to the current clients. Future write operations return
444 unwilling-to-perform, though. Slapd terminates when all clients
445 have closed their connections (if they ever do), or \- as before \-
446 if it receives a SIGTERM signal. This can be useful if you wish to
447 terminate the server and start a new
450 .B with another database,
451 without disrupting the currently active clients.
452 The default is off. You may wish to use
454 along with this option.
456 .B idletimeout <integer>
457 Specify the number of seconds to wait before forcibly closing
458 an idle client connection. A idletimeout of 0 disables this
459 feature. The default is 0.
461 .B include <filename>
462 Read additional configuration information from the given file before
463 continuing with the next line of the current file.
465 .B index_substr_if_minlen <integer>
466 Specify the minimum length for subinitial and subfinal indices. An
467 attribute value must have at least this many characters in order to be
468 processed by the indexing functions. The default is 2.
470 .B index_substr_if_maxlen <integer>
471 Specify the maximum length for subinitial and subfinal indices. Only
472 this many characters of an attribute value will be processed by the
473 indexing functions; any excess characters are ignored. The default is 4.
475 .B index_substr_any_len <integer>
476 Specify the length used for subany indices. An attribute value must have
477 at least this many characters in order to be processed. Attribute values
478 longer than this length will be processed in segments of this length. The
479 default is 4. The subany index will also be used in subinitial and
480 subfinal index lookups when the filter string is longer than the
481 .I index_substr_if_maxlen
484 .B index_substr_any_step <integer>
485 Specify the steps used in subany index lookups. This value sets the offset
486 for the segments of a filter string that are processed for a subany index
487 lookup. The default is 2. For example, with the default values, a search
488 using this filter "cn=*abcdefgh*" would generate index lookups for
489 "abcd", "cdef", and "efgh".
491 .\"-- NEW_LOGGING option --
493 .\".B logfile <filename>
494 .\"Specify a file for recording debug log messages. By default these messages
495 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
496 .\"copies messages to both stderr and the logfile.
499 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
500 such as those to the ldapi:// listener. For a description of SSF values,
504 option description. The default is 71.
506 .B loglevel <integer> [...]
507 Specify the level at which debugging statements and operation
508 statistics should be syslogged (currently logged to the
510 LOG_LOCAL4 facility).
511 They must be considered subsystems rather than increasingly verbose
513 Some messages with higher priority are logged regardless
514 of the configured loglevel as soon as some logging is configured,
515 otherwise anything is logged at all.
516 Log levels are additive, and available levels are:
527 debug packet handling
531 heavy trace debugging (function args)
535 connection management
539 print out packets sent and received
543 search filter processing
547 configuration file processing
551 access control list processing
555 stats log connections/operations/results
559 stats log entries sent
563 print communication with shell backends
575 \"data indexing (unused)
583 only messages that get logged whatever log level is set
586 The desired log level can be input as a single integer that combines
587 the (ORed) desired levels, both in decimal or in hexadecimal notation,
588 as a list of integers (that are ORed internally),
589 or as a list of the names that are shown between brackets, such that
602 can be used as a shortcut to enable logging at all levels (equivalent to -1).
605 or the equivalent integer representation, causes those messages
606 that are logged regardless of the configured loglevel to be logged.
607 In fact, if no loglevel (or a 0 level) is defined, no logging occurs,
610 level is required to have high priority messages logged.
613 .B moduleload <filename>
614 Specify the name of a dynamically loadable module to load. The filename
615 may be an absolute path name or a simple filename. Non-absolute names
616 are searched for in the directories specified by the
618 option. This option and the
620 option are only usable if slapd was compiled with --enable-modules.
622 .B modulepath <pathspec>
623 Specify a list of directories to search for loadable modules. Typically
624 the path is colon-separated but this depends on the operating system.
627 .B objectclass "(\ <oid>\
629 [DESC\ <description>]\
632 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
633 [MUST\ <oids>] [MAY\ <oids>] )"
635 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
636 The slapd parser extends the RFC 2252 definition by allowing string
637 forms as well as numeric OIDs to be used for the object class OID.
641 description.) Object classes are "STRUCTURAL" by default.
644 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
645 Define a string name that equates to the given OID. The string can be used
646 in place of the numeric OID in objectclass and attribute definitions. The
647 name can also be used with a suffix of the form ":xx" in which case the
648 value "oid.xx" will be used.
650 .B password-hash <hash> [<hash>...]
651 This option configures one or more hashes to be used in generation of user
652 passwords stored in the userPassword attribute during processing of
653 LDAP Password Modify Extended Operations (RFC 3062).
654 The <hash> must be one of
668 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
673 use the MD5 algorithm (RFC 1321), the latter with a seed.
680 indicates that the new password should be
681 added to userPassword as clear text.
683 Note that this option does not alter the normal user applications
684 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
686 .B password\-crypt\-salt\-format <format>
687 Specify the format of the salt passed to
689 when generating {CRYPT} passwords (see
691 during processing of LDAP Password Modify Extended Operations (RFC 3062).
693 This string needs to be in
695 format and may include one (and only one) %s conversion.
696 This conversion will be substituted with a string of random
697 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
698 provides a two character salt and "$1$%.8s" tells some
699 versions of crypt(3) to use an MD5 algorithm and provides
700 8 random characters of salt. The default is "%s", which
701 provides 31 characters of salt.
703 .B pidfile <filename>
704 The ( absolute ) name of a file that will hold the
706 server's process ID ( see
708 ) if started without the debugging command line option.
711 Specify the referral to pass back when
713 cannot find a local database to handle a request.
714 If specified multiple times, each url is provided.
717 The ( absolute ) name of a file that will hold the
719 server's command line options
720 if started without the debugging command line option.
721 If it appears after a
723 directive, the args file is specific to the
725 instance that handles that replication log.
728 The ( absolute ) name of a file that will hold the
730 server's process ID ( see
732 ) if started without the debugging command line option.
733 If it appears after a
735 directive, the pid file is specific to the
737 instance that handles that replication log.
739 .B replicationinterval
740 The number of seconds
742 waits before checking the replogfile for changes.
743 If it appears after a
745 directive, the replication interval is specific to the
747 instance that handles that replication log.
749 .B require <conditions>
750 Specify a set of conditions (separated by white space) to
751 require (default none).
752 The directive may be specified globally and/or per-database.
754 requires bind operation prior to directory operations.
756 requires session to be using LDAP version 3.
758 requires authentication prior to directory operations.
760 requires SASL authentication prior to directory operations.
762 requires strong authentication prior to directory operations.
763 The strong keyword allows protected "simple" authentication
764 as well as SASL authentication.
766 may be used to require no conditions (useful for clearly globally
767 set conditions within a particular database).
769 .B reverse-lookup on | off
770 Enable/disable client name unverified reverse lookup (default is
772 if compiled with --enable-rlookups).
775 Specify the name of an LDIF(5) file containing user defined attributes
776 for the root DSE. These attributes are returned in addition to the
777 attributes normally produced by slapd.
780 Used to specify the fully qualified domain name used for SASL processing.
782 .B sasl-realm <realm>
783 Specify SASL realm. Default is empty.
785 .B sasl-secprops <properties>
786 Used to specify Cyrus SASL security properties.
789 flag (without any other properties) causes the flag properties
790 default, "noanonymous,noplain", to be cleared.
793 flag disables mechanisms susceptible to simple passive attacks.
796 flag disables mechanisms susceptible to active attacks.
799 flag disables mechanisms susceptible to passive dictionary attacks.
802 flag disables mechanisms which support anonymous login.
805 flag require forward secrecy between sessions.
808 require mechanisms which pass client credentials (and allow
809 mechanisms which can pass credentials to do so).
812 property specifies the minimum acceptable
813 .I security strength factor
814 as an integer approximate to effective key length used for
815 encryption. 0 (zero) implies no protection, 1 implies integrity
816 protection only, 56 allows DES or other weak ciphers, 112
817 allows triple DES and other strong ciphers, 128 allows RC4,
818 Blowfish and other modern strong ciphers. The default is 0.
821 property specifies the maximum acceptable
822 .I security strength factor
823 as an integer (see minssf description). The default is INT_MAX.
826 property specifies the maximum security layer receive buffer
827 size allowed. 0 disables security layers. The default is 65536.
830 Specify the distinguished name for the subschema subentry that
831 controls the entries on this server. The default is "cn=Subschema".
833 .B security <factors>
834 Specify a set of security strength factors (separated by white space)
838 option for a description of security strength factors).
839 The directive may be specified globally and/or per-database.
841 specifies the overall security strength factor.
843 specifies the transport security strength factor.
845 specifies the TLS security strength factor.
847 specifies the SASL security strength factor.
849 specifies the overall security strength factor to require for
851 .B update_transport=<n>
852 specifies the transport security strength factor to require for
855 specifies the TLS security strength factor to require for
858 specifies the SASL security strength factor to require for
861 specifies the security strength factor required for
863 username/password authentication.
866 factor is measure of security provided by the underlying transport,
867 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
869 .B sizelimit {<integer>|unlimited}
871 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
872 Specify the maximum number of entries to return from a search operation.
873 The default size limit is 500.
876 to specify no limits.
877 The second format allows a fine grain setting of the size limits.
878 Extra args can be added on the same line.
881 for an explanation of the different flags.
883 .B sockbuf_max_incoming <integer>
884 Specify the maximum incoming LDAP PDU size for anonymous sessions.
885 The default is 262143.
887 .B sockbuf_max_incoming_auth <integer>
888 Specify the maximum incoming LDAP PDU size for authenticated sessions.
889 The default is 4194303.
892 Specify the maximum size of the primary thread pool.
895 .B timelimit {<integer>|unlimited}
897 .B timelimit time[.{soft|hard}]=<integer> [...]
898 Specify the maximum number of seconds (in real time)
900 will spend answering a search request. The default time limit is 3600.
903 to specify no limits.
904 The second format allows a fine grain setting of the time limits.
905 Extra args can be added on the same line.
908 for an explanation of the different flags.
910 .B tool-threads <integer>
911 Specify the maximum number of threads to use in tool mode.
912 This should not be greater than the number of CPUs in the system.
914 .\"ucdata-path is obsolete / ignored...
916 .\".B ucdata-path <path>
917 .\"Specify the path to the directory containing the Unicode character
918 .\"tables. The default path is DATADIR/ucdata.
922 is built with support for Transport Layer Security, there are more options
925 .B TLSCipherSuite <cipher-suite-spec>
926 Permits configuring what ciphers will be accepted and the preference order.
927 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
929 TLSCipherSuite HIGH:MEDIUM:+SSLv2
931 To check what ciphers a given spec selects, use:
933 openssl ciphers -v <cipher-suite-spec>
935 .B TLSCACertificateFile <filename>
936 Specifies the file that contains certificates for all of the Certificate
941 .B TLSCACertificatePath <path>
942 Specifies the path of a directory that contains Certificate Authority
943 certificates in separate individual files. Usually only one of this
944 or the TLSCACertificateFile is used.
946 .B TLSCertificateFile <filename>
947 Specifies the file that contains the
951 .B TLSCertificateKeyFile <filename>
952 Specifies the file that contains the
954 server private key that matches the certificate stored in the
955 .B TLSCertificateFile
956 file. Currently, the private key must not be protected with a password, so
957 it is of critical importance that it is protected carefully.
959 .B TLSDHParamFile <filename>
960 This directive specifies the file that contains parameters for Diffie-Hellman
961 ephemeral key exchange. This is required in order to use a DSA certificate on
962 the server. If multiple sets of parameters are present in the file, all of
963 them will be processed.
965 .B TLSRandFile <filename>
966 Specifies the file to obtain random bits from when /dev/[u]random
967 is not available. Generally set to the name of the EGD/PRNGD socket.
968 The environment variable RANDFILE can also be used to specify the filename.
970 .B TLSVerifyClient <level>
971 Specifies what checks to perform on client certificates in an
972 incoming TLS session, if any.
975 can be specified as one of the following keywords:
981 will not ask the client for a certificate.
984 The client certificate is requested. If no certificate is provided,
985 the session proceeds normally. If a bad certificate is provided,
986 it will be ignored and the session proceeds normally.
989 The client certificate is requested. If no certificate is provided,
990 the session proceeds normally. If a bad certificate is provided,
991 the session is immediately terminated.
993 .B demand | hard | true
994 These keywords are all equivalent, for compatibility reasons.
995 The client certificate is requested. If no certificate is provided,
996 or a bad certificate is provided, the session is immediately terminated.
998 Note that a valid client certificate is required in order to use the
999 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1002 setting must be chosen to enable SASL EXTERNAL authentication.
1005 .B TLSCRLCheck <level>
1006 Specifies if the Certificate Revocation List (CRL) of the CA should be
1007 used to verify if the client certificates have not been revoked. This
1009 .B TLSCACertificatePath
1010 parameter to be set.
1012 can be specified as one of the following keywords:
1016 No CRL checks are performed
1019 Check the CRL of the peer certificate
1022 Check the CRL for a whole certificate chain
1024 .SH GENERAL BACKEND OPTIONS
1025 Options in this section only apply to the configuration file section
1026 for the specified backend. They are supported by every
1029 .B backend <databasetype>
1030 Mark the beginning of a backend definition. <databasetype>
1048 depending on which backend will serve the database.
1050 .SH GENERAL DATABASE OPTIONS
1051 Options in this section only apply to the configuration file section
1052 for the database in which they are defined. They are supported by every
1053 type of backend. Note that the
1057 option are mandatory for each database.
1059 .B database <databasetype>
1060 Mark the beginning of a new database instance definition. <databasetype>
1078 depending on which backend will serve the database.
1083 will automatically maintain the
1084 modifiersName, modifyTimestamp, creatorsName, and
1085 createTimestamp attributes for entries. By default, lastmod is on.
1087 .B limits <who> <limit> [<limit> [...]]
1088 Specify time and size limits based on who initiated an operation.
1095 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1101 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1106 matches all unauthenticated clients.
1109 matches all authenticated clients;
1112 dn pattern is assumed unless otherwise specified by qualifying
1113 the (optional) key string
1119 (which are synonyms), to require an exact match; with
1121 to require exactly one level of depth match; with
1123 to allow any level of depth match, including the exact match; with
1125 to allow any level of depth match, not including the exact match;
1127 explicitly requires the (default) match based on POSIX (''extended'')
1128 regular expression pattern.
1131 matches unbound operations; the
1134 The same behavior is obtained by using the
1141 with the optional objectClass
1147 sets the limits for any DN listed in the values of the
1153 group objectClass (default
1155 whose DN exactly matches
1158 The currently supported limits are
1163 The syntax for time limits is
1164 .BR time[.{soft|hard}]=<integer> ,
1167 is the number of seconds slapd will spend answering a search request.
1168 If no time limit is explicitly requested by the client, the
1170 limit is used; if the requested time limit exceeds the
1173 .\".I "Administrative limit exceeded"
1174 .\"error is returned.
1175 limit, the value of the limit is used instead.
1178 limit is set to the keyword
1180 the soft limit is used in either case; if it is set to the keyword
1182 no hard limit is enforced.
1183 Explicit requests for time limits smaller or equal to the
1186 If no limit specifier is set, the value is assigned to the
1192 to preserve the original behavior.
1194 The syntax for size limits is
1195 .BR size[.{soft|hard|unchecked}]=<integer> ,
1198 is the maximum number of entries slapd will return answering a search
1200 If no size limit is explicitly requested by the client, the
1202 limit is used; if the requested size limit exceeds the
1205 .\".I "Administrative limit exceeded"
1206 .\"error is returned.
1207 limit, the value of the limit is used instead.
1210 limit is set to the keyword
1212 the soft limit is used in either case; if it is set to the keyword
1214 no hard limit is enforced.
1215 Explicit requests for size limits smaller or equal to the
1220 specifier sets a limit on the number of candidates a search request is allowed
1222 The rationale behind it is that searches for non-properly indexed
1223 attributes may result in large sets of candidates, which must be
1226 to determine whether they match the search filter or not.
1229 limit provides a means to drop such operations before they are even
1231 If the selected candidates exceed the
1233 limit, the search will abort with
1234 .IR "Unwilling to perform" .
1235 If it is set to the keyword
1237 no limit is applied (the default).
1240 the search is not even performed; this can be used to disallow searches
1241 for a specific set of users.
1242 If no limit specifier is set, the value is assigned to the
1248 to preserve the original behavior.
1250 In case of no match, the global limits are used.
1251 The default values are the same of
1260 control is requested, the
1262 size limit is used by default, because the request of a specific page size
1263 is considered an explicit request for a limitation on the number
1264 of entries to be returned.
1265 However, the size limit applies to the total count of entries returned within
1266 the search, and not to a single page.
1267 Additional size limits may be enforced; the syntax is
1268 .BR size.pr={<integer>|noEstimate|unlimited} ,
1271 is the max page size if no explicit limit is set; the keyword
1273 inhibits the server from returning an estimate of the total number
1274 of entries that might be returned
1275 (note: the current implementation does not return any estimate).
1278 indicates that no limit is applied to the pagedResults control page size.
1280 .B size.prtotal={<integer>|unlimited|disabled}
1281 allows to set a limit on the total number of entries that a pagedResults
1282 control allows to return.
1283 By default it is set to the
1288 is the max number of entries that the whole search with pagedResults control
1292 to allow unlimited number of entries to be returned, e.g. to allow
1293 the use of the pagedResults control as a means to circumvent size
1294 limitations on regular searches; the keyword
1296 disables the control, i.e. no paged results can be returned.
1297 Note that the total number of entries returned when the pagedResults control
1298 is requested cannot exceed the
1300 size limit of regular searches unless extended by the
1305 .B maxderefdepth <depth>
1306 Specifies the maximum number of aliases to dereference when trying to
1307 resolve an entry, used to avoid infinite alias loops. The default is 1.
1309 .B overlay <overlay-name>
1310 Add the specified overlay to this database. An overlay is a piece of
1311 code that intercepts database operations in order to extend or change
1312 them. Overlays are pushed onto
1313 a stack over the database, and so they will execute in the reverse
1314 of the order in which they were configured and the database itself
1315 will receive control last of all.
1317 .B readonly on | off
1318 This option puts the database into "read-only" mode. Any attempts to
1319 modify the database will return an "unwilling to perform" error. By
1320 default, readonly is off.
1323 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1324 .B [starttls=yes|critical]
1325 .B [suffix=<suffix> [...]]
1326 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1327 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1328 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1329 .B [attrs[!]=<attr list>]
1331 Specify a replication site for this database. Refer to the "OpenLDAP
1332 Administrator's Guide" for detailed information on setting up a replicated
1334 directory service. Zero or more
1336 instances can be used to select the subtrees that will be replicated
1337 (defaults to all the database).
1339 is deprecated in favor of the
1343 allows the replica LDAP server to be specified as an LDAP URI.
1348 requires the options
1352 and should only be used when adequate security services
1353 (e.g TLS or IPSEC) are in place. A
1359 Specific security properties (as with the
1361 keyword above) for a SASL bind can be set with the
1363 option. A non-default SASL realm can be set with the
1368 will use Kerberos, a kerberos instance should be given in
1372 can be given after the
1374 keyword to allow the selective replication of the listed attributes only;
1377 mark is used, the list is considered exclusive, i.e. the listed attributes
1379 If an objectClass is listed, all the related attributes
1380 are (are not) replicated.
1383 .B replogfile <filename>
1384 Specify the name of the replication log file to log changes to.
1385 The replication log is typically written by
1390 .BR slapd.replog (5)
1391 for more information. The specified file should be located
1392 in a directory with limited read/write/execute access as the replication
1393 logs may contain sensitive information.
1395 .B restrict <oplist>
1396 Specify a whitespace separated list of operations that are restricted.
1397 If defined inside a database specification, restrictions apply only
1398 to that database, otherwise they are global.
1399 Operations can be any of
1404 .BR extended[=<OID>] ,
1408 or the special pseudo-operations
1412 which respectively summarize read and write operations.
1420 keyword allows to indicate the OID of the specific operation
1424 Specify the distinguished name that is not subject to access control
1425 or administrative limit restrictions for operations on this database.
1426 This DN may or may not be associated with an entry. An empty root
1427 DN (the default) specifies no root access is to be granted. It is
1428 recommended that the rootdn only be specified when needed (such as
1429 when initially populating a database). If the rootdn is within
1430 a namingContext (suffix) of the database, a simple bind password
1431 may also be provided using the
1433 directive. Note that the rootdn is always needed when using syncrepl.
1435 .B rootpw <password>
1436 Specify a password (or hash of the password) for the rootdn. The
1437 password can only be set if the rootdn is within the namingContext
1438 (suffix) of the database.
1439 This option accepts all RFC 2307 userPassword formats known to
1442 description) as well as cleartext.
1444 may be used to generate a hash of a password. Cleartext
1445 and \fB{CRYPT}\fP passwords are not recommended. If empty
1446 (the default), authentication of the root DN is by other means
1447 (e.g. SASL). Use of SASL is encouraged.
1449 .B suffix <dn suffix>
1450 Specify the DN suffix of queries that will be passed to this
1451 backend database. Multiple suffix lines can be given and at least one is
1452 required for each database definition.
1453 If the suffix of one database is "inside" that of another, the database
1454 with the inner suffix must come first in the configuration file.
1456 .B subordinate [advertise]
1457 Specify that the current backend database is a subordinate of another
1458 backend database. A subordinate database may have only one suffix. This
1459 option may be used to glue multiple databases into a single namingContext.
1460 If the suffix of the current database is within the namingContext of a
1461 superior database, searches against the superior database will be
1462 propagated to the subordinate as well. All of the databases
1463 associated with a single namingContext should have identical rootdns.
1464 Behavior of other LDAP operations is unaffected by this setting. In
1465 particular, it is not possible to use moddn to move an entry from
1466 one subordinate to another subordinate within the namingContext.
1468 If the optional \fBadvertise\fP flag is supplied, the naming context of
1469 this database is advertised in the root DSE. The default is to hide this
1470 database context, so that only the superior context is visible.
1477 are used on the superior database, any glued subordinates that support
1478 these tools are opened as well.
1480 Databases that are glued together should usually be configured with the
1481 same indices (assuming they support indexing), even for attributes that
1482 only exist in some of these databases. In general, all of the glued
1483 databases should be configured as similarly as possible, since the intent
1484 is to provide the appearance of a single directory.
1486 Note that the \fIsubordinate\fP functionality is implemented internally
1487 by the \fIglue\fP overlay and as such its behavior will interact with other
1488 overlays in use. By default, the glue overlay is automatically configured as
1489 the last overlay on the superior backend. Its position on the backend
1490 can be explicitly configured by setting an \fBoverlay glue\fP directive
1491 at the desired position. This explicit configuration is necessary e.g.
1492 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1493 in order to work over all of the glued databases. E.g.
1497 suffix dc=example,dc=com
1505 .B syncrepl rid=<replica ID>
1506 .B provider=ldap[s]://<hostname>[:port]
1507 .B [type=refreshOnly|refreshAndPersist]
1508 .B [interval=dd:hh:mm:ss]
1509 .B [retry=[<retry interval> <# of retries>]+]
1510 .B [searchbase=<base DN>]
1511 .B [filter=<filter str>]
1512 .B [scope=sub|one|base]
1513 .B [attrs=<attr list>]
1515 .B [sizelimit=<limit>]
1516 .B [timelimit=<limit>]
1517 .B [schemachecking=on|off]
1518 .B [starttls=yes|critical]
1519 .B [bindmethod=simple|sasl]
1521 .B [saslmech=<mech>]
1522 .B [authcid=<identity>]
1523 .B [authzid=<identity>]
1524 .B [credentials=<passwd>]
1526 .B [secprops=<properties>]
1527 .B [logbase=<base DN>]
1528 .B [logfilter=<filter str>]
1529 .B [syncdata=default|accesslog|changelog]
1531 Specify the current database as a replica which is kept up-to-date with the
1532 master content by establishing the current
1534 as a replication consumer site running a
1537 The replica content is kept synchronized to the master content using
1538 the LDAP Content Synchronization protocol. Refer to the
1539 "OpenLDAP Administrator's Guide" for detailed information on
1540 setting up a replicated
1542 directory service using the
1546 identifies the current
1548 directive within the replication consumer site.
1549 It is a non-negative integer having no more than three digits.
1551 specifies the replication provider site containing the master content
1552 as an LDAP URI. If <port> is not given, the standard LDAP port number
1553 (389 or 636) is used. The content of the
1555 replica is defined using a search
1556 specification as its result set. The consumer
1558 will send search requests to the provider
1560 according to the search specification. The search specification includes
1561 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1564 parameters as in the normal search specification.
1565 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1566 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1567 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1568 attributes, and \fBattrsonly\fP is unset by default.
1569 The \fBsizelimit\fP and \fBtimelimit\fP only
1570 accept "unlimited" and positive integers, and both default to "unlimited".
1571 The LDAP Content Synchronization protocol has two operation types.
1574 operation, the next synchronization search operation
1575 is periodically rescheduled at an interval time (specified by
1577 parameter; 1 day by default)
1578 after each synchronization operation finishes.
1580 .B refreshAndPersist
1581 operation, a synchronization search remains persistent in the provider slapd.
1582 Further updates to the master replica will generate
1583 .B searchResultEntry
1584 to the consumer slapd as the search responses to the persistent
1585 synchronization search.
1586 If an error occurs during replication, the consumer will attempt to
1587 reconnect according to the
1589 parameter which is a list of the <retry interval> and <# of retries> pairs.
1590 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1591 for the first 10 times and then retry every 300 seconds for the next 3
1592 times before stop retrying. The `+' in <# of retries> means indefinite
1593 number of retries until success.
1594 The schema checking can be enforced at the LDAP Sync
1595 consumer site by turning on the
1597 parameter. The default is off.
1600 parameter specifies use of the StartTLS extended operation
1601 to establish a TLS session before Binding to the provider. If the
1603 argument is supplied, the session will be aborted if the StartTLS request
1604 fails. Otherwise the syncrepl session continues without TLS.
1609 requires the options
1613 and should only be used when adequate security services
1614 (e.g. TLS or IPSEC) are in place.
1621 Depending on the mechanism, an authentication identity and/or
1622 credentials can be specified using
1628 parameter may be used to specify an authorization identity.
1629 Specific security properties (as with the
1631 keyword above) for a SASL bind can be set with the
1633 option. A non default SASL realm can be set with the
1637 Rather than replicating whole entries, the consumer can query logs of
1638 data modifications. This mode of operation is referred to as \fIdelta
1639 syncrepl\fP. In addition to the above parameters, the
1643 parameters must be set appropriately for the log that will be used. The
1645 parameter must be set to either "accesslog" if the log conforms to the
1646 .BR slapo-accesslog (5)
1647 log format, or "changelog" if the log conforms
1648 to the obsolete \fIchangelog\fP format. If the
1650 parameter is omitted or set to "default" then the log parameters are
1655 This option is only applicable in a slave
1656 database updated using
1658 It specifies the DN permitted to update (subject to access controls)
1659 the replica (typically, this is the DN
1661 binds to update the replica). Generally, this DN
1668 Specify the referral to pass back when
1670 is asked to modify a replicated local database.
1671 If specified multiple times, each url is provided.
1673 .SH DATABASE-SPECIFIC OPTIONS
1674 Each database may allow specific configuration options; they are
1675 documented separately in the backends' manual pages.
1677 The following backends can be compiled into slapd.
1678 They are documented in the
1679 .BR slapd-<backend> (5)
1683 This is the recommended backend for a normal slapd database.
1684 However, it takes more care than with the LDBM backend to configure
1686 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1689 This backend is used to manage the configuration of slapd run-time.
1692 This backend is experimental.
1693 It serves up referrals based upon SRV resource records held in the
1697 This is a variant of the BDB backend that uses a hierarchical database
1698 layout which supports subtree renames.
1701 This backend acts as a proxy to forward incoming requests to another
1705 This is the database backend which is easiest to configure.
1706 However, it does not offer the data durability features of the BDB
1708 It uses Berkeley DB or GDBM to store data.
1711 This database uses the filesystem to build the tree structure
1712 of the database, using plain ascii files to store data.
1713 Its usage should be limited to very simple databases, where performance
1714 is not a requirement.
1717 This backend performs basic LDAP proxying with respect to a set of
1718 remote LDAP servers. It is an enhancement of the ldap backend.
1721 This backend provides information about the running status of the slapd
1725 Operations in this backend succeed but do nothing.
1728 This backend is provided for demonstration purposes only.
1729 It serves up user account information from the system
1734 This backend embeds a
1736 interpreter into slapd.
1737 It runs Perl subroutines to implement LDAP operations.
1740 This backend is experimental.
1741 It redirects LDAP operations to another database
1742 in the same server, based on the naming context of the request.
1743 Its use requires the
1747 for details) to rewrite the naming context of the request.
1748 It is primarily intended to implement virtual views on databases
1749 that actually store data.
1752 This backend executes external programs to implement LDAP operations.
1753 It is primarily intended to be used in prototypes.
1756 This backend is experimental.
1757 It services LDAP requests from an SQL database.
1759 The following overlays can be compiled into slapd.
1760 They are documented in the
1761 .BR slapo-<overlay> (5)
1766 This overlay can record accesses to a given backend database on another
1771 This overlay records changes on a given backend database to an LDIF log
1773 By default it is not built.
1777 This overlay allows automatic referral chasing when a referral would
1778 have been returned, either when configured by the server or when
1779 requested by the client.
1783 This overlay allows selected operations to be denied, similar to the
1784 \fBrestrict\fP option.
1788 This is a demo overlay which extends the Compare operation to detect
1789 members of a dynamic group.
1790 It has no effect on any other operations.
1794 This overlay allows expansion of dynamic groups and more.
1798 This overlay maintains a service entry in the database with the DN,
1799 modification type, modifiersName and modifyTimestamp of the last write
1800 operation performed on that database.
1804 This overlay allows caching of LDAP search requests in a local database.
1805 It is most often used with the ldap or meta backends.
1809 This overlay provides a variety of password control mechanisms,
1810 e.g. password aging, password reuse and duplication control, mandatory
1811 password resets, etc.
1814 Referential Integrity.
1815 This overlay can be used with a backend database such as
1817 to maintain the cohesiveness of a schema which utilizes reference
1822 This overlay is useful to test the behavior of clients when
1823 server-generated erroneous and/or unusual responses occur.
1827 This overlay is experimental.
1828 It performs basic DN/data rewrite and
1829 objectClass/attributeType mapping.
1833 This overlay implements the provider-side support for
1835 replication, including persistent search functionality.
1839 This overlay can be used with a backend database such as
1841 to create a "translucent proxy".
1842 Content of entries retrieved from a remote LDAP server can be partially
1843 overridden by the database.
1846 Attribute Uniqueness.
1847 This overlay can be used with a backend database such as
1849 to enforce the uniqueness of some or all attributes within a subtree.
1852 Here is a short example of a configuration file:
1856 include SYSCONFDIR/schema/core.schema
1857 pidfile LOCALSTATEDIR/slapd.pid
1859 # Subtypes of "name" (e.g. "cn" and "ou") with the
1860 # option ";x-hidden" can be searched for/compared,
1861 # but are not shown. See \fBslapd.access\fP(5).
1862 attributeoptions x-hidden lang-
1863 access to attrs=name;x-hidden by * =cs
1865 # Protect passwords. See \fBslapd.access\fP(5).
1866 access to attrs=userPassword by * auth
1867 # Read access to other attributes and entries.
1868 access to * by * read
1871 suffix "dc=our-domain,dc=com"
1872 # The database directory MUST exist prior to
1873 # running slapd AND should only be accessible
1874 # by the slapd/tools. Mode 0700 recommended.
1875 directory LOCALSTATEDIR/openldap-data
1876 # Indices to maintain
1877 index objectClass eq
1878 index cn,sn,mail pres,eq,approx,sub
1880 # We serve small clients that do not handle referrals,
1881 # so handle remote lookups on their behalf.
1884 uri ldap://ldap.some-server.com/
1889 "OpenLDAP Administrator's Guide" contains a longer annotated
1890 example of a configuration file.
1891 The original ETCDIR/slapd.conf is another example.
1895 default slapd configuration file
1899 .BR slapd\-dnssrv (5),
1901 .BR slapd\-ldap (5),
1902 .BR slapd\-ldbm (5),
1903 .BR slapd\-ldif (5),
1904 .BR slapd\-meta (5),
1905 .BR slapd\-monitor (5),
1906 .BR slapd\-null (5),
1907 .BR slapd\-passwd (5),
1908 .BR slapd\-perl (5),
1909 .BR slapd\-relay (5),
1910 .BR slapd\-shell (5),
1912 .BR slapd.access (5),
1913 .BR slapd.plugin (5),
1914 .BR slapd.replog (5),
1926 Known overlays are documented in
1927 .BR slapo\-accesslog (5),
1928 .BR slapo\-auditlog (5),
1929 .BR slapo\-chain (5),
1930 .BR slapo\-dynlist (5),
1931 .BR slapo\-lastmod (5),
1932 .BR slapo\-pcache (5),
1933 .BR slapo\-ppolicy (5),
1934 .BR slapo\-refint (5),
1935 .BR slapo\-retcode (5),
1937 .BR slapo\-syncprov (5),
1938 .BR slapo\-translucent (5),
1939 .BR slapo\-unique (5).
1941 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1942 .SH ACKNOWLEDGEMENTS
1944 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1946 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob