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
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 RFC2251 reserves options beginning with `x-' for private experiments.
124 Other options should be registered with IANA, see RFC3383 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>
301 <style> ::= exact | base | one | 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
341 The currently supported limits are
346 The syntax for time limits is
347 .BR time[.{soft|hard}]=<integer> ,
350 is the number of seconds slapd will spend answering a search request.
351 If no time limit is explicitly requested by the client, the
353 limit is used; if the requested time limit exceeds the
355 limit, an "Administrative limit exceeded" is returned.
358 limit is set to 0 or to the keyword "soft", the soft limit is used
359 in either case; if it is set to -1 or to the keyword "none",
360 no hard limit is enforced.
361 Explicit requests for time limits smaller or equal to the
364 If no flag is set, the value is assigned to the
368 limit is set to zero, to preserve the original behavior.
370 The syntax for size limits is
371 .BR size[.{soft|hard|unchecked}]=<integer> ,
374 is the maximum number of entries slapd will return answering a search
376 If no size limit is explicitly requested by the client, the
378 limit is used; if the requested size limit exceeds the
380 limit, an "Administrative limit exceeded" is returned.
383 limit is set to 0 or to the keyword "soft", the soft limit is used
384 in either case; if it is set to -1 or to the keyword "none",
385 no hard limit is enforced.
386 Explicit requests for size limits smaller or equal to the
391 flag sets a limit on the number of candidates a search request is allowed
393 If the selected candidates exceed the
395 limit, the search will abort with "Unwilling to perform".
396 If it is set to -1 or to the keyword "none", no limit is applied (the default).
397 If no flag is set, the value is assigned to the
401 limit is set to zero, to preserve the original behavior.
403 In case of no match, the global limits are used.
404 The default values are the same of
413 control is defined, additional size limits may be enforced; the syntax is
414 .BR size.pr={<integer>|noEstimate} ,
417 is the max page size if no explicit limit is set; the keyword
419 inhibits the server to return an estimate of the total number
420 of entries that will be returned.
423 .\".B logfile <filename>
424 .\"Specify a file for recording debug log messages. By default these messages
425 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
426 .\"copies messages to both stderr and the logfile.
428 .B loglevel <integer>
429 Specify the level at which debugging statements and operation
430 statistics should be syslogged (currently logged to the
432 LOG_LOCAL4 facility). Log levels are additive, and available levels
442 debug packet handling
445 heavy trace debugging
448 connection management
451 print out packets sent and received
454 search filter processing
457 configuration file processing
460 access control list processing
463 stats log connections/operations/results
466 stats log entries sent
469 print communication with shell backends
477 .B moduleload <filename>
478 Specify the name of a dynamically loadable module to load. The filename
479 may be an absolute path name or a simple filename. Non-absolute names
480 are searched for in the directories specified by the
482 option. This option and the
484 option are only usable if slapd was compiled with --enable-modules.
486 .B modulepath <pathspec>
487 Specify a list of directories to search for loadable modules. Typically
488 the path is colon-separated but this depends on the operating system.
491 .B objectclass "(\ <oid>\
493 [DESC\ <description]\
496 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
497 [MUST\ <oids>] [MAY\ <oids>] )"
499 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
500 The slapd parser extends the RFC 2252 definition by allowing string
501 forms as well as numeric OIDs to be used for the object class OID.
505 description.) Object classes are "STRUCTURAL" by default.
508 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
509 Define a string name that equates to the given OID. The string can be used
510 in place of the numeric OID in objectclass and attribute definitions. The
511 name can also be used with a suffix of the form ":xx" in which case the
512 value "oid.xx" will be used.
514 .B password-hash <hash>
515 This option sets the hash to be used in generation of user
516 passwords, stored in userPassword, during processing of
517 LDAP Password Modify Extended Operations (RFC 3052).
518 The <hash> must be one of
532 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
537 use the MD5 algorithm (RFC 1321), the latter with a seed.
544 indicates that the new password should be
545 added to userPassword as clear text.
547 Note that this option does not alter the normal user applications
548 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
550 .B password\-crypt\-salt\-format <format>
551 Specify the format of the salt passed to
553 when generating {CRYPT} passwords (see
555 during processing of LDAP Password Modify Extended Operations (RFC 3062).
557 This string needs to be in
559 format and may include one (and only one) %s conversion.
560 This conversion will be substituted with a string random
561 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
562 provides a two character salt and "$1$%.8s" tells some
563 versions of crypt(3) to use an MD5 algorithm and provides
564 8 random characters of salt. The default is "%s", which
565 provides 31 characters of salt.
567 .B pidfile <filename>
568 The ( absolute ) name of a file that will hold the
570 server's process ID ( see
572 ) if started without the debugging command line option.
575 Specify the referral to pass back when
577 cannot find a local database to handle a request.
578 If specified multiple times, each url is provided.
581 The ( absolute ) name of a file that will hold the
583 server's command line options
584 if started without the debugging command line option.
587 The ( absolute ) name of a file that will hold the
589 server's process ID ( see
591 ) if started without the debugging command line option.
593 .B require <conditions>
594 Specify a set of conditions (separated by white space) to
595 require (default none).
596 The directive may be specified globally and/or per-database.
598 requires bind operation prior to directory operations.
600 requires session to be using LDAP version 3.
602 requires authentication prior to directory operations.
604 requires SASL authentication prior to directory operations.
606 requires strong authentication prior to directory operations.
607 The strong keyword allows protected "simple" authentication
608 as well as SASL authentication.
610 may be used to require no conditions (useful for clearly globally
611 set conditions within a particular database).
613 .B reverse-lookup on | off
614 Enable/disable client name unverified reverse lookup (default is
616 if compiled with --enable-rlookups).
619 Specify the name of an LDIF(5) file containing user defined attributes
620 for the root DSE. These attributes are returned in addition to the
621 attributes normally produced by slapd.
623 .B sasl-authz-policy <policy>
624 Used to specify which rules to use for SASL Proxy Authorization. Proxy
625 authorization allows a client to authenticate to the server using one
626 user's credentials, but specify a different identity to use for authorization
627 and access control purposes. It essentially allows user A to login as user
628 B, using user A's password.
631 flag disables proxy authorization. This is the default setting.
634 flag will use rules in the
636 attribute of the authorization DN.
639 flag will use rules in the
641 attribute of the authentication DN.
644 flag will allow both of the above. The rules are simply regular expressions
645 specifying which DNs are allowed to perform proxy authorization. The
647 attribute in an entry specifies which other users
648 are allowed to proxy login to this entry. The
651 an entry specifies which other users this user can authorize as. Use of
654 abused if users are allowed to write arbitrary values to this attribute.
657 attribute must be protected with ACLs such that
658 only privileged users can modify it.
661 Used to specify the fully qualified domain name used for SASL processing.
663 .B sasl-realm <realm>
664 Specify SASL realm. Default is empty.
666 .B sasl-regexp <match> <replace>
667 Used by the SASL mechanism to convert a SASL authenticated
668 username to an LDAP DN used for authorization purposes. Note that
669 the resultant DN need not refer to an existing entry to be considered
670 valid. When an authorization request is received, the SASL
674 are taken, when available, and combined into a SASL name of the
679 .B UID=<username>[[,CN=<realm>],CN=<mechanism>,]CN=auth
682 This SASL name is then compared against the
684 regular expression, and if the match is successful, the SASL name is
687 string. If there are wildcard strings in the
689 regular expression that are enclosed in parenthesis, e.g.
695 then the portion of the SASL name that matched the wildcard will be stored
696 in the numbered placeholder variable $1. If there are other wildcard strings
697 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
698 placeholders can then be used in the
703 .B UID=$1,OU=Accounts,DC=example,DC=com
706 The replaced SASL name can be either a DN or an LDAP URI. If the
707 latter, the server will use the URI to search its own database(s)
708 and, if the search returns exactly one entry, the SASL name is
709 replaced by the DN of that entry. The LDAP URI must have no
710 hostport, attrs, or extensions components, e.g.
713 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
718 options can be given in the configuration file to allow for multiple matching
719 and replacement patterns. The matching patterns are checked in the order they
720 appear in the file, stopping at the first successful match.
723 .\"Because the plus sign + is a character recognized by the regular expression engine,
724 .\"and it will appear in SASL names that include a REALM, be careful to escape the
725 .\"plus sign with a backslash \\+ to remove the character's special meaning.
728 .B sasl-secprops <properties>
729 Used to specify Cyrus SASL security properties.
732 flag (without any other properties) causes the flag properties
733 default, "noanonymous,noplain", to be cleared.
736 flag disables mechanisms susceptible to simple passive attacks.
739 flag disables mechanisms susceptible to active attacks.
742 flag disables mechanisms susceptible to passive dictionary attacks.
745 flag disables mechanisms which support anonymous login.
748 flag require forward secrecy between sessions.
751 require mechanisms which pass client credentials (and allow
752 mechanisms which can pass credentials to do so).
755 property specifies the minimum acceptable
756 .I security strength factor
757 as an integer approximate to effective key length used for
758 encryption. 0 (zero) implies no protection, 1 implies integrity
759 protection only, 56 allows DES or other weak ciphers, 112
760 allows triple DES and other strong ciphers, 128 allows RC4,
761 Blowfish and other modern strong ciphers. The default is 0.
764 property specifies the maximum acceptable
765 .I security strength factor
766 as an integer (see minssf description). The default is INT_MAX.
769 property specifies the maximum security layer receive buffer
770 size allowed. 0 disables security layers. The default is 65536.
773 Specify the distinguished name for the subschema subentry that
774 controls the entries on this server. The default is "cn=Subschema".
776 .B security <factors>
777 Specify a set of factors (separated by white space) to require.
778 An integer value is associated with each factor and is roughly
779 equivalent of the encryption key length to require. A value
780 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
781 The directive may be specified globally and/or per-database.
783 specifies the overall security strength factor.
785 specifies the transport security strength factor.
787 specifies the TLS security strength factor.
789 specifies the SASL security strength factor.
791 specifies the overall security strength factor to require for
793 .B update_transport=<n>
794 specifies the transport security strength factor to require for
797 specifies the TLS security strength factor to require for
800 specifies the SASL security strength factor to require for
803 specifies the security strength factor required for
805 username/password authentication.
808 factor is measure of security provided by the underlying transport,
809 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
811 .B sizelimit {<integer>|unlimited}
813 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
814 Specify the maximum number of entries to return from a search operation.
815 The default size limit is 500.
820 to specify no limits.
821 The second format allows a fine grain setting of the size limits.
822 Extra args can be added on the same line.
825 for an explanation of the different flags.
827 .B sockbuf_max_incoming <integer>
828 Specify the maximum incoming LDAP PDU size for anonymous sessions.
829 The default is 262143.
831 .B sockbuf_max_incoming_auth <integer>
832 Specify the maximum incoming LDAP PDU size for authenticated sessions.
833 The default is 4194303.
836 Specify the srvtab file in which the kerberos keys necessary for
837 authenticating clients using kerberos can be found. This option is only
838 meaningful if you are using Kerberos authentication.
841 Specify the maximum size of the primary thread pool.
844 .B timelimit {<integer>|unlimited}
846 .B timelimit time[.{soft|hard}]=<integer> [...]
847 Specify the maximum number of seconds (in real time)
849 will spend answering a search request. The default time limit is 3600.
854 to specify no limits.
855 The second format allows a fine grain setting of the time limits.
856 Extra args can be added on the same line.
859 for an explanation of the different flags.
861 .B ucdata-path <path>
862 Specify the path to the directory containing the Unicode character
863 tables. The default path is DATADIR/ucdata.
867 is built with support for Transport Layer Security, there are more options
870 .B TLSCipherSuite <cipher-suite-spec>
871 Permits configuring what ciphers will be accepted and the preference order.
872 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
874 TLSCipherSuite HIGH:MEDIUM:+SSLv2
876 To check what ciphers a given spec selects, use:
878 openssl ciphers -v <cipher-suite-spec>
880 .B TLSCACertificateFile <filename>
881 Specifies the file that contains certificates for all of the Certificate
886 .B TLSCACertificatePath <path>
887 Specifies the path of a directory that contains Certificate Authority
888 certificates in separate individual files. Usually only one of this
889 or the TLSCACertificateFile is used.
891 .B TLSCertificateFile <filename>
892 Specifies the file that contains the
896 .B TLSCertificateKeyFile <filename>
897 Specifies the file that contains the
899 server private key that matches the certificate stored in the
900 .B TLSCertificateFile
901 file. Currently, the private key must not be protected with a password, so
902 it is of critical importance that it is protected carefully.
904 .B TLSRandFile <filename>
905 Specifies the file to obtain random bits from when /dev/[u]random
906 is not available. Generally set to the name of the EGD/PRNGD socket.
907 The environment variable RANDFILE can also be used to specify the filename.
909 .B TLSVerifyClient <level>
910 Specifies what checks to perform on client certificates in an
911 incoming TLS session, if any.
914 can be specified as one of the following keywords:
920 will not ask the client for a certificate.
923 The client certificate is requested. If no certificate is provided,
924 the session proceeds normally. If a bad certificate is provided,
925 it will be ignored and the session proceeds normally.
928 The client certificate is requested. If no certificate is provided,
929 the session proceeds normally. If a bad certificate is provided,
930 the session is immediately terminated.
932 .B demand | hard | true
933 These keywords are all equivalent, for compatibility reasons.
934 The client certificate is requested. If no certificate is provided,
935 or a bad certificate is provided, the session is immediately terminated.
937 Note that a valid client certificate is required in order to use the
938 SASL EXTERNAL authentication mechanism with a TLS session. As such,
941 setting must be chosen to enable SASL EXTERNAL authentication.
943 .SH GENERAL BACKEND OPTIONS
944 Options in this section only apply to the configuration file section
945 for the specified backend. They are supported by every
948 .B backend <databasetype>
949 Mark the beginning of a backend definition. <databasetype>
964 depending on which backend will serve the database.
966 .SH GENERAL DATABASE OPTIONS
967 Options in this section only apply to the configuration file section
968 for the database in which they are defined. They are supported by every
969 type of backend. Note that the
973 option are mandatory for each database.
975 .B database <databasetype>
976 Mark the beginning of a new database instance definition. <databasetype>
991 depending on which backend will serve the database.
996 will automatically maintain the
997 modifiersName, modifyTimestamp, creatorsName, and
998 createTimestamp attributes for entries. By default, lastmod is on.
1000 .B maxderefdepth <depth>
1001 Specifies the maximum number of aliases to dereference when trying to
1002 resolve an entry, used to avoid infinite alias loops. The default is 1.
1004 .B readonly on | off
1005 This option puts the database into "read-only" mode. Any attempts to
1006 modify the database will return an "unwilling to perform" error. By
1007 default, readonly is off.
1010 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1011 .B [starttls=yes|critical]
1012 .B [suffix=<suffix> [...]]
1013 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1014 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1015 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1016 .B [attr[!]=<attr list>]
1018 Specify a replication site for this database. Refer to the "OpenLDAP
1019 Administrator's Guide" for detailed information on setting up a replicated
1021 directory service. Zero or more
1023 instances can be used to select the subtrees that will be replicated
1024 (defaults to all the database).
1026 is deprecated in favor of the
1030 allows the replica LDAP server to be specified as an LDAP URI.
1035 requires the options
1039 and should only be used when adequate security services
1040 (e.g TLS or IPSEC) are in place. A
1046 Specific security properties (as with the
1048 keyword above) for a SASL bind can be set with the
1050 option. A non-default SASL realm can be set with the
1055 will use Kerberos, a kerberos instance should be given in
1059 can be given after the
1061 keyword to allow the selective replication of the listed attributes only;
1064 mark is used, the list is considered exclusive, i.e. the listed attributes
1066 If an objectClass is listed, all the related attributes
1067 are (are not) replicated.
1070 .B replogfile <filename>
1071 Specify the name of the replication log file to log changes to.
1072 The replication log is typically written by
1077 .BR slapd.replog (5)
1078 for more information. The specified file should be located
1079 in a directory with limited read/write/execute access as the replication
1080 logs may contain sensitive information.
1083 Specify the distinguished name that is not subject to access control
1084 or administrative limit restrictions for operations on this database.
1085 This DN may or may not be associated with an entry. An empty root
1086 DN (the default) specifies no root access is to be granted. It is
1087 recommended that the rootdn only be specified when needed (such as
1088 when initially populating a database). If the rootdn is within
1089 a namingContext (suffix) of the database, a simple bind password
1090 may also be provided using the
1094 .B rootpw <password>
1095 Specify a password (or hash of the password) for the rootdn. The
1096 password can only be set if the rootdn is within the namingContext
1097 (suffix) of the database.
1098 This option accepts all RFC 2307 userPassword formats known to
1101 description) as well as cleartext.
1103 may be used to generate a hash of a password. Cleartext
1104 and \fB{CRYPT}\fP passwords are not recommended. If empty
1105 (the default), authentication of the root DN is by other means
1106 (e.g. SASL). Use of SASL is encouraged.
1108 .B suffix <dn suffix>
1109 Specify the DN suffix of queries that will be passed to this
1110 backend database. Multiple suffix lines can be given and at least one is
1111 required for each database definition.
1112 If the suffix of one database is "inside" that of another, the database
1113 with the inner suffix must come first in the configuration file.
1116 Specify that the current backend database is a subordinate of another
1117 backend database. A subordinate database may have only one suffix. This
1118 option may be used to glue multiple databases into a single namingContext.
1119 If the suffix of the current database is within the namingContext of a
1120 superior database, searches against the superior database will be
1121 propagated to the subordinate as well. All of the databases
1122 associated with a single namingContext should have identical rootdns.
1123 Behavior of other LDAP operations is unaffected by this setting. In
1124 particular, it is not possible to use moddn to move an entry from
1125 one subordinate to another subordinate within the namingContext.
1128 .B syncrepl id=<replica ID>
1129 .B provider=ldap[s]://<hostname>[:port]
1130 .B [type=refreshOnly|refreshAndPersist]
1131 .B [interval=dd:hh:mm:ss]
1132 .B [searchbase=<base DN>]
1133 .B [filter=<filter str>]
1134 .B [scope=sub|one|base]
1135 .B [attrs=<attr list>]
1137 .B [sizelimit=<limit>]
1138 .B [timelimit=<limit>]
1139 .B [schemachecking=on|off]
1141 .B [bindmethod=simple|sasl]
1143 .B [saslmech=<mech>]
1144 .B [authcid=<identity>]
1145 .B [authzid=<identity>]
1146 .B [credentials=<passwd>]
1148 .B [secprops=<properties>]
1150 Specify the current database as a replica which is kept up-to-date with the
1151 master content by establishing the current
1153 as a replication consumer site running a
1156 The replica content is kept synchronized to the master content using
1157 the LDAP Content Synchronization protocol. Refer to the
1158 "OpenLDAP Administrator's Guide" for detailed information on
1159 setting up a replicated
1161 directory service using the
1165 identifies the current
1167 directive within the database.
1168 It is a non-negative integer having no more than three digits.
1170 specifies the replication provider site containing the master content
1171 as an LDAP URI. If <port> is not given, the standard LDAP port number
1172 (389 or 636) is used. The content of the
1174 replica is defined using a search
1175 specification as its result set. The consumer
1177 will send search requests to the provider
1179 according to the search specification. The search specification includes
1180 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1183 parameters as in the normal search specification.
1184 The search specification for the LDAP Content Synchronization operation
1185 has the same value syntax and the same default values as in the
1188 The LDAP Content Synchronization protocol has two operation types.
1191 operation, the next synchronization search operation
1192 is periodically rescheduled at an interval time (specified by
1194 parameter; 1 day by default)
1195 after each synchronization operation finishes.
1197 .B refreshAndPersist
1198 operation, a synchronization search remains persistent in the provider slapd.
1199 Further updates to the master replica will generate
1200 .B searchResultEntry
1201 to the consumer slapd as the search responses to the persistent
1202 synchronization search. The schema checking can be enforced at the LDAP Sync
1203 consumer site by turning on the
1205 parameter. The default is off.
1208 parameter specifies the DN in the consumer site
1209 which is allowed to make changes to the replica.
1210 The DN should have read/write access to the replica database.
1215 requires the options
1219 and should only be used when adequate security services
1220 (e.g. TLS or IPSEC) are in place.
1227 Depending on the mechanism, an authentication identity and/or
1228 credentials can be specified using
1234 parameter may be used to specify an authorization identity.
1235 Specific security properties (as with the
1237 keyword above) for a SASL bind can be set with the
1239 option. A non default SASL realm can be set with the
1245 This option is only applicable in a slave
1247 It specifies the DN permitted to update (subject to access controls)
1248 the replica (typically, this is the DN
1250 binds to update the replica).
1253 Specify the referral to pass back when
1255 is asked to modify a replicated local database.
1256 If specified multiple times, each url is provided.
1258 .SH DATABASE-SPECIFIC OPTIONS
1259 Each database may allow specific configuration options; they are
1260 documented separately in the backends' manual pages.
1262 The following backends can be compiled into slapd.
1263 They are documented in the
1264 .BR slapd-<backend> (5)
1268 This is the recommended backend for a normal slapd database.
1269 However, it takes more care than with the LDBM backend to configure
1271 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1274 This is the database backend which is easiest to configure.
1275 However, it does not offer the data durability features of the BDB
1277 It uses Berkeley DB or GDBM to store data.
1280 This backend is experimental.
1281 It serves up referrals based upon SRV resource records held in the
1285 This backend acts as a proxy to forward incoming requests to another
1289 This backend performs basic LDAP proxying with respect to a set of
1290 remote LDAP servers. It is an enhancement of the ldap backend. The
1291 proxy cache extension of meta backend provides answering of search
1292 requests from the proxy using results of previously cached requests.
1295 This backend provides information about the running status of the slapd
1299 Operations in this backend succeed but do nothing.
1302 This backend is provided for demonstration purposes only.
1303 It serves up user account information from the system
1308 This backend embeds a
1310 interpreter into slapd.
1311 It runs Perl subroutines to implement LDAP operations.
1314 This backend executes external programs to implement LDAP operations.
1315 It is is primarily intended to be used in prototypes.
1318 This backend is experimental.
1319 It services LDAP requests from an SQL database.
1322 This backend is experimental.
1325 interpreter into slapd.
1326 It runs Tcl commands to implement LDAP operations.
1329 Here is a short example of a configuration file:
1333 include SYSCONFDIR/schema/core.schema
1334 pidfile LOCALSTATEDIR/slapd.pid
1336 # Subtypes of "name" (e.g. "cn" and "ou") with the
1337 # option ";x-hidden" can be searched for/compared,
1338 # but are not shown. See \fBslapd.access\fP(5).
1339 attributeoptions x-hidden lang-
1340 access to attr=name;x-hidden by * =cs
1343 suffix "dc=our-domain,dc=com"
1344 # The database directory MUST exist prior to
1345 # running slapd AND should only be accessible
1346 # by the slapd/tools. Mode 0700 recommended.
1347 directory LOCALSTATEDIR/openldap-data
1348 # Indices to maintain
1349 index objectClass eq
1350 index cn,sn,mail pres,eq,approx,sub
1352 # We serve small clients that do not handle referrals,
1353 # so handle remote lookups on their behalf.
1356 uri ldap://ldap.some-server.com/
1361 "OpenLDAP Administrator's Guide" contains a longer annotated
1362 example of a configuration file.
1363 The original ETCDIR/slapd.conf is another example.
1367 default slapd configuration file
1371 .BR slapd-dnssrv (5),
1375 .BR slapd-monitor (5),
1377 .BR slapd-passwd (5),
1379 .BR slapd-shell (5),
1382 .BR slapd.access (5),
1383 .BR slapd.plugin (5),
1384 .BR slapd.replog (5),
1392 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1393 .SH ACKNOWLEDGEMENTS
1395 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1397 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob