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
258 to be compiled according to
262 means any non-anonymous DN.
263 The third form is a SASL
265 with the optional fields
269 that allow to specify a SASL
271 and eventually a SASL
273 for those mechanisms that support one.
274 The need to allow the specification of a mechanism is still debated,
275 and users are strongly discouraged to rely on this possibility.
276 The fourth form is a group specification, consisting of the keyword
278 optionally followed by the specification of the group
284 is searched with base scope, and in case of match, the values of the
287 are searched for the asserted DN.
288 For backwards compatibility, if no identity type is provided, i.e. only
292 is assumed; as a consequence,
294 is subjected to DN normalization.
295 Since the interpretation of
299 can impact security, users are strongly encouraged
300 to explicitly set the type of identity specification that is being used.
301 A subset of these rules can be used as third arg in the
303 statement (see below); significantly, the
310 .B authz-regexp <match> <replace>
311 Used by the authentication framework to convert simple user names,
312 such as provided by SASL subsystem, to an LDAP DN used for
313 authorization purposes. Note that the resultant DN need not refer
314 to an existing entry to be considered valid. When an authorization
315 request is received from the SASL subsystem, the SASL
320 are taken, when available, and combined into a name of the form
324 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
327 This name is then compared against the
329 regular expression, and if the match is successful, the name is
332 string. If there are wildcard strings in the
334 regular expression that are enclosed in parenthesis, e.g.
340 then the portion of the name that matched the wildcard will be stored
341 in the numbered placeholder variable $1. If there are other wildcard strings
342 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
343 placeholders can then be used in the
348 .B UID=$1,OU=Accounts,DC=example,DC=com
351 The replaced name can be either a DN or an LDAP URI. If the
352 latter, the server will use the URI to search its own database(s)
353 and, if the search returns exactly one entry, the name is
354 replaced by the DN of that entry. The LDAP URI must have no
355 hostport, attrs, or extensions components, e.g.
358 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
363 options can be given in the configuration file to allow for multiple matching
364 and replacement patterns. The matching patterns are checked in the order they
365 appear in the file, stopping at the first successful match.
368 .\"Because the plus sign + is a character recognized by the regular expression engine,
369 .\"and it will appear in names that include a REALM, be careful to escape the
370 .\"plus sign with a backslash \\+ to remove the character's special meaning.
373 .B concurrency <integer>
374 Specify a desired level of concurrency. Provided to the underlying
375 thread system as a hint. The default is not to provide any hint.
377 .B conn_max_pending <integer>
378 Specify the maximum number of pending requests for an anonymous session.
379 If requests are submitted faster than the server can process them, they
380 will be queued up to this limit. If the limit is exceeded, the session
381 is closed. The default is 100.
383 .B conn_max_pending_auth <integer>
384 Specify the maximum number of pending requests for an authenticated session.
386 .\"-- NEW_LOGGING option --
388 .\".B debug <subsys> <level>
389 .\"Specify a logging level for a particular subsystem. The subsystems include
391 .\"a global level for all subsystems,
395 .\"the backend databases,
397 .\"the entry cache manager,
399 .\"the config file reader,
401 .\"the connection manager,
403 .\"the Cyrus SASL library interface,
405 .\"the search filter processor,
407 .\"the DN normalization library,
409 .\"the database indexer,
411 .\"the ASN.1 BER library,
413 .\"the dynamic module loader,
415 .\"the LDAP operation processors,
417 .\"the SASL authentication subsystem,
419 .\"the schema processor, and
421 .\"the TLS library interface. This is not an exhaustive list; there are many
422 .\"other subsystems and more are added over time.
424 .\"The levels are, in order of decreasing priority:
425 .\".B emergency, alert, critical, error, warning, notice, information, entry,
426 .\".B args, results, detail1, detail2
427 .\"An integer may be used instead, with 0 corresponding to
433 .\"level logs function entry points,
435 .\"adds function call parameters, and
437 .\"adds the function results to the logs.
442 .\"levels add even more low level detail from individual functions.
444 .B defaultsearchbase <dn>
445 Specify a default search base to use when client submits a
446 non-base search request with an empty base DN.
448 .B disallow <features>
449 Specify a set of features (separated by white space) to
450 disallow (default none).
452 disables acceptance of anonymous bind requests.
454 disables simple (bind) authentication.
456 disables Kerberos V4 (bind) authentication.
458 disables Start TLS from forcing session to anonymous status (see also
461 disables StartTLS if authenticated (see also
465 .B ditcontentrule "(\ <oid>\
467 [DESC\ <description>]\
474 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
475 The slapd parser extends the RFC 2252 definition by allowing string
476 forms as well as numeric OIDs to be used for the attribute OID and
477 attribute syntax OID.
483 .B gentlehup { on | off }
484 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
486 will stop listening for new connections, but will not close the
487 connections to the current clients. Future write operations return
488 unwilling-to-perform, though. Slapd terminates when all clients
489 have closed their connections (if they ever do), or \- as before \-
490 if it receives a SIGTERM signal. This can be useful if you wish to
491 terminate the server and start a new
494 .B with another database,
495 without disrupting the currently active clients.
496 The default is off. You may wish to use
498 along with this option.
500 .B idletimeout <integer>
501 Specify the number of seconds to wait before forcibly closing
502 an idle client connection. A idletimeout of 0 disables this
503 feature. The default is 0.
505 .B include <filename>
506 Read additional configuration information from the given file before
507 continuing with the next line of the current file.
508 .\"-- NEW_LOGGING option --
510 .\".B logfile <filename>
511 .\"Specify a file for recording debug log messages. By default these messages
512 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
513 .\"copies messages to both stderr and the logfile.
516 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
517 such as those to the ldapi:// listener. For a description of SSF values,
521 property description.
523 .B loglevel <integer> [...]
524 Specify the level at which debugging statements and operation
525 statistics should be syslogged (currently logged to the
527 LOG_LOCAL4 facility). Log levels are additive, and available levels
539 debug packet handling
543 heavy trace debugging
547 connection management
551 print out packets sent and received
555 search filter processing
559 configuration file processing
563 access control list processing
567 stats log connections/operations/results
571 stats log entries sent
575 print communication with shell backends
582 The desired log level can be input as a single integer that combines
583 the (ORed) desired levels, as a list of integers (that are ORed internally),
584 or as a list of the names that are shown between brackets, such that
595 can be used as a shortcut to enable logging at all levels (equivalent to -1).
598 .B moduleload <filename>
599 Specify the name of a dynamically loadable module to load. The filename
600 may be an absolute path name or a simple filename. Non-absolute names
601 are searched for in the directories specified by the
603 option. This option and the
605 option are only usable if slapd was compiled with --enable-modules.
607 .B modulepath <pathspec>
608 Specify a list of directories to search for loadable modules. Typically
609 the path is colon-separated but this depends on the operating system.
612 .B objectclass "(\ <oid>\
614 [DESC\ <description]\
617 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
618 [MUST\ <oids>] [MAY\ <oids>] )"
620 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
621 The slapd parser extends the RFC 2252 definition by allowing string
622 forms as well as numeric OIDs to be used for the object class OID.
626 description.) Object classes are "STRUCTURAL" by default.
629 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
630 Define a string name that equates to the given OID. The string can be used
631 in place of the numeric OID in objectclass and attribute definitions. The
632 name can also be used with a suffix of the form ":xx" in which case the
633 value "oid.xx" will be used.
635 .B password-hash <hash> [<hash>...]
636 This option configures one or more hashes to be used in generation of user
637 passwords stored in the userPassword attribute during processing of
638 LDAP Password Modify Extended Operations (RFC 3062).
639 The <hash> must be one of
653 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
658 use the MD5 algorithm (RFC 1321), the latter with a seed.
665 indicates that the new password should be
666 added to userPassword as clear text.
668 Note that this option does not alter the normal user applications
669 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
671 .B password\-crypt\-salt\-format <format>
672 Specify the format of the salt passed to
674 when generating {CRYPT} passwords (see
676 during processing of LDAP Password Modify Extended Operations (RFC 3062).
678 This string needs to be in
680 format and may include one (and only one) %s conversion.
681 This conversion will be substituted with a string of random
682 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
683 provides a two character salt and "$1$%.8s" tells some
684 versions of crypt(3) to use an MD5 algorithm and provides
685 8 random characters of salt. The default is "%s", which
686 provides 31 characters of salt.
688 .B pidfile <filename>
689 The ( absolute ) name of a file that will hold the
691 server's process ID ( see
693 ) if started without the debugging command line option.
696 Specify the referral to pass back when
698 cannot find a local database to handle a request.
699 If specified multiple times, each url is provided.
702 The ( absolute ) name of a file that will hold the
704 server's command line options
705 if started without the debugging command line option.
708 The ( absolute ) name of a file that will hold the
710 server's process ID ( see
712 ) if started without the debugging command line option.
714 .B replicationinterval
715 The number of seconds
717 waits before checking the replogfile for changes.
719 .B require <conditions>
720 Specify a set of conditions (separated by white space) to
721 require (default none).
722 The directive may be specified globally and/or per-database.
724 requires bind operation prior to directory operations.
726 requires session to be using LDAP version 3.
728 requires authentication prior to directory operations.
730 requires SASL authentication prior to directory operations.
732 requires strong authentication prior to directory operations.
733 The strong keyword allows protected "simple" authentication
734 as well as SASL authentication.
736 may be used to require no conditions (useful for clearly globally
737 set conditions within a particular database).
739 .B reverse-lookup on | off
740 Enable/disable client name unverified reverse lookup (default is
742 if compiled with --enable-rlookups).
745 Specify the name of an LDIF(5) file containing user defined attributes
746 for the root DSE. These attributes are returned in addition to the
747 attributes normally produced by slapd.
750 Used to specify the fully qualified domain name used for SASL processing.
752 .B sasl-realm <realm>
753 Specify SASL realm. Default is empty.
755 .B sasl-secprops <properties>
756 Used to specify Cyrus SASL security properties.
759 flag (without any other properties) causes the flag properties
760 default, "noanonymous,noplain", to be cleared.
763 flag disables mechanisms susceptible to simple passive attacks.
766 flag disables mechanisms susceptible to active attacks.
769 flag disables mechanisms susceptible to passive dictionary attacks.
772 flag disables mechanisms which support anonymous login.
775 flag require forward secrecy between sessions.
778 require mechanisms which pass client credentials (and allow
779 mechanisms which can pass credentials to do so).
782 property specifies the minimum acceptable
783 .I security strength factor
784 as an integer approximate to effective key length used for
785 encryption. 0 (zero) implies no protection, 1 implies integrity
786 protection only, 56 allows DES or other weak ciphers, 112
787 allows triple DES and other strong ciphers, 128 allows RC4,
788 Blowfish and other modern strong ciphers. The default is 0.
791 property specifies the maximum acceptable
792 .I security strength factor
793 as an integer (see minssf description). The default is INT_MAX.
796 property specifies the maximum security layer receive buffer
797 size allowed. 0 disables security layers. The default is 65536.
800 Specify the distinguished name for the subschema subentry that
801 controls the entries on this server. The default is "cn=Subschema".
803 .B security <factors>
804 Specify a set of factors (separated by white space) to require.
805 An integer value is associated with each factor and is roughly
806 equivalent of the encryption key length to require. A value
807 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
808 The directive may be specified globally and/or per-database.
810 specifies the overall security strength factor.
812 specifies the transport security strength factor.
814 specifies the TLS security strength factor.
816 specifies the SASL security strength factor.
818 specifies the overall security strength factor to require for
820 .B update_transport=<n>
821 specifies the transport security strength factor to require for
824 specifies the TLS security strength factor to require for
827 specifies the SASL security strength factor to require for
830 specifies the security strength factor required for
832 username/password authentication.
835 factor is measure of security provided by the underlying transport,
836 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
838 .B sizelimit {<integer>|unlimited}
840 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
841 Specify the maximum number of entries to return from a search operation.
842 The default size limit is 500.
845 to specify no limits.
846 The second format allows a fine grain setting of the size limits.
847 Extra args can be added on the same line.
850 for an explanation of the different flags.
852 .B sockbuf_max_incoming <integer>
853 Specify the maximum incoming LDAP PDU size for anonymous sessions.
854 The default is 262143.
856 .B sockbuf_max_incoming_auth <integer>
857 Specify the maximum incoming LDAP PDU size for authenticated sessions.
858 The default is 4194303.
861 Specify the srvtab file in which the kerberos keys necessary for
862 authenticating clients using kerberos can be found. This option is only
863 meaningful if you are using Kerberos authentication.
866 Specify the maximum size of the primary thread pool.
869 .B timelimit {<integer>|unlimited}
871 .B timelimit time[.{soft|hard}]=<integer> [...]
872 Specify the maximum number of seconds (in real time)
874 will spend answering a search request. The default time limit is 3600.
877 to specify no limits.
878 The second format allows a fine grain setting of the time limits.
879 Extra args can be added on the same line.
882 for an explanation of the different flags.
884 .B ucdata-path <path>
885 Specify the path to the directory containing the Unicode character
886 tables. The default path is DATADIR/ucdata.
890 is built with support for Transport Layer Security, there are more options
893 .B TLSCipherSuite <cipher-suite-spec>
894 Permits configuring what ciphers will be accepted and the preference order.
895 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
897 TLSCipherSuite HIGH:MEDIUM:+SSLv2
899 To check what ciphers a given spec selects, use:
901 openssl ciphers -v <cipher-suite-spec>
903 .B TLSCACertificateFile <filename>
904 Specifies the file that contains certificates for all of the Certificate
909 .B TLSCACertificatePath <path>
910 Specifies the path of a directory that contains Certificate Authority
911 certificates in separate individual files. Usually only one of this
912 or the TLSCACertificateFile is used.
914 .B TLSCertificateFile <filename>
915 Specifies the file that contains the
919 .B TLSCertificateKeyFile <filename>
920 Specifies the file that contains the
922 server private key that matches the certificate stored in the
923 .B TLSCertificateFile
924 file. Currently, the private key must not be protected with a password, so
925 it is of critical importance that it is protected carefully.
927 .B TLSRandFile <filename>
928 Specifies the file to obtain random bits from when /dev/[u]random
929 is not available. Generally set to the name of the EGD/PRNGD socket.
930 The environment variable RANDFILE can also be used to specify the filename.
932 .B TLSVerifyClient <level>
933 Specifies what checks to perform on client certificates in an
934 incoming TLS session, if any.
937 can be specified as one of the following keywords:
943 will not ask the client for a certificate.
946 The client certificate is requested. If no certificate is provided,
947 the session proceeds normally. If a bad certificate is provided,
948 it will be ignored and the session proceeds normally.
951 The client certificate is requested. If no certificate is provided,
952 the session proceeds normally. If a bad certificate is provided,
953 the session is immediately terminated.
955 .B demand | hard | true
956 These keywords are all equivalent, for compatibility reasons.
957 The client certificate is requested. If no certificate is provided,
958 or a bad certificate is provided, the session is immediately terminated.
960 Note that a valid client certificate is required in order to use the
961 SASL EXTERNAL authentication mechanism with a TLS session. As such,
964 setting must be chosen to enable SASL EXTERNAL authentication.
966 .SH GENERAL BACKEND OPTIONS
967 Options in this section only apply to the configuration file section
968 for the specified backend. They are supported by every
971 .B backend <databasetype>
972 Mark the beginning of a backend definition. <databasetype>
988 depending on which backend will serve the database.
990 .SH GENERAL DATABASE OPTIONS
991 Options in this section only apply to the configuration file section
992 for the database in which they are defined. They are supported by every
993 type of backend. Note that the
997 option are mandatory for each database.
999 .B database <databasetype>
1000 Mark the beginning of a new database instance definition. <databasetype>
1016 depending on which backend will serve the database.
1021 will automatically maintain the
1022 modifiersName, modifyTimestamp, creatorsName, and
1023 createTimestamp attributes for entries. By default, lastmod is on.
1025 .B limits <who> <limit> [<limit> [...]]
1026 Specify time and size limits based on who initiated an operation.
1033 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1039 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1044 matches all unauthenticated clients.
1047 matches all authenticated clients;
1050 dn pattern is assumed unless otherwise specified by qualifying
1051 the (optional) key string
1057 (which are synonyms), to require an exact match; with
1059 to require exactly one level of depth match; with
1061 to allow any level of depth match, including the exact match; with
1063 to allow any level of depth match, not including the exact match;
1065 explicitly requires the (default) match based on regular expression
1066 pattern, as detailed in
1070 matches unbound operations; the
1073 The same behavior is obtained by using the
1080 with the optional objectClass
1086 sets the limits for any DN listed in the values of the
1092 group objectClass (default
1094 whose DN exactly matches
1097 The currently supported limits are
1102 The syntax for time limits is
1103 .BR time[.{soft|hard}]=<integer> ,
1106 is the number of seconds slapd will spend answering a search request.
1107 If no time limit is explicitly requested by the client, the
1109 limit is used; if the requested time limit exceeds the
1112 .\".I "Administrative limit exceeded"
1113 .\"error is returned.
1114 limit, the value of the limit is used instead.
1117 limit is set to the keyword
1119 the soft limit is used in either case; if it is set to the keyword
1121 no hard limit is enforced.
1122 Explicit requests for time limits smaller or equal to the
1125 If no limit specifier is set, the value is assigned to the
1131 to preserve the original behavior.
1133 The syntax for size limits is
1134 .BR size[.{soft|hard|unchecked}]=<integer> ,
1137 is the maximum number of entries slapd will return answering a search
1139 If no size limit is explicitly requested by the client, the
1141 limit is used; if the requested size limit exceeds the
1144 .\".I "Administrative limit exceeded"
1145 .\"error is returned.
1146 limit, the value of the limit is used instead.
1149 limit is set to the keyword
1151 the soft limit is used in either case; if it is set to the keyword
1153 no hard limit is enforced.
1154 Explicit requests for size limits smaller or equal to the
1159 specifier sets a limit on the number of candidates a search request is allowed
1161 The rationale behind it is that searches for non-properly indicized
1162 attributes may result in large sets of candidates, which must be
1165 to determine whether they match the search filter or not.
1168 limit provides a means to drop such operations before they are even
1170 If the selected candidates exceed the
1172 limit, the search will abort with
1173 .IR "Unwilling to perform" .
1174 If it is set to the keyword
1176 no limit is applied (the default).
1179 the search is not even performed; this can be used to disallow searches
1180 for a specific set of users.
1181 If no limit specifier is set, the value is assigned to the
1187 to preserve the original behavior.
1189 In case of no match, the global limits are used.
1190 The default values are the same of
1199 control is requested, the
1201 size limit is used by default, because the request of a specific page size
1202 is considered an explicit request for a limitation on the number
1203 of entries to be returned.
1204 However, the size limit applies to the total count of entries returned within
1205 the search, and not to a single page.
1206 Additional size limits may be enforced; the syntax is
1207 .BR size.pr={<integer>|noEstimate|unlimited} ,
1210 is the max page size if no explicit limit is set; the keyword
1212 inhibits the server from returning an estimate of the total number
1213 of entries that might be returned
1214 (note: the current implementation does not return any estimate).
1217 indicates that no limit is applied to the pagedResults control page size.
1219 .B size.prtotal={<integer>|unlimited|disabled}
1220 allows to set a limit on the total number of entries that a pagedResults
1221 control allows to return.
1222 By default it is set to the
1227 is the max number of entries that the whole search with pagedResults control
1231 to allow unlimited number of entries to be returned, e.g. to allow
1232 the use of the pagedResults control as a means to circumvent size
1233 limitations on regular searches; the keyword
1235 disables the control, i.e. no paged results can be returned.
1236 Note that the total number of entries returned when the pagedResults control
1237 is requested cannot exceed the
1239 size limit of regular searches unless extended by the
1244 .B maxderefdepth <depth>
1245 Specifies the maximum number of aliases to dereference when trying to
1246 resolve an entry, used to avoid infinite alias loops. The default is 1.
1248 .B overlay <overlay-name>
1249 Add the specified overlay to this database. An overlay is a piece of
1250 code that intercepts database operations in order to extend or change
1251 them. Overlays are pushed onto
1252 a stack over the database, and so they will execute in the reverse
1253 of the order in which they were configured and the database itself
1254 will receive control last of all.
1256 .B readonly on | off
1257 This option puts the database into "read-only" mode. Any attempts to
1258 modify the database will return an "unwilling to perform" error. By
1259 default, readonly is off.
1262 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1263 .B [starttls=yes|critical]
1264 .B [suffix=<suffix> [...]]
1265 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1266 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1267 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1268 .B [attr[!]=<attr list>]
1270 Specify a replication site for this database. Refer to the "OpenLDAP
1271 Administrator's Guide" for detailed information on setting up a replicated
1273 directory service. Zero or more
1275 instances can be used to select the subtrees that will be replicated
1276 (defaults to all the database).
1278 is deprecated in favor of the
1282 allows the replica LDAP server to be specified as an LDAP URI.
1287 requires the options
1291 and should only be used when adequate security services
1292 (e.g TLS or IPSEC) are in place. A
1298 Specific security properties (as with the
1300 keyword above) for a SASL bind can be set with the
1302 option. A non-default SASL realm can be set with the
1307 will use Kerberos, a kerberos instance should be given in
1311 can be given after the
1313 keyword to allow the selective replication of the listed attributes only;
1316 mark is used, the list is considered exclusive, i.e. the listed attributes
1318 If an objectClass is listed, all the related attributes
1319 are (are not) replicated.
1322 .B replogfile <filename>
1323 Specify the name of the replication log file to log changes to.
1324 The replication log is typically written by
1329 .BR slapd.replog (5)
1330 for more information. The specified file should be located
1331 in a directory with limited read/write/execute access as the replication
1332 logs may contain sensitive information.
1334 .B restrict <oplist>
1335 Specify a whitespace separated list of operations that are restricted.
1336 If defined inside a database specification, restrictions apply only
1337 to that database, otherwise they are global.
1338 Operations can be any of
1343 .BR extended[=<OID>] ,
1347 or the special pseudo-operations
1351 which respectively summarize read and write operations.
1359 keyword allows to indicate the OID of the specific operation
1363 Specify the distinguished name that is not subject to access control
1364 or administrative limit restrictions for operations on this database.
1365 This DN may or may not be associated with an entry. An empty root
1366 DN (the default) specifies no root access is to be granted. It is
1367 recommended that the rootdn only be specified when needed (such as
1368 when initially populating a database). If the rootdn is within
1369 a namingContext (suffix) of the database, a simple bind password
1370 may also be provided using the
1374 .B rootpw <password>
1375 Specify a password (or hash of the password) for the rootdn. The
1376 password can only be set if the rootdn is within the namingContext
1377 (suffix) of the database.
1378 This option accepts all RFC 2307 userPassword formats known to
1381 description) as well as cleartext.
1383 may be used to generate a hash of a password. Cleartext
1384 and \fB{CRYPT}\fP passwords are not recommended. If empty
1385 (the default), authentication of the root DN is by other means
1386 (e.g. SASL). Use of SASL is encouraged.
1388 .B suffix <dn suffix>
1389 Specify the DN suffix of queries that will be passed to this
1390 backend database. Multiple suffix lines can be given and at least one is
1391 required for each database definition.
1392 If the suffix of one database is "inside" that of another, the database
1393 with the inner suffix must come first in the configuration file.
1396 Specify that the current backend database is a subordinate of another
1397 backend database. A subordinate database may have only one suffix. This
1398 option may be used to glue multiple databases into a single namingContext.
1399 If the suffix of the current database is within the namingContext of a
1400 superior database, searches against the superior database will be
1401 propagated to the subordinate as well. All of the databases
1402 associated with a single namingContext should have identical rootdns.
1403 Behavior of other LDAP operations is unaffected by this setting. In
1404 particular, it is not possible to use moddn to move an entry from
1405 one subordinate to another subordinate within the namingContext.
1408 .B syncrepl rid=<replica ID>
1409 .B provider=ldap[s]://<hostname>[:port]
1410 .B [type=refreshOnly|refreshAndPersist]
1411 .B [interval=dd:hh:mm:ss]
1412 .B [searchbase=<base DN>]
1413 .B [filter=<filter str>]
1414 .B [scope=sub|one|base]
1415 .B [attrs=<attr list>]
1417 .B [sizelimit=<limit>]
1418 .B [timelimit=<limit>]
1419 .B [schemachecking=on|off]
1421 .B [bindmethod=simple|sasl]
1423 .B [saslmech=<mech>]
1424 .B [authcid=<identity>]
1425 .B [authzid=<identity>]
1426 .B [credentials=<passwd>]
1428 .B [secprops=<properties>]
1430 Specify the current database as a replica which is kept up-to-date with the
1431 master content by establishing the current
1433 as a replication consumer site running a
1436 The replica content is kept synchronized to the master content using
1437 the LDAP Content Synchronization protocol. Refer to the
1438 "OpenLDAP Administrator's Guide" for detailed information on
1439 setting up a replicated
1441 directory service using the
1445 identifies the current
1447 directive within the replication consumer site.
1448 It is a non-negative integer having no more than three digits.
1450 specifies the replication provider site containing the master content
1451 as an LDAP URI. If <port> is not given, the standard LDAP port number
1452 (389 or 636) is used. The content of the
1454 replica is defined using a search
1455 specification as its result set. The consumer
1457 will send search requests to the provider
1459 according to the search specification. The search specification includes
1460 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1463 parameters as in the normal search specification.
1464 The search specification for the LDAP Content Synchronization operation
1465 has the same value syntax and the same default values as in the
1468 The LDAP Content Synchronization protocol has two operation types.
1471 operation, the next synchronization search operation
1472 is periodically rescheduled at an interval time (specified by
1474 parameter; 1 day by default)
1475 after each synchronization operation finishes.
1477 .B refreshAndPersist
1478 operation, a synchronization search remains persistent in the provider slapd.
1479 Further updates to the master replica will generate
1480 .B searchResultEntry
1481 to the consumer slapd as the search responses to the persistent
1482 synchronization search. If the connection is lost, the consumer will
1483 attempt to reconnect at an interval time (specified by
1485 parameter; 60 seconds by default) until the session is re-established.
1486 The schema checking can be enforced at the LDAP Sync
1487 consumer site by turning on the
1489 parameter. The default is off.
1492 parameter specifies the DN in the consumer site
1493 which is allowed to make changes to the replica.
1494 The DN should have read/write access to the replica database.
1499 of the master database.
1504 requires the options
1508 and should only be used when adequate security services
1509 (e.g. TLS or IPSEC) are in place.
1516 Depending on the mechanism, an authentication identity and/or
1517 credentials can be specified using
1523 parameter may be used to specify an authorization identity.
1524 Specific security properties (as with the
1526 keyword above) for a SASL bind can be set with the
1528 option. A non default SASL realm can be set with the
1534 This option is only applicable in a slave
1535 database updated using
1537 It specifies the DN permitted to update (subject to access controls)
1538 the replica (typically, this is the DN
1540 binds to update the replica). Generally, this DN
1547 Specify the referral to pass back when
1549 is asked to modify a replicated local database.
1550 If specified multiple times, each url is provided.
1552 .SH DATABASE-SPECIFIC OPTIONS
1553 Each database may allow specific configuration options; they are
1554 documented separately in the backends' manual pages.
1556 The following backends can be compiled into slapd.
1557 They are documented in the
1558 .BR slapd-<backend> (5)
1562 This is the recommended backend for a normal slapd database.
1563 However, it takes more care than with the LDBM backend to configure
1565 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1568 This is the database backend which is easiest to configure.
1569 However, it does not offer the data durability features of the BDB
1571 It uses Berkeley DB or GDBM to store data.
1574 This backend is experimental.
1575 It serves up referrals based upon SRV resource records held in the
1579 This backend acts as a proxy to forward incoming requests to another
1583 This backend performs basic LDAP proxying with respect to a set of
1584 remote LDAP servers. It is an enhancement of the ldap backend. The
1585 proxy cache extension of meta backend provides answering of search
1586 requests from the proxy using results of previously cached requests.
1589 This backend provides information about the running status of the slapd
1593 Operations in this backend succeed but do nothing.
1596 This backend is provided for demonstration purposes only.
1597 It serves up user account information from the system
1602 This backend embeds a
1604 interpreter into slapd.
1605 It runs Perl subroutines to implement LDAP operations.
1608 This backend redirects LDAP operations to another database
1609 in the same server, based on the naming context of the request.
1610 Its use requires the
1614 for details) to rewrite the naming context of the request.
1615 It is is primarily intended to implement virtual views on databases
1616 that actually store data.
1619 This backend executes external programs to implement LDAP operations.
1620 It is primarily intended to be used in prototypes.
1623 This backend is experimental.
1624 It services LDAP requests from an SQL database.
1627 This backend is experimental.
1630 interpreter into slapd.
1631 It runs Tcl commands to implement LDAP operations.
1634 Here is a short example of a configuration file:
1638 include SYSCONFDIR/schema/core.schema
1639 pidfile LOCALSTATEDIR/slapd.pid
1641 # Subtypes of "name" (e.g. "cn" and "ou") with the
1642 # option ";x-hidden" can be searched for/compared,
1643 # but are not shown. See \fBslapd.access\fP(5).
1644 attributeoptions x-hidden lang-
1645 access to attr=name;x-hidden by * =cs
1648 suffix "dc=our-domain,dc=com"
1649 # The database directory MUST exist prior to
1650 # running slapd AND should only be accessible
1651 # by the slapd/tools. Mode 0700 recommended.
1652 directory LOCALSTATEDIR/openldap-data
1653 # Indices to maintain
1654 index objectClass eq
1655 index cn,sn,mail pres,eq,approx,sub
1657 # We serve small clients that do not handle referrals,
1658 # so handle remote lookups on their behalf.
1661 uri ldap://ldap.some-server.com/
1666 "OpenLDAP Administrator's Guide" contains a longer annotated
1667 example of a configuration file.
1668 The original ETCDIR/slapd.conf is another example.
1672 default slapd configuration file
1676 .BR slapd\-dnssrv (5),
1677 .BR slapd\-ldap (5),
1678 .BR slapd\-ldbm (5),
1679 .BR slapd\-meta (5),
1680 .BR slapd\-monitor (5),
1681 .BR slapd\-null (5),
1682 .BR slapd\-passwd (5),
1683 .BR slapd\-perl (5),
1684 .BR slapd\-relay (5),
1685 .BR slapd\-shell (5),
1688 .BR slapd.access (5),
1689 .BR slapd.plugin (5),
1690 .BR slapd.replog (5),
1702 Known overlays are documented in
1703 .BR slapo\-lastmod (5),
1704 .BR slapo\-pcache (5),
1705 .BR slapo\-ppolicy (5),
1706 .BR slapo\-refint (5),
1708 .BR slapo\-unique (5).
1710 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1711 .SH ACKNOWLEDGEMENTS
1713 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1715 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob