1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2003 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
48 file is used). Blank lines and comment lines beginning with a `#'
49 character are ignored. If a line begins with white space, it is
50 considered a continuation of the previous line.
52 Arguments on configuration lines are separated by white space. If an
53 argument contains white space, the argument should be enclosed in
54 double quotes. If an argument contains a double quote (`"') or a
55 backslash character (`\\'), the character should be preceded by a
58 The specific configuration options available are discussed below in the
59 Global Configuration Options, General Backend Options, and General Database
60 Options. Backend-specific options are discussed in the
62 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
63 details on the slapd configuration file.
64 .SH GLOBAL CONFIGURATION OPTIONS
65 Options described in this section apply to all backends, unless specifically
66 overridden in a backend definition. Arguments that should be replaced by
67 actual text are shown in brackets <>.
69 .B access to <what> "[ by <who> <access> <control> ]+"
70 Grant access (specified by <access>) to a set of entries and/or
71 attributes (specified by <what>) by one or more requestors (specified
75 and the "OpenLDAP's Administrator's Guide" for details.
78 Specify a set of features (separated by white space) to
81 allows acceptance of LDAPv2 bind requests. Note that
83 does not truely implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
85 allows anonymous bind when credentials are not empty (e.g.
88 allows unauthenticated (anonymous) bind when DN is not empty.
90 allow unauthenticated (anonymous) update operations to be processed
91 (subject to access controls and other administrative limits).
93 .B argsfile <filename>
94 The ( absolute ) name of a file that will hold the
96 server's command line options
97 if started without the debugging command line option.
99 .B attributeoptions [option-name]...
100 Define tagging attribute options or option tag/range prefixes.
101 Options must not end with `-', prefixes must end with `-'.
102 The `lang-' prefix is predefined.
105 directive, `lang-' will no longer be defined and you must specify it
106 explicitly if you want it defined.
108 An attribute description with a tagging option is a subtype of that
109 attribute description without the option.
110 Except for that, options defined this way have no special semantics.
111 Prefixes defined this way work like the `lang-' options:
112 They define a prefix for tagging options starting with the prefix.
113 That is, if you define the prefix `x-foo-', you can use the option
115 Furthermore, in a search or compare, a prefix or range name (with
116 a trailing `-') matches all options starting with that name, as well
117 as the option with the range name sans the trailing `-'.
118 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
120 RFC2251 reserves options beginning with `x-' for private experiments.
121 Other options should be registered with IANA, see RFC3383 section 3.4.
122 OpenLDAP also has the `binary' option built in, but this is a transfer
123 option, not a tagging option.
126 .B attributetype "(\ <oid> [NAME\ <name>] [OBSOLETE]\
127 [DESC\ <description>]\
128 [SUP\ <oid>] [EQUALITY\ <oid>] [ORDERING\ <oid>]\
129 [SUBSTR\ <oid>] [SYNTAX\ <oidlen>] [SINGLE\-VALUE] [COLLECTIVE]\
130 [NO\-USER\-MODIFICATION] [USAGE\ <attributeUsage>]\ )"
132 Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
133 The slapd parser extends the RFC 2252 definition by allowing string
134 forms as well as numeric OIDs to be used for the attribute OID and
135 attribute syntax OID.
141 .B concurrency <integer>
142 Specify a desired level of concurrency. Provided to the underlying
143 thread system as a hint. The default is not to provide any hint.
145 .B conn_max_pending <integer>
146 Specify the maximum number of pending requests for an anonymous session.
147 If requests are submitted faster than the server can process them, they
148 will be queued up to this limit. If the limit is exceeded, the session
149 is closed. The default is 100.
151 .B conn_max_pending_auth <integer>
152 Specify the maximum number of pending requests for an authenticated session.
155 .\".B debug <subsys> <level>
156 .\"Specify a logging level for a particular subsystem. The subsystems include
158 .\"a global level for all subsystems,
162 .\"the backend databases,
164 .\"the entry cache manager,
166 .\"the config file reader,
168 .\"the connection manager,
170 .\"the Cyrus SASL library interface,
172 .\"the search filter processor,
174 .\"the DN normalization library,
176 .\"the database indexer,
178 .\"the ASN.1 BER library,
180 .\"the dynamic module loader,
182 .\"the LDAP operation processors,
184 .\"the SASL authentication subsystem,
186 .\"the schema processor, and
188 .\"the TLS library interface. This is not an exhaustive list; there are many
189 .\"other subsystems and more are added over time.
191 .\"The levels are, in order of decreasing priority:
192 .\".B emergency, alert, critical, error, warning, notice, information, entry,
193 .\".B args, results, detail1, detail2
194 .\"An integer may be used instead, with 0 corresponding to
200 .\"level logs function entry points,
202 .\"adds function call parameters, and
204 .\"adds the function results to the logs.
209 .\"levels add even more low level detail from individual functions.
211 .B defaultsearchbase <dn>
212 Specify a default search base to use when client submits a
213 non-base search request with an empty base DN.
215 .B disallow <features>
216 Specify a set of features (separated by white space) to
217 disallow (default none).
219 disables acceptance of anonymous bind requests.
221 disables simple (bind) authentication.
223 disables Kerberos V4 (bind) authentication.
225 disables Start TLS from forcing session to anonymous status (see also
228 disables StartTLS if authenticated (see also
231 .B gentlehup { on | off }
232 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
234 will stop listening for new connections, but will not close the
235 connections to the current clients. Future write operations return
236 unwilling-to-perform, though. Slapd terminates when all clients
237 have closed their connections (if they ever do), or \- as before \-
238 if it receives a SIGTERM signal. This can be useful if you wish to
239 terminate the server and start a new
242 .B with another database,
243 without disrupting the currently active clients.
244 The default is off. You may wish to use
246 along with this option.
248 .B idletimeout <integer>
249 Specify the number of seconds to wait before forcibly closing
250 an idle client connection. A idletimeout of 0 disables this
251 feature. The default is 0.
253 .B include <filename>
254 Read additional configuration information from the given file before
255 continuing with the next line of the current file.
257 .B limits <who> <limit> [<limit> [...]]
258 Specify time and size limits based on who initiated an operation.
265 anonymous | users | [dn[.<style>]=]<pattern>
271 <style> ::= exact | base | one | subtree | children | regex | anonymous
276 matches all unauthenticated clients.
279 matches all authenticated clients;
282 dn pattern is assumed unless otherwise specified by qualifying
283 the (optional) key string
289 (which are synonims), to require an exact match; with
291 to require exactly one level of depth match; with
293 to allow any level of depth match, including the exact match; with
295 to allow any level of depth match, not including the exact match;
297 explicitly requires the (default) match based on regular expression
298 pattern, as detailed in
302 matches unbound operations; the
305 The same behavior is obtained by using the
311 The currently supported limits are
316 The syntax for time limits is
317 .BR time[.{soft|hard}]=<integer> ,
320 is the number of seconds slapd will spend answering a search request.
321 If no time limit is explicitly requested by the client, the
323 limit is used; if the requested time limit exceedes the
325 limit, an "Administrative limit exceeded" is returned.
328 limit is set to 0 or to the keyword "soft", the soft limit is used
329 in either case; if it is set to -1 or to the keyword "none",
330 no hard limit is enforced.
331 Explicit requests for time limits smaller or equal to the
334 If no flag is set, the value is assigned to the
338 limit is set to zero, to preserve the original behavior.
340 The syntax for size limits is
341 .BR size[.{soft|hard|unchecked}]=<integer> ,
344 is the maximum number of entries slapd will return answering a search
346 If no size limit is explicitly requested by the client, the
348 limit is used; if the requested size limit exceedes the
350 limit, an "Administrative limit exceeded" is returned.
353 limit is set to 0 or to the keyword "soft", the soft limit is used
354 in either case; if it is set to -1 or to the keyword "none",
355 no hard limit is enforced.
356 Explicit requests for size limits smaller or equal to the
361 flag sets a limit on the number of candidates a search request is allowed
363 If the selected candidates exceed the
365 limit, the search will abort with "Unwilling to perform".
366 If it is set to -1 or to the keyword "none", no limit is applied (the default).
367 If no flag is set, the value is assigned to the
371 limit is set to zero, to preserve the original behavior.
373 In case of no match, the global limits are used.
374 The default values are the same of
383 control is defined, additional size limits may be enforced; the syntax is
384 .BR size.pr={<integer>|noEstimate} ,
387 is the max page size if no explicit limit is set; the keyword
389 inhibits the server to return an estimate of the total number
390 of entries that will be returned.
393 .\".B logfile <filename>
394 .\"Specify a file for recording debug log messages. By default these messages
395 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
396 .\"copies messages to both stderr and the logfile.
398 .B loglevel <integer>
399 Specify the level at which debugging statements and operation
400 statistics should be syslogged (currently logged to the
402 LOG_LOCAL4 facility). Log levels are additive, and available levels
412 debug packet handling
415 heavy trace debugging
418 connection management
421 print out packets sent and received
424 search filter processing
427 configuration file processing
430 access control list processing
433 stats log connections/operations/results
436 stats log entries sent
439 print communication with shell backends
447 .B moduleload <filename>
448 Specify the name of a dynamically loadable module to load. The filename
449 may be an absolute path name or a simple filename. Non-absolute names
450 are searched for in the directories specified by the
452 option. This option and the
454 option are only usable if slapd was compiled with --enable-modules.
456 .B modulepath <pathspec>
457 Specify a list of directories to search for loadable modules. Typically
458 the path is colon-separated but this depends on the operating system.
460 .B objectclass "( <oid> [NAME <name>] [DESC <description] [OBSOLETE]\
461 [SUP <oids>] [{ ABSTRACT | STRUCTURAL | AUXILIARY }] [MUST <oids>]\
464 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
465 The slapd parser extends the RFC 2252 definition by allowing string
466 forms as well as numeric OIDs to be used for the object class OID.
470 description.) Object classes are "STRUCTURAL" by default.
473 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
474 Define a string name that equates to the given OID. The string can be used
475 in place of the numeric OID in objectclass and attribute definitions. The
476 name can also be used with a suffix of the form ":xx" in which case the
477 value "oid.xx" will be used.
479 .B password-hash <hash>
480 This option sets the hash to be used in generation of user
481 passwords, stored in userPassword, during processing of
482 LDAP Password Modify Extended Operations (RFC 3052).
483 The <hash> must be one of
497 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
502 use the MD5 algorithm (RFC 1321), the latter with a seed.
509 indicates that the new password should be
510 added to userPassword as clear text.
512 Note that this option does not alter the normal user applications
513 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
515 .B password\-crypt\-salt\-format <format>
516 Specify the format of the salt passed to
518 when generating {CRYPT} passwords (see
520 during processing of LDAP Password Modify Extended Operations (RFC 3062).
522 This string needs to be in
524 format and may include one (and only one) %s conversion.
525 This conversion will be substituted with a string random
526 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
527 provides a two character salt and "$1$%.8s" tells some
528 versions of crypt(3) to use an MD5 algorithm and provides
529 8 random characters of salt. The default is "%s", which
530 provides 31 characters of salt.
532 .B pidfile <filename>
533 The ( absolute ) name of a file that will hold the
535 server's process ID ( see
537 ) if started without the debugging command line option.
540 Specify the referral to pass back when
542 cannot find a local database to handle a request.
543 If specified multiple times, each url is provided.
546 The ( absolute ) name of a file that will hold the
548 server's command line options
549 if started without the debugging command line option.
552 The ( absolute ) name of a file that will hold the
554 server's process ID ( see
556 ) if started without the debugging command line option.
558 .B require <conditions>
559 Specify a set of conditions (separated by white space) to
560 require (default none).
561 The directive may be specified globally and/or per-database.
563 requires bind operation prior to directory operations.
565 requires session to be using LDAP version 3.
567 requires authentication prior to directory operations.
569 requires SASL authentication prior to directory operations.
571 requires strong authentication prior to directory operations.
572 The strong keyword allows protected "simple" authentication
573 as well as SASL authentication.
575 may be used to require no conditions (useful for clearly globally
576 set conditions within a particular database).
578 .B reverse-lookup on | off
579 Enable/disable client name unverified reverse lookup (default is
581 if compiled with --enable-rlookups).
584 Specify the name of an LDIF(5) file containing user defined attributes
585 for the root DSE. These attributes are returned in addition to the
586 attributes normally produced by slapd.
588 .B sasl-authz-policy <policy>
589 Used to specify which rules to use for SASL Proxy Authorization. Proxy
590 authorization allows a client to authenticate to the server using one
591 user's credentials, but specify a different identity to use for authorization
592 and access control purposes. It essentially allows user A to login as user
593 B, using user A's password.
596 flag disables proxy authorization. This is the default setting.
599 flag will use rules in the
601 attribute of the authorization DN.
604 flag will use rules in the
606 attribute of the authentication DN.
609 flag will allow both of the above. The rules are simply regular expressions
610 specifying which DNs are allowed to perform proxy authorization. The
612 attribute in an entry specifies which other users
613 are allowed to proxy login to this entry. The
616 an entry specifies which other users this user can authorize as. Use of
619 abused if users are allowed to write arbitrary values to this attribute.
622 attribute must be protected with ACLs such that
623 only privileged users can modify it.
626 Used to specify the fully qualified domain name used for SASL processing.
628 .B sasl-realm <realm>
629 Specify SASL realm. Default is empty.
631 .B sasl-regexp <match> <replace>
632 Used by the SASL mechanism to convert a SASL authenticated
633 username to an LDAP DN used for authorization purposes. Note that
634 the resultant DN need not refer to an existing entry to be considered
635 valid. When an authorization request is received, the SASL
639 are taken, when available, and combined into a SASL name of the
644 .B UID=<username>[[,CN=<realm>],CN=<mechanism>,]CN=auth
647 This SASL name is then compared against the
649 regular expression, and if the match is successful, the SASL name is
652 string. If there are wildcard strings in the
654 regular expression that are enclosed in parenthesis, e.g.
660 then the portion of the SASL name that matched the wildcard will be stored
661 in the numbered placeholder variable $1. If there are other wildcard strings
662 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
663 placeholders can then be used in the
668 .B UID=$1,OU=Accounts,DC=example,DC=com
671 The replaced SASL name can be either a DN or an LDAP URI. If the
672 latter, the server will use the URI to search its own database(s)
673 and, if the search returns exactly one entry, the SASL name is
674 replaced by the DN of that entry. The LDAP URI must have no
675 hostport, attrs, or extensions components, e.g.
678 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
683 options can be given in the configuration file to allow for multiple matching
684 and replacement patterns. The matching patterns are checked in the order they
685 appear in the file, stopping at the first successful match.
688 .\"Because the plus sign + is a character recognized by the regular expression engine,
689 .\"and it will appear in SASL names that include a REALM, be careful to escape the
690 .\"plus sign with a backslash \\+ to remove the character's special meaning.
693 .B sasl-secprops <properties>
694 Used to specify Cyrus SASL security properties.
697 flag (without any other properities) causes the flag properites
698 default, "noanonymous,noplain", to be cleared.
701 flag disables mechanisms susceptible to simple passive attacks.
704 flag disables mechanisms susceptible to active attacks.
707 flag disables mechanisms susceptible to passive dictionary attacks.
710 flag disables mechanisms which support anonymous login.
713 flag require forward secrecy between sessions.
716 require mechanisms which pass client credentials (and allow
717 mechanisms which can pass credentials to do so).
720 property specifies the minimum acceptable
721 .I security strength factor
722 as an integer approximate to effective key length used for
723 encryption. 0 (zero) implies no protection, 1 implies integrity
724 protection only, 56 allows DES or other weak ciphers, 112
725 allows triple DES and other strong ciphers, 128 allows RC4,
726 Blowfish and other modern strong ciphers. The default is 0.
729 property specifies the maximum acceptable
730 .I security strength factor
731 as an integer (see minssf description). The default is INT_MAX.
734 property specifies the maximum security layer receive buffer
735 size allowed. 0 disables security layers. The default is 65536.
738 Specify the distinguished name for the subschema subentry that
739 controls the entries on this server. The default is "cn=Subschema".
741 .B security <factors>
742 Specify a set of factors (separated by white space) to require.
743 An integer value is associated with each factor and is roughly
744 equivalent of the encryption key length to require. A value
745 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
746 The directive may be specified globally and/or per-database.
748 specifies the overall security strength factor.
750 specifies the transport security strength factor.
752 specifies the TLS security strength factor.
754 specifies the SASL security strength factor.
756 specifies the overall security strength factor to require for
758 .B update_transport=<n>
759 specifies the transport security strength factor to require for
762 specifies the TLS security strength factor to require for
765 specifies the SASL security strength factor to require for
768 specifies the security strength factor required for
770 username/password authentication.
773 factor is measure of security provided by the underlying transport,
774 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
776 .B sizelimit {<integer>|unlimited}
778 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
779 Specify the maximum number of entries to return from a search operation.
780 The default size limit is 500.
785 to specify no limits.
786 The second format allows a fine grain setting of the size limits.
787 Extra args can be added on the same line.
790 for an explanation of the different flags.
792 .B sockbuf_max_incoming <integer>
793 Specify the maximum incoming LDAP PDU size for anonymous sessions.
794 The default is 262143.
796 .B sockbuf_max_incoming_auth <integer>
797 Specify the maximum incoming LDAP PDU size for authenticated sessions.
798 The default is 4194303.
801 Specify the srvtab file in which the kerberos keys necessary for
802 authenticating clients using kerberos can be found. This option is only
803 meaningful if you are using Kerberos authentication.
806 Specify the maximum size of the primary thread pool.
809 .B timelimit {<integer>|unlimited}
811 .B timelimit time[.{soft|hard}]=<integer> [...]
812 Specify the maximum number of seconds (in real time)
814 will spend answering a search request. The default time limit is 3600.
819 to specify no limits.
820 The second format allows a fine grain setting of the time limits.
821 Extra args can be added on the same line.
824 for an explanation of the different flags.
826 .B ucdata-path <path>
827 Specify the path to the directory containing the Unicode character
828 tables. The default path is DATADIR/ucdata.
832 is built with support for Transport Layer Security, there are more options
835 .B TLSCipherSuite <cipher-suite-spec>
836 Permits configuring what ciphers will be accepted and the preference order.
837 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
839 TLSCipherSuite HIGH:MEDIUM:+SSLv2
841 To check what ciphers a given spec selects, use:
843 openssl ciphers -v <cipher-suite-spec>
845 .B TLSCACertificateFile <filename>
846 Specifies the file that contains certificates for all of the Certificate
851 .B TLSCACertificatePath <path>
852 Specifies the path of a directory that contains Certificate Authority
853 certificates in separate individual files. Usually only one of this
854 or the TLSCACertificateFile is used.
856 .B TLSCertificateFile <filename>
857 Specifies the file that contains the
861 .B TLSCertificateKeyFile <filename>
862 Specifies the file that contains the
864 server private key that matches the certificate stored in the
865 .B TLSCertificateFile
866 file. Currently, the private key must not be protected with a password, so
867 it is of critical importance that it is protected carefully.
869 .B TLSRandFile <filename>
870 Specifies the file to obtain random bits from when /dev/[u]random
871 is not available. Generally set to the name of the EGD/PRNGD socket.
872 The environment variable RANDFILE can also be used to specify the filename.
874 .B TLSVerifyClient <level>
875 Specifies what checks to perform on client certificates in an
876 incoming TLS session, if any.
879 can be specified as one of the following keywords:
885 will not ask the client for a certificate.
888 The client certificate is requested. If no certificate is provided,
889 the session proceeds normally. If a bad certificate is provided,
890 it will be ignored and the session proceeds normally.
893 The client certificate is requested. If no certificate is provided,
894 the session proceeds normally. If a bad certificate is provided,
895 the session is immediately terminated.
897 .B demand | hard | true
898 These keywords are all equivalent, for compatibility reasons.
899 The client certificate is requested. If no certificate is provided,
900 or a bad certificate is provided, the session is immediately terminated.
902 Note that a valid client certificate is required in order to use the
903 SASL EXTERNAL authentication mechanism with a TLS session. As such,
906 setting must be chosen to enable SASL EXTERNAL authentication.
908 .SH GENERAL BACKEND OPTIONS
909 Options in this section only apply to the configuration file section
910 for the specified backend. They are supported by every
913 .B backend <databasetype>
914 Mark the beginning of a backend definition. <databasetype>
929 depending on which backend will serve the database.
931 .SH GENERAL DATABASE OPTIONS
932 Options in this section only apply to the configuration file section
933 for the database in which they are defined. They are supported by every
934 type of backend. Note that the
938 option are mandatory for each database.
940 .B database <databasetype>
941 Mark the beginning of a new database instance definition. <databasetype>
956 depending on which backend will serve the database.
961 will automatically maintain the
962 modifiersName, modifyTimestamp, creatorsName, and
963 createTimestamp attributes for entries. By default, lastmod is on.
965 .B maxderefdepth <depth>
966 Specifies the maximum number of aliases to dereference when trying to
967 resolve an entry, used to avoid inifinite alias loops. The default is 1.
970 This option puts the database into "read-only" mode. Any attempts to
971 modify the database will return an "unwilling to perform" error. By
972 default, readonly is off.
974 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
975 .B [starttls=yes|critical]
976 .B [suffix=<suffix> [...]]
977 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
978 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
979 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
980 .B [attr[!]=<attr list>]
982 Specify a replication site for this database. Refer to the "OpenLDAP
983 Administrator's Guide" for detailed information on setting up a replicated
985 directory service. Zero or more
987 instances can be used to select the subtrees that will be replicated
988 (defaults to all the database).
990 is deprecated in favor of the
994 allows the replica LDAP server to be specified as an LDAP URI.
1003 and should only be used when adequate security services
1004 (e.g TLS or IPSEC) are in place. A
1010 Specific security properties (as with the
1012 keyword above) for a SASL bind can be set with the
1014 option. A non-default SASL realm can be set with the
1019 will use Kerberos, a kerberos instance should be given in
1023 can be given after the
1025 keyword to allow the selective replication of the listed attributes only;
1028 mark is used, the list is considered exclusive, i.e. the listed attributes
1030 If an objectClass is listed, all the related attributes
1031 are (are not) replicated.
1034 .B replogfile <filename>
1035 Specify the name of the replication log file to log changes to.
1036 The replication log is typically written by
1041 .BR slapd.replog (5)
1042 for more information. The specified file should be located
1043 in a directory with limited read/write/execute access as the replication
1044 logs may contain sensitive information.
1047 Specify the distinguished name that is not subject to access control
1048 or administrative limit restrictions for operations on this database.
1049 This DN may or may not be associated with an entry. An empty root
1050 DN (the default) specifies no root access is to be granted. It is
1051 recommended that the rootdn only be specified when needed (such as
1052 when initially populating a database). If the rootdn is within
1053 a namingContext (suffix) of the database, a simple bind password
1054 may also be provided using the
1058 .B rootpw <password>
1059 Specify a password (or hash of the password) for the rootdn. The
1060 password can only be set if the rootdn is within the namingContext
1061 (suffix) of the database.
1062 This option accepts all RFC 2307 userPassword formats known to
1065 desription) as well as cleartext.
1067 may be used to generate a hash of a password. Cleartext
1068 and \fB{CRYPT}\fP passwords are not recommended. If empty
1069 (the default), authentication of the root DN is by other means
1070 (e.g. SASL). Use of SASL is encouraged.
1072 .B suffix <dn suffix>
1073 Specify the DN suffix of queries that will be passed to this
1074 backend database. Multiple suffix lines can be given and at least one is
1075 required for each database definition.
1076 If the suffix of one database is "inside" that of another, the database
1077 with the inner suffix must come first in the configuration file.
1080 Specify that the current backend database is a subordinate of another
1081 backend database. A subordinate database may have only one suffix. This
1082 option may be used to glue multiple databases into a single namingContext.
1083 If the suffix of the current database is within the namingContext of a
1084 superior database, searches against the superior database will be
1085 propagated to the subordinate as well. All of the databases
1086 associated with a single namingContext should have identical rootdns.
1087 Behavior of other LDAP operations is unaffected by this setting. In
1088 particular, it is not possible to use moddn to move an entry from
1089 one subordinate to another subordinate within the namingContext.
1092 This option is only applicable in a slave
1094 It specifies the DN permitted to update (subject to access controls)
1095 the replica (typically, this is the DN
1097 binds to update the replica).
1100 Specify the referral to pass back when
1102 is asked to modify a replicated local database.
1103 If specified multiple times, each url is provided.
1105 .B syncrepl id=<replica ID>
1106 .B provider=ldap[s]://<hostname>[:port]
1109 .B [bindmethod=simple|sasl] [binddn=<simple DN>] [credentials=<simple passwd>]
1110 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1111 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1112 .B [searchbase=<base DN>]
1113 .B [filter=<filter str>]
1114 .B [attrs=<attr list>]
1115 .B [schemachecking=on|off]
1116 .B [scope=sub|one|base]
1117 .B [type=refreshOnly|refreshAndPersist]
1118 .B [interval=dd:hh:mm]
1120 Specify an LDAP Sync replication session between the specified replication provider
1121 site and this database (a replication consumer).
1122 The replication consumer communicates with the replication provider to perform
1123 an initial population and the following periodic or persistent synchronizations.
1124 The LDAP Sync replication engine is based on the LDAP Content Sync protocol :
1125 a stateful, pull, incremental, and partial synchronization protocol which
1126 supports both polling and listening modes of operations.
1127 It currently supports entry-level synchronization.
1128 A directory server wide
1130 uniquely identifies this LDAP Sync replication specification
1131 in the directory server instance. The specification of an LDAP Sync replication
1132 session is based on the search specification which defines the replica content.
1133 The replicated entries are those directory entries of the subtree under the
1139 Only the attributes specified in the
1141 are included in the replica content.
1142 There are two synchronization modes depending on the incremental
1143 synchronization semantics after the intial content population.
1144 The incremental synchronization is performed periodically with
1151 Alternatively, the provider sends synchronization messages to the consumer
1152 upon updates to the replicated contents when the sync
1155 .B refreshAndPersist.
1156 The replication provider site is specified by
1163 every replicated entry will be checked for its schema
1164 when it is stored in the consumer replica.
1165 The consumer slapd should retrieve attributes of an entry
1166 that are required by the schema definition.
1171 entries will be stored without checking the schema conformance.
1176 requires the options
1180 and should only be used when adequate security services (e.g. TLS or IPSEC) are in place.
1187 Specific security properties (as with the
1189 keyword above) for a SASL bind can be set with the
1191 option. A non default SASL realm can be set with the
1196 will use Kerberos, a kerberos instance should be given in
1199 specifies the DN used to update (subject to access controls) the
1200 replica at the consumer replica.
1201 .SH DATABASE-SPECIFIC OPTIONS
1202 Each database may allow specific configuration options; they are
1203 documented separately in the backends' manual pages.
1205 The following backends can be compiled into slapd.
1206 They are documented in the
1207 .BR slapd-<backend> (5)
1211 This is the recommended backend for a normal slapd database.
1212 However, it takes more care than with the LDBM backend to configure
1214 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1217 This is the database backend which is easiest to configure.
1218 However, it does not offer the data durability features of the BDB
1220 It uses Berkeley DB or GDBM to store data.
1223 This backend is experimental.
1224 It serves up referrals based upon SRV resource records held in the
1228 This backend acts as a proxy to forward incoming requests to another
1232 This backend performs basic LDAP proxying with respect to a set of
1233 remote LDAP servers. It is an enhancement of the ldap backend. The
1234 proxy cache extension of meta backend provides answering of search
1235 requests from the proxy using results of previously cached requests.
1238 This backend provides information about the running status of the slapd
1242 Operations in this backend succeed but do nothing.
1245 This backend is provided for demonstration purposes only.
1246 It serves up user account information from the system
1251 This backend embeds a
1253 interpreter into slapd.
1254 It runs Perl subroutines to implement LDAP operations.
1257 This backend executes external programs to implement LDAP operations.
1258 It is is primarily intended to be used in prototypes.
1261 This backend is experimental.
1262 It services LDAP requests from an SQL database.
1265 This backend is experimental.
1268 interpreter into slapd.
1269 It runs Tcl commands to implement LDAP operations.
1272 Here is a short example of a configuration file:
1276 include SYSCONFDIR/schema/core.schema
1277 pidfile LOCALSTATEDIR/slapd.pid
1279 # Subtypes of "name" (e.g. "cn" and "ou") with the
1280 # option ";x-hidden" can be searched for/compared,
1281 # but are not shown. See \fBslapd.access\fP(5).
1282 attributeoptions x-hidden lang-
1283 access to attr=name;x-hidden by * =cs
1286 suffix "dc=our-domain,dc=com"
1287 # The database directory MUST exist prior to
1288 # running slapd AND should only be accessible
1289 # by the slapd/tools. Mode 0700 recommended.
1290 directory LOCALSTATEDIR/openldap-data
1291 # Indices to maintain
1292 index objectClass eq
1293 index cn,sn,mail pres,eq,approx,sub
1295 # We serve small clients that do not handle referrals,
1296 # so handle remote lookups on their behalf.
1299 uri ldap://ldap.some-server.com/
1304 "OpenLDAP Administrator's Guide" contains a longer annotated
1305 example of a configuration file.
1306 The original ETCDIR/slapd.conf is another example.
1310 default slapd configuration file
1314 .BR slapd-dnssrv (5),
1318 .BR slapd-monitor (5),
1320 .BR slapd-passwd (5),
1322 .BR slapd-shell (5),
1325 .BR slapd.replog (5),
1326 .BR slapd.access (5),
1334 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1335 .SH ACKNOWLEDGEMENTS
1337 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1339 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob