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.
509 .B index_substr_if_minlen <integer>
510 Specify the minimum length for subinitial and subfinal indices. An
511 attribute value must have at least this many characters in order to be
512 processed by the indexing functions. The default is 2.
514 .B index_substr_if_maxlen <integer>
515 Specify the maximum length for subinitial and subfinal indices. Only
516 this many characters of an attribute value will be processed by the
517 indexing functions; any excess characters are ignored. The default is 4.
519 .B index_substr_any_len <integer>
520 Specify the length used for subany indices. An attribute value must have
521 at least this many characters in order to be processed. Attribute values
522 longer than this length will be processed in segments of this length. The
523 default is 4. The subany index will also be used in subinitial and
524 subfinal index lookups when the filter string is longer than the
525 .I index_substr_if_maxlen
528 .B index_substr_any_step <integer>
529 Specify the steps used in subany index lookups. This value sets the offset
530 for the segments of a filter string that are processed for a subany index
531 lookup. The default is 2. For example, with the default values, a search
532 using this filter "cn=*abcdefgh*" would generate index lookups for
533 "abcd", "cdef", and "efgh".
535 .\"-- NEW_LOGGING option --
537 .\".B logfile <filename>
538 .\"Specify a file for recording debug log messages. By default these messages
539 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
540 .\"copies messages to both stderr and the logfile.
543 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
544 such as those to the ldapi:// listener. For a description of SSF values,
548 option description. The default is 71.
550 .B loglevel <integer> [...]
551 Specify the level at which debugging statements and operation
552 statistics should be syslogged (currently logged to the
554 LOG_LOCAL4 facility). Log levels are additive, and available levels
566 debug packet handling
570 heavy trace debugging
574 connection management
578 print out packets sent and received
582 search filter processing
586 configuration file processing
590 access control list processing
594 stats log connections/operations/results
598 stats log entries sent
602 print communication with shell backends
609 The desired log level can be input as a single integer that combines
610 the (ORed) desired levels, as a list of integers (that are ORed internally),
611 or as a list of the names that are shown between brackets, such that
622 can be used as a shortcut to enable logging at all levels (equivalent to -1).
625 .B moduleload <filename>
626 Specify the name of a dynamically loadable module to load. The filename
627 may be an absolute path name or a simple filename. Non-absolute names
628 are searched for in the directories specified by the
630 option. This option and the
632 option are only usable if slapd was compiled with --enable-modules.
634 .B modulepath <pathspec>
635 Specify a list of directories to search for loadable modules. Typically
636 the path is colon-separated but this depends on the operating system.
639 .B objectclass "(\ <oid>\
641 [DESC\ <description]\
644 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
645 [MUST\ <oids>] [MAY\ <oids>] )"
647 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
648 The slapd parser extends the RFC 2252 definition by allowing string
649 forms as well as numeric OIDs to be used for the object class OID.
653 description.) Object classes are "STRUCTURAL" by default.
656 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
657 Define a string name that equates to the given OID. The string can be used
658 in place of the numeric OID in objectclass and attribute definitions. The
659 name can also be used with a suffix of the form ":xx" in which case the
660 value "oid.xx" will be used.
662 .B password-hash <hash> [<hash>...]
663 This option configures one or more hashes to be used in generation of user
664 passwords stored in the userPassword attribute during processing of
665 LDAP Password Modify Extended Operations (RFC 3062).
666 The <hash> must be one of
680 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
685 use the MD5 algorithm (RFC 1321), the latter with a seed.
692 indicates that the new password should be
693 added to userPassword as clear text.
695 Note that this option does not alter the normal user applications
696 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
698 .B password\-crypt\-salt\-format <format>
699 Specify the format of the salt passed to
701 when generating {CRYPT} passwords (see
703 during processing of LDAP Password Modify Extended Operations (RFC 3062).
705 This string needs to be in
707 format and may include one (and only one) %s conversion.
708 This conversion will be substituted with a string of random
709 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
710 provides a two character salt and "$1$%.8s" tells some
711 versions of crypt(3) to use an MD5 algorithm and provides
712 8 random characters of salt. The default is "%s", which
713 provides 31 characters of salt.
715 .B pidfile <filename>
716 The ( absolute ) name of a file that will hold the
718 server's process ID ( see
720 ) if started without the debugging command line option.
723 Specify the referral to pass back when
725 cannot find a local database to handle a request.
726 If specified multiple times, each url is provided.
729 The ( absolute ) name of a file that will hold the
731 server's command line options
732 if started without the debugging command line option.
735 The ( absolute ) name of a file that will hold the
737 server's process ID ( see
739 ) if started without the debugging command line option.
741 .B replicationinterval
742 The number of seconds
744 waits before checking the replogfile for changes.
746 .B require <conditions>
747 Specify a set of conditions (separated by white space) to
748 require (default none).
749 The directive may be specified globally and/or per-database.
751 requires bind operation prior to directory operations.
753 requires session to be using LDAP version 3.
755 requires authentication prior to directory operations.
757 requires SASL authentication prior to directory operations.
759 requires strong authentication prior to directory operations.
760 The strong keyword allows protected "simple" authentication
761 as well as SASL authentication.
763 may be used to require no conditions (useful for clearly globally
764 set conditions within a particular database).
766 .B reverse-lookup on | off
767 Enable/disable client name unverified reverse lookup (default is
769 if compiled with --enable-rlookups).
772 Specify the name of an LDIF(5) file containing user defined attributes
773 for the root DSE. These attributes are returned in addition to the
774 attributes normally produced by slapd.
777 Used to specify the fully qualified domain name used for SASL processing.
779 .B sasl-realm <realm>
780 Specify SASL realm. Default is empty.
782 .B sasl-secprops <properties>
783 Used to specify Cyrus SASL security properties.
786 flag (without any other properties) causes the flag properties
787 default, "noanonymous,noplain", to be cleared.
790 flag disables mechanisms susceptible to simple passive attacks.
793 flag disables mechanisms susceptible to active attacks.
796 flag disables mechanisms susceptible to passive dictionary attacks.
799 flag disables mechanisms which support anonymous login.
802 flag require forward secrecy between sessions.
805 require mechanisms which pass client credentials (and allow
806 mechanisms which can pass credentials to do so).
809 property specifies the minimum acceptable
810 .I security strength factor
811 as an integer approximate to effective key length used for
812 encryption. 0 (zero) implies no protection, 1 implies integrity
813 protection only, 56 allows DES or other weak ciphers, 112
814 allows triple DES and other strong ciphers, 128 allows RC4,
815 Blowfish and other modern strong ciphers. The default is 0.
818 property specifies the maximum acceptable
819 .I security strength factor
820 as an integer (see minssf description). The default is INT_MAX.
823 property specifies the maximum security layer receive buffer
824 size allowed. 0 disables security layers. The default is 65536.
827 Specify the distinguished name for the subschema subentry that
828 controls the entries on this server. The default is "cn=Subschema".
830 .B security <factors>
831 Specify a set of security strength factors (separated by white space)
835 option for a description of security strength factors).
836 The directive may be specified globally and/or per-database.
838 specifies the overall security strength factor.
840 specifies the transport security strength factor.
842 specifies the TLS security strength factor.
844 specifies the SASL security strength factor.
846 specifies the overall security strength factor to require for
848 .B update_transport=<n>
849 specifies the transport security strength factor to require for
852 specifies the TLS security strength factor to require for
855 specifies the SASL security strength factor to require for
858 specifies the security strength factor required for
860 username/password authentication.
863 factor is measure of security provided by the underlying transport,
864 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
866 .B sizelimit {<integer>|unlimited}
868 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
869 Specify the maximum number of entries to return from a search operation.
870 The default size limit is 500.
873 to specify no limits.
874 The second format allows a fine grain setting of the size limits.
875 Extra args can be added on the same line.
878 for an explanation of the different flags.
880 .B sockbuf_max_incoming <integer>
881 Specify the maximum incoming LDAP PDU size for anonymous sessions.
882 The default is 262143.
884 .B sockbuf_max_incoming_auth <integer>
885 Specify the maximum incoming LDAP PDU size for authenticated sessions.
886 The default is 4194303.
889 Specify the srvtab file in which the kerberos keys necessary for
890 authenticating clients using kerberos can be found. This option is only
891 meaningful if you are using Kerberos authentication.
894 Specify the maximum size of the primary thread pool.
897 .B timelimit {<integer>|unlimited}
899 .B timelimit time[.{soft|hard}]=<integer> [...]
900 Specify the maximum number of seconds (in real time)
902 will spend answering a search request. The default time limit is 3600.
905 to specify no limits.
906 The second format allows a fine grain setting of the time limits.
907 Extra args can be added on the same line.
910 for an explanation of the different flags.
912 .B ucdata-path <path>
913 Specify the path to the directory containing the Unicode character
914 tables. The default path is DATADIR/ucdata.
918 is built with support for Transport Layer Security, there are more options
921 .B TLSCipherSuite <cipher-suite-spec>
922 Permits configuring what ciphers will be accepted and the preference order.
923 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
925 TLSCipherSuite HIGH:MEDIUM:+SSLv2
927 To check what ciphers a given spec selects, use:
929 openssl ciphers -v <cipher-suite-spec>
931 .B TLSCACertificateFile <filename>
932 Specifies the file that contains certificates for all of the Certificate
937 .B TLSCACertificatePath <path>
938 Specifies the path of a directory that contains Certificate Authority
939 certificates in separate individual files. Usually only one of this
940 or the TLSCACertificateFile is used.
942 .B TLSCertificateFile <filename>
943 Specifies the file that contains the
947 .B TLSCertificateKeyFile <filename>
948 Specifies the file that contains the
950 server private key that matches the certificate stored in the
951 .B TLSCertificateFile
952 file. Currently, the private key must not be protected with a password, so
953 it is of critical importance that it is protected carefully.
955 .B TLSRandFile <filename>
956 Specifies the file to obtain random bits from when /dev/[u]random
957 is not available. Generally set to the name of the EGD/PRNGD socket.
958 The environment variable RANDFILE can also be used to specify the filename.
960 .B TLSVerifyClient <level>
961 Specifies what checks to perform on client certificates in an
962 incoming TLS session, if any.
965 can be specified as one of the following keywords:
971 will not ask the client for a certificate.
974 The client certificate is requested. If no certificate is provided,
975 the session proceeds normally. If a bad certificate is provided,
976 it will be ignored and the session proceeds normally.
979 The client certificate is requested. If no certificate is provided,
980 the session proceeds normally. If a bad certificate is provided,
981 the session is immediately terminated.
983 .B demand | hard | true
984 These keywords are all equivalent, for compatibility reasons.
985 The client certificate is requested. If no certificate is provided,
986 or a bad certificate is provided, the session is immediately terminated.
988 Note that a valid client certificate is required in order to use the
989 SASL EXTERNAL authentication mechanism with a TLS session. As such,
992 setting must be chosen to enable SASL EXTERNAL authentication.
994 .SH GENERAL BACKEND OPTIONS
995 Options in this section only apply to the configuration file section
996 for the specified backend. They are supported by every
999 .B backend <databasetype>
1000 Mark the beginning of a backend definition. <databasetype>
1016 depending on which backend will serve the database.
1018 .SH GENERAL DATABASE OPTIONS
1019 Options in this section only apply to the configuration file section
1020 for the database in which they are defined. They are supported by every
1021 type of backend. Note that the
1025 option are mandatory for each database.
1027 .B database <databasetype>
1028 Mark the beginning of a new database instance definition. <databasetype>
1044 depending on which backend will serve the database.
1049 will automatically maintain the
1050 modifiersName, modifyTimestamp, creatorsName, and
1051 createTimestamp attributes for entries. By default, lastmod is on.
1053 .B limits <who> <limit> [<limit> [...]]
1054 Specify time and size limits based on who initiated an operation.
1061 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1067 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1072 matches all unauthenticated clients.
1075 matches all authenticated clients;
1078 dn pattern is assumed unless otherwise specified by qualifying
1079 the (optional) key string
1085 (which are synonyms), to require an exact match; with
1087 to require exactly one level of depth match; with
1089 to allow any level of depth match, including the exact match; with
1091 to allow any level of depth match, not including the exact match;
1093 explicitly requires the (default) match based on regular expression
1094 pattern, as detailed in
1098 matches unbound operations; the
1101 The same behavior is obtained by using the
1108 with the optional objectClass
1114 sets the limits for any DN listed in the values of the
1120 group objectClass (default
1122 whose DN exactly matches
1125 The currently supported limits are
1130 The syntax for time limits is
1131 .BR time[.{soft|hard}]=<integer> ,
1134 is the number of seconds slapd will spend answering a search request.
1135 If no time limit is explicitly requested by the client, the
1137 limit is used; if the requested time limit exceeds the
1140 .\".I "Administrative limit exceeded"
1141 .\"error is returned.
1142 limit, the value of the limit is used instead.
1145 limit is set to the keyword
1147 the soft limit is used in either case; if it is set to the keyword
1149 no hard limit is enforced.
1150 Explicit requests for time limits smaller or equal to the
1153 If no limit specifier is set, the value is assigned to the
1159 to preserve the original behavior.
1161 The syntax for size limits is
1162 .BR size[.{soft|hard|unchecked}]=<integer> ,
1165 is the maximum number of entries slapd will return answering a search
1167 If no size limit is explicitly requested by the client, the
1169 limit is used; if the requested size limit exceeds the
1172 .\".I "Administrative limit exceeded"
1173 .\"error is returned.
1174 limit, the value of the limit is used instead.
1177 limit is set to the keyword
1179 the soft limit is used in either case; if it is set to the keyword
1181 no hard limit is enforced.
1182 Explicit requests for size limits smaller or equal to the
1187 specifier sets a limit on the number of candidates a search request is allowed
1189 The rationale behind it is that searches for non-properly indicized
1190 attributes may result in large sets of candidates, which must be
1193 to determine whether they match the search filter or not.
1196 limit provides a means to drop such operations before they are even
1198 If the selected candidates exceed the
1200 limit, the search will abort with
1201 .IR "Unwilling to perform" .
1202 If it is set to the keyword
1204 no limit is applied (the default).
1207 the search is not even performed; this can be used to disallow searches
1208 for a specific set of users.
1209 If no limit specifier is set, the value is assigned to the
1215 to preserve the original behavior.
1217 In case of no match, the global limits are used.
1218 The default values are the same of
1227 control is requested, the
1229 size limit is used by default, because the request of a specific page size
1230 is considered an explicit request for a limitation on the number
1231 of entries to be returned.
1232 However, the size limit applies to the total count of entries returned within
1233 the search, and not to a single page.
1234 Additional size limits may be enforced; the syntax is
1235 .BR size.pr={<integer>|noEstimate|unlimited} ,
1238 is the max page size if no explicit limit is set; the keyword
1240 inhibits the server from returning an estimate of the total number
1241 of entries that might be returned
1242 (note: the current implementation does not return any estimate).
1245 indicates that no limit is applied to the pagedResults control page size.
1247 .B size.prtotal={<integer>|unlimited|disabled}
1248 allows to set a limit on the total number of entries that a pagedResults
1249 control allows to return.
1250 By default it is set to the
1255 is the max number of entries that the whole search with pagedResults control
1259 to allow unlimited number of entries to be returned, e.g. to allow
1260 the use of the pagedResults control as a means to circumvent size
1261 limitations on regular searches; the keyword
1263 disables the control, i.e. no paged results can be returned.
1264 Note that the total number of entries returned when the pagedResults control
1265 is requested cannot exceed the
1267 size limit of regular searches unless extended by the
1272 .B maxderefdepth <depth>
1273 Specifies the maximum number of aliases to dereference when trying to
1274 resolve an entry, used to avoid infinite alias loops. The default is 1.
1276 .B overlay <overlay-name>
1277 Add the specified overlay to this database. An overlay is a piece of
1278 code that intercepts database operations in order to extend or change
1279 them. Overlays are pushed onto
1280 a stack over the database, and so they will execute in the reverse
1281 of the order in which they were configured and the database itself
1282 will receive control last of all.
1284 .B readonly on | off
1285 This option puts the database into "read-only" mode. Any attempts to
1286 modify the database will return an "unwilling to perform" error. By
1287 default, readonly is off.
1290 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1291 .B [starttls=yes|critical]
1292 .B [suffix=<suffix> [...]]
1293 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1294 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1295 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1296 .B [attr[!]=<attr list>]
1298 Specify a replication site for this database. Refer to the "OpenLDAP
1299 Administrator's Guide" for detailed information on setting up a replicated
1301 directory service. Zero or more
1303 instances can be used to select the subtrees that will be replicated
1304 (defaults to all the database).
1306 is deprecated in favor of the
1310 allows the replica LDAP server to be specified as an LDAP URI.
1315 requires the options
1319 and should only be used when adequate security services
1320 (e.g TLS or IPSEC) are in place. A
1326 Specific security properties (as with the
1328 keyword above) for a SASL bind can be set with the
1330 option. A non-default SASL realm can be set with the
1335 will use Kerberos, a kerberos instance should be given in
1339 can be given after the
1341 keyword to allow the selective replication of the listed attributes only;
1344 mark is used, the list is considered exclusive, i.e. the listed attributes
1346 If an objectClass is listed, all the related attributes
1347 are (are not) replicated.
1350 .B replogfile <filename>
1351 Specify the name of the replication log file to log changes to.
1352 The replication log is typically written by
1357 .BR slapd.replog (5)
1358 for more information. The specified file should be located
1359 in a directory with limited read/write/execute access as the replication
1360 logs may contain sensitive information.
1362 .B restrict <oplist>
1363 Specify a whitespace separated list of operations that are restricted.
1364 If defined inside a database specification, restrictions apply only
1365 to that database, otherwise they are global.
1366 Operations can be any of
1371 .BR extended[=<OID>] ,
1375 or the special pseudo-operations
1379 which respectively summarize read and write operations.
1387 keyword allows to indicate the OID of the specific operation
1391 Specify the distinguished name that is not subject to access control
1392 or administrative limit restrictions for operations on this database.
1393 This DN may or may not be associated with an entry. An empty root
1394 DN (the default) specifies no root access is to be granted. It is
1395 recommended that the rootdn only be specified when needed (such as
1396 when initially populating a database). If the rootdn is within
1397 a namingContext (suffix) of the database, a simple bind password
1398 may also be provided using the
1402 .B rootpw <password>
1403 Specify a password (or hash of the password) for the rootdn. The
1404 password can only be set if the rootdn is within the namingContext
1405 (suffix) of the database.
1406 This option accepts all RFC 2307 userPassword formats known to
1409 description) as well as cleartext.
1411 may be used to generate a hash of a password. Cleartext
1412 and \fB{CRYPT}\fP passwords are not recommended. If empty
1413 (the default), authentication of the root DN is by other means
1414 (e.g. SASL). Use of SASL is encouraged.
1416 .B suffix <dn suffix>
1417 Specify the DN suffix of queries that will be passed to this
1418 backend database. Multiple suffix lines can be given and at least one is
1419 required for each database definition.
1420 If the suffix of one database is "inside" that of another, the database
1421 with the inner suffix must come first in the configuration file.
1424 Specify that the current backend database is a subordinate of another
1425 backend database. A subordinate database may have only one suffix. This
1426 option may be used to glue multiple databases into a single namingContext.
1427 If the suffix of the current database is within the namingContext of a
1428 superior database, searches against the superior database will be
1429 propagated to the subordinate as well. All of the databases
1430 associated with a single namingContext should have identical rootdns.
1431 Behavior of other LDAP operations is unaffected by this setting. In
1432 particular, it is not possible to use moddn to move an entry from
1433 one subordinate to another subordinate within the namingContext.
1436 .B syncrepl rid=<replica ID>
1437 .B provider=ldap[s]://<hostname>[:port]
1438 .B [type=refreshOnly|refreshAndPersist]
1439 .B [interval=dd:hh:mm:ss]
1440 .B [searchbase=<base DN>]
1441 .B [filter=<filter str>]
1442 .B [scope=sub|one|base]
1443 .B [attrs=<attr list>]
1445 .B [sizelimit=<limit>]
1446 .B [timelimit=<limit>]
1447 .B [schemachecking=on|off]
1449 .B [bindmethod=simple|sasl]
1451 .B [saslmech=<mech>]
1452 .B [authcid=<identity>]
1453 .B [authzid=<identity>]
1454 .B [credentials=<passwd>]
1456 .B [secprops=<properties>]
1458 Specify the current database as a replica which is kept up-to-date with the
1459 master content by establishing the current
1461 as a replication consumer site running a
1464 The replica content is kept synchronized to the master content using
1465 the LDAP Content Synchronization protocol. Refer to the
1466 "OpenLDAP Administrator's Guide" for detailed information on
1467 setting up a replicated
1469 directory service using the
1473 identifies the current
1475 directive within the replication consumer site.
1476 It is a non-negative integer having no more than three digits.
1478 specifies the replication provider site containing the master content
1479 as an LDAP URI. If <port> is not given, the standard LDAP port number
1480 (389 or 636) is used. The content of the
1482 replica is defined using a search
1483 specification as its result set. The consumer
1485 will send search requests to the provider
1487 according to the search specification. The search specification includes
1488 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1491 parameters as in the normal search specification.
1492 The search specification for the LDAP Content Synchronization operation
1493 has the same value syntax and the same default values as in the
1496 The LDAP Content Synchronization protocol has two operation types.
1499 operation, the next synchronization search operation
1500 is periodically rescheduled at an interval time (specified by
1502 parameter; 1 day by default)
1503 after each synchronization operation finishes.
1505 .B refreshAndPersist
1506 operation, a synchronization search remains persistent in the provider slapd.
1507 Further updates to the master replica will generate
1508 .B searchResultEntry
1509 to the consumer slapd as the search responses to the persistent
1510 synchronization search. If the connection is lost, the consumer will
1511 attempt to reconnect at an interval time (specified by
1513 parameter; 60 seconds by default) until the session is re-established.
1514 The schema checking can be enforced at the LDAP Sync
1515 consumer site by turning on the
1517 parameter. The default is off.
1520 parameter specifies the DN in the consumer site
1521 which is allowed to make changes to the replica.
1522 The DN should have read/write access to the replica database.
1527 of the master database.
1532 requires the options
1536 and should only be used when adequate security services
1537 (e.g. TLS or IPSEC) are in place.
1544 Depending on the mechanism, an authentication identity and/or
1545 credentials can be specified using
1551 parameter may be used to specify an authorization identity.
1552 Specific security properties (as with the
1554 keyword above) for a SASL bind can be set with the
1556 option. A non default SASL realm can be set with the
1562 This option is only applicable in a slave
1563 database updated using
1565 It specifies the DN permitted to update (subject to access controls)
1566 the replica (typically, this is the DN
1568 binds to update the replica). Generally, this DN
1575 Specify the referral to pass back when
1577 is asked to modify a replicated local database.
1578 If specified multiple times, each url is provided.
1580 .SH DATABASE-SPECIFIC OPTIONS
1581 Each database may allow specific configuration options; they are
1582 documented separately in the backends' manual pages.
1584 The following backends can be compiled into slapd.
1585 They are documented in the
1586 .BR slapd-<backend> (5)
1590 This is the recommended backend for a normal slapd database.
1591 However, it takes more care than with the LDBM backend to configure
1593 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1596 This is the database backend which is easiest to configure.
1597 However, it does not offer the data durability features of the BDB
1599 It uses Berkeley DB or GDBM to store data.
1602 This backend is experimental.
1603 It serves up referrals based upon SRV resource records held in the
1607 This backend acts as a proxy to forward incoming requests to another
1611 This backend performs basic LDAP proxying with respect to a set of
1612 remote LDAP servers. It is an enhancement of the ldap backend. The
1613 proxy cache extension of meta backend provides answering of search
1614 requests from the proxy using results of previously cached requests.
1617 This backend provides information about the running status of the slapd
1621 Operations in this backend succeed but do nothing.
1624 This backend is provided for demonstration purposes only.
1625 It serves up user account information from the system
1630 This backend embeds a
1632 interpreter into slapd.
1633 It runs Perl subroutines to implement LDAP operations.
1636 This backend redirects LDAP operations to another database
1637 in the same server, based on the naming context of the request.
1638 Its use requires the
1642 for details) to rewrite the naming context of the request.
1643 It is is primarily intended to implement virtual views on databases
1644 that actually store data.
1647 This backend executes external programs to implement LDAP operations.
1648 It is primarily intended to be used in prototypes.
1651 This backend is experimental.
1652 It services LDAP requests from an SQL database.
1655 This backend is experimental.
1658 interpreter into slapd.
1659 It runs Tcl commands to implement LDAP operations.
1662 Here is a short example of a configuration file:
1666 include SYSCONFDIR/schema/core.schema
1667 pidfile LOCALSTATEDIR/slapd.pid
1669 # Subtypes of "name" (e.g. "cn" and "ou") with the
1670 # option ";x-hidden" can be searched for/compared,
1671 # but are not shown. See \fBslapd.access\fP(5).
1672 attributeoptions x-hidden lang-
1673 access to attr=name;x-hidden by * =cs
1676 suffix "dc=our-domain,dc=com"
1677 # The database directory MUST exist prior to
1678 # running slapd AND should only be accessible
1679 # by the slapd/tools. Mode 0700 recommended.
1680 directory LOCALSTATEDIR/openldap-data
1681 # Indices to maintain
1682 index objectClass eq
1683 index cn,sn,mail pres,eq,approx,sub
1685 # We serve small clients that do not handle referrals,
1686 # so handle remote lookups on their behalf.
1689 uri ldap://ldap.some-server.com/
1694 "OpenLDAP Administrator's Guide" contains a longer annotated
1695 example of a configuration file.
1696 The original ETCDIR/slapd.conf is another example.
1700 default slapd configuration file
1704 .BR slapd\-dnssrv (5),
1705 .BR slapd\-ldap (5),
1706 .BR slapd\-ldbm (5),
1707 .BR slapd\-meta (5),
1708 .BR slapd\-monitor (5),
1709 .BR slapd\-null (5),
1710 .BR slapd\-passwd (5),
1711 .BR slapd\-perl (5),
1712 .BR slapd\-relay (5),
1713 .BR slapd\-shell (5),
1716 .BR slapd.access (5),
1717 .BR slapd.plugin (5),
1718 .BR slapd.replog (5),
1730 Known overlays are documented in
1731 .BR slapo\-lastmod (5),
1732 .BR slapo\-pcache (5),
1733 .BR slapo\-ppolicy (5),
1734 .BR slapo\-refint (5),
1736 .BR slapo\-unique (5).
1738 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1739 .SH ACKNOWLEDGEMENTS
1741 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1743 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob