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.
389 .\"-- NEW_LOGGING option --
391 .\".B debug <subsys> <level>
392 .\"Specify a logging level for a particular subsystem. The subsystems include
394 .\"a global level for all subsystems,
398 .\"the backend databases,
400 .\"the entry cache manager,
402 .\"the config file reader,
404 .\"the connection manager,
406 .\"the Cyrus SASL library interface,
408 .\"the search filter processor,
410 .\"the DN normalization library,
412 .\"the database indexer,
414 .\"the ASN.1 BER library,
416 .\"the dynamic module loader,
418 .\"the LDAP operation processors,
420 .\"the SASL authentication subsystem,
422 .\"the schema processor, and
424 .\"the TLS library interface. This is not an exhaustive list; there are many
425 .\"other subsystems and more are added over time.
427 .\"The levels are, in order of decreasing priority:
428 .\".B emergency, alert, critical, error, warning, notice, information, entry,
429 .\".B args, results, detail1, detail2
430 .\"An integer may be used instead, with 0 corresponding to
436 .\"level logs function entry points,
438 .\"adds function call parameters, and
440 .\"adds the function results to the logs.
445 .\"levels add even more low level detail from individual functions.
447 .B defaultsearchbase <dn>
448 Specify a default search base to use when client submits a
449 non-base search request with an empty base DN.
451 .B disallow <features>
452 Specify a set of features (separated by white space) to
453 disallow (default none).
455 disables acceptance of anonymous bind requests.
457 disables simple (bind) authentication.
459 disables Kerberos V4 (bind) authentication.
461 disables Start TLS from forcing session to anonymous status (see also
464 disables StartTLS if authenticated (see also
468 .B ditcontentrule "(\ <oid>\
470 [DESC\ <description>]\
477 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
478 The slapd parser extends the RFC 2252 definition by allowing string
479 forms as well as numeric OIDs to be used for the attribute OID and
480 attribute syntax OID.
486 .B gentlehup { on | off }
487 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
489 will stop listening for new connections, but will not close the
490 connections to the current clients. Future write operations return
491 unwilling-to-perform, though. Slapd terminates when all clients
492 have closed their connections (if they ever do), or \- as before \-
493 if it receives a SIGTERM signal. This can be useful if you wish to
494 terminate the server and start a new
497 .B with another database,
498 without disrupting the currently active clients.
499 The default is off. You may wish to use
501 along with this option.
503 .B idletimeout <integer>
504 Specify the number of seconds to wait before forcibly closing
505 an idle client connection. A idletimeout of 0 disables this
506 feature. The default is 0.
508 .B include <filename>
509 Read additional configuration information from the given file before
510 continuing with the next line of the current file.
512 .B index_substr_if_minlen <integer>
513 Specify the minimum length for subinitial and subfinal indices. An
514 attribute value must have at least this many characters in order to be
515 processed by the indexing functions. The default is 2.
517 .B index_substr_if_maxlen <integer>
518 Specify the maximum length for subinitial and subfinal indices. Only
519 this many characters of an attribute value will be processed by the
520 indexing functions; any excess characters are ignored. The default is 4.
522 .B index_substr_any_len <integer>
523 Specify the length used for subany indices. An attribute value must have
524 at least this many characters in order to be processed. Attribute values
525 longer than this length will be processed in segments of this length. The
526 default is 4. The subany index will also be used in subinitial and
527 subfinal index lookups when the filter string is longer than the
528 .I index_substr_if_maxlen
531 .B index_substr_any_step <integer>
532 Specify the steps used in subany index lookups. This value sets the offset
533 for the segments of a filter string that are processed for a subany index
534 lookup. The default is 2. For example, with the default values, a search
535 using this filter "cn=*abcdefgh*" would generate index lookups for
536 "abcd", "cdef", and "efgh".
538 .\"-- NEW_LOGGING option --
540 .\".B logfile <filename>
541 .\"Specify a file for recording debug log messages. By default these messages
542 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
543 .\"copies messages to both stderr and the logfile.
546 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
547 such as those to the ldapi:// listener. For a description of SSF values,
551 option description. The default is 71.
553 .B loglevel <integer> [...]
554 Specify the level at which debugging statements and operation
555 statistics should be syslogged (currently logged to the
557 LOG_LOCAL4 facility). Log levels are additive, and available levels
569 debug packet handling
573 heavy trace debugging
577 connection management
581 print out packets sent and received
585 search filter processing
589 configuration file processing
593 access control list processing
597 stats log connections/operations/results
601 stats log entries sent
605 print communication with shell backends
612 The desired log level can be input as a single integer that combines
613 the (ORed) desired levels, as a list of integers (that are ORed internally),
614 or as a list of the names that are shown between brackets, such that
625 can be used as a shortcut to enable logging at all levels (equivalent to -1).
628 .B moduleload <filename>
629 Specify the name of a dynamically loadable module to load. The filename
630 may be an absolute path name or a simple filename. Non-absolute names
631 are searched for in the directories specified by the
633 option. This option and the
635 option are only usable if slapd was compiled with --enable-modules.
637 .B modulepath <pathspec>
638 Specify a list of directories to search for loadable modules. Typically
639 the path is colon-separated but this depends on the operating system.
642 .B objectclass "(\ <oid>\
644 [DESC\ <description]\
647 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
648 [MUST\ <oids>] [MAY\ <oids>] )"
650 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
651 The slapd parser extends the RFC 2252 definition by allowing string
652 forms as well as numeric OIDs to be used for the object class OID.
656 description.) Object classes are "STRUCTURAL" by default.
659 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
660 Define a string name that equates to the given OID. The string can be used
661 in place of the numeric OID in objectclass and attribute definitions. The
662 name can also be used with a suffix of the form ":xx" in which case the
663 value "oid.xx" will be used.
665 .B password-hash <hash> [<hash>...]
666 This option configures one or more hashes to be used in generation of user
667 passwords stored in the userPassword attribute during processing of
668 LDAP Password Modify Extended Operations (RFC 3062).
669 The <hash> must be one of
683 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
688 use the MD5 algorithm (RFC 1321), the latter with a seed.
695 indicates that the new password should be
696 added to userPassword as clear text.
698 Note that this option does not alter the normal user applications
699 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
701 .B password\-crypt\-salt\-format <format>
702 Specify the format of the salt passed to
704 when generating {CRYPT} passwords (see
706 during processing of LDAP Password Modify Extended Operations (RFC 3062).
708 This string needs to be in
710 format and may include one (and only one) %s conversion.
711 This conversion will be substituted with a string of random
712 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
713 provides a two character salt and "$1$%.8s" tells some
714 versions of crypt(3) to use an MD5 algorithm and provides
715 8 random characters of salt. The default is "%s", which
716 provides 31 characters of salt.
718 .B pidfile <filename>
719 The ( absolute ) name of a file that will hold the
721 server's process ID ( see
723 ) if started without the debugging command line option.
726 Specify the referral to pass back when
728 cannot find a local database to handle a request.
729 If specified multiple times, each url is provided.
732 The ( absolute ) name of a file that will hold the
734 server's command line options
735 if started without the debugging command line option.
738 The ( absolute ) name of a file that will hold the
740 server's process ID ( see
742 ) if started without the debugging command line option.
744 .B replicationinterval
745 The number of seconds
747 waits before checking the replogfile for changes.
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 srvtab file in which the kerberos keys necessary for
893 authenticating clients using kerberos can be found. This option is only
894 meaningful if you are using Kerberos authentication.
897 Specify the maximum size of the primary thread pool.
900 .B timelimit {<integer>|unlimited}
902 .B timelimit time[.{soft|hard}]=<integer> [...]
903 Specify the maximum number of seconds (in real time)
905 will spend answering a search request. The default time limit is 3600.
908 to specify no limits.
909 The second format allows a fine grain setting of the time limits.
910 Extra args can be added on the same line.
913 for an explanation of the different flags.
915 .B ucdata-path <path>
916 Specify the path to the directory containing the Unicode character
917 tables. The default path is DATADIR/ucdata.
921 is built with support for Transport Layer Security, there are more options
924 .B TLSCipherSuite <cipher-suite-spec>
925 Permits configuring what ciphers will be accepted and the preference order.
926 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
928 TLSCipherSuite HIGH:MEDIUM:+SSLv2
930 To check what ciphers a given spec selects, use:
932 openssl ciphers -v <cipher-suite-spec>
934 .B TLSCACertificateFile <filename>
935 Specifies the file that contains certificates for all of the Certificate
940 .B TLSCACertificatePath <path>
941 Specifies the path of a directory that contains Certificate Authority
942 certificates in separate individual files. Usually only one of this
943 or the TLSCACertificateFile is used.
945 .B TLSCertificateFile <filename>
946 Specifies the file that contains the
950 .B TLSCertificateKeyFile <filename>
951 Specifies the file that contains the
953 server private key that matches the certificate stored in the
954 .B TLSCertificateFile
955 file. Currently, the private key must not be protected with a password, so
956 it is of critical importance that it is protected carefully.
958 .B TLSRandFile <filename>
959 Specifies the file to obtain random bits from when /dev/[u]random
960 is not available. Generally set to the name of the EGD/PRNGD socket.
961 The environment variable RANDFILE can also be used to specify the filename.
963 .B TLSVerifyClient <level>
964 Specifies what checks to perform on client certificates in an
965 incoming TLS session, if any.
968 can be specified as one of the following keywords:
974 will not ask the client for a certificate.
977 The client certificate is requested. If no certificate is provided,
978 the session proceeds normally. If a bad certificate is provided,
979 it will be ignored and the session proceeds normally.
982 The client certificate is requested. If no certificate is provided,
983 the session proceeds normally. If a bad certificate is provided,
984 the session is immediately terminated.
986 .B demand | hard | true
987 These keywords are all equivalent, for compatibility reasons.
988 The client certificate is requested. If no certificate is provided,
989 or a bad certificate is provided, the session is immediately terminated.
991 Note that a valid client certificate is required in order to use the
992 SASL EXTERNAL authentication mechanism with a TLS session. As such,
995 setting must be chosen to enable SASL EXTERNAL authentication.
997 .SH GENERAL BACKEND OPTIONS
998 Options in this section only apply to the configuration file section
999 for the specified backend. They are supported by every
1002 .B backend <databasetype>
1003 Mark the beginning of a backend definition. <databasetype>
1019 depending on which backend will serve the database.
1021 .SH GENERAL DATABASE OPTIONS
1022 Options in this section only apply to the configuration file section
1023 for the database in which they are defined. They are supported by every
1024 type of backend. Note that the
1028 option are mandatory for each database.
1030 .B database <databasetype>
1031 Mark the beginning of a new database instance definition. <databasetype>
1047 depending on which backend will serve the database.
1052 will automatically maintain the
1053 modifiersName, modifyTimestamp, creatorsName, and
1054 createTimestamp attributes for entries. By default, lastmod is on.
1056 .B limits <who> <limit> [<limit> [...]]
1057 Specify time and size limits based on who initiated an operation.
1064 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1070 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1075 matches all unauthenticated clients.
1078 matches all authenticated clients;
1081 dn pattern is assumed unless otherwise specified by qualifying
1082 the (optional) key string
1088 (which are synonyms), to require an exact match; with
1090 to require exactly one level of depth match; with
1092 to allow any level of depth match, including the exact match; with
1094 to allow any level of depth match, not including the exact match;
1096 explicitly requires the (default) match based on POSIX (''extended'')
1097 regular expression pattern.
1100 matches unbound operations; the
1103 The same behavior is obtained by using the
1110 with the optional objectClass
1116 sets the limits for any DN listed in the values of the
1122 group objectClass (default
1124 whose DN exactly matches
1127 The currently supported limits are
1132 The syntax for time limits is
1133 .BR time[.{soft|hard}]=<integer> ,
1136 is the number of seconds slapd will spend answering a search request.
1137 If no time limit is explicitly requested by the client, the
1139 limit is used; if the requested time limit exceeds the
1142 .\".I "Administrative limit exceeded"
1143 .\"error is returned.
1144 limit, the value of the limit is used instead.
1147 limit is set to the keyword
1149 the soft limit is used in either case; if it is set to the keyword
1151 no hard limit is enforced.
1152 Explicit requests for time limits smaller or equal to the
1155 If no limit specifier is set, the value is assigned to the
1161 to preserve the original behavior.
1163 The syntax for size limits is
1164 .BR size[.{soft|hard|unchecked}]=<integer> ,
1167 is the maximum number of entries slapd will return answering a search
1169 If no size limit is explicitly requested by the client, the
1171 limit is used; if the requested size limit exceeds the
1174 .\".I "Administrative limit exceeded"
1175 .\"error is returned.
1176 limit, the value of the limit is used instead.
1179 limit is set to the keyword
1181 the soft limit is used in either case; if it is set to the keyword
1183 no hard limit is enforced.
1184 Explicit requests for size limits smaller or equal to the
1189 specifier sets a limit on the number of candidates a search request is allowed
1191 The rationale behind it is that searches for non-properly indicized
1192 attributes may result in large sets of candidates, which must be
1195 to determine whether they match the search filter or not.
1198 limit provides a means to drop such operations before they are even
1200 If the selected candidates exceed the
1202 limit, the search will abort with
1203 .IR "Unwilling to perform" .
1204 If it is set to the keyword
1206 no limit is applied (the default).
1209 the search is not even performed; this can be used to disallow searches
1210 for a specific set of users.
1211 If no limit specifier is set, the value is assigned to the
1217 to preserve the original behavior.
1219 In case of no match, the global limits are used.
1220 The default values are the same of
1229 control is requested, the
1231 size limit is used by default, because the request of a specific page size
1232 is considered an explicit request for a limitation on the number
1233 of entries to be returned.
1234 However, the size limit applies to the total count of entries returned within
1235 the search, and not to a single page.
1236 Additional size limits may be enforced; the syntax is
1237 .BR size.pr={<integer>|noEstimate|unlimited} ,
1240 is the max page size if no explicit limit is set; the keyword
1242 inhibits the server from returning an estimate of the total number
1243 of entries that might be returned
1244 (note: the current implementation does not return any estimate).
1247 indicates that no limit is applied to the pagedResults control page size.
1249 .B size.prtotal={<integer>|unlimited|disabled}
1250 allows to set a limit on the total number of entries that a pagedResults
1251 control allows to return.
1252 By default it is set to the
1257 is the max number of entries that the whole search with pagedResults control
1261 to allow unlimited number of entries to be returned, e.g. to allow
1262 the use of the pagedResults control as a means to circumvent size
1263 limitations on regular searches; the keyword
1265 disables the control, i.e. no paged results can be returned.
1266 Note that the total number of entries returned when the pagedResults control
1267 is requested cannot exceed the
1269 size limit of regular searches unless extended by the
1274 .B maxderefdepth <depth>
1275 Specifies the maximum number of aliases to dereference when trying to
1276 resolve an entry, used to avoid infinite alias loops. The default is 1.
1278 .B overlay <overlay-name>
1279 Add the specified overlay to this database. An overlay is a piece of
1280 code that intercepts database operations in order to extend or change
1281 them. Overlays are pushed onto
1282 a stack over the database, and so they will execute in the reverse
1283 of the order in which they were configured and the database itself
1284 will receive control last of all.
1286 .B readonly on | off
1287 This option puts the database into "read-only" mode. Any attempts to
1288 modify the database will return an "unwilling to perform" error. By
1289 default, readonly is off.
1292 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1293 .B [starttls=yes|critical]
1294 .B [suffix=<suffix> [...]]
1295 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1296 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1297 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1298 .B [attr[!]=<attr list>]
1300 Specify a replication site for this database. Refer to the "OpenLDAP
1301 Administrator's Guide" for detailed information on setting up a replicated
1303 directory service. Zero or more
1305 instances can be used to select the subtrees that will be replicated
1306 (defaults to all the database).
1308 is deprecated in favor of the
1312 allows the replica LDAP server to be specified as an LDAP URI.
1317 requires the options
1321 and should only be used when adequate security services
1322 (e.g TLS or IPSEC) are in place. A
1328 Specific security properties (as with the
1330 keyword above) for a SASL bind can be set with the
1332 option. A non-default SASL realm can be set with the
1337 will use Kerberos, a kerberos instance should be given in
1341 can be given after the
1343 keyword to allow the selective replication of the listed attributes only;
1346 mark is used, the list is considered exclusive, i.e. the listed attributes
1348 If an objectClass is listed, all the related attributes
1349 are (are not) replicated.
1352 .B replogfile <filename>
1353 Specify the name of the replication log file to log changes to.
1354 The replication log is typically written by
1359 .BR slapd.replog (5)
1360 for more information. The specified file should be located
1361 in a directory with limited read/write/execute access as the replication
1362 logs may contain sensitive information.
1364 .B restrict <oplist>
1365 Specify a whitespace separated list of operations that are restricted.
1366 If defined inside a database specification, restrictions apply only
1367 to that database, otherwise they are global.
1368 Operations can be any of
1373 .BR extended[=<OID>] ,
1377 or the special pseudo-operations
1381 which respectively summarize read and write operations.
1389 keyword allows to indicate the OID of the specific operation
1393 Specify the distinguished name that is not subject to access control
1394 or administrative limit restrictions for operations on this database.
1395 This DN may or may not be associated with an entry. An empty root
1396 DN (the default) specifies no root access is to be granted. It is
1397 recommended that the rootdn only be specified when needed (such as
1398 when initially populating a database). If the rootdn is within
1399 a namingContext (suffix) of the database, a simple bind password
1400 may also be provided using the
1404 .B rootpw <password>
1405 Specify a password (or hash of the password) for the rootdn. The
1406 password can only be set if the rootdn is within the namingContext
1407 (suffix) of the database.
1408 This option accepts all RFC 2307 userPassword formats known to
1411 description) as well as cleartext.
1413 may be used to generate a hash of a password. Cleartext
1414 and \fB{CRYPT}\fP passwords are not recommended. If empty
1415 (the default), authentication of the root DN is by other means
1416 (e.g. SASL). Use of SASL is encouraged.
1418 .B suffix <dn suffix>
1419 Specify the DN suffix of queries that will be passed to this
1420 backend database. Multiple suffix lines can be given and at least one is
1421 required for each database definition.
1422 If the suffix of one database is "inside" that of another, the database
1423 with the inner suffix must come first in the configuration file.
1426 Specify that the current backend database is a subordinate of another
1427 backend database. A subordinate database may have only one suffix. This
1428 option may be used to glue multiple databases into a single namingContext.
1429 If the suffix of the current database is within the namingContext of a
1430 superior database, searches against the superior database will be
1431 propagated to the subordinate as well. All of the databases
1432 associated with a single namingContext should have identical rootdns.
1433 Behavior of other LDAP operations is unaffected by this setting. In
1434 particular, it is not possible to use moddn to move an entry from
1435 one subordinate to another subordinate within the namingContext.
1438 .B syncrepl rid=<replica ID>
1439 .B provider=ldap[s]://<hostname>[:port]
1440 .B [type=refreshOnly|refreshAndPersist]
1441 .B [interval=dd:hh:mm:ss]
1442 .B [searchbase=<base DN>]
1443 .B [filter=<filter str>]
1444 .B [scope=sub|one|base]
1445 .B [attrs=<attr list>]
1447 .B [sizelimit=<limit>]
1448 .B [timelimit=<limit>]
1449 .B [schemachecking=on|off]
1451 .B [bindmethod=simple|sasl]
1453 .B [saslmech=<mech>]
1454 .B [authcid=<identity>]
1455 .B [authzid=<identity>]
1456 .B [credentials=<passwd>]
1458 .B [secprops=<properties>]
1460 Specify the current database as a replica which is kept up-to-date with the
1461 master content by establishing the current
1463 as a replication consumer site running a
1466 The replica content is kept synchronized to the master content using
1467 the LDAP Content Synchronization protocol. Refer to the
1468 "OpenLDAP Administrator's Guide" for detailed information on
1469 setting up a replicated
1471 directory service using the
1475 identifies the current
1477 directive within the replication consumer site.
1478 It is a non-negative integer having no more than three digits.
1480 specifies the replication provider site containing the master content
1481 as an LDAP URI. If <port> is not given, the standard LDAP port number
1482 (389 or 636) is used. The content of the
1484 replica is defined using a search
1485 specification as its result set. The consumer
1487 will send search requests to the provider
1489 according to the search specification. The search specification includes
1490 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1493 parameters as in the normal search specification.
1494 The search specification for the LDAP Content Synchronization operation
1495 has the same value syntax and the same default values as in the
1498 The LDAP Content Synchronization protocol has two operation types.
1501 operation, the next synchronization search operation
1502 is periodically rescheduled at an interval time (specified by
1504 parameter; 1 day by default)
1505 after each synchronization operation finishes.
1507 .B refreshAndPersist
1508 operation, a synchronization search remains persistent in the provider slapd.
1509 Further updates to the master replica will generate
1510 .B searchResultEntry
1511 to the consumer slapd as the search responses to the persistent
1512 synchronization search. If the connection is lost, the consumer will
1513 attempt to reconnect at an interval time (specified by
1515 parameter; 60 seconds by default) until the session is re-established.
1516 The schema checking can be enforced at the LDAP Sync
1517 consumer site by turning on the
1519 parameter. The default is off.
1522 parameter specifies the DN in the consumer site
1523 which is allowed to make changes to the replica.
1524 The DN should have read/write access to the replica database.
1529 of the master database.
1534 requires the options
1538 and should only be used when adequate security services
1539 (e.g. TLS or IPSEC) are in place.
1546 Depending on the mechanism, an authentication identity and/or
1547 credentials can be specified using
1553 parameter may be used to specify an authorization identity.
1554 Specific security properties (as with the
1556 keyword above) for a SASL bind can be set with the
1558 option. A non default SASL realm can be set with the
1564 This option is only applicable in a slave
1565 database updated using
1567 It specifies the DN permitted to update (subject to access controls)
1568 the replica (typically, this is the DN
1570 binds to update the replica). Generally, this DN
1577 Specify the referral to pass back when
1579 is asked to modify a replicated local database.
1580 If specified multiple times, each url is provided.
1582 .SH DATABASE-SPECIFIC OPTIONS
1583 Each database may allow specific configuration options; they are
1584 documented separately in the backends' manual pages.
1586 The following backends can be compiled into slapd.
1587 They are documented in the
1588 .BR slapd-<backend> (5)
1592 This is the recommended backend for a normal slapd database.
1593 However, it takes more care than with the LDBM backend to configure
1595 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1598 This is the database backend which is easiest to configure.
1599 However, it does not offer the data durability features of the BDB
1601 It uses Berkeley DB or GDBM to store data.
1604 This backend is experimental.
1605 It serves up referrals based upon SRV resource records held in the
1609 This backend acts as a proxy to forward incoming requests to another
1613 This backend performs basic LDAP proxying with respect to a set of
1614 remote LDAP servers. It is an enhancement of the ldap backend. The
1615 proxy cache extension of meta backend provides answering of search
1616 requests from the proxy using results of previously cached requests.
1619 This backend provides information about the running status of the slapd
1623 Operations in this backend succeed but do nothing.
1626 This backend is provided for demonstration purposes only.
1627 It serves up user account information from the system
1632 This backend embeds a
1634 interpreter into slapd.
1635 It runs Perl subroutines to implement LDAP operations.
1638 This backend redirects LDAP operations to another database
1639 in the same server, based on the naming context of the request.
1640 Its use requires the
1644 for details) to rewrite the naming context of the request.
1645 It is is primarily intended to implement virtual views on databases
1646 that actually store data.
1649 This backend executes external programs to implement LDAP operations.
1650 It is primarily intended to be used in prototypes.
1653 This backend is experimental.
1654 It services LDAP requests from an SQL database.
1657 This backend is experimental.
1660 interpreter into slapd.
1661 It runs Tcl commands to implement LDAP operations.
1664 Here is a short example of a configuration file:
1668 include SYSCONFDIR/schema/core.schema
1669 pidfile LOCALSTATEDIR/slapd.pid
1671 # Subtypes of "name" (e.g. "cn" and "ou") with the
1672 # option ";x-hidden" can be searched for/compared,
1673 # but are not shown. See \fBslapd.access\fP(5).
1674 attributeoptions x-hidden lang-
1675 access to attr=name;x-hidden by * =cs
1678 suffix "dc=our-domain,dc=com"
1679 # The database directory MUST exist prior to
1680 # running slapd AND should only be accessible
1681 # by the slapd/tools. Mode 0700 recommended.
1682 directory LOCALSTATEDIR/openldap-data
1683 # Indices to maintain
1684 index objectClass eq
1685 index cn,sn,mail pres,eq,approx,sub
1687 # We serve small clients that do not handle referrals,
1688 # so handle remote lookups on their behalf.
1691 uri ldap://ldap.some-server.com/
1696 "OpenLDAP Administrator's Guide" contains a longer annotated
1697 example of a configuration file.
1698 The original ETCDIR/slapd.conf is another example.
1702 default slapd configuration file
1706 .BR slapd\-dnssrv (5),
1707 .BR slapd\-ldap (5),
1708 .BR slapd\-ldbm (5),
1709 .BR slapd\-meta (5),
1710 .BR slapd\-monitor (5),
1711 .BR slapd\-null (5),
1712 .BR slapd\-passwd (5),
1713 .BR slapd\-perl (5),
1714 .BR slapd\-relay (5),
1715 .BR slapd\-shell (5),
1718 .BR slapd.access (5),
1719 .BR slapd.plugin (5),
1720 .BR slapd.replog (5),
1732 Known overlays are documented in
1733 .BR slapo\-lastmod (5),
1734 .BR slapo\-pcache (5),
1735 .BR slapo\-ppolicy (5),
1736 .BR slapo\-refint (5),
1738 .BR slapo\-unique (5).
1740 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1741 .SH ACKNOWLEDGEMENTS
1743 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1745 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob