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
24 file consists of a series of global configuration options that apply to
26 as a whole (including all backends), followed by zero or more database
27 backend definitions that contain information specific to a backend
35 # comment - these options apply to every database
36 <global configuration options>
37 # first database definition & configuration options
38 database <backend 1 type>
39 <configuration options specific to backend 1>
40 # subsequent database definitions & configuration options
44 As many backend-specific sections as desired may be included. Global
45 options can be overridden in a backend (for options that appear more
46 than once, the last appearance in the
50 If a line begins with white space, it is considered a continuation
51 of the previous line. Blank lines and comment lines beginning with
52 a `#' character are ignored. (Note: continuation lines are unwrapped
53 before comment processing is applied.)
55 Arguments on configuration lines are separated by white space. If an
56 argument contains white space, the argument should be enclosed in
57 double quotes. If an argument contains a double quote (`"') or a
58 backslash character (`\\'), the character should be preceded by a
61 The specific configuration options available are discussed below in the
62 Global Configuration Options, General Backend Options, and General Database
63 Options. Backend-specific options are discussed in the
65 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
66 details on the slapd configuration file.
67 .SH GLOBAL CONFIGURATION OPTIONS
68 Options described in this section apply to all backends, unless specifically
69 overridden in a backend definition. Arguments that should be replaced by
70 actual text are shown in brackets <>.
72 .B access to <what> "[ by <who> <access> <control> ]+"
73 Grant access (specified by <access>) to a set of entries and/or
74 attributes (specified by <what>) by one or more requestors (specified
78 and the "OpenLDAP's Administrator's Guide" for details.
81 Specify a set of features (separated by white space) to
84 allows acceptance of LDAPv2 bind requests. Note that
86 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
88 allows anonymous bind when credentials are not empty (e.g.
91 allows unauthenticated (anonymous) bind when DN is not empty.
93 allow unauthenticated (anonymous) update operations to be processed
94 (subject to access controls and other administrative limits).
96 .B argsfile <filename>
97 The ( absolute ) name of a file that will hold the
99 server's command line options
100 if started without the debugging command line option.
102 .B attributeoptions [option-name]...
103 Define tagging attribute options or option tag/range prefixes.
104 Options must not end with `-', prefixes must end with `-'.
105 The `lang-' prefix is predefined.
108 directive, `lang-' will no longer be defined and you must specify it
109 explicitly if you want it defined.
111 An attribute description with a tagging option is a subtype of that
112 attribute description without the option.
113 Except for that, options defined this way have no special semantics.
114 Prefixes defined this way work like the `lang-' options:
115 They define a prefix for tagging options starting with the prefix.
116 That is, if you define the prefix `x-foo-', you can use the option
118 Furthermore, in a search or compare, a prefix or range name (with
119 a trailing `-') matches all options starting with that name, as well
120 as the option with the range name sans the trailing `-'.
121 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
123 RFC 2251 reserves options beginning with `x-' for private experiments.
124 Other options should be registered with IANA, see RFC 3383 section 3.4.
125 OpenLDAP also has the `binary' option built in, but this is a transfer
126 option, not a tagging option.
129 .B attributetype "(\ <oid>\
131 [DESC\ <description>]\
140 [NO\-USER\-MODIFICATION]\
141 [USAGE\ <attributeUsage>]\ )"
143 Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
144 The slapd parser extends the RFC 2252 definition by allowing string
145 forms as well as numeric OIDs to be used for the attribute OID and
146 attribute syntax OID.
152 .B concurrency <integer>
153 Specify a desired level of concurrency. Provided to the underlying
154 thread system as a hint. The default is not to provide any hint.
156 .B conn_max_pending <integer>
157 Specify the maximum number of pending requests for an anonymous session.
158 If requests are submitted faster than the server can process them, they
159 will be queued up to this limit. If the limit is exceeded, the session
160 is closed. The default is 100.
162 .B conn_max_pending_auth <integer>
163 Specify the maximum number of pending requests for an authenticated session.
166 .\".B debug <subsys> <level>
167 .\"Specify a logging level for a particular subsystem. The subsystems include
169 .\"a global level for all subsystems,
173 .\"the backend databases,
175 .\"the entry cache manager,
177 .\"the config file reader,
179 .\"the connection manager,
181 .\"the Cyrus SASL library interface,
183 .\"the search filter processor,
185 .\"the DN normalization library,
187 .\"the database indexer,
189 .\"the ASN.1 BER library,
191 .\"the dynamic module loader,
193 .\"the LDAP operation processors,
195 .\"the SASL authentication subsystem,
197 .\"the schema processor, and
199 .\"the TLS library interface. This is not an exhaustive list; there are many
200 .\"other subsystems and more are added over time.
202 .\"The levels are, in order of decreasing priority:
203 .\".B emergency, alert, critical, error, warning, notice, information, entry,
204 .\".B args, results, detail1, detail2
205 .\"An integer may be used instead, with 0 corresponding to
211 .\"level logs function entry points,
213 .\"adds function call parameters, and
215 .\"adds the function results to the logs.
220 .\"levels add even more low level detail from individual functions.
222 .B defaultsearchbase <dn>
223 Specify a default search base to use when client submits a
224 non-base search request with an empty base DN.
226 .B disallow <features>
227 Specify a set of features (separated by white space) to
228 disallow (default none).
230 disables acceptance of anonymous bind requests.
232 disables simple (bind) authentication.
234 disables Kerberos V4 (bind) authentication.
236 disables Start TLS from forcing session to anonymous status (see also
239 disables StartTLS if authenticated (see also
243 .B ditcontentrule "(\ <oid>\
245 [DESC\ <description>]\
252 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
253 The slapd parser extends the RFC 2252 definition by allowing string
254 forms as well as numeric OIDs to be used for the attribute OID and
255 attribute syntax OID.
261 .B gentlehup { on | off }
262 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
264 will stop listening for new connections, but will not close the
265 connections to the current clients. Future write operations return
266 unwilling-to-perform, though. Slapd terminates when all clients
267 have closed their connections (if they ever do), or \- as before \-
268 if it receives a SIGTERM signal. This can be useful if you wish to
269 terminate the server and start a new
272 .B with another database,
273 without disrupting the currently active clients.
274 The default is off. You may wish to use
276 along with this option.
278 .B idletimeout <integer>
279 Specify the number of seconds to wait before forcibly closing
280 an idle client connection. A idletimeout of 0 disables this
281 feature. The default is 0.
283 .B include <filename>
284 Read additional configuration information from the given file before
285 continuing with the next line of the current file.
287 .B limits <who> <limit> [<limit> [...]]
288 Specify time and size limits based on who initiated an operation.
295 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
301 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
306 matches all unauthenticated clients.
309 matches all authenticated clients;
312 dn pattern is assumed unless otherwise specified by qualifying
313 the (optional) key string
319 (which are synonyms), to require an exact match; with
321 to require exactly one level of depth match; with
323 to allow any level of depth match, including the exact match; with
325 to allow any level of depth match, not including the exact match;
327 explicitly requires the (default) match based on regular expression
328 pattern, as detailed in
332 matches unbound operations; the
335 The same behavior is obtained by using the
342 with the optional objectClass
348 sets the limits for any DN listed in the values of the
354 group objectClass (default
356 whose DN exactly matches
359 The currently supported limits are
364 The syntax for time limits is
365 .BR time[.{soft|hard}]=<integer> ,
368 is the number of seconds slapd will spend answering a search request.
369 If no time limit is explicitly requested by the client, the
371 limit is used; if the requested time limit exceeds the
374 .I \"Administrative limit exceeded\"
378 limit is set to 0 or to the keyword
380 the soft limit is used in either case; if it is set to
384 no hard limit is enforced.
385 Explicit requests for time limits smaller or equal to the
388 If no flag is set, the value is assigned to the
392 limit is set to zero, to preserve the original behavior.
394 The syntax for size limits is
395 .BR size[.{soft|hard|unchecked}]=<integer> ,
398 is the maximum number of entries slapd will return answering a search
400 If no size limit is explicitly requested by the client, the
402 limit is used; if the requested size limit exceeds the
405 .I \"Administrative limit exceeded\"
409 limit is set to 0 or to the keyword
411 the soft limit is used in either case; if it is set to
415 no hard limit is enforced.
416 Explicit requests for size limits smaller or equal to the
421 flag sets a limit on the number of candidates a search request is allowed
423 If the selected candidates exceed the
425 limit, the search will abort with
426 .IR \"Unwilling to perform\" .
431 no limit is applied (the default).
432 If no flag is set, the value is assigned to the
436 limit is set to zero, to preserve the original behavior.
438 In case of no match, the global limits are used.
439 The default values are the same of
448 control is defined, additional size limits may be enforced; the syntax is
449 .BR size.pr={<integer>|noEstimate} ,
452 is the max page size if no explicit limit is set; the keyword
454 inhibits the server to return an estimate of the total number
455 of entries that will be returned.
458 .\".B logfile <filename>
459 .\"Specify a file for recording debug log messages. By default these messages
460 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
461 .\"copies messages to both stderr and the logfile.
463 .B loglevel <integer>
464 Specify the level at which debugging statements and operation
465 statistics should be syslogged (currently logged to the
467 LOG_LOCAL4 facility). Log levels are additive, and available levels
477 debug packet handling
480 heavy trace debugging
483 connection management
486 print out packets sent and received
489 search filter processing
492 configuration file processing
495 access control list processing
498 stats log connections/operations/results
501 stats log entries sent
504 print communication with shell backends
512 .B moduleload <filename>
513 Specify the name of a dynamically loadable module to load. The filename
514 may be an absolute path name or a simple filename. Non-absolute names
515 are searched for in the directories specified by the
517 option. This option and the
519 option are only usable if slapd was compiled with --enable-modules.
521 .B modulepath <pathspec>
522 Specify a list of directories to search for loadable modules. Typically
523 the path is colon-separated but this depends on the operating system.
526 .B objectclass "(\ <oid>\
528 [DESC\ <description]\
531 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
532 [MUST\ <oids>] [MAY\ <oids>] )"
534 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
535 The slapd parser extends the RFC 2252 definition by allowing string
536 forms as well as numeric OIDs to be used for the object class OID.
540 description.) Object classes are "STRUCTURAL" by default.
543 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
544 Define a string name that equates to the given OID. The string can be used
545 in place of the numeric OID in objectclass and attribute definitions. The
546 name can also be used with a suffix of the form ":xx" in which case the
547 value "oid.xx" will be used.
549 .B password-hash <hash> [<hash>...]
550 This option configures one or more hashes to be used in generation of user
551 passwords stored in the userPassword attribute during processing of
552 LDAP Password Modify Extended Operations (RFC 3062).
553 The <hash> must be one of
567 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
572 use the MD5 algorithm (RFC 1321), the latter with a seed.
579 indicates that the new password should be
580 added to userPassword as clear text.
582 Note that this option does not alter the normal user applications
583 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
585 .B password\-crypt\-salt\-format <format>
586 Specify the format of the salt passed to
588 when generating {CRYPT} passwords (see
590 during processing of LDAP Password Modify Extended Operations (RFC 3062).
592 This string needs to be in
594 format and may include one (and only one) %s conversion.
595 This conversion will be substituted with a string random
596 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
597 provides a two character salt and "$1$%.8s" tells some
598 versions of crypt(3) to use an MD5 algorithm and provides
599 8 random characters of salt. The default is "%s", which
600 provides 31 characters of salt.
602 .B pidfile <filename>
603 The ( absolute ) name of a file that will hold the
605 server's process ID ( see
607 ) if started without the debugging command line option.
610 Specify the referral to pass back when
612 cannot find a local database to handle a request.
613 If specified multiple times, each url is provided.
616 The ( absolute ) name of a file that will hold the
618 server's command line options
619 if started without the debugging command line option.
622 The ( absolute ) name of a file that will hold the
624 server's process ID ( see
626 ) if started without the debugging command line option.
628 .B replicationinterval
629 The number of seconds
631 waits before checking the replogfile for changes.
633 .B require <conditions>
634 Specify a set of conditions (separated by white space) to
635 require (default none).
636 The directive may be specified globally and/or per-database.
638 requires bind operation prior to directory operations.
640 requires session to be using LDAP version 3.
642 requires authentication prior to directory operations.
644 requires SASL authentication prior to directory operations.
646 requires strong authentication prior to directory operations.
647 The strong keyword allows protected "simple" authentication
648 as well as SASL authentication.
650 may be used to require no conditions (useful for clearly globally
651 set conditions within a particular database).
653 .B reverse-lookup on | off
654 Enable/disable client name unverified reverse lookup (default is
656 if compiled with --enable-rlookups).
659 Specify the name of an LDIF(5) file containing user defined attributes
660 for the root DSE. These attributes are returned in addition to the
661 attributes normally produced by slapd.
663 .B sasl-authz-policy <policy>
664 Used to specify which rules to use for SASL Proxy Authorization. Proxy
665 authorization allows a client to authenticate to the server using one
666 user's credentials, but specify a different identity to use for authorization
667 and access control purposes. It essentially allows user A to login as user
668 B, using user A's password.
671 flag disables proxy authorization. This is the default setting.
674 flag will use rules in the
676 attribute of the authorization DN.
679 flag will use rules in the
681 attribute of the authentication DN.
684 flag, an alias for the deprecated value of
686 will allow any of the above, whatever succeeds first (checked in
692 flag requires both authorizations to succeed.
693 The rules are simply regular expressions specifying which DNs are allowed
694 to perform proxy authorization.
697 attribute in an entry specifies which other users
698 are allowed to proxy login to this entry. The
701 an entry specifies which other users this user can authorize as. Use of
704 abused if users are allowed to write arbitrary values to this attribute.
707 attribute must be protected with ACLs such that
708 only privileged users can modify it.
715 or a set of identities; it can take three forms:
719 .B ldap:///<base>??[<scope>]?<filter>
722 .B dn[.<dnstyle>]:<pattern>
725 .B u[<mech>[<realm>]]:<pattern>
732 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
735 The first form is a valid LDAP
743 portions must be absent, so that the search occurs locally on either
749 with the optional style modifiers
755 for exact, onelevel, children and subtree matches, which cause
757 to be normalized according to the DN normalization rules, or the special
761 to be compiled according to
763 The third form is a SASL
765 with the optional fields
769 that allow to specify a SASL
771 and eventually a SASL
773 for those mechanisms that support one.
774 The need to allow the specification of a mechanism is still debated,
775 and users are strongly discouraged to rely on this possibility.
776 For backwards compatibility, if no identity type is provided, i.e. only
780 is assumed; as a consequence,
782 is subjected to DN normalization.
783 Since the interpretation of
787 can impact security, users are strongly encouraged
788 to explicitly set the type of identity specification that is being used.
792 Used to specify the fully qualified domain name used for SASL processing.
794 .B sasl-realm <realm>
795 Specify SASL realm. Default is empty.
797 .B sasl-regexp <match> <replace>
798 Used by the SASL mechanism to convert a SASL authenticated
799 username to an LDAP DN used for authorization purposes. Note that
800 the resultant DN need not refer to an existing entry to be considered
801 valid. When an authorization request is received, the SASL
805 are taken, when available, and combined into a SASL name of the
810 .B UID=<username>[[,CN=<realm>],CN=<mechanism>,]CN=auth
813 This SASL name is then compared against the
815 regular expression, and if the match is successful, the SASL name is
818 string. If there are wildcard strings in the
820 regular expression that are enclosed in parenthesis, e.g.
826 then the portion of the SASL name that matched the wildcard will be stored
827 in the numbered placeholder variable $1. If there are other wildcard strings
828 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
829 placeholders can then be used in the
834 .B UID=$1,OU=Accounts,DC=example,DC=com
837 The replaced SASL name can be either a DN or an LDAP URI. If the
838 latter, the server will use the URI to search its own database(s)
839 and, if the search returns exactly one entry, the SASL name is
840 replaced by the DN of that entry. The LDAP URI must have no
841 hostport, attrs, or extensions components, e.g.
844 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
849 options can be given in the configuration file to allow for multiple matching
850 and replacement patterns. The matching patterns are checked in the order they
851 appear in the file, stopping at the first successful match.
854 .\"Because the plus sign + is a character recognized by the regular expression engine,
855 .\"and it will appear in SASL names that include a REALM, be careful to escape the
856 .\"plus sign with a backslash \\+ to remove the character's special meaning.
859 .B sasl-secprops <properties>
860 Used to specify Cyrus SASL security properties.
863 flag (without any other properties) causes the flag properties
864 default, "noanonymous,noplain", to be cleared.
867 flag disables mechanisms susceptible to simple passive attacks.
870 flag disables mechanisms susceptible to active attacks.
873 flag disables mechanisms susceptible to passive dictionary attacks.
876 flag disables mechanisms which support anonymous login.
879 flag require forward secrecy between sessions.
882 require mechanisms which pass client credentials (and allow
883 mechanisms which can pass credentials to do so).
886 property specifies the minimum acceptable
887 .I security strength factor
888 as an integer approximate to effective key length used for
889 encryption. 0 (zero) implies no protection, 1 implies integrity
890 protection only, 56 allows DES or other weak ciphers, 112
891 allows triple DES and other strong ciphers, 128 allows RC4,
892 Blowfish and other modern strong ciphers. The default is 0.
895 property specifies the maximum acceptable
896 .I security strength factor
897 as an integer (see minssf description). The default is INT_MAX.
900 property specifies the maximum security layer receive buffer
901 size allowed. 0 disables security layers. The default is 65536.
904 Specify the distinguished name for the subschema subentry that
905 controls the entries on this server. The default is "cn=Subschema".
907 .B security <factors>
908 Specify a set of factors (separated by white space) to require.
909 An integer value is associated with each factor and is roughly
910 equivalent of the encryption key length to require. A value
911 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
912 The directive may be specified globally and/or per-database.
914 specifies the overall security strength factor.
916 specifies the transport security strength factor.
918 specifies the TLS security strength factor.
920 specifies the SASL security strength factor.
922 specifies the overall security strength factor to require for
924 .B update_transport=<n>
925 specifies the transport security strength factor to require for
928 specifies the TLS security strength factor to require for
931 specifies the SASL security strength factor to require for
934 specifies the security strength factor required for
936 username/password authentication.
939 factor is measure of security provided by the underlying transport,
940 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
942 .B sizelimit {<integer>|unlimited}
944 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
945 Specify the maximum number of entries to return from a search operation.
946 The default size limit is 500.
951 to specify no limits.
952 The second format allows a fine grain setting of the size limits.
953 Extra args can be added on the same line.
956 for an explanation of the different flags.
958 .B sockbuf_max_incoming <integer>
959 Specify the maximum incoming LDAP PDU size for anonymous sessions.
960 The default is 262143.
962 .B sockbuf_max_incoming_auth <integer>
963 Specify the maximum incoming LDAP PDU size for authenticated sessions.
964 The default is 4194303.
967 Specify the srvtab file in which the kerberos keys necessary for
968 authenticating clients using kerberos can be found. This option is only
969 meaningful if you are using Kerberos authentication.
972 Specify the maximum size of the primary thread pool.
975 .B timelimit {<integer>|unlimited}
977 .B timelimit time[.{soft|hard}]=<integer> [...]
978 Specify the maximum number of seconds (in real time)
980 will spend answering a search request. The default time limit is 3600.
985 to specify no limits.
986 The second format allows a fine grain setting of the time limits.
987 Extra args can be added on the same line.
990 for an explanation of the different flags.
992 .B ucdata-path <path>
993 Specify the path to the directory containing the Unicode character
994 tables. The default path is DATADIR/ucdata.
998 is built with support for Transport Layer Security, there are more options
1001 .B TLSCipherSuite <cipher-suite-spec>
1002 Permits configuring what ciphers will be accepted and the preference order.
1003 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
1005 TLSCipherSuite HIGH:MEDIUM:+SSLv2
1007 To check what ciphers a given spec selects, use:
1009 openssl ciphers -v <cipher-suite-spec>
1011 .B TLSCACertificateFile <filename>
1012 Specifies the file that contains certificates for all of the Certificate
1017 .B TLSCACertificatePath <path>
1018 Specifies the path of a directory that contains Certificate Authority
1019 certificates in separate individual files. Usually only one of this
1020 or the TLSCACertificateFile is used.
1022 .B TLSCertificateFile <filename>
1023 Specifies the file that contains the
1027 .B TLSCertificateKeyFile <filename>
1028 Specifies the file that contains the
1030 server private key that matches the certificate stored in the
1031 .B TLSCertificateFile
1032 file. Currently, the private key must not be protected with a password, so
1033 it is of critical importance that it is protected carefully.
1035 .B TLSRandFile <filename>
1036 Specifies the file to obtain random bits from when /dev/[u]random
1037 is not available. Generally set to the name of the EGD/PRNGD socket.
1038 The environment variable RANDFILE can also be used to specify the filename.
1040 .B TLSVerifyClient <level>
1041 Specifies what checks to perform on client certificates in an
1042 incoming TLS session, if any.
1045 can be specified as one of the following keywords:
1049 This is the default.
1051 will not ask the client for a certificate.
1054 The client certificate is requested. If no certificate is provided,
1055 the session proceeds normally. If a bad certificate is provided,
1056 it will be ignored and the session proceeds normally.
1059 The client certificate is requested. If no certificate is provided,
1060 the session proceeds normally. If a bad certificate is provided,
1061 the session is immediately terminated.
1063 .B demand | hard | true
1064 These keywords are all equivalent, for compatibility reasons.
1065 The client certificate is requested. If no certificate is provided,
1066 or a bad certificate is provided, the session is immediately terminated.
1068 Note that a valid client certificate is required in order to use the
1069 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1072 setting must be chosen to enable SASL EXTERNAL authentication.
1074 .SH GENERAL BACKEND OPTIONS
1075 Options in this section only apply to the configuration file section
1076 for the specified backend. They are supported by every
1079 .B backend <databasetype>
1080 Mark the beginning of a backend definition. <databasetype>
1095 depending on which backend will serve the database.
1097 .SH GENERAL DATABASE OPTIONS
1098 Options in this section only apply to the configuration file section
1099 for the database in which they are defined. They are supported by every
1100 type of backend. Note that the
1104 option are mandatory for each database.
1106 .B database <databasetype>
1107 Mark the beginning of a new database instance definition. <databasetype>
1122 depending on which backend will serve the database.
1127 will automatically maintain the
1128 modifiersName, modifyTimestamp, creatorsName, and
1129 createTimestamp attributes for entries. By default, lastmod is on.
1131 .B maxderefdepth <depth>
1132 Specifies the maximum number of aliases to dereference when trying to
1133 resolve an entry, used to avoid infinite alias loops. The default is 1.
1135 .B overlay <overlay-name>
1136 Add the specified overlay to this database. An overlay is a piece of
1137 code that intercepts database operations in order to extend or change
1138 them. Overlays are pushed onto
1139 a stack over the database, and so they will execute in the reverse
1140 of the order in which they were configured and the database itself
1141 will receive control last of all.
1143 .B readonly on | off
1144 This option puts the database into "read-only" mode. Any attempts to
1145 modify the database will return an "unwilling to perform" error. By
1146 default, readonly is off.
1149 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1150 .B [starttls=yes|critical]
1151 .B [suffix=<suffix> [...]]
1152 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1153 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1154 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1155 .B [attr[!]=<attr list>]
1157 Specify a replication site for this database. Refer to the "OpenLDAP
1158 Administrator's Guide" for detailed information on setting up a replicated
1160 directory service. Zero or more
1162 instances can be used to select the subtrees that will be replicated
1163 (defaults to all the database).
1165 is deprecated in favor of the
1169 allows the replica LDAP server to be specified as an LDAP URI.
1174 requires the options
1178 and should only be used when adequate security services
1179 (e.g TLS or IPSEC) are in place. A
1185 Specific security properties (as with the
1187 keyword above) for a SASL bind can be set with the
1189 option. A non-default SASL realm can be set with the
1194 will use Kerberos, a kerberos instance should be given in
1198 can be given after the
1200 keyword to allow the selective replication of the listed attributes only;
1203 mark is used, the list is considered exclusive, i.e. the listed attributes
1205 If an objectClass is listed, all the related attributes
1206 are (are not) replicated.
1209 .B replogfile <filename>
1210 Specify the name of the replication log file to log changes to.
1211 The replication log is typically written by
1216 .BR slapd.replog (5)
1217 for more information. The specified file should be located
1218 in a directory with limited read/write/execute access as the replication
1219 logs may contain sensitive information.
1222 Specify the distinguished name that is not subject to access control
1223 or administrative limit restrictions for operations on this database.
1224 This DN may or may not be associated with an entry. An empty root
1225 DN (the default) specifies no root access is to be granted. It is
1226 recommended that the rootdn only be specified when needed (such as
1227 when initially populating a database). If the rootdn is within
1228 a namingContext (suffix) of the database, a simple bind password
1229 may also be provided using the
1233 .B rootpw <password>
1234 Specify a password (or hash of the password) for the rootdn. The
1235 password can only be set if the rootdn is within the namingContext
1236 (suffix) of the database.
1237 This option accepts all RFC 2307 userPassword formats known to
1240 description) as well as cleartext.
1242 may be used to generate a hash of a password. Cleartext
1243 and \fB{CRYPT}\fP passwords are not recommended. If empty
1244 (the default), authentication of the root DN is by other means
1245 (e.g. SASL). Use of SASL is encouraged.
1247 .B suffix <dn suffix>
1248 Specify the DN suffix of queries that will be passed to this
1249 backend database. Multiple suffix lines can be given and at least one is
1250 required for each database definition.
1251 If the suffix of one database is "inside" that of another, the database
1252 with the inner suffix must come first in the configuration file.
1255 Specify that the current backend database is a subordinate of another
1256 backend database. A subordinate database may have only one suffix. This
1257 option may be used to glue multiple databases into a single namingContext.
1258 If the suffix of the current database is within the namingContext of a
1259 superior database, searches against the superior database will be
1260 propagated to the subordinate as well. All of the databases
1261 associated with a single namingContext should have identical rootdns.
1262 Behavior of other LDAP operations is unaffected by this setting. In
1263 particular, it is not possible to use moddn to move an entry from
1264 one subordinate to another subordinate within the namingContext.
1267 .B syncrepl rid=<replica ID>
1268 .B provider=ldap[s]://<hostname>[:port]
1269 .B [type=refreshOnly|refreshAndPersist]
1270 .B [interval=dd:hh:mm:ss]
1271 .B [searchbase=<base DN>]
1272 .B [filter=<filter str>]
1273 .B [scope=sub|one|base]
1274 .B [attrs=<attr list>]
1276 .B [sizelimit=<limit>]
1277 .B [timelimit=<limit>]
1278 .B [schemachecking=on|off]
1280 .B [bindmethod=simple|sasl]
1282 .B [saslmech=<mech>]
1283 .B [authcid=<identity>]
1284 .B [authzid=<identity>]
1285 .B [credentials=<passwd>]
1287 .B [secprops=<properties>]
1289 Specify the current database as a replica which is kept up-to-date with the
1290 master content by establishing the current
1292 as a replication consumer site running a
1295 The replica content is kept synchronized to the master content using
1296 the LDAP Content Synchronization protocol. Refer to the
1297 "OpenLDAP Administrator's Guide" for detailed information on
1298 setting up a replicated
1300 directory service using the
1304 identifies the current
1306 directive within the replication consumer site.
1307 It is a non-negative integer having no more than three digits.
1309 specifies the replication provider site containing the master content
1310 as an LDAP URI. If <port> is not given, the standard LDAP port number
1311 (389 or 636) is used. The content of the
1313 replica is defined using a search
1314 specification as its result set. The consumer
1316 will send search requests to the provider
1318 according to the search specification. The search specification includes
1319 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1322 parameters as in the normal search specification.
1323 The search specification for the LDAP Content Synchronization operation
1324 has the same value syntax and the same default values as in the
1327 The LDAP Content Synchronization protocol has two operation types.
1330 operation, the next synchronization search operation
1331 is periodically rescheduled at an interval time (specified by
1333 parameter; 1 day by default)
1334 after each synchronization operation finishes.
1336 .B refreshAndPersist
1337 operation, a synchronization search remains persistent in the provider slapd.
1338 Further updates to the master replica will generate
1339 .B searchResultEntry
1340 to the consumer slapd as the search responses to the persistent
1341 synchronization search. The schema checking can be enforced at the LDAP Sync
1342 consumer site by turning on the
1344 parameter. The default is off.
1347 parameter specifies the DN in the consumer site
1348 which is allowed to make changes to the replica.
1349 The DN should have read/write access to the replica database.
1354 of the master database.
1359 requires the options
1363 and should only be used when adequate security services
1364 (e.g. TLS or IPSEC) are in place.
1371 Depending on the mechanism, an authentication identity and/or
1372 credentials can be specified using
1378 parameter may be used to specify an authorization identity.
1379 Specific security properties (as with the
1381 keyword above) for a SASL bind can be set with the
1383 option. A non default SASL realm can be set with the
1389 This option is only applicable in a slave
1391 It specifies the DN permitted to update (subject to access controls)
1392 the replica (typically, this is the DN
1394 binds to update the replica). Generally, this DN
1400 Specify the referral to pass back when
1402 is asked to modify a replicated local database.
1403 If specified multiple times, each url is provided.
1405 .SH DATABASE-SPECIFIC OPTIONS
1406 Each database may allow specific configuration options; they are
1407 documented separately in the backends' manual pages.
1409 The following backends can be compiled into slapd.
1410 They are documented in the
1411 .BR slapd-<backend> (5)
1415 This is the recommended backend for a normal slapd database.
1416 However, it takes more care than with the LDBM backend to configure
1418 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1421 This is the database backend which is easiest to configure.
1422 However, it does not offer the data durability features of the BDB
1424 It uses Berkeley DB or GDBM to store data.
1427 This backend is experimental.
1428 It serves up referrals based upon SRV resource records held in the
1432 This backend acts as a proxy to forward incoming requests to another
1436 This backend performs basic LDAP proxying with respect to a set of
1437 remote LDAP servers. It is an enhancement of the ldap backend. The
1438 proxy cache extension of meta backend provides answering of search
1439 requests from the proxy using results of previously cached requests.
1442 This backend provides information about the running status of the slapd
1446 Operations in this backend succeed but do nothing.
1449 This backend is provided for demonstration purposes only.
1450 It serves up user account information from the system
1455 This backend embeds a
1457 interpreter into slapd.
1458 It runs Perl subroutines to implement LDAP operations.
1461 This backend executes external programs to implement LDAP operations.
1462 It is is primarily intended to be used in prototypes.
1465 This backend is experimental.
1466 It services LDAP requests from an SQL database.
1469 This backend is experimental.
1472 interpreter into slapd.
1473 It runs Tcl commands to implement LDAP operations.
1476 Here is a short example of a configuration file:
1480 include SYSCONFDIR/schema/core.schema
1481 pidfile LOCALSTATEDIR/slapd.pid
1483 # Subtypes of "name" (e.g. "cn" and "ou") with the
1484 # option ";x-hidden" can be searched for/compared,
1485 # but are not shown. See \fBslapd.access\fP(5).
1486 attributeoptions x-hidden lang-
1487 access to attr=name;x-hidden by * =cs
1490 suffix "dc=our-domain,dc=com"
1491 # The database directory MUST exist prior to
1492 # running slapd AND should only be accessible
1493 # by the slapd/tools. Mode 0700 recommended.
1494 directory LOCALSTATEDIR/openldap-data
1495 # Indices to maintain
1496 index objectClass eq
1497 index cn,sn,mail pres,eq,approx,sub
1499 # We serve small clients that do not handle referrals,
1500 # so handle remote lookups on their behalf.
1503 uri ldap://ldap.some-server.com/
1508 "OpenLDAP Administrator's Guide" contains a longer annotated
1509 example of a configuration file.
1510 The original ETCDIR/slapd.conf is another example.
1514 default slapd configuration file
1518 .BR slapd-dnssrv (5),
1522 .BR slapd-monitor (5),
1524 .BR slapd-passwd (5),
1526 .BR slapd-shell (5),
1529 .BR slapd.access (5),
1530 .BR slapd.plugin (5),
1531 .BR slapd.replog (5),
1539 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1540 .SH ACKNOWLEDGEMENTS
1542 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1544 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob