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.
186 The rules are simply regular expressions specifying which DNs are allowed
187 to perform proxy authorization.
190 attribute in an entry specifies which other users
191 are allowed to proxy login to this entry. The
194 an entry specifies which other users this user can authorize as. Use of
197 abused if users are allowed to write arbitrary values to this attribute.
200 attribute must be protected with ACLs such that
201 only privileged users can modify it.
208 or a set of identities; it can take three forms:
212 .B ldap:///<base>??[<scope>]?<filter>
215 .B dn[.<dnstyle>]:<pattern>
218 .B u[<mech>[<realm>]]:<pattern>
221 .B group[/objectClass[/attributeType]]:<pattern>
228 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
231 The first form is a valid LDAP
239 portions must be absent, so that the search occurs locally on either
245 with the optional style modifiers
251 for exact, onelevel, children and subtree matches, which cause
253 to be normalized according to the DN normalization rules, or the special
257 to be compiled according to
259 The third form is a SASL
261 with the optional fields
265 that allow to specify a SASL
267 and eventually a SASL
269 for those mechanisms that support one.
270 The need to allow the specification of a mechanism is still debated,
271 and users are strongly discouraged to rely on this possibility.
272 The fourth form is a group specification, consisting of the keyword
274 optionally followed by the specification of the group
280 is searched with base scope, and in case of match, the values of the
283 are searched for the asserted DN.
284 For backwards compatibility, if no identity type is provided, i.e. only
288 is assumed; as a consequence,
290 is subjected to DN normalization.
291 Since the interpretation of
295 can impact security, users are strongly encouraged
296 to explicitly set the type of identity specification that is being used.
299 .B authz-regexp <match> <replace>
300 Used by the authentication framework to convert simple user names,
301 such as provided by SASL subsystem, to an LDAP DN used for
302 authorization purposes. Note that the resultant DN need not refer
303 to an existing entry to be considered valid. When an authorization
304 request is received from the SASL subsystem, the SASL
309 are taken, when available, and combined into a name of the form
313 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
316 This name is then compared against the
318 regular expression, and if the match is successful, the name is
321 string. If there are wildcard strings in the
323 regular expression that are enclosed in parenthesis, e.g.
329 then the portion of the name that matched the wildcard will be stored
330 in the numbered placeholder variable $1. If there are other wildcard strings
331 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
332 placeholders can then be used in the
337 .B UID=$1,OU=Accounts,DC=example,DC=com
340 The replaced name can be either a DN or an LDAP URI. If the
341 latter, the server will use the URI to search its own database(s)
342 and, if the search returns exactly one entry, the name is
343 replaced by the DN of that entry. The LDAP URI must have no
344 hostport, attrs, or extensions components, e.g.
347 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
352 options can be given in the configuration file to allow for multiple matching
353 and replacement patterns. The matching patterns are checked in the order they
354 appear in the file, stopping at the first successful match.
357 .\"Because the plus sign + is a character recognized by the regular expression engine,
358 .\"and it will appear in names that include a REALM, be careful to escape the
359 .\"plus sign with a backslash \\+ to remove the character's special meaning.
362 .B concurrency <integer>
363 Specify a desired level of concurrency. Provided to the underlying
364 thread system as a hint. The default is not to provide any hint.
366 .B conn_max_pending <integer>
367 Specify the maximum number of pending requests for an anonymous session.
368 If requests are submitted faster than the server can process them, they
369 will be queued up to this limit. If the limit is exceeded, the session
370 is closed. The default is 100.
372 .B conn_max_pending_auth <integer>
373 Specify the maximum number of pending requests for an authenticated session.
375 .\"-- NEW_LOGGING option --
377 .\".B debug <subsys> <level>
378 .\"Specify a logging level for a particular subsystem. The subsystems include
380 .\"a global level for all subsystems,
384 .\"the backend databases,
386 .\"the entry cache manager,
388 .\"the config file reader,
390 .\"the connection manager,
392 .\"the Cyrus SASL library interface,
394 .\"the search filter processor,
396 .\"the DN normalization library,
398 .\"the database indexer,
400 .\"the ASN.1 BER library,
402 .\"the dynamic module loader,
404 .\"the LDAP operation processors,
406 .\"the SASL authentication subsystem,
408 .\"the schema processor, and
410 .\"the TLS library interface. This is not an exhaustive list; there are many
411 .\"other subsystems and more are added over time.
413 .\"The levels are, in order of decreasing priority:
414 .\".B emergency, alert, critical, error, warning, notice, information, entry,
415 .\".B args, results, detail1, detail2
416 .\"An integer may be used instead, with 0 corresponding to
422 .\"level logs function entry points,
424 .\"adds function call parameters, and
426 .\"adds the function results to the logs.
431 .\"levels add even more low level detail from individual functions.
433 .B defaultsearchbase <dn>
434 Specify a default search base to use when client submits a
435 non-base search request with an empty base DN.
437 .B disallow <features>
438 Specify a set of features (separated by white space) to
439 disallow (default none).
441 disables acceptance of anonymous bind requests.
443 disables simple (bind) authentication.
445 disables Kerberos V4 (bind) authentication.
447 disables Start TLS from forcing session to anonymous status (see also
450 disables StartTLS if authenticated (see also
454 .B ditcontentrule "(\ <oid>\
456 [DESC\ <description>]\
463 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
464 The slapd parser extends the RFC 2252 definition by allowing string
465 forms as well as numeric OIDs to be used for the attribute OID and
466 attribute syntax OID.
472 .B gentlehup { on | off }
473 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
475 will stop listening for new connections, but will not close the
476 connections to the current clients. Future write operations return
477 unwilling-to-perform, though. Slapd terminates when all clients
478 have closed their connections (if they ever do), or \- as before \-
479 if it receives a SIGTERM signal. This can be useful if you wish to
480 terminate the server and start a new
483 .B with another database,
484 without disrupting the currently active clients.
485 The default is off. You may wish to use
487 along with this option.
489 .B idletimeout <integer>
490 Specify the number of seconds to wait before forcibly closing
491 an idle client connection. A idletimeout of 0 disables this
492 feature. The default is 0.
494 .B include <filename>
495 Read additional configuration information from the given file before
496 continuing with the next line of the current file.
497 .\"-- NEW_LOGGING option --
499 .\".B logfile <filename>
500 .\"Specify a file for recording debug log messages. By default these messages
501 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
502 .\"copies messages to both stderr and the logfile.
504 .B loglevel <integer>
505 Specify the level at which debugging statements and operation
506 statistics should be syslogged (currently logged to the
508 LOG_LOCAL4 facility). Log levels are additive, and available levels
518 debug packet handling
521 heavy trace debugging
524 connection management
527 print out packets sent and received
530 search filter processing
533 configuration file processing
536 access control list processing
539 stats log connections/operations/results
542 stats log entries sent
545 print communication with shell backends
553 .B moduleload <filename>
554 Specify the name of a dynamically loadable module to load. The filename
555 may be an absolute path name or a simple filename. Non-absolute names
556 are searched for in the directories specified by the
558 option. This option and the
560 option are only usable if slapd was compiled with --enable-modules.
562 .B modulepath <pathspec>
563 Specify a list of directories to search for loadable modules. Typically
564 the path is colon-separated but this depends on the operating system.
567 .B objectclass "(\ <oid>\
569 [DESC\ <description]\
572 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
573 [MUST\ <oids>] [MAY\ <oids>] )"
575 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
576 The slapd parser extends the RFC 2252 definition by allowing string
577 forms as well as numeric OIDs to be used for the object class OID.
581 description.) Object classes are "STRUCTURAL" by default.
584 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
585 Define a string name that equates to the given OID. The string can be used
586 in place of the numeric OID in objectclass and attribute definitions. The
587 name can also be used with a suffix of the form ":xx" in which case the
588 value "oid.xx" will be used.
590 .B password-hash <hash> [<hash>...]
591 This option configures one or more hashes to be used in generation of user
592 passwords stored in the userPassword attribute during processing of
593 LDAP Password Modify Extended Operations (RFC 3062).
594 The <hash> must be one of
608 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
613 use the MD5 algorithm (RFC 1321), the latter with a seed.
620 indicates that the new password should be
621 added to userPassword as clear text.
623 Note that this option does not alter the normal user applications
624 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
626 .B password\-crypt\-salt\-format <format>
627 Specify the format of the salt passed to
629 when generating {CRYPT} passwords (see
631 during processing of LDAP Password Modify Extended Operations (RFC 3062).
633 This string needs to be in
635 format and may include one (and only one) %s conversion.
636 This conversion will be substituted with a string random
637 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
638 provides a two character salt and "$1$%.8s" tells some
639 versions of crypt(3) to use an MD5 algorithm and provides
640 8 random characters of salt. The default is "%s", which
641 provides 31 characters of salt.
643 .B pidfile <filename>
644 The ( absolute ) name of a file that will hold the
646 server's process ID ( see
648 ) if started without the debugging command line option.
651 Specify the referral to pass back when
653 cannot find a local database to handle a request.
654 If specified multiple times, each url is provided.
657 The ( absolute ) name of a file that will hold the
659 server's command line options
660 if started without the debugging command line option.
663 The ( absolute ) name of a file that will hold the
665 server's process ID ( see
667 ) if started without the debugging command line option.
669 .B replicationinterval
670 The number of seconds
672 waits before checking the replogfile for changes.
674 .B require <conditions>
675 Specify a set of conditions (separated by white space) to
676 require (default none).
677 The directive may be specified globally and/or per-database.
679 requires bind operation prior to directory operations.
681 requires session to be using LDAP version 3.
683 requires authentication prior to directory operations.
685 requires SASL authentication prior to directory operations.
687 requires strong authentication prior to directory operations.
688 The strong keyword allows protected "simple" authentication
689 as well as SASL authentication.
691 may be used to require no conditions (useful for clearly globally
692 set conditions within a particular database).
694 .B reverse-lookup on | off
695 Enable/disable client name unverified reverse lookup (default is
697 if compiled with --enable-rlookups).
700 Specify the name of an LDIF(5) file containing user defined attributes
701 for the root DSE. These attributes are returned in addition to the
702 attributes normally produced by slapd.
705 Used to specify the fully qualified domain name used for SASL processing.
707 .B sasl-realm <realm>
708 Specify SASL realm. Default is empty.
710 .B sasl-secprops <properties>
711 Used to specify Cyrus SASL security properties.
714 flag (without any other properties) causes the flag properties
715 default, "noanonymous,noplain", to be cleared.
718 flag disables mechanisms susceptible to simple passive attacks.
721 flag disables mechanisms susceptible to active attacks.
724 flag disables mechanisms susceptible to passive dictionary attacks.
727 flag disables mechanisms which support anonymous login.
730 flag require forward secrecy between sessions.
733 require mechanisms which pass client credentials (and allow
734 mechanisms which can pass credentials to do so).
737 property specifies the minimum acceptable
738 .I security strength factor
739 as an integer approximate to effective key length used for
740 encryption. 0 (zero) implies no protection, 1 implies integrity
741 protection only, 56 allows DES or other weak ciphers, 112
742 allows triple DES and other strong ciphers, 128 allows RC4,
743 Blowfish and other modern strong ciphers. The default is 0.
746 property specifies the maximum acceptable
747 .I security strength factor
748 as an integer (see minssf description). The default is INT_MAX.
751 property specifies the maximum security layer receive buffer
752 size allowed. 0 disables security layers. The default is 65536.
755 Specify the distinguished name for the subschema subentry that
756 controls the entries on this server. The default is "cn=Subschema".
758 .B security <factors>
759 Specify a set of factors (separated by white space) to require.
760 An integer value is associated with each factor and is roughly
761 equivalent of the encryption key length to require. A value
762 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
763 The directive may be specified globally and/or per-database.
765 specifies the overall security strength factor.
767 specifies the transport security strength factor.
769 specifies the TLS security strength factor.
771 specifies the SASL security strength factor.
773 specifies the overall security strength factor to require for
775 .B update_transport=<n>
776 specifies the transport security strength factor to require for
779 specifies the TLS security strength factor to require for
782 specifies the SASL security strength factor to require for
785 specifies the security strength factor required for
787 username/password authentication.
790 factor is measure of security provided by the underlying transport,
791 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
793 .B sizelimit {<integer>|unlimited}
795 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
796 Specify the maximum number of entries to return from a search operation.
797 The default size limit is 500.
802 to specify no limits.
803 The second format allows a fine grain setting of the size limits.
804 Extra args can be added on the same line.
807 for an explanation of the different flags.
809 .B sockbuf_max_incoming <integer>
810 Specify the maximum incoming LDAP PDU size for anonymous sessions.
811 The default is 262143.
813 .B sockbuf_max_incoming_auth <integer>
814 Specify the maximum incoming LDAP PDU size for authenticated sessions.
815 The default is 4194303.
818 Specify the srvtab file in which the kerberos keys necessary for
819 authenticating clients using kerberos can be found. This option is only
820 meaningful if you are using Kerberos authentication.
823 Specify the maximum size of the primary thread pool.
826 .B timelimit {<integer>|unlimited}
828 .B timelimit time[.{soft|hard}]=<integer> [...]
829 Specify the maximum number of seconds (in real time)
831 will spend answering a search request. The default time limit is 3600.
836 to specify no limits.
837 The second format allows a fine grain setting of the time limits.
838 Extra args can be added on the same line.
841 for an explanation of the different flags.
843 .B ucdata-path <path>
844 Specify the path to the directory containing the Unicode character
845 tables. The default path is DATADIR/ucdata.
849 is built with support for Transport Layer Security, there are more options
852 .B TLSCipherSuite <cipher-suite-spec>
853 Permits configuring what ciphers will be accepted and the preference order.
854 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
856 TLSCipherSuite HIGH:MEDIUM:+SSLv2
858 To check what ciphers a given spec selects, use:
860 openssl ciphers -v <cipher-suite-spec>
862 .B TLSCACertificateFile <filename>
863 Specifies the file that contains certificates for all of the Certificate
868 .B TLSCACertificatePath <path>
869 Specifies the path of a directory that contains Certificate Authority
870 certificates in separate individual files. Usually only one of this
871 or the TLSCACertificateFile is used.
873 .B TLSCertificateFile <filename>
874 Specifies the file that contains the
878 .B TLSCertificateKeyFile <filename>
879 Specifies the file that contains the
881 server private key that matches the certificate stored in the
882 .B TLSCertificateFile
883 file. Currently, the private key must not be protected with a password, so
884 it is of critical importance that it is protected carefully.
886 .B TLSRandFile <filename>
887 Specifies the file to obtain random bits from when /dev/[u]random
888 is not available. Generally set to the name of the EGD/PRNGD socket.
889 The environment variable RANDFILE can also be used to specify the filename.
891 .B TLSVerifyClient <level>
892 Specifies what checks to perform on client certificates in an
893 incoming TLS session, if any.
896 can be specified as one of the following keywords:
902 will not ask the client for a certificate.
905 The client certificate is requested. If no certificate is provided,
906 the session proceeds normally. If a bad certificate is provided,
907 it will be ignored and the session proceeds normally.
910 The client certificate is requested. If no certificate is provided,
911 the session proceeds normally. If a bad certificate is provided,
912 the session is immediately terminated.
914 .B demand | hard | true
915 These keywords are all equivalent, for compatibility reasons.
916 The client certificate is requested. If no certificate is provided,
917 or a bad certificate is provided, the session is immediately terminated.
919 Note that a valid client certificate is required in order to use the
920 SASL EXTERNAL authentication mechanism with a TLS session. As such,
923 setting must be chosen to enable SASL EXTERNAL authentication.
925 .SH GENERAL BACKEND OPTIONS
926 Options in this section only apply to the configuration file section
927 for the specified backend. They are supported by every
930 .B backend <databasetype>
931 Mark the beginning of a backend definition. <databasetype>
946 depending on which backend will serve the database.
948 .SH GENERAL DATABASE OPTIONS
949 Options in this section only apply to the configuration file section
950 for the database in which they are defined. They are supported by every
951 type of backend. Note that the
955 option are mandatory for each database.
957 .B database <databasetype>
958 Mark the beginning of a new database instance definition. <databasetype>
973 depending on which backend will serve the database.
978 will automatically maintain the
979 modifiersName, modifyTimestamp, creatorsName, and
980 createTimestamp attributes for entries. By default, lastmod is on.
982 .B limits <who> <limit> [<limit> [...]]
983 Specify time and size limits based on who initiated an operation.
990 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
996 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1001 matches all unauthenticated clients.
1004 matches all authenticated clients;
1007 dn pattern is assumed unless otherwise specified by qualifying
1008 the (optional) key string
1014 (which are synonyms), to require an exact match; with
1016 to require exactly one level of depth match; with
1018 to allow any level of depth match, including the exact match; with
1020 to allow any level of depth match, not including the exact match;
1022 explicitly requires the (default) match based on regular expression
1023 pattern, as detailed in
1027 matches unbound operations; the
1030 The same behavior is obtained by using the
1037 with the optional objectClass
1043 sets the limits for any DN listed in the values of the
1049 group objectClass (default
1051 whose DN exactly matches
1054 The currently supported limits are
1059 The syntax for time limits is
1060 .BR time[.{soft|hard}]=<integer> ,
1063 is the number of seconds slapd will spend answering a search request.
1064 If no time limit is explicitly requested by the client, the
1066 limit is used; if the requested time limit exceeds the
1069 .I \"Administrative limit exceeded\"
1073 limit is set to 0 or to the keyword
1075 the soft limit is used in either case; if it is set to
1079 no hard limit is enforced.
1080 Explicit requests for time limits smaller or equal to the
1083 If no flag is set, the value is assigned to the
1087 limit is set to zero, to preserve the original behavior.
1089 The syntax for size limits is
1090 .BR size[.{soft|hard|unchecked}]=<integer> ,
1093 is the maximum number of entries slapd will return answering a search
1095 If no size limit is explicitly requested by the client, the
1097 limit is used; if the requested size limit exceeds the
1100 .I \"Administrative limit exceeded\"
1104 limit is set to 0 or to the keyword
1106 the soft limit is used in either case; if it is set to
1110 no hard limit is enforced.
1111 Explicit requests for size limits smaller or equal to the
1116 flag sets a limit on the number of candidates a search request is allowed
1118 If the selected candidates exceed the
1120 limit, the search will abort with
1121 .IR \"Unwilling to perform\" .
1126 no limit is applied (the default).
1129 the search is not even performed; this can be used to disallow searches
1130 for a specific set of users.
1131 If no flag is set, the value is assigned to the
1135 limit is set to zero, to preserve the original behavior.
1137 In case of no match, the global limits are used.
1138 The default values are the same of
1147 control is requested, the
1149 size limit is used by default, because the request of a specific page size
1150 is considered as an explicit request for a limitation on the number
1151 of entries to be returned.
1152 However, the size limit applies to the total count of entries returned within
1153 the search, and not to a single page.
1154 Additional size limits may be enforced; the syntax is
1155 .BR size.pr={<integer>|noEstimate|none} ,
1158 is the max page size if no explicit limit is set; the keyword
1160 inhibits the server to return an estimate of the total number
1161 of entries that will be returned; the keyword
1163 indicates that no limit is applied to the pagedResults control page size.
1165 .B size.prtotal={<integer>|none|disabled}
1166 allows to set a limit on the total number of entries that a pagedResults
1167 control allows to return.
1168 By default it is set to the
1173 is the max number of entries that the whole search with pagedResults control
1177 to allow unlimited number of entries to be returned, i.e. to use
1178 pagedResults as a means to allow clients to circumvent size limitations
1179 on regular searches; the keyword
1181 disables the control, i.e. no paged results can be returned.
1182 Note that the total number of entries returned when the pagedResults control
1183 is requested cannot exceed the
1185 size limit of regular searches unless extended by the
1190 .B maxderefdepth <depth>
1191 Specifies the maximum number of aliases to dereference when trying to
1192 resolve an entry, used to avoid infinite alias loops. The default is 1.
1194 .B overlay <overlay-name>
1195 Add the specified overlay to this database. An overlay is a piece of
1196 code that intercepts database operations in order to extend or change
1197 them. Overlays are pushed onto
1198 a stack over the database, and so they will execute in the reverse
1199 of the order in which they were configured and the database itself
1200 will receive control last of all.
1202 .B readonly on | off
1203 This option puts the database into "read-only" mode. Any attempts to
1204 modify the database will return an "unwilling to perform" error. By
1205 default, readonly is off.
1208 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1209 .B [starttls=yes|critical]
1210 .B [suffix=<suffix> [...]]
1211 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1212 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1213 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1214 .B [attr[!]=<attr list>]
1216 Specify a replication site for this database. Refer to the "OpenLDAP
1217 Administrator's Guide" for detailed information on setting up a replicated
1219 directory service. Zero or more
1221 instances can be used to select the subtrees that will be replicated
1222 (defaults to all the database).
1224 is deprecated in favor of the
1228 allows the replica LDAP server to be specified as an LDAP URI.
1233 requires the options
1237 and should only be used when adequate security services
1238 (e.g TLS or IPSEC) are in place. A
1244 Specific security properties (as with the
1246 keyword above) for a SASL bind can be set with the
1248 option. A non-default SASL realm can be set with the
1253 will use Kerberos, a kerberos instance should be given in
1257 can be given after the
1259 keyword to allow the selective replication of the listed attributes only;
1262 mark is used, the list is considered exclusive, i.e. the listed attributes
1264 If an objectClass is listed, all the related attributes
1265 are (are not) replicated.
1268 .B replogfile <filename>
1269 Specify the name of the replication log file to log changes to.
1270 The replication log is typically written by
1275 .BR slapd.replog (5)
1276 for more information. The specified file should be located
1277 in a directory with limited read/write/execute access as the replication
1278 logs may contain sensitive information.
1280 .B restrict <oplist>
1281 Specify a whitespace separated list of operations that are restricted.
1282 If defined inside a database specification, restrictions apply only
1283 to that database, otherwise they are global.
1284 Operations can be any of
1289 .BR extended[=<OID>] ,
1293 or the special pseudo-operations
1297 which respectively summarize read and write operations.
1305 keyword allows to indicate the OID of the specific operation
1309 Specify the distinguished name that is not subject to access control
1310 or administrative limit restrictions for operations on this database.
1311 This DN may or may not be associated with an entry. An empty root
1312 DN (the default) specifies no root access is to be granted. It is
1313 recommended that the rootdn only be specified when needed (such as
1314 when initially populating a database). If the rootdn is within
1315 a namingContext (suffix) of the database, a simple bind password
1316 may also be provided using the
1320 .B rootpw <password>
1321 Specify a password (or hash of the password) for the rootdn. The
1322 password can only be set if the rootdn is within the namingContext
1323 (suffix) of the database.
1324 This option accepts all RFC 2307 userPassword formats known to
1327 description) as well as cleartext.
1329 may be used to generate a hash of a password. Cleartext
1330 and \fB{CRYPT}\fP passwords are not recommended. If empty
1331 (the default), authentication of the root DN is by other means
1332 (e.g. SASL). Use of SASL is encouraged.
1334 .B suffix <dn suffix>
1335 Specify the DN suffix of queries that will be passed to this
1336 backend database. Multiple suffix lines can be given and at least one is
1337 required for each database definition.
1338 If the suffix of one database is "inside" that of another, the database
1339 with the inner suffix must come first in the configuration file.
1342 Specify that the current backend database is a subordinate of another
1343 backend database. A subordinate database may have only one suffix. This
1344 option may be used to glue multiple databases into a single namingContext.
1345 If the suffix of the current database is within the namingContext of a
1346 superior database, searches against the superior database will be
1347 propagated to the subordinate as well. All of the databases
1348 associated with a single namingContext should have identical rootdns.
1349 Behavior of other LDAP operations is unaffected by this setting. In
1350 particular, it is not possible to use moddn to move an entry from
1351 one subordinate to another subordinate within the namingContext.
1354 .B syncrepl rid=<replica ID>
1355 .B provider=ldap[s]://<hostname>[:port]
1356 .B [type=refreshOnly|refreshAndPersist]
1357 .B [interval=dd:hh:mm:ss]
1358 .B [searchbase=<base DN>]
1359 .B [filter=<filter str>]
1360 .B [scope=sub|one|base]
1361 .B [attrs=<attr list>]
1363 .B [sizelimit=<limit>]
1364 .B [timelimit=<limit>]
1365 .B [schemachecking=on|off]
1367 .B [bindmethod=simple|sasl]
1369 .B [saslmech=<mech>]
1370 .B [authcid=<identity>]
1371 .B [authzid=<identity>]
1372 .B [credentials=<passwd>]
1374 .B [secprops=<properties>]
1376 Specify the current database as a replica which is kept up-to-date with the
1377 master content by establishing the current
1379 as a replication consumer site running a
1382 The replica content is kept synchronized to the master content using
1383 the LDAP Content Synchronization protocol. Refer to the
1384 "OpenLDAP Administrator's Guide" for detailed information on
1385 setting up a replicated
1387 directory service using the
1391 identifies the current
1393 directive within the replication consumer site.
1394 It is a non-negative integer having no more than three digits.
1396 specifies the replication provider site containing the master content
1397 as an LDAP URI. If <port> is not given, the standard LDAP port number
1398 (389 or 636) is used. The content of the
1400 replica is defined using a search
1401 specification as its result set. The consumer
1403 will send search requests to the provider
1405 according to the search specification. The search specification includes
1406 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1409 parameters as in the normal search specification.
1410 The search specification for the LDAP Content Synchronization operation
1411 has the same value syntax and the same default values as in the
1414 The LDAP Content Synchronization protocol has two operation types.
1417 operation, the next synchronization search operation
1418 is periodically rescheduled at an interval time (specified by
1420 parameter; 1 day by default)
1421 after each synchronization operation finishes.
1423 .B refreshAndPersist
1424 operation, a synchronization search remains persistent in the provider slapd.
1425 Further updates to the master replica will generate
1426 .B searchResultEntry
1427 to the consumer slapd as the search responses to the persistent
1428 synchronization search. If the connection is lost, the consumer will
1429 attempt to reconnect at an interval time (specified by
1431 parameter; 60 seconds by default) until the session is re-established.
1432 The schema checking can be enforced at the LDAP Sync
1433 consumer site by turning on the
1435 parameter. The default is off.
1438 parameter specifies the DN in the consumer site
1439 which is allowed to make changes to the replica.
1440 The DN should have read/write access to the replica database.
1445 of the master database.
1450 requires the options
1454 and should only be used when adequate security services
1455 (e.g. TLS or IPSEC) are in place.
1462 Depending on the mechanism, an authentication identity and/or
1463 credentials can be specified using
1469 parameter may be used to specify an authorization identity.
1470 Specific security properties (as with the
1472 keyword above) for a SASL bind can be set with the
1474 option. A non default SASL realm can be set with the
1480 This option is only applicable in a slave
1481 database updated using
1483 It specifies the DN permitted to update (subject to access controls)
1484 the replica (typically, this is the DN
1486 binds to update the replica). Generally, this DN
1493 Specify the referral to pass back when
1495 is asked to modify a replicated local database.
1496 If specified multiple times, each url is provided.
1498 .SH DATABASE-SPECIFIC OPTIONS
1499 Each database may allow specific configuration options; they are
1500 documented separately in the backends' manual pages.
1502 The following backends can be compiled into slapd.
1503 They are documented in the
1504 .BR slapd-<backend> (5)
1508 This is the recommended backend for a normal slapd database.
1509 However, it takes more care than with the LDBM backend to configure
1511 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1514 This is the database backend which is easiest to configure.
1515 However, it does not offer the data durability features of the BDB
1517 It uses Berkeley DB or GDBM to store data.
1520 This backend is experimental.
1521 It serves up referrals based upon SRV resource records held in the
1525 This backend acts as a proxy to forward incoming requests to another
1529 This backend performs basic LDAP proxying with respect to a set of
1530 remote LDAP servers. It is an enhancement of the ldap backend. The
1531 proxy cache extension of meta backend provides answering of search
1532 requests from the proxy using results of previously cached requests.
1535 This backend provides information about the running status of the slapd
1539 Operations in this backend succeed but do nothing.
1542 This backend is provided for demonstration purposes only.
1543 It serves up user account information from the system
1548 This backend embeds a
1550 interpreter into slapd.
1551 It runs Perl subroutines to implement LDAP operations.
1554 This backend executes external programs to implement LDAP operations.
1555 It is is primarily intended to be used in prototypes.
1558 This backend is experimental.
1559 It services LDAP requests from an SQL database.
1562 This backend is experimental.
1565 interpreter into slapd.
1566 It runs Tcl commands to implement LDAP operations.
1569 Here is a short example of a configuration file:
1573 include SYSCONFDIR/schema/core.schema
1574 pidfile LOCALSTATEDIR/slapd.pid
1576 # Subtypes of "name" (e.g. "cn" and "ou") with the
1577 # option ";x-hidden" can be searched for/compared,
1578 # but are not shown. See \fBslapd.access\fP(5).
1579 attributeoptions x-hidden lang-
1580 access to attr=name;x-hidden by * =cs
1583 suffix "dc=our-domain,dc=com"
1584 # The database directory MUST exist prior to
1585 # running slapd AND should only be accessible
1586 # by the slapd/tools. Mode 0700 recommended.
1587 directory LOCALSTATEDIR/openldap-data
1588 # Indices to maintain
1589 index objectClass eq
1590 index cn,sn,mail pres,eq,approx,sub
1592 # We serve small clients that do not handle referrals,
1593 # so handle remote lookups on their behalf.
1596 uri ldap://ldap.some-server.com/
1601 "OpenLDAP Administrator's Guide" contains a longer annotated
1602 example of a configuration file.
1603 The original ETCDIR/slapd.conf is another example.
1607 default slapd configuration file
1611 .BR slapd-dnssrv (5),
1615 .BR slapd-monitor (5),
1617 .BR slapd-passwd (5),
1619 .BR slapd-shell (5),
1622 .BR slapd.access (5),
1623 .BR slapd.plugin (5),
1624 .BR slapd.replog (5),
1636 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1637 .SH ACKNOWLEDGEMENTS
1639 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1641 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob