1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2004 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
39 # comment - these options apply to every database
40 <global configuration options>
41 # first database definition & configuration options
42 database <backend 1 type>
43 <configuration options specific to backend 1>
44 # subsequent database definitions & configuration options
48 As many backend-specific sections as desired may be included. Global
49 options can be overridden in a backend (for options that appear more
50 than once, the last appearance in the
54 If a line begins with white space, it is considered a continuation
55 of the previous line. Blank lines and comment lines beginning with
56 a `#' character are ignored. (Note: continuation lines are unwrapped
57 before comment processing is applied.)
59 Arguments on configuration lines are separated by white space. If an
60 argument contains white space, the argument should be enclosed in
61 double quotes. If an argument contains a double quote (`"') or a
62 backslash character (`\\'), the character should be preceded by a
65 The specific configuration options available are discussed below in the
66 Global Configuration Options, General Backend Options, and General Database
67 Options. Backend-specific options are discussed in the
69 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
70 details on the slapd configuration file.
71 .SH GLOBAL CONFIGURATION OPTIONS
72 Options described in this section apply to all backends, unless specifically
73 overridden in a backend definition. Arguments that should be replaced by
74 actual text are shown in brackets <>.
76 .B access to <what> "[ by <who> <access> <control> ]+"
77 Grant access (specified by <access>) to a set of entries and/or
78 attributes (specified by <what>) by one or more requestors (specified
82 and the "OpenLDAP's Administrator's Guide" for details.
85 Specify a set of features (separated by white space) to
88 allows acceptance of LDAPv2 bind requests. Note that
90 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
92 allows anonymous bind when credentials are not empty (e.g.
95 allows unauthenticated (anonymous) bind when DN is not empty.
97 allow unauthenticated (anonymous) update operations to be processed
98 (subject to access controls and other administrative limits).
100 .B argsfile <filename>
101 The ( absolute ) name of a file that will hold the
103 server's command line options
104 if started without the debugging command line option.
106 .B attributeoptions [option-name]...
107 Define tagging attribute options or option tag/range prefixes.
108 Options must not end with `-', prefixes must end with `-'.
109 The `lang-' prefix is predefined.
112 directive, `lang-' will no longer be defined and you must specify it
113 explicitly if you want it defined.
115 An attribute description with a tagging option is a subtype of that
116 attribute description without the option.
117 Except for that, options defined this way have no special semantics.
118 Prefixes defined this way work like the `lang-' options:
119 They define a prefix for tagging options starting with the prefix.
120 That is, if you define the prefix `x-foo-', you can use the option
122 Furthermore, in a search or compare, a prefix or range name (with
123 a trailing `-') matches all options starting with that name, as well
124 as the option with the range name sans the trailing `-'.
125 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
127 RFC 2251 reserves options beginning with `x-' for private experiments.
128 Other options should be registered with IANA, see RFC 3383 section 3.4.
129 OpenLDAP also has the `binary' option built in, but this is a transfer
130 option, not a tagging option.
133 .B attributetype "(\ <oid>\
135 [DESC\ <description>]\
144 [NO\-USER\-MODIFICATION]\
145 [USAGE\ <attributeUsage>]\ )"
147 Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
148 The slapd parser extends the RFC 2252 definition by allowing string
149 forms as well as numeric OIDs to be used for the attribute OID and
150 attribute syntax OID.
156 .B authz-policy <policy>
157 Used to specify which rules to use for Proxy Authorization. Proxy
158 authorization allows a client to authenticate to the server using one
159 user's credentials, but specify a different identity to use for authorization
160 and access control purposes. It essentially allows user A to login as user
161 B, using user A's password.
164 flag disables proxy authorization. This is the default setting.
167 flag will use rules in the
169 attribute of the authorization DN.
172 flag will use rules in the
174 attribute of the authentication DN.
177 flag, an alias for the deprecated value of
179 will allow any of the above, whatever succeeds first (checked in
185 flag requires both authorizations to succeed.
188 The rules are mechanisms to specify which identities are allowed
189 to perform proxy authorization.
192 attribute in an entry specifies which other users
193 are allowed to proxy login to this entry. The
196 an entry specifies which other users this user can authorize as. Use of
199 abused if users are allowed to write arbitrary values to this attribute.
202 attribute must be protected with ACLs such that
203 only privileged users can modify it.
210 or a set of identities; it can take three forms:
213 .B ldap:///<base>??[<scope>]?<filter>
216 .B dn[.<dnstyle>]:<pattern>
219 .B u[<mech>[<realm>]]:<pattern>
222 .B group[/objectClass[/attributeType]]:<pattern>
229 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
232 The first form is a valid LDAP
240 portions must be absent, so that the search occurs locally on either
246 with the optional style modifiers
252 for exact, onelevel, children and subtree matches, which cause
254 to be normalized according to the DN normalization rules, or the special
256 style, which causes the
258 to be treated as a POSIX (''extended'') regular expression, as
265 means any non-anonymous DN.
266 The third form is a SASL
268 with the optional fields
272 that allow to specify a SASL
274 and eventually a SASL
276 for those mechanisms that support one.
277 The need to allow the specification of a mechanism is still debated,
278 and users are strongly discouraged to rely on this possibility.
279 The fourth form is a group specification, consisting of the keyword
281 optionally followed by the specification of the group
287 is searched with base scope, and in case of match, the values of the
290 are searched for the asserted DN.
291 For backwards compatibility, if no identity type is provided, i.e. only
295 is assumed; as a consequence,
297 is subjected to DN normalization.
298 Since the interpretation of
302 can impact security, users are strongly encouraged
303 to explicitly set the type of identity specification that is being used.
304 A subset of these rules can be used as third arg in the
306 statement (see below); significantly, the
313 .B authz-regexp <match> <replace>
314 Used by the authentication framework to convert simple user names,
315 such as provided by SASL subsystem, to an LDAP DN used for
316 authorization purposes. Note that the resultant DN need not refer
317 to an existing entry to be considered valid. When an authorization
318 request is received from the SASL subsystem, the SASL
323 are taken, when available, and combined into a name of the form
327 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
330 This name is then compared against the
332 POSIX (''extended'') regular expression, and if the match is successful,
333 the name is replaced with the
335 string. If there are wildcard strings in the
337 regular expression that are enclosed in parenthesis, e.g.
343 then the portion of the name that matched the wildcard will be stored
344 in the numbered placeholder variable $1. If there are other wildcard strings
345 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
346 placeholders can then be used in the
351 .B UID=$1,OU=Accounts,DC=example,DC=com
354 The replaced name can be either a DN or an LDAP URI. If the
355 latter, the server will use the URI to search its own database(s)
356 and, if the search returns exactly one entry, the name is
357 replaced by the DN of that entry. The LDAP URI must have no
358 hostport, attrs, or extensions components, e.g.
361 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
366 options can be given in the configuration file to allow for multiple matching
367 and replacement patterns. The matching patterns are checked in the order they
368 appear in the file, stopping at the first successful match.
371 .\"Because the plus sign + is a character recognized by the regular expression engine,
372 .\"and it will appear in names that include a REALM, be careful to escape the
373 .\"plus sign with a backslash \\+ to remove the character's special meaning.
376 .B concurrency <integer>
377 Specify a desired level of concurrency. Provided to the underlying
378 thread system as a hint. The default is not to provide any hint.
380 .B conn_max_pending <integer>
381 Specify the maximum number of pending requests for an anonymous session.
382 If requests are submitted faster than the server can process them, they
383 will be queued up to this limit. If the limit is exceeded, the session
384 is closed. The default is 100.
386 .B conn_max_pending_auth <integer>
387 Specify the maximum number of pending requests for an authenticated session.
390 .B defaultsearchbase <dn>
391 Specify a default search base to use when client submits a
392 non-base search request with an empty base DN.
394 .B disallow <features>
395 Specify a set of features (separated by white space) to
396 disallow (default none).
398 disables acceptance of anonymous bind requests.
400 disables simple (bind) authentication.
402 disables Kerberos V4 (bind) authentication.
404 disables Start TLS from forcing session to anonymous status (see also
407 disables StartTLS if authenticated (see also
411 .B ditcontentrule "(\ <oid>\
413 [DESC\ <description>]\
420 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
421 The slapd parser extends the RFC 2252 definition by allowing string
422 forms as well as numeric OIDs to be used for the attribute OID and
423 attribute syntax OID.
429 .B gentlehup { on | off }
430 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
432 will stop listening for new connections, but will not close the
433 connections to the current clients. Future write operations return
434 unwilling-to-perform, though. Slapd terminates when all clients
435 have closed their connections (if they ever do), or \- as before \-
436 if it receives a SIGTERM signal. This can be useful if you wish to
437 terminate the server and start a new
440 .B with another database,
441 without disrupting the currently active clients.
442 The default is off. You may wish to use
444 along with this option.
446 .B idletimeout <integer>
447 Specify the number of seconds to wait before forcibly closing
448 an idle client connection. A idletimeout of 0 disables this
449 feature. The default is 0.
451 .B include <filename>
452 Read additional configuration information from the given file before
453 continuing with the next line of the current file.
455 .B index_substr_if_minlen <integer>
456 Specify the minimum length for subinitial and subfinal indices. An
457 attribute value must have at least this many characters in order to be
458 processed by the indexing functions. The default is 2.
460 .B index_substr_if_maxlen <integer>
461 Specify the maximum length for subinitial and subfinal indices. Only
462 this many characters of an attribute value will be processed by the
463 indexing functions; any excess characters are ignored. The default is 4.
465 .B index_substr_any_len <integer>
466 Specify the length used for subany indices. An attribute value must have
467 at least this many characters in order to be processed. Attribute values
468 longer than this length will be processed in segments of this length. The
469 default is 4. The subany index will also be used in subinitial and
470 subfinal index lookups when the filter string is longer than the
471 .I index_substr_if_maxlen
474 .B index_substr_any_step <integer>
475 Specify the steps used in subany index lookups. This value sets the offset
476 for the segments of a filter string that are processed for a subany index
477 lookup. The default is 2. For example, with the default values, a search
478 using this filter "cn=*abcdefgh*" would generate index lookups for
479 "abcd", "cdef", and "efgh".
481 .\"-- NEW_LOGGING option --
483 .\".B logfile <filename>
484 .\"Specify a file for recording debug log messages. By default these messages
485 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
486 .\"copies messages to both stderr and the logfile.
489 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
490 such as those to the ldapi:// listener. For a description of SSF values,
494 option description. The default is 71.
496 .B loglevel <integer> [...]
497 Specify the level at which debugging statements and operation
498 statistics should be syslogged (currently logged to the
500 LOG_LOCAL4 facility). Log levels are additive, and available levels
512 debug packet handling
516 heavy trace debugging
520 connection management
524 print out packets sent and received
528 search filter processing
532 configuration file processing
536 access control list processing
540 stats log connections/operations/results
544 stats log entries sent
548 print communication with shell backends
555 The desired log level can be input as a single integer that combines
556 the (ORed) desired levels, as a list of integers (that are ORed internally),
557 or as a list of the names that are shown between brackets, such that
568 can be used as a shortcut to enable logging at all levels (equivalent to -1).
571 .B moduleload <filename>
572 Specify the name of a dynamically loadable module to load. The filename
573 may be an absolute path name or a simple filename. Non-absolute names
574 are searched for in the directories specified by the
576 option. This option and the
578 option are only usable if slapd was compiled with --enable-modules.
580 .B modulepath <pathspec>
581 Specify a list of directories to search for loadable modules. Typically
582 the path is colon-separated but this depends on the operating system.
585 .B objectclass "(\ <oid>\
587 [DESC\ <description]\
590 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
591 [MUST\ <oids>] [MAY\ <oids>] )"
593 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
594 The slapd parser extends the RFC 2252 definition by allowing string
595 forms as well as numeric OIDs to be used for the object class OID.
599 description.) Object classes are "STRUCTURAL" by default.
602 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
603 Define a string name that equates to the given OID. The string can be used
604 in place of the numeric OID in objectclass and attribute definitions. The
605 name can also be used with a suffix of the form ":xx" in which case the
606 value "oid.xx" will be used.
608 .B password-hash <hash> [<hash>...]
609 This option configures one or more hashes to be used in generation of user
610 passwords stored in the userPassword attribute during processing of
611 LDAP Password Modify Extended Operations (RFC 3062).
612 The <hash> must be one of
626 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
631 use the MD5 algorithm (RFC 1321), the latter with a seed.
638 indicates that the new password should be
639 added to userPassword as clear text.
641 Note that this option does not alter the normal user applications
642 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
644 .B password\-crypt\-salt\-format <format>
645 Specify the format of the salt passed to
647 when generating {CRYPT} passwords (see
649 during processing of LDAP Password Modify Extended Operations (RFC 3062).
651 This string needs to be in
653 format and may include one (and only one) %s conversion.
654 This conversion will be substituted with a string of random
655 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
656 provides a two character salt and "$1$%.8s" tells some
657 versions of crypt(3) to use an MD5 algorithm and provides
658 8 random characters of salt. The default is "%s", which
659 provides 31 characters of salt.
661 .B pidfile <filename>
662 The ( absolute ) name of a file that will hold the
664 server's process ID ( see
666 ) if started without the debugging command line option.
669 Specify the referral to pass back when
671 cannot find a local database to handle a request.
672 If specified multiple times, each url is provided.
675 The ( absolute ) name of a file that will hold the
677 server's command line options
678 if started without the debugging command line option.
681 The ( absolute ) name of a file that will hold the
683 server's process ID ( see
685 ) if started without the debugging command line option.
687 .B replicationinterval
688 The number of seconds
690 waits before checking the replogfile for changes.
692 .B require <conditions>
693 Specify a set of conditions (separated by white space) to
694 require (default none).
695 The directive may be specified globally and/or per-database.
697 requires bind operation prior to directory operations.
699 requires session to be using LDAP version 3.
701 requires authentication prior to directory operations.
703 requires SASL authentication prior to directory operations.
705 requires strong authentication prior to directory operations.
706 The strong keyword allows protected "simple" authentication
707 as well as SASL authentication.
709 may be used to require no conditions (useful for clearly globally
710 set conditions within a particular database).
712 .B reverse-lookup on | off
713 Enable/disable client name unverified reverse lookup (default is
715 if compiled with --enable-rlookups).
718 Specify the name of an LDIF(5) file containing user defined attributes
719 for the root DSE. These attributes are returned in addition to the
720 attributes normally produced by slapd.
723 Used to specify the fully qualified domain name used for SASL processing.
725 .B sasl-realm <realm>
726 Specify SASL realm. Default is empty.
728 .B sasl-secprops <properties>
729 Used to specify Cyrus SASL security properties.
732 flag (without any other properties) causes the flag properties
733 default, "noanonymous,noplain", to be cleared.
736 flag disables mechanisms susceptible to simple passive attacks.
739 flag disables mechanisms susceptible to active attacks.
742 flag disables mechanisms susceptible to passive dictionary attacks.
745 flag disables mechanisms which support anonymous login.
748 flag require forward secrecy between sessions.
751 require mechanisms which pass client credentials (and allow
752 mechanisms which can pass credentials to do so).
755 property specifies the minimum acceptable
756 .I security strength factor
757 as an integer approximate to effective key length used for
758 encryption. 0 (zero) implies no protection, 1 implies integrity
759 protection only, 56 allows DES or other weak ciphers, 112
760 allows triple DES and other strong ciphers, 128 allows RC4,
761 Blowfish and other modern strong ciphers. The default is 0.
764 property specifies the maximum acceptable
765 .I security strength factor
766 as an integer (see minssf description). The default is INT_MAX.
769 property specifies the maximum security layer receive buffer
770 size allowed. 0 disables security layers. The default is 65536.
773 Specify the distinguished name for the subschema subentry that
774 controls the entries on this server. The default is "cn=Subschema".
776 .B security <factors>
777 Specify a set of security strength factors (separated by white space)
781 option for a description of security strength factors).
782 The directive may be specified globally and/or per-database.
784 specifies the overall security strength factor.
786 specifies the transport security strength factor.
788 specifies the TLS security strength factor.
790 specifies the SASL security strength factor.
792 specifies the overall security strength factor to require for
794 .B update_transport=<n>
795 specifies the transport security strength factor to require for
798 specifies the TLS security strength factor to require for
801 specifies the SASL security strength factor to require for
804 specifies the security strength factor required for
806 username/password authentication.
809 factor is measure of security provided by the underlying transport,
810 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
812 .B sizelimit {<integer>|unlimited}
814 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
815 Specify the maximum number of entries to return from a search operation.
816 The default size limit is 500.
819 to specify no limits.
820 The second format allows a fine grain setting of the size limits.
821 Extra args can be added on the same line.
824 for an explanation of the different flags.
826 .B sockbuf_max_incoming <integer>
827 Specify the maximum incoming LDAP PDU size for anonymous sessions.
828 The default is 262143.
830 .B sockbuf_max_incoming_auth <integer>
831 Specify the maximum incoming LDAP PDU size for authenticated sessions.
832 The default is 4194303.
835 Specify the srvtab file in which the kerberos keys necessary for
836 authenticating clients using kerberos can be found. This option is only
837 meaningful if you are using Kerberos authentication.
840 Specify the maximum size of the primary thread pool.
843 .B timelimit {<integer>|unlimited}
845 .B timelimit time[.{soft|hard}]=<integer> [...]
846 Specify the maximum number of seconds (in real time)
848 will spend answering a search request. The default time limit is 3600.
851 to specify no limits.
852 The second format allows a fine grain setting of the time limits.
853 Extra args can be added on the same line.
856 for an explanation of the different flags.
858 .B ucdata-path <path>
859 Specify the path to the directory containing the Unicode character
860 tables. The default path is DATADIR/ucdata.
864 is built with support for Transport Layer Security, there are more options
867 .B TLSCipherSuite <cipher-suite-spec>
868 Permits configuring what ciphers will be accepted and the preference order.
869 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
871 TLSCipherSuite HIGH:MEDIUM:+SSLv2
873 To check what ciphers a given spec selects, use:
875 openssl ciphers -v <cipher-suite-spec>
877 .B TLSCACertificateFile <filename>
878 Specifies the file that contains certificates for all of the Certificate
883 .B TLSCACertificatePath <path>
884 Specifies the path of a directory that contains Certificate Authority
885 certificates in separate individual files. Usually only one of this
886 or the TLSCACertificateFile is used.
888 .B TLSCertificateFile <filename>
889 Specifies the file that contains the
893 .B TLSCertificateKeyFile <filename>
894 Specifies the file that contains the
896 server private key that matches the certificate stored in the
897 .B TLSCertificateFile
898 file. Currently, the private key must not be protected with a password, so
899 it is of critical importance that it is protected carefully.
901 .B TLSRandFile <filename>
902 Specifies the file to obtain random bits from when /dev/[u]random
903 is not available. Generally set to the name of the EGD/PRNGD socket.
904 The environment variable RANDFILE can also be used to specify the filename.
906 .B TLSVerifyClient <level>
907 Specifies what checks to perform on client certificates in an
908 incoming TLS session, if any.
911 can be specified as one of the following keywords:
917 will not ask the client for a certificate.
920 The client certificate is requested. If no certificate is provided,
921 the session proceeds normally. If a bad certificate is provided,
922 it will be ignored and the session proceeds normally.
925 The client certificate is requested. If no certificate is provided,
926 the session proceeds normally. If a bad certificate is provided,
927 the session is immediately terminated.
929 .B demand | hard | true
930 These keywords are all equivalent, for compatibility reasons.
931 The client certificate is requested. If no certificate is provided,
932 or a bad certificate is provided, the session is immediately terminated.
934 Note that a valid client certificate is required in order to use the
935 SASL EXTERNAL authentication mechanism with a TLS session. As such,
938 setting must be chosen to enable SASL EXTERNAL authentication.
940 .SH GENERAL BACKEND OPTIONS
941 Options in this section only apply to the configuration file section
942 for the specified backend. They are supported by every
945 .B backend <databasetype>
946 Mark the beginning of a backend definition. <databasetype>
962 depending on which backend will serve the database.
964 .SH GENERAL DATABASE OPTIONS
965 Options in this section only apply to the configuration file section
966 for the database in which they are defined. They are supported by every
967 type of backend. Note that the
971 option are mandatory for each database.
973 .B database <databasetype>
974 Mark the beginning of a new database instance definition. <databasetype>
990 depending on which backend will serve the database.
995 will automatically maintain the
996 modifiersName, modifyTimestamp, creatorsName, and
997 createTimestamp attributes for entries. By default, lastmod is on.
999 .B limits <who> <limit> [<limit> [...]]
1000 Specify time and size limits based on who initiated an operation.
1007 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1013 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1018 matches all unauthenticated clients.
1021 matches all authenticated clients;
1024 dn pattern is assumed unless otherwise specified by qualifying
1025 the (optional) key string
1031 (which are synonyms), to require an exact match; with
1033 to require exactly one level of depth match; with
1035 to allow any level of depth match, including the exact match; with
1037 to allow any level of depth match, not including the exact match;
1039 explicitly requires the (default) match based on POSIX (''extended'')
1040 regular expression pattern.
1043 matches unbound operations; the
1046 The same behavior is obtained by using the
1053 with the optional objectClass
1059 sets the limits for any DN listed in the values of the
1065 group objectClass (default
1067 whose DN exactly matches
1070 The currently supported limits are
1075 The syntax for time limits is
1076 .BR time[.{soft|hard}]=<integer> ,
1079 is the number of seconds slapd will spend answering a search request.
1080 If no time limit is explicitly requested by the client, the
1082 limit is used; if the requested time limit exceeds the
1085 .\".I "Administrative limit exceeded"
1086 .\"error is returned.
1087 limit, the value of the limit is used instead.
1090 limit is set to the keyword
1092 the soft limit is used in either case; if it is set to the keyword
1094 no hard limit is enforced.
1095 Explicit requests for time limits smaller or equal to the
1098 If no limit specifier is set, the value is assigned to the
1104 to preserve the original behavior.
1106 The syntax for size limits is
1107 .BR size[.{soft|hard|unchecked}]=<integer> ,
1110 is the maximum number of entries slapd will return answering a search
1112 If no size limit is explicitly requested by the client, the
1114 limit is used; if the requested size limit exceeds the
1117 .\".I "Administrative limit exceeded"
1118 .\"error is returned.
1119 limit, the value of the limit is used instead.
1122 limit is set to the keyword
1124 the soft limit is used in either case; if it is set to the keyword
1126 no hard limit is enforced.
1127 Explicit requests for size limits smaller or equal to the
1132 specifier sets a limit on the number of candidates a search request is allowed
1134 The rationale behind it is that searches for non-properly indicized
1135 attributes may result in large sets of candidates, which must be
1138 to determine whether they match the search filter or not.
1141 limit provides a means to drop such operations before they are even
1143 If the selected candidates exceed the
1145 limit, the search will abort with
1146 .IR "Unwilling to perform" .
1147 If it is set to the keyword
1149 no limit is applied (the default).
1152 the search is not even performed; this can be used to disallow searches
1153 for a specific set of users.
1154 If no limit specifier is set, the value is assigned to the
1160 to preserve the original behavior.
1162 In case of no match, the global limits are used.
1163 The default values are the same of
1172 control is requested, the
1174 size limit is used by default, because the request of a specific page size
1175 is considered an explicit request for a limitation on the number
1176 of entries to be returned.
1177 However, the size limit applies to the total count of entries returned within
1178 the search, and not to a single page.
1179 Additional size limits may be enforced; the syntax is
1180 .BR size.pr={<integer>|noEstimate|unlimited} ,
1183 is the max page size if no explicit limit is set; the keyword
1185 inhibits the server from returning an estimate of the total number
1186 of entries that might be returned
1187 (note: the current implementation does not return any estimate).
1190 indicates that no limit is applied to the pagedResults control page size.
1192 .B size.prtotal={<integer>|unlimited|disabled}
1193 allows to set a limit on the total number of entries that a pagedResults
1194 control allows to return.
1195 By default it is set to the
1200 is the max number of entries that the whole search with pagedResults control
1204 to allow unlimited number of entries to be returned, e.g. to allow
1205 the use of the pagedResults control as a means to circumvent size
1206 limitations on regular searches; the keyword
1208 disables the control, i.e. no paged results can be returned.
1209 Note that the total number of entries returned when the pagedResults control
1210 is requested cannot exceed the
1212 size limit of regular searches unless extended by the
1217 .B maxderefdepth <depth>
1218 Specifies the maximum number of aliases to dereference when trying to
1219 resolve an entry, used to avoid infinite alias loops. The default is 1.
1221 .B overlay <overlay-name>
1222 Add the specified overlay to this database. An overlay is a piece of
1223 code that intercepts database operations in order to extend or change
1224 them. Overlays are pushed onto
1225 a stack over the database, and so they will execute in the reverse
1226 of the order in which they were configured and the database itself
1227 will receive control last of all.
1229 .B readonly on | off
1230 This option puts the database into "read-only" mode. Any attempts to
1231 modify the database will return an "unwilling to perform" error. By
1232 default, readonly is off.
1235 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1236 .B [starttls=yes|critical]
1237 .B [suffix=<suffix> [...]]
1238 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1239 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1240 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1241 .B [attr[!]=<attr list>]
1243 Specify a replication site for this database. Refer to the "OpenLDAP
1244 Administrator's Guide" for detailed information on setting up a replicated
1246 directory service. Zero or more
1248 instances can be used to select the subtrees that will be replicated
1249 (defaults to all the database).
1251 is deprecated in favor of the
1255 allows the replica LDAP server to be specified as an LDAP URI.
1260 requires the options
1264 and should only be used when adequate security services
1265 (e.g TLS or IPSEC) are in place. A
1271 Specific security properties (as with the
1273 keyword above) for a SASL bind can be set with the
1275 option. A non-default SASL realm can be set with the
1280 will use Kerberos, a kerberos instance should be given in
1284 can be given after the
1286 keyword to allow the selective replication of the listed attributes only;
1289 mark is used, the list is considered exclusive, i.e. the listed attributes
1291 If an objectClass is listed, all the related attributes
1292 are (are not) replicated.
1295 .B replogfile <filename>
1296 Specify the name of the replication log file to log changes to.
1297 The replication log is typically written by
1302 .BR slapd.replog (5)
1303 for more information. The specified file should be located
1304 in a directory with limited read/write/execute access as the replication
1305 logs may contain sensitive information.
1307 .B restrict <oplist>
1308 Specify a whitespace separated list of operations that are restricted.
1309 If defined inside a database specification, restrictions apply only
1310 to that database, otherwise they are global.
1311 Operations can be any of
1316 .BR extended[=<OID>] ,
1320 or the special pseudo-operations
1324 which respectively summarize read and write operations.
1332 keyword allows to indicate the OID of the specific operation
1336 Specify the distinguished name that is not subject to access control
1337 or administrative limit restrictions for operations on this database.
1338 This DN may or may not be associated with an entry. An empty root
1339 DN (the default) specifies no root access is to be granted. It is
1340 recommended that the rootdn only be specified when needed (such as
1341 when initially populating a database). If the rootdn is within
1342 a namingContext (suffix) of the database, a simple bind password
1343 may also be provided using the
1347 .B rootpw <password>
1348 Specify a password (or hash of the password) for the rootdn. The
1349 password can only be set if the rootdn is within the namingContext
1350 (suffix) of the database.
1351 This option accepts all RFC 2307 userPassword formats known to
1354 description) as well as cleartext.
1356 may be used to generate a hash of a password. Cleartext
1357 and \fB{CRYPT}\fP passwords are not recommended. If empty
1358 (the default), authentication of the root DN is by other means
1359 (e.g. SASL). Use of SASL is encouraged.
1361 .B suffix <dn suffix>
1362 Specify the DN suffix of queries that will be passed to this
1363 backend database. Multiple suffix lines can be given and at least one is
1364 required for each database definition.
1365 If the suffix of one database is "inside" that of another, the database
1366 with the inner suffix must come first in the configuration file.
1369 Specify that the current backend database is a subordinate of another
1370 backend database. A subordinate database may have only one suffix. This
1371 option may be used to glue multiple databases into a single namingContext.
1372 If the suffix of the current database is within the namingContext of a
1373 superior database, searches against the superior database will be
1374 propagated to the subordinate as well. All of the databases
1375 associated with a single namingContext should have identical rootdns.
1376 Behavior of other LDAP operations is unaffected by this setting. In
1377 particular, it is not possible to use moddn to move an entry from
1378 one subordinate to another subordinate within the namingContext.
1381 .B syncrepl rid=<replica ID>
1382 .B provider=ldap[s]://<hostname>[:port]
1383 .B [type=refreshOnly|refreshAndPersist]
1384 .B [interval=dd:hh:mm:ss]
1385 .B [searchbase=<base DN>]
1386 .B [filter=<filter str>]
1387 .B [scope=sub|one|base]
1388 .B [attrs=<attr list>]
1390 .B [sizelimit=<limit>]
1391 .B [timelimit=<limit>]
1392 .B [schemachecking=on|off]
1394 .B [bindmethod=simple|sasl]
1396 .B [saslmech=<mech>]
1397 .B [authcid=<identity>]
1398 .B [authzid=<identity>]
1399 .B [credentials=<passwd>]
1401 .B [secprops=<properties>]
1403 Specify the current database as a replica which is kept up-to-date with the
1404 master content by establishing the current
1406 as a replication consumer site running a
1409 The replica content is kept synchronized to the master content using
1410 the LDAP Content Synchronization protocol. Refer to the
1411 "OpenLDAP Administrator's Guide" for detailed information on
1412 setting up a replicated
1414 directory service using the
1418 identifies the current
1420 directive within the replication consumer site.
1421 It is a non-negative integer having no more than three digits.
1423 specifies the replication provider site containing the master content
1424 as an LDAP URI. If <port> is not given, the standard LDAP port number
1425 (389 or 636) is used. The content of the
1427 replica is defined using a search
1428 specification as its result set. The consumer
1430 will send search requests to the provider
1432 according to the search specification. The search specification includes
1433 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1436 parameters as in the normal search specification.
1437 The search specification for the LDAP Content Synchronization operation
1438 has the same value syntax and the same default values as in the
1441 The LDAP Content Synchronization protocol has two operation types.
1444 operation, the next synchronization search operation
1445 is periodically rescheduled at an interval time (specified by
1447 parameter; 1 day by default)
1448 after each synchronization operation finishes.
1450 .B refreshAndPersist
1451 operation, a synchronization search remains persistent in the provider slapd.
1452 Further updates to the master replica will generate
1453 .B searchResultEntry
1454 to the consumer slapd as the search responses to the persistent
1455 synchronization search. If the connection is lost, the consumer will
1456 attempt to reconnect at an interval time (specified by
1458 parameter; 60 seconds by default) until the session is re-established.
1459 The schema checking can be enforced at the LDAP Sync
1460 consumer site by turning on the
1462 parameter. The default is off.
1465 parameter specifies the DN in the consumer site
1466 which is allowed to make changes to the replica.
1467 The DN should have read/write access to the replica database.
1472 of the master database.
1477 requires the options
1481 and should only be used when adequate security services
1482 (e.g. TLS or IPSEC) are in place.
1489 Depending on the mechanism, an authentication identity and/or
1490 credentials can be specified using
1496 parameter may be used to specify an authorization identity.
1497 Specific security properties (as with the
1499 keyword above) for a SASL bind can be set with the
1501 option. A non default SASL realm can be set with the
1507 This option is only applicable in a slave
1508 database updated using
1510 It specifies the DN permitted to update (subject to access controls)
1511 the replica (typically, this is the DN
1513 binds to update the replica). Generally, this DN
1520 Specify the referral to pass back when
1522 is asked to modify a replicated local database.
1523 If specified multiple times, each url is provided.
1525 .SH DATABASE-SPECIFIC OPTIONS
1526 Each database may allow specific configuration options; they are
1527 documented separately in the backends' manual pages.
1529 The following backends can be compiled into slapd.
1530 They are documented in the
1531 .BR slapd-<backend> (5)
1535 This is the recommended backend for a normal slapd database.
1536 However, it takes more care than with the LDBM backend to configure
1538 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1541 This is the database backend which is easiest to configure.
1542 However, it does not offer the data durability features of the BDB
1544 It uses Berkeley DB or GDBM to store data.
1547 This backend is experimental.
1548 It serves up referrals based upon SRV resource records held in the
1552 This backend acts as a proxy to forward incoming requests to another
1556 This backend performs basic LDAP proxying with respect to a set of
1557 remote LDAP servers. It is an enhancement of the ldap backend. The
1558 proxy cache extension of meta backend provides answering of search
1559 requests from the proxy using results of previously cached requests.
1562 This backend provides information about the running status of the slapd
1566 Operations in this backend succeed but do nothing.
1569 This backend is provided for demonstration purposes only.
1570 It serves up user account information from the system
1575 This backend embeds a
1577 interpreter into slapd.
1578 It runs Perl subroutines to implement LDAP operations.
1581 This backend redirects LDAP operations to another database
1582 in the same server, based on the naming context of the request.
1583 Its use requires the
1587 for details) to rewrite the naming context of the request.
1588 It is is primarily intended to implement virtual views on databases
1589 that actually store data.
1592 This backend executes external programs to implement LDAP operations.
1593 It is primarily intended to be used in prototypes.
1596 This backend is experimental.
1597 It services LDAP requests from an SQL database.
1600 This backend is experimental.
1603 interpreter into slapd.
1604 It runs Tcl commands to implement LDAP operations.
1607 Here is a short example of a configuration file:
1611 include SYSCONFDIR/schema/core.schema
1612 pidfile LOCALSTATEDIR/slapd.pid
1614 # Subtypes of "name" (e.g. "cn" and "ou") with the
1615 # option ";x-hidden" can be searched for/compared,
1616 # but are not shown. See \fBslapd.access\fP(5).
1617 attributeoptions x-hidden lang-
1618 access to attr=name;x-hidden by * =cs
1621 suffix "dc=our-domain,dc=com"
1622 # The database directory MUST exist prior to
1623 # running slapd AND should only be accessible
1624 # by the slapd/tools. Mode 0700 recommended.
1625 directory LOCALSTATEDIR/openldap-data
1626 # Indices to maintain
1627 index objectClass eq
1628 index cn,sn,mail pres,eq,approx,sub
1630 # We serve small clients that do not handle referrals,
1631 # so handle remote lookups on their behalf.
1634 uri ldap://ldap.some-server.com/
1639 "OpenLDAP Administrator's Guide" contains a longer annotated
1640 example of a configuration file.
1641 The original ETCDIR/slapd.conf is another example.
1645 default slapd configuration file
1649 .BR slapd\-dnssrv (5),
1650 .BR slapd\-ldap (5),
1651 .BR slapd\-ldbm (5),
1652 .BR slapd\-meta (5),
1653 .BR slapd\-monitor (5),
1654 .BR slapd\-null (5),
1655 .BR slapd\-passwd (5),
1656 .BR slapd\-perl (5),
1657 .BR slapd\-relay (5),
1658 .BR slapd\-shell (5),
1661 .BR slapd.access (5),
1662 .BR slapd.plugin (5),
1663 .BR slapd.replog (5),
1675 Known overlays are documented in
1676 .BR slapo\-lastmod (5),
1677 .BR slapo\-pcache (5),
1678 .BR slapo\-ppolicy (5),
1679 .BR slapo\-refint (5),
1681 .BR slapo\-unique (5).
1683 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1684 .SH ACKNOWLEDGEMENTS
1686 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1688 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob