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.
165 .\"-- NEW_LOGGING option --
167 .\".B debug <subsys> <level>
168 .\"Specify a logging level for a particular subsystem. The subsystems include
170 .\"a global level for all subsystems,
174 .\"the backend databases,
176 .\"the entry cache manager,
178 .\"the config file reader,
180 .\"the connection manager,
182 .\"the Cyrus SASL library interface,
184 .\"the search filter processor,
186 .\"the DN normalization library,
188 .\"the database indexer,
190 .\"the ASN.1 BER library,
192 .\"the dynamic module loader,
194 .\"the LDAP operation processors,
196 .\"the SASL authentication subsystem,
198 .\"the schema processor, and
200 .\"the TLS library interface. This is not an exhaustive list; there are many
201 .\"other subsystems and more are added over time.
203 .\"The levels are, in order of decreasing priority:
204 .\".B emergency, alert, critical, error, warning, notice, information, entry,
205 .\".B args, results, detail1, detail2
206 .\"An integer may be used instead, with 0 corresponding to
212 .\"level logs function entry points,
214 .\"adds function call parameters, and
216 .\"adds the function results to the logs.
221 .\"levels add even more low level detail from individual functions.
223 .B defaultsearchbase <dn>
224 Specify a default search base to use when client submits a
225 non-base search request with an empty base DN.
227 .B disallow <features>
228 Specify a set of features (separated by white space) to
229 disallow (default none).
231 disables acceptance of anonymous bind requests.
233 disables simple (bind) authentication.
235 disables Kerberos V4 (bind) authentication.
237 disables Start TLS from forcing session to anonymous status (see also
240 disables StartTLS if authenticated (see also
244 .B ditcontentrule "(\ <oid>\
246 [DESC\ <description>]\
253 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
254 The slapd parser extends the RFC 2252 definition by allowing string
255 forms as well as numeric OIDs to be used for the attribute OID and
256 attribute syntax OID.
262 .B gentlehup { on | off }
263 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
265 will stop listening for new connections, but will not close the
266 connections to the current clients. Future write operations return
267 unwilling-to-perform, though. Slapd terminates when all clients
268 have closed their connections (if they ever do), or \- as before \-
269 if it receives a SIGTERM signal. This can be useful if you wish to
270 terminate the server and start a new
273 .B with another database,
274 without disrupting the currently active clients.
275 The default is off. You may wish to use
277 along with this option.
279 .B idletimeout <integer>
280 Specify the number of seconds to wait before forcibly closing
281 an idle client connection. A idletimeout of 0 disables this
282 feature. The default is 0.
284 .B include <filename>
285 Read additional configuration information from the given file before
286 continuing with the next line of the current file.
288 .B limits <who> <limit> [<limit> [...]]
289 Specify time and size limits based on who initiated an operation.
296 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
302 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
307 matches all unauthenticated clients.
310 matches all authenticated clients;
313 dn pattern is assumed unless otherwise specified by qualifying
314 the (optional) key string
320 (which are synonyms), to require an exact match; with
322 to require exactly one level of depth match; with
324 to allow any level of depth match, including the exact match; with
326 to allow any level of depth match, not including the exact match;
328 explicitly requires the (default) match based on regular expression
329 pattern, as detailed in
333 matches unbound operations; the
336 The same behavior is obtained by using the
343 with the optional objectClass
349 sets the limits for any DN listed in the values of the
355 group objectClass (default
357 whose DN exactly matches
360 The currently supported limits are
365 The syntax for time limits is
366 .BR time[.{soft|hard}]=<integer> ,
369 is the number of seconds slapd will spend answering a search request.
370 If no time limit is explicitly requested by the client, the
372 limit is used; if the requested time limit exceeds the
375 .I \"Administrative limit exceeded\"
379 limit is set to 0 or to the keyword
381 the soft limit is used in either case; if it is set to
385 no hard limit is enforced.
386 Explicit requests for time limits smaller or equal to the
389 If no flag is set, the value is assigned to the
393 limit is set to zero, to preserve the original behavior.
395 The syntax for size limits is
396 .BR size[.{soft|hard|unchecked}]=<integer> ,
399 is the maximum number of entries slapd will return answering a search
401 If no size limit is explicitly requested by the client, the
403 limit is used; if the requested size limit exceeds the
406 .I \"Administrative limit exceeded\"
410 limit is set to 0 or to the keyword
412 the soft limit is used in either case; if it is set to
416 no hard limit is enforced.
417 Explicit requests for size limits smaller or equal to the
422 flag sets a limit on the number of candidates a search request is allowed
424 If the selected candidates exceed the
426 limit, the search will abort with
427 .IR \"Unwilling to perform\" .
432 no limit is applied (the default).
433 If no flag is set, the value is assigned to the
437 limit is set to zero, to preserve the original behavior.
439 In case of no match, the global limits are used.
440 The default values are the same of
449 control is defined, additional size limits may be enforced; the syntax is
450 .BR size.pr={<integer>|noEstimate|disabled|none} ,
453 is the max page size if no explicit limit is set; the keyword
455 inhibits the server to return an estimate of the total number
456 of entries that will be returned; the keyword
458 disables the control; the keyword
460 indicates that no limit is applied to the pagedResults control page size.
462 .B size.prtotal={<integer>|none}
463 allows to set a limit on the total number of entries that a pagedResults
464 control allows to return.
465 By default it is unlimited, which is indicated by the keyword
469 is the max number of entries that the whole search with pagedResults control
472 .\"-- NEW_LOGGING option --
474 .\".B logfile <filename>
475 .\"Specify a file for recording debug log messages. By default these messages
476 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
477 .\"copies messages to both stderr and the logfile.
479 .B loglevel <integer>
480 Specify the level at which debugging statements and operation
481 statistics should be syslogged (currently logged to the
483 LOG_LOCAL4 facility). Log levels are additive, and available levels
493 debug packet handling
496 heavy trace debugging
499 connection management
502 print out packets sent and received
505 search filter processing
508 configuration file processing
511 access control list processing
514 stats log connections/operations/results
517 stats log entries sent
520 print communication with shell backends
528 .B moduleload <filename>
529 Specify the name of a dynamically loadable module to load. The filename
530 may be an absolute path name or a simple filename. Non-absolute names
531 are searched for in the directories specified by the
533 option. This option and the
535 option are only usable if slapd was compiled with --enable-modules.
537 .B modulepath <pathspec>
538 Specify a list of directories to search for loadable modules. Typically
539 the path is colon-separated but this depends on the operating system.
542 .B objectclass "(\ <oid>\
544 [DESC\ <description]\
547 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
548 [MUST\ <oids>] [MAY\ <oids>] )"
550 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
551 The slapd parser extends the RFC 2252 definition by allowing string
552 forms as well as numeric OIDs to be used for the object class OID.
556 description.) Object classes are "STRUCTURAL" by default.
559 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
560 Define a string name that equates to the given OID. The string can be used
561 in place of the numeric OID in objectclass and attribute definitions. The
562 name can also be used with a suffix of the form ":xx" in which case the
563 value "oid.xx" will be used.
565 .B password-hash <hash> [<hash>...]
566 This option configures one or more hashes to be used in generation of user
567 passwords stored in the userPassword attribute during processing of
568 LDAP Password Modify Extended Operations (RFC 3062).
569 The <hash> must be one of
583 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
588 use the MD5 algorithm (RFC 1321), the latter with a seed.
595 indicates that the new password should be
596 added to userPassword as clear text.
598 Note that this option does not alter the normal user applications
599 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
601 .B password\-crypt\-salt\-format <format>
602 Specify the format of the salt passed to
604 when generating {CRYPT} passwords (see
606 during processing of LDAP Password Modify Extended Operations (RFC 3062).
608 This string needs to be in
610 format and may include one (and only one) %s conversion.
611 This conversion will be substituted with a string random
612 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
613 provides a two character salt and "$1$%.8s" tells some
614 versions of crypt(3) to use an MD5 algorithm and provides
615 8 random characters of salt. The default is "%s", which
616 provides 31 characters of salt.
618 .B pidfile <filename>
619 The ( absolute ) name of a file that will hold the
621 server's process ID ( see
623 ) if started without the debugging command line option.
626 Specify the referral to pass back when
628 cannot find a local database to handle a request.
629 If specified multiple times, each url is provided.
632 The ( absolute ) name of a file that will hold the
634 server's command line options
635 if started without the debugging command line option.
638 The ( absolute ) name of a file that will hold the
640 server's process ID ( see
642 ) if started without the debugging command line option.
644 .B replicationinterval
645 The number of seconds
647 waits before checking the replogfile for changes.
649 .B require <conditions>
650 Specify a set of conditions (separated by white space) to
651 require (default none).
652 The directive may be specified globally and/or per-database.
654 requires bind operation prior to directory operations.
656 requires session to be using LDAP version 3.
658 requires authentication prior to directory operations.
660 requires SASL authentication prior to directory operations.
662 requires strong authentication prior to directory operations.
663 The strong keyword allows protected "simple" authentication
664 as well as SASL authentication.
666 may be used to require no conditions (useful for clearly globally
667 set conditions within a particular database).
669 .B reverse-lookup on | off
670 Enable/disable client name unverified reverse lookup (default is
672 if compiled with --enable-rlookups).
675 Specify the name of an LDIF(5) file containing user defined attributes
676 for the root DSE. These attributes are returned in addition to the
677 attributes normally produced by slapd.
679 .B sasl-authz-policy <policy>
680 Used to specify which rules to use for SASL Proxy Authorization. Proxy
681 authorization allows a client to authenticate to the server using one
682 user's credentials, but specify a different identity to use for authorization
683 and access control purposes. It essentially allows user A to login as user
684 B, using user A's password.
687 flag disables proxy authorization. This is the default setting.
690 flag will use rules in the
692 attribute of the authorization DN.
695 flag will use rules in the
697 attribute of the authentication DN.
700 flag, an alias for the deprecated value of
702 will allow any of the above, whatever succeeds first (checked in
708 flag requires both authorizations to succeed.
709 The rules are simply regular expressions specifying which DNs are allowed
710 to perform proxy authorization.
713 attribute in an entry specifies which other users
714 are allowed to proxy login to this entry. The
717 an entry specifies which other users this user can authorize as. Use of
720 abused if users are allowed to write arbitrary values to this attribute.
723 attribute must be protected with ACLs such that
724 only privileged users can modify it.
731 or a set of identities; it can take three forms:
735 .B ldap:///<base>??[<scope>]?<filter>
738 .B dn[.<dnstyle>]:<pattern>
741 .B u[<mech>[<realm>]]:<pattern>
748 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
751 The first form is a valid LDAP
759 portions must be absent, so that the search occurs locally on either
765 with the optional style modifiers
771 for exact, onelevel, children and subtree matches, which cause
773 to be normalized according to the DN normalization rules, or the special
777 to be compiled according to
779 The third form is a SASL
781 with the optional fields
785 that allow to specify a SASL
787 and eventually a SASL
789 for those mechanisms that support one.
790 The need to allow the specification of a mechanism is still debated,
791 and users are strongly discouraged to rely on this possibility.
792 For backwards compatibility, if no identity type is provided, i.e. only
796 is assumed; as a consequence,
798 is subjected to DN normalization.
799 Since the interpretation of
803 can impact security, users are strongly encouraged
804 to explicitly set the type of identity specification that is being used.
808 Used to specify the fully qualified domain name used for SASL processing.
810 .B sasl-realm <realm>
811 Specify SASL realm. Default is empty.
813 .B sasl-regexp <match> <replace>
814 Used by the SASL mechanism to convert a SASL authenticated
815 username to an LDAP DN used for authorization purposes. Note that
816 the resultant DN need not refer to an existing entry to be considered
817 valid. When an authorization request is received, the SASL
821 are taken, when available, and combined into a SASL name of the
826 .B UID=<username>[[,CN=<realm>],CN=<mechanism>,]CN=auth
829 This SASL name is then compared against the
831 regular expression, and if the match is successful, the SASL name is
834 string. If there are wildcard strings in the
836 regular expression that are enclosed in parenthesis, e.g.
842 then the portion of the SASL name that matched the wildcard will be stored
843 in the numbered placeholder variable $1. If there are other wildcard strings
844 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
845 placeholders can then be used in the
850 .B UID=$1,OU=Accounts,DC=example,DC=com
853 The replaced SASL name can be either a DN or an LDAP URI. If the
854 latter, the server will use the URI to search its own database(s)
855 and, if the search returns exactly one entry, the SASL name is
856 replaced by the DN of that entry. The LDAP URI must have no
857 hostport, attrs, or extensions components, e.g.
860 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
865 options can be given in the configuration file to allow for multiple matching
866 and replacement patterns. The matching patterns are checked in the order they
867 appear in the file, stopping at the first successful match.
870 .\"Because the plus sign + is a character recognized by the regular expression engine,
871 .\"and it will appear in SASL names that include a REALM, be careful to escape the
872 .\"plus sign with a backslash \\+ to remove the character's special meaning.
875 .B sasl-secprops <properties>
876 Used to specify Cyrus SASL security properties.
879 flag (without any other properties) causes the flag properties
880 default, "noanonymous,noplain", to be cleared.
883 flag disables mechanisms susceptible to simple passive attacks.
886 flag disables mechanisms susceptible to active attacks.
889 flag disables mechanisms susceptible to passive dictionary attacks.
892 flag disables mechanisms which support anonymous login.
895 flag require forward secrecy between sessions.
898 require mechanisms which pass client credentials (and allow
899 mechanisms which can pass credentials to do so).
902 property specifies the minimum acceptable
903 .I security strength factor
904 as an integer approximate to effective key length used for
905 encryption. 0 (zero) implies no protection, 1 implies integrity
906 protection only, 56 allows DES or other weak ciphers, 112
907 allows triple DES and other strong ciphers, 128 allows RC4,
908 Blowfish and other modern strong ciphers. The default is 0.
911 property specifies the maximum acceptable
912 .I security strength factor
913 as an integer (see minssf description). The default is INT_MAX.
916 property specifies the maximum security layer receive buffer
917 size allowed. 0 disables security layers. The default is 65536.
920 Specify the distinguished name for the subschema subentry that
921 controls the entries on this server. The default is "cn=Subschema".
923 .B security <factors>
924 Specify a set of factors (separated by white space) to require.
925 An integer value is associated with each factor and is roughly
926 equivalent of the encryption key length to require. A value
927 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
928 The directive may be specified globally and/or per-database.
930 specifies the overall security strength factor.
932 specifies the transport security strength factor.
934 specifies the TLS security strength factor.
936 specifies the SASL security strength factor.
938 specifies the overall security strength factor to require for
940 .B update_transport=<n>
941 specifies the transport security strength factor to require for
944 specifies the TLS security strength factor to require for
947 specifies the SASL security strength factor to require for
950 specifies the security strength factor required for
952 username/password authentication.
955 factor is measure of security provided by the underlying transport,
956 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
958 .B sizelimit {<integer>|unlimited}
960 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
961 Specify the maximum number of entries to return from a search operation.
962 The default size limit is 500.
967 to specify no limits.
968 The second format allows a fine grain setting of the size limits.
969 Extra args can be added on the same line.
972 for an explanation of the different flags.
974 .B sockbuf_max_incoming <integer>
975 Specify the maximum incoming LDAP PDU size for anonymous sessions.
976 The default is 262143.
978 .B sockbuf_max_incoming_auth <integer>
979 Specify the maximum incoming LDAP PDU size for authenticated sessions.
980 The default is 4194303.
983 Specify the srvtab file in which the kerberos keys necessary for
984 authenticating clients using kerberos can be found. This option is only
985 meaningful if you are using Kerberos authentication.
988 Specify the maximum size of the primary thread pool.
991 .B timelimit {<integer>|unlimited}
993 .B timelimit time[.{soft|hard}]=<integer> [...]
994 Specify the maximum number of seconds (in real time)
996 will spend answering a search request. The default time limit is 3600.
1001 to specify no limits.
1002 The second format allows a fine grain setting of the time limits.
1003 Extra args can be added on the same line.
1006 for an explanation of the different flags.
1008 .B ucdata-path <path>
1009 Specify the path to the directory containing the Unicode character
1010 tables. The default path is DATADIR/ucdata.
1014 is built with support for Transport Layer Security, there are more options
1017 .B TLSCipherSuite <cipher-suite-spec>
1018 Permits configuring what ciphers will be accepted and the preference order.
1019 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
1021 TLSCipherSuite HIGH:MEDIUM:+SSLv2
1023 To check what ciphers a given spec selects, use:
1025 openssl ciphers -v <cipher-suite-spec>
1027 .B TLSCACertificateFile <filename>
1028 Specifies the file that contains certificates for all of the Certificate
1033 .B TLSCACertificatePath <path>
1034 Specifies the path of a directory that contains Certificate Authority
1035 certificates in separate individual files. Usually only one of this
1036 or the TLSCACertificateFile is used.
1038 .B TLSCertificateFile <filename>
1039 Specifies the file that contains the
1043 .B TLSCertificateKeyFile <filename>
1044 Specifies the file that contains the
1046 server private key that matches the certificate stored in the
1047 .B TLSCertificateFile
1048 file. Currently, the private key must not be protected with a password, so
1049 it is of critical importance that it is protected carefully.
1051 .B TLSRandFile <filename>
1052 Specifies the file to obtain random bits from when /dev/[u]random
1053 is not available. Generally set to the name of the EGD/PRNGD socket.
1054 The environment variable RANDFILE can also be used to specify the filename.
1056 .B TLSVerifyClient <level>
1057 Specifies what checks to perform on client certificates in an
1058 incoming TLS session, if any.
1061 can be specified as one of the following keywords:
1065 This is the default.
1067 will not ask the client for a certificate.
1070 The client certificate is requested. If no certificate is provided,
1071 the session proceeds normally. If a bad certificate is provided,
1072 it will be ignored and the session proceeds normally.
1075 The client certificate is requested. If no certificate is provided,
1076 the session proceeds normally. If a bad certificate is provided,
1077 the session is immediately terminated.
1079 .B demand | hard | true
1080 These keywords are all equivalent, for compatibility reasons.
1081 The client certificate is requested. If no certificate is provided,
1082 or a bad certificate is provided, the session is immediately terminated.
1084 Note that a valid client certificate is required in order to use the
1085 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1088 setting must be chosen to enable SASL EXTERNAL authentication.
1090 .SH GENERAL BACKEND OPTIONS
1091 Options in this section only apply to the configuration file section
1092 for the specified backend. They are supported by every
1095 .B backend <databasetype>
1096 Mark the beginning of a backend definition. <databasetype>
1111 depending on which backend will serve the database.
1113 .SH GENERAL DATABASE OPTIONS
1114 Options in this section only apply to the configuration file section
1115 for the database in which they are defined. They are supported by every
1116 type of backend. Note that the
1120 option are mandatory for each database.
1122 .B database <databasetype>
1123 Mark the beginning of a new database instance definition. <databasetype>
1138 depending on which backend will serve the database.
1143 will automatically maintain the
1144 modifiersName, modifyTimestamp, creatorsName, and
1145 createTimestamp attributes for entries. By default, lastmod is on.
1147 .B maxderefdepth <depth>
1148 Specifies the maximum number of aliases to dereference when trying to
1149 resolve an entry, used to avoid infinite alias loops. The default is 1.
1151 .B overlay <overlay-name>
1152 Add the specified overlay to this database. An overlay is a piece of
1153 code that intercepts database operations in order to extend or change
1154 them. Overlays are pushed onto
1155 a stack over the database, and so they will execute in the reverse
1156 of the order in which they were configured and the database itself
1157 will receive control last of all.
1159 .B readonly on | off
1160 This option puts the database into "read-only" mode. Any attempts to
1161 modify the database will return an "unwilling to perform" error. By
1162 default, readonly is off.
1165 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1166 .B [starttls=yes|critical]
1167 .B [suffix=<suffix> [...]]
1168 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1169 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1170 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1171 .B [attr[!]=<attr list>]
1173 Specify a replication site for this database. Refer to the "OpenLDAP
1174 Administrator's Guide" for detailed information on setting up a replicated
1176 directory service. Zero or more
1178 instances can be used to select the subtrees that will be replicated
1179 (defaults to all the database).
1181 is deprecated in favor of the
1185 allows the replica LDAP server to be specified as an LDAP URI.
1190 requires the options
1194 and should only be used when adequate security services
1195 (e.g TLS or IPSEC) are in place. A
1201 Specific security properties (as with the
1203 keyword above) for a SASL bind can be set with the
1205 option. A non-default SASL realm can be set with the
1210 will use Kerberos, a kerberos instance should be given in
1214 can be given after the
1216 keyword to allow the selective replication of the listed attributes only;
1219 mark is used, the list is considered exclusive, i.e. the listed attributes
1221 If an objectClass is listed, all the related attributes
1222 are (are not) replicated.
1225 .B replogfile <filename>
1226 Specify the name of the replication log file to log changes to.
1227 The replication log is typically written by
1232 .BR slapd.replog (5)
1233 for more information. The specified file should be located
1234 in a directory with limited read/write/execute access as the replication
1235 logs may contain sensitive information.
1238 Specify the distinguished name that is not subject to access control
1239 or administrative limit restrictions for operations on this database.
1240 This DN may or may not be associated with an entry. An empty root
1241 DN (the default) specifies no root access is to be granted. It is
1242 recommended that the rootdn only be specified when needed (such as
1243 when initially populating a database). If the rootdn is within
1244 a namingContext (suffix) of the database, a simple bind password
1245 may also be provided using the
1249 .B rootpw <password>
1250 Specify a password (or hash of the password) for the rootdn. The
1251 password can only be set if the rootdn is within the namingContext
1252 (suffix) of the database.
1253 This option accepts all RFC 2307 userPassword formats known to
1256 description) as well as cleartext.
1258 may be used to generate a hash of a password. Cleartext
1259 and \fB{CRYPT}\fP passwords are not recommended. If empty
1260 (the default), authentication of the root DN is by other means
1261 (e.g. SASL). Use of SASL is encouraged.
1263 .B suffix <dn suffix>
1264 Specify the DN suffix of queries that will be passed to this
1265 backend database. Multiple suffix lines can be given and at least one is
1266 required for each database definition.
1267 If the suffix of one database is "inside" that of another, the database
1268 with the inner suffix must come first in the configuration file.
1271 Specify that the current backend database is a subordinate of another
1272 backend database. A subordinate database may have only one suffix. This
1273 option may be used to glue multiple databases into a single namingContext.
1274 If the suffix of the current database is within the namingContext of a
1275 superior database, searches against the superior database will be
1276 propagated to the subordinate as well. All of the databases
1277 associated with a single namingContext should have identical rootdns.
1278 Behavior of other LDAP operations is unaffected by this setting. In
1279 particular, it is not possible to use moddn to move an entry from
1280 one subordinate to another subordinate within the namingContext.
1283 .B syncrepl rid=<replica ID>
1284 .B provider=ldap[s]://<hostname>[:port]
1285 .B [type=refreshOnly|refreshAndPersist]
1286 .B [interval=dd:hh:mm:ss]
1287 .B [searchbase=<base DN>]
1288 .B [filter=<filter str>]
1289 .B [scope=sub|one|base]
1290 .B [attrs=<attr list>]
1292 .B [sizelimit=<limit>]
1293 .B [timelimit=<limit>]
1294 .B [schemachecking=on|off]
1296 .B [bindmethod=simple|sasl]
1298 .B [saslmech=<mech>]
1299 .B [authcid=<identity>]
1300 .B [authzid=<identity>]
1301 .B [credentials=<passwd>]
1303 .B [secprops=<properties>]
1305 Specify the current database as a replica which is kept up-to-date with the
1306 master content by establishing the current
1308 as a replication consumer site running a
1311 The replica content is kept synchronized to the master content using
1312 the LDAP Content Synchronization protocol. Refer to the
1313 "OpenLDAP Administrator's Guide" for detailed information on
1314 setting up a replicated
1316 directory service using the
1320 identifies the current
1322 directive within the replication consumer site.
1323 It is a non-negative integer having no more than three digits.
1325 specifies the replication provider site containing the master content
1326 as an LDAP URI. If <port> is not given, the standard LDAP port number
1327 (389 or 636) is used. The content of the
1329 replica is defined using a search
1330 specification as its result set. The consumer
1332 will send search requests to the provider
1334 according to the search specification. The search specification includes
1335 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1338 parameters as in the normal search specification.
1339 The search specification for the LDAP Content Synchronization operation
1340 has the same value syntax and the same default values as in the
1343 The LDAP Content Synchronization protocol has two operation types.
1346 operation, the next synchronization search operation
1347 is periodically rescheduled at an interval time (specified by
1349 parameter; 1 day by default)
1350 after each synchronization operation finishes.
1352 .B refreshAndPersist
1353 operation, a synchronization search remains persistent in the provider slapd.
1354 Further updates to the master replica will generate
1355 .B searchResultEntry
1356 to the consumer slapd as the search responses to the persistent
1357 synchronization search. The schema checking can be enforced at the LDAP Sync
1358 consumer site by turning on the
1360 parameter. The default is off.
1363 parameter specifies the DN in the consumer site
1364 which is allowed to make changes to the replica.
1365 The DN should have read/write access to the replica database.
1370 of the master database.
1375 requires the options
1379 and should only be used when adequate security services
1380 (e.g. TLS or IPSEC) are in place.
1387 Depending on the mechanism, an authentication identity and/or
1388 credentials can be specified using
1394 parameter may be used to specify an authorization identity.
1395 Specific security properties (as with the
1397 keyword above) for a SASL bind can be set with the
1399 option. A non default SASL realm can be set with the
1405 This option is only applicable in a slave
1406 database updated using
1408 It specifies the DN permitted to update (subject to access controls)
1409 the replica (typically, this is the DN
1411 binds to update the replica). Generally, this DN
1418 Specify the referral to pass back when
1420 is asked to modify a replicated local database.
1421 If specified multiple times, each url is provided.
1423 .SH DATABASE-SPECIFIC OPTIONS
1424 Each database may allow specific configuration options; they are
1425 documented separately in the backends' manual pages.
1427 The following backends can be compiled into slapd.
1428 They are documented in the
1429 .BR slapd-<backend> (5)
1433 This is the recommended backend for a normal slapd database.
1434 However, it takes more care than with the LDBM backend to configure
1436 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1439 This is the database backend which is easiest to configure.
1440 However, it does not offer the data durability features of the BDB
1442 It uses Berkeley DB or GDBM to store data.
1445 This backend is experimental.
1446 It serves up referrals based upon SRV resource records held in the
1450 This backend acts as a proxy to forward incoming requests to another
1454 This backend performs basic LDAP proxying with respect to a set of
1455 remote LDAP servers. It is an enhancement of the ldap backend. The
1456 proxy cache extension of meta backend provides answering of search
1457 requests from the proxy using results of previously cached requests.
1460 This backend provides information about the running status of the slapd
1464 Operations in this backend succeed but do nothing.
1467 This backend is provided for demonstration purposes only.
1468 It serves up user account information from the system
1473 This backend embeds a
1475 interpreter into slapd.
1476 It runs Perl subroutines to implement LDAP operations.
1479 This backend executes external programs to implement LDAP operations.
1480 It is is primarily intended to be used in prototypes.
1483 This backend is experimental.
1484 It services LDAP requests from an SQL database.
1487 This backend is experimental.
1490 interpreter into slapd.
1491 It runs Tcl commands to implement LDAP operations.
1494 Here is a short example of a configuration file:
1498 include SYSCONFDIR/schema/core.schema
1499 pidfile LOCALSTATEDIR/slapd.pid
1501 # Subtypes of "name" (e.g. "cn" and "ou") with the
1502 # option ";x-hidden" can be searched for/compared,
1503 # but are not shown. See \fBslapd.access\fP(5).
1504 attributeoptions x-hidden lang-
1505 access to attr=name;x-hidden by * =cs
1508 suffix "dc=our-domain,dc=com"
1509 # The database directory MUST exist prior to
1510 # running slapd AND should only be accessible
1511 # by the slapd/tools. Mode 0700 recommended.
1512 directory LOCALSTATEDIR/openldap-data
1513 # Indices to maintain
1514 index objectClass eq
1515 index cn,sn,mail pres,eq,approx,sub
1517 # We serve small clients that do not handle referrals,
1518 # so handle remote lookups on their behalf.
1521 uri ldap://ldap.some-server.com/
1526 "OpenLDAP Administrator's Guide" contains a longer annotated
1527 example of a configuration file.
1528 The original ETCDIR/slapd.conf is another example.
1532 default slapd configuration file
1536 .BR slapd-dnssrv (5),
1540 .BR slapd-monitor (5),
1542 .BR slapd-passwd (5),
1544 .BR slapd-shell (5),
1547 .BR slapd.access (5),
1548 .BR slapd.plugin (5),
1549 .BR slapd.replog (5),
1557 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1558 .SH ACKNOWLEDGEMENTS
1560 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1562 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob