1 .TH SLAPD-CONFIG 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2017 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd\-config \- configuration backend to slapd
12 backend manages all of the configuration information for the
14 daemon. This configuration information is also used by the SLAPD tools
26 backend is backward compatible with the older
28 file but provides the ability to change the configuration dynamically
29 at runtime. If slapd is run with only a
31 file dynamic changes will be allowed but they will not persist across
32 a server restart. Dynamic changes are only saved when slapd is running
35 configuration directory.
38 Unlike other backends, there can only be one instance of the
40 backend, and most of its structure is predefined. The root of the
41 database is hardcoded to
43 and this root entry contains
44 global settings for slapd. Multiple child entries underneath the
45 root entry are used to carry various other settings:
49 dynamically loaded modules
55 backend-specific settings
58 database-specific settings
63 entries will only appear in configurations where slapd
64 was built with support for dynamically loaded modules. There can be
65 multiple entries, one for each configured module path. Within each
66 entry there will be values recorded for each module loaded on a
67 given path. These entries have no children.
71 entry contains all of the hardcoded schema elements.
72 The children of this entry contain all user-defined schema elements.
73 In schema that were loaded from include files, the child entry will
74 be named after the include file from which the schema was loaded.
75 Typically the first child in this subtree will be
76 .BR cn=core,cn=schema,cn=config .
79 entries are for storing settings specific to a single
80 backend type (and thus global to all database instances of that type).
81 At present there are no backends that implement settings of this
82 nature, so usually there will not be any olcBackend entries.
85 entries store settings specific to a single database
86 instance. These entries may have
88 child entries corresponding
89 to any overlays configured on the database. The olcDatabase and
90 olcOverlay entries may also have miscellaneous child entries for
91 other settings as needed. There are two special database entries
92 that are predefined \- one is an entry for the config database itself,
93 and the other is for the "frontend" database. Settings in the
94 frontend database are inherited by the other databases, unless
95 they are explicitly overridden in a specific database.
97 The specific configuration options available are discussed below in the
98 Global Configuration Options, General Backend Options, and General Database
99 Options. Options are set by defining LDAP attributes with specific values.
100 In general the names of the LDAP attributes are the same as the corresponding
102 keyword, with an "olc" prefix added on.
104 The parser for many of these attributes is the same as used for parsing
105 the slapd.conf keywords. As such, slapd.conf keywords that allow multiple
106 items to be specified on one line, separated by whitespace, will allow
107 multiple items to be specified in one attribute value. However, when
108 reading the attribute via LDAP, the items will be returned as individual
111 Backend-specific options are discussed in the
112 .B slapd\-<backend>(5)
113 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
114 details on configuring slapd.
115 .SH GLOBAL CONFIGURATION OPTIONS
116 Options described in this section apply to the server as a whole.
117 Arguments that should be replaced by
118 actual text are shown in brackets <>.
120 These options may only be specified in the
122 entry. This entry must have an objectClass of
126 .B olcAllows: <features>
127 Specify a set of features to allow (default none).
129 allows acceptance of LDAPv2 bind requests. Note that
131 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
133 allows anonymous bind when credentials are not empty (e.g.
136 allows unauthenticated (anonymous) bind when DN is not empty.
138 allows unauthenticated (anonymous) update operations to be processed
139 (subject to access controls and other administrative limits).
141 allows unauthenticated (anonymous) proxy authorization control to be processed
142 (subject to access controls, authorization and other administrative limits).
144 .B olcArgsFile: <filename>
145 The (absolute) name of a file that will hold the
147 server's command line (program name and options).
149 .B olcAttributeOptions: <option-name>...
150 Define tagging attribute options or option tag/range prefixes.
151 Options must not end with `\-', prefixes must end with `\-'.
152 The `lang\-' prefix is predefined.
154 .B olcAttributeOptions
155 directive, `lang\-' will no longer be defined and you must specify it
156 explicitly if you want it defined.
158 An attribute description with a tagging option is a subtype of that
159 attribute description without the option.
160 Except for that, options defined this way have no special semantics.
161 Prefixes defined this way work like the `lang\-' options:
162 They define a prefix for tagging options starting with the prefix.
163 That is, if you define the prefix `x\-foo\-', you can use the option
165 Furthermore, in a search or compare, a prefix or range name (with
166 a trailing `\-') matches all options starting with that name, as well
167 as the option with the range name sans the trailing `\-'.
168 That is, `x\-foo\-bar\-' matches `x\-foo\-bar' and `x\-foo\-bar\-baz'.
170 RFC 4520 reserves options beginning with `x\-' for private experiments.
171 Other options should be registered with IANA, see RFC 4520 section 3.5.
172 OpenLDAP also has the `binary' option built in, but this is a transfer
173 option, not a tagging option.
175 .B olcAuthIDRewrite: <rewrite\-rule>
176 Used by the authentication framework to convert simple user names
177 to an LDAP DN used for authorization purposes.
178 Its purpose is analogous to that of
183 is a set of rules analogous to those described in
185 for data rewriting (after stripping the \fIrwm\-\fP prefix).
189 should not be intermixed.
191 .B olcAuthzPolicy: <policy>
192 Used to specify which rules to use for Proxy Authorization. Proxy
193 authorization allows a client to authenticate to the server using one
194 user's credentials, but specify a different identity to use for authorization
195 and access control purposes. It essentially allows user A to login as user
196 B, using user A's password.
199 flag disables proxy authorization. This is the default setting.
202 flag will use rules in the
204 attribute of the authorization DN.
207 flag will use rules in the
209 attribute of the authentication DN.
212 flag, an alias for the deprecated value of
214 will allow any of the above, whatever succeeds first (checked in
220 flag requires both authorizations to succeed.
223 The rules are mechanisms to specify which identities are allowed
224 to perform proxy authorization.
227 attribute in an entry specifies which other users
228 are allowed to proxy login to this entry. The
231 an entry specifies which other users this user can authorize as. Use of
234 abused if users are allowed to write arbitrary values to this attribute.
237 attribute must be protected with ACLs such that
238 only privileged users can modify it.
245 or a set of identities; it can take five forms:
248 .B ldap:///<base>??[<scope>]?<filter>
251 .B dn[.<dnstyle>]:<pattern>
254 .B u[<mech>[<realm>]]:<pattern>
257 .B group[/objectClass[/attributeType]]:<pattern>
264 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
267 The first form is a valid LDAP
275 portions must be absent, so that the search occurs locally on either
281 with the optional style modifiers
287 for exact, onelevel, children and subtree matches, which cause
289 to be normalized according to the DN normalization rules, or the special
291 style, which causes the
293 to be treated as a POSIX (''extended'') regular expression, as
300 means any non-anonymous DN.
301 The third form is a SASL
303 with the optional fields
307 that allow to specify a SASL
309 and eventually a SASL
311 for those mechanisms that support one.
312 The need to allow the specification of a mechanism is still debated,
313 and users are strongly discouraged to rely on this possibility.
314 The fourth form is a group specification, consisting of the keyword
316 optionally followed by the specification of the group
322 is searched with base scope, and in case of match, the values of the
325 are searched for the asserted DN.
326 For backwards compatibility, if no identity type is provided, i.e. only
330 is assumed; as a consequence,
332 is subjected to DN normalization.
333 Since the interpretation of
337 can impact security, users are strongly encouraged
338 to explicitly set the type of identity specification that is being used.
339 A subset of these rules can be used as third arg in the
341 statement (see below); significantly, the
348 .B olcAuthzRegexp: <match> <replace>
349 Used by the authentication framework to convert simple user names,
350 such as provided by SASL subsystem, to an LDAP DN used for
351 authorization purposes. Note that the resultant DN need not refer
352 to an existing entry to be considered valid. When an authorization
353 request is received from the SASL subsystem, the SASL
358 are taken, when available, and combined into a name of the form
362 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
365 This name is then compared against the
367 POSIX (''extended'') regular expression, and if the match is successful,
368 the name is replaced with the
370 string. If there are wildcard strings in the
372 regular expression that are enclosed in parenthesis, e.g.
378 then the portion of the name that matched the wildcard will be stored
379 in the numbered placeholder variable $1. If there are other wildcard strings
380 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
381 placeholders can then be used in the
386 .B UID=$1,OU=Accounts,DC=example,DC=com
389 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
391 If the latter, the server will use the URI to search its own database(s)
392 and, if the search returns exactly one entry, the name is
393 replaced by the DN of that entry. The LDAP URI must have no
394 hostport, attrs, or extensions components, but the filter is mandatory,
398 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
401 The protocol portion of the URI must be strictly
403 Note that this search is subject to access controls. Specifically,
404 the authentication identity must have "auth" access in the subject.
408 values can be specified to allow for multiple matching
409 and replacement patterns. The matching patterns are checked in the order they
410 appear in the attribute, stopping at the first successful match.
413 .\"Because the plus sign + is a character recognized by the regular expression engine,
414 .\"and it will appear in names that include a REALM, be careful to escape the
415 .\"plus sign with a backslash \\+ to remove the character's special meaning.
418 .B olcConcurrency: <integer>
419 Specify a desired level of concurrency. Provided to the underlying
420 thread system as a hint. The default is not to provide any hint. This setting
421 is only meaningful on some platforms where there is not a one to one
422 correspondence between user threads and kernel threads.
424 .B olcConnMaxPending: <integer>
425 Specify the maximum number of pending requests for an anonymous session.
426 If requests are submitted faster than the server can process them, they
427 will be queued up to this limit. If the limit is exceeded, the session
428 is closed. The default is 100.
430 .B olcConnMaxPendingAuth: <integer>
431 Specify the maximum number of pending requests for an authenticated session.
434 .B olcDisallows: <features>
435 Specify a set of features to disallow (default none).
437 disables acceptance of anonymous bind requests. Note that this setting
438 does not prohibit anonymous directory access (See "require authc").
440 disables simple (bind) authentication.
442 disables forcing session to anonymous status (see also
444 upon StartTLS operation receipt.
446 disallows the StartTLS operation if authenticated (see also
449 .B olcGentleHUP: { TRUE | FALSE }
450 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
452 will stop listening for new connections, but will not close the
453 connections to the current clients. Future write operations return
454 unwilling-to-perform, though. Slapd terminates when all clients
455 have closed their connections (if they ever do), or \- as before \-
456 if it receives a SIGTERM signal. This can be useful if you wish to
457 terminate the server and start a new
460 .B with another database,
461 without disrupting the currently active clients.
462 The default is FALSE. You may wish to use
464 along with this option.
466 .B olcIdleTimeout: <integer>
467 Specify the number of seconds to wait before forcibly closing
468 an idle client connection. A setting of 0 disables this
469 feature. The default is 0. You may also want to set the
473 .B olcIndexHash64: { on | off }
474 Use a 64 bit hash for indexing. The default is to use 32 bit hashes.
475 These hashes are used for equality and substring indexing. The 64 bit
476 version may be needed to avoid index collisions when the number of
477 indexed values exceeds ~64 million. (Note that substring indexing
478 generates multiple index values per actual attribute value.)
479 Indices generated with 32 bit hashes are incompatible with the 64 bit
480 version, and vice versa. Any existing databases must be fully reloaded
481 when changing this setting. This directive is only supported on 64 bit CPUs.
483 .B olcIndexIntLen: <integer>
484 Specify the key length for ordered integer indices. The most significant
485 bytes of the binary integer will be used for index keys. The default
486 value is 4, which provides exact indexing for 31 bit values.
487 A floating point representation is used to index too large values.
489 .B olcIndexSubstrIfMaxlen: <integer>
490 Specify the maximum length for subinitial and subfinal indices. Only
491 this many characters of an attribute value will be processed by the
492 indexing functions; any excess characters are ignored. The default is 4.
494 .B olcIndexSubstrIfMinlen: <integer>
495 Specify the minimum length for subinitial and subfinal indices. An
496 attribute value must have at least this many characters in order to be
497 processed by the indexing functions. The default is 2.
499 .B olcIndexSubstrAnyLen: <integer>
500 Specify the length used for subany indices. An attribute value must have
501 at least this many characters in order to be processed. Attribute values
502 longer than this length will be processed in segments of this length. The
503 default is 4. The subany index will also be used in subinitial and
504 subfinal index lookups when the filter string is longer than the
505 .I olcIndexSubstrIfMaxlen
508 .B olcIndexSubstrAnyStep: <integer>
509 Specify the steps used in subany index lookups. This value sets the offset
510 for the segments of a filter string that are processed for a subany index
511 lookup. The default is 2. For example, with the default values, a search
512 using this filter "cn=*abcdefgh*" would generate index lookups for
513 "abcd", "cdef", and "efgh".
516 Note: Indexing support depends on the particular backend in use. Also,
517 changing these settings will generally require deleting any indices that
518 depend on these parameters and recreating them with
522 .B olcListenerThreads: <integer>
523 Specify the number of threads to use for the connection manager.
524 The default is 1 and this is typically adequate for up to 16 CPU cores.
525 The value should be set to a power of 2.
527 .B olcLocalSSF: <SSF>
528 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
529 such as those to the ldapi:// listener. For a description of SSF values,
531 .BR olcSaslSecProps 's
533 option description. The default is 71.
535 .B olcLogFile: <filename>
536 Specify a file for recording debug log messages. By default these messages
537 only go to stderr and are not recorded anywhere else. Specifying a logfile
538 copies messages to both stderr and the logfile.
540 .B olcLogLevel: <integer> [...]
541 Specify the level at which debugging statements and operation
542 statistics should be syslogged (currently logged to the
544 LOG_LOCAL4 facility).
545 They must be considered subsystems rather than increasingly verbose
547 Some messages with higher priority are logged regardless
548 of the configured loglevel as soon as any logging is configured.
549 Log levels are additive, and available levels are:
560 debug packet handling
564 heavy trace debugging (function args)
568 connection management
572 print out packets sent and received
576 search filter processing
580 configuration file processing
584 access control list processing
588 stats log connections/operations/results
592 stats log entries sent
596 print communication with shell backends
608 \"data indexing (unused)
616 only messages that get logged whatever log level is set
619 The desired log level can be input as a single integer that combines
620 the (ORed) desired levels, both in decimal or in hexadecimal notation,
621 as a list of integers (that are ORed internally),
622 or as a list of the names that are shown between parenthesis, such that
628 olcLogLevel: 0x80 0x1
629 olcLogLevel: acl trace
635 can be used as a shortcut to enable logging at all levels (equivalent to \-1).
638 or the equivalent integer representation, causes those messages
639 that are logged regardless of the configured olcLogLevel to be logged.
640 In fact, if no olcLogLevel (or a 0 level) is defined, no logging occurs,
643 level is required to have high priority messages logged.
646 .B olcPasswordCryptSaltFormat: <format>
647 Specify the format of the salt passed to
649 when generating {CRYPT} passwords (see
650 .BR olcPasswordHash )
651 during processing of LDAP Password Modify Extended Operations (RFC 3062).
653 This string needs to be in
655 format and may include one (and only one) %s conversion.
656 This conversion will be substituted with a string of random
657 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
658 provides a two character salt and "$1$%.8s" tells some
659 versions of crypt(3) to use an MD5 algorithm and provides
660 8 random characters of salt. The default is "%s", which
661 provides 31 characters of salt.
663 .B olcPidFile: <filename>
664 The (absolute) name of a file that will hold the
666 server's process ID (see
669 .B olcPluginLogFile: <filename>
670 The ( absolute ) name of a file that will contain log
677 .B olcReferral: <url>
678 Specify the referral to pass back when
680 cannot find a local database to handle a request.
681 If multiple values are specified, each url is provided.
683 .B olcReverseLookup: TRUE | FALSE
684 Enable/disable client name unverified reverse lookup (default is
686 if compiled with \-\-enable\-rlookups).
688 .B olcRootDSE: <file>
689 Specify the name of an LDIF(5) file containing user defined attributes
690 for the root DSE. These attributes are returned in addition to the
691 attributes normally produced by slapd.
693 The root DSE is an entry with information about the server and its
694 capabilities, in operational attributes.
695 It has the empty DN, and can be read with e.g.:
697 ldapsearch \-x \-b "" \-s base "+"
699 See RFC 4512 section 5.1 for details.
701 .B olcSaslAuxprops: <plugin> [...]
702 Specify which auxprop plugins to use for authentication lookups. The
703 default is empty, which just uses slapd's internal support. Usually
704 no other auxprop plugins are needed.
706 .B olcSaslAuxpropsDontUseCopy: <attr> [...]
707 Specify which attribute(s) should be subject to the don't use copy control. This
708 is necessary for some SASL mechanisms such as OTP to work in a replicated
709 environment. The attribute "cmusaslsecretOTP" is the default value.
711 .B olcSaslAuxpropsDontUseCopyIgnore TRUE | FALSE
712 Used to disable replication of the attribute(s) defined by
713 olcSaslAuxpropsDontUseCopy and instead use a local value for the attribute. This
714 allows the SASL mechanism to continue to work if the master is offline. This can
715 cause replication inconsistency. Defaults to FALSE.
717 .B olcSaslHost: <fqdn>
718 Used to specify the fully qualified domain name used for SASL processing.
720 .B olcSaslRealm: <realm>
721 Specify SASL realm. Default is empty.
723 .B olcSaslSecProps: <properties>
724 Used to specify Cyrus SASL security properties.
727 flag (without any other properties) causes the flag properties
728 default, "noanonymous,noplain", to be cleared.
731 flag disables mechanisms susceptible to simple passive attacks.
734 flag disables mechanisms susceptible to active attacks.
737 flag disables mechanisms susceptible to passive dictionary attacks.
740 flag disables mechanisms which support anonymous login.
743 flag require forward secrecy between sessions.
746 require mechanisms which pass client credentials (and allow
747 mechanisms which can pass credentials to do so).
750 property specifies the minimum acceptable
751 .I security strength factor
752 as an integer approximate to effective key length used for
753 encryption. 0 (zero) implies no protection, 1 implies integrity
754 protection only, 56 allows DES or other weak ciphers, 112
755 allows triple DES and other strong ciphers, 128 allows RC4,
756 Blowfish and other modern strong ciphers. The default is 0.
759 property specifies the maximum acceptable
760 .I security strength factor
761 as an integer (see minssf description). The default is INT_MAX.
764 property specifies the maximum security layer receive buffer
765 size allowed. 0 disables security layers. The default is 65536.
767 .B olcServerID: <integer> [<URL>]
768 Specify an integer ID from 0 to 4095 for this server (limited
769 to 3 hexadecimal digits). The ID may also be specified as a
770 hexadecimal ID by prefixing the value with "0x".
772 required when using multimaster replication and each master must have a
773 unique non-zero ID. Note that this requirement also applies to separate masters
774 contributing to a glued set of databases.
775 If the URL is provided, this directive may be specified
776 multiple times, providing a complete list of participating servers
777 and their IDs. The fully qualified hostname of each server should be
778 used in the supplied URLs. The IDs are used in the "replica id" field
779 of all CSNs generated by the specified server. The default value is zero, which
780 is only valid for single master replication.
784 olcServerID: 1 ldap://ldap1.example.com
785 olcServerID: 2 ldap://ldap2.example.com
788 .B olcSockbufMaxIncoming: <integer>
789 Specify the maximum incoming LDAP PDU size for anonymous sessions.
790 The default is 262143.
792 .B olcSockbufMaxIncomingAuth: <integer>
793 Specify the maximum incoming LDAP PDU size for authenticated sessions.
794 The default is 4194303.
796 .B olcTCPBuffer [listener=<URL>] [{read|write}=]<size>
797 Specify the size of the TCP buffer.
798 A global value for both read and write TCP buffers related to any listener
799 is defined, unless the listener is explicitly specified,
800 or either the read or write qualifiers are used.
804 Note that some OS-es implement automatic TCP buffer tuning.
806 .B olcThreads: <integer>
807 Specify the maximum size of the primary thread pool.
808 The default is 16; the minimum value is 2.
810 .B olcThreadQueues: <integer>
811 Specify the number of work queues to use for the primary thread pool.
812 The default is 1 and this is typically adequate for up to 8 CPU cores.
813 The value should not exceed the number of CPUs in the system.
815 .B olcToolThreads: <integer>
816 Specify the maximum number of threads to use in tool mode.
817 This should not be greater than the number of CPUs in the system.
820 .B olcWriteTimeout: <integer>
821 Specify the number of seconds to wait before forcibly closing
822 a connection with an outstanding write. This allows recovery from
823 various network hang conditions. A setting of 0 disables this
824 feature. The default is 0.
828 is built with support for Transport Layer Security, there are more options
831 .B olcTLSCipherSuite: <cipher-suite-spec>
832 Permits configuring what ciphers will be accepted and the preference order.
833 <cipher-suite-spec> should be a cipher specification for
834 the TLS library in use (OpenSSL, GnuTLS, or Mozilla NSS).
840 olcTLSCipherSuite: HIGH:MEDIUM:+SSLv2
843 olcTLSCiphersuite: SECURE256:!AES-128-CBC
846 To check what ciphers a given spec selects in OpenSSL, use:
849 openssl ciphers \-v <cipher-suite-spec>
852 With GnuTLS the available specs can be found in the manual page of
854 (see the description of the
858 In older versions of GnuTLS, where gnutls\-cli does not support the option
859 \-\-priority, you can obtain the \(em more limited \(em list of ciphers by calling:
865 When using Mozilla NSS, the OpenSSL cipher suite specifications are used and
866 translated into the format used internally by Mozilla NSS. There isn't an easy
867 way to list the cipher suites from the command line. The authoritative list
868 is in the source code for Mozilla NSS in the file sslinfo.c in the structure
870 static const SSLCipherSuiteInfo suiteInfo[]
874 .B olcTLSCACertificateFile: <filename>
875 Specifies the file that contains certificates for all of the Certificate
880 .B olcTLSCACertificatePath: <path>
881 Specifies the path of a directory that contains Certificate Authority
882 certificates in separate individual files. Usually only one of this
883 or the olcTLSCACertificateFile is defined. If both are specified, both
884 locations will be used. This directive is not supported
887 When using Mozilla NSS, <path> may contain a Mozilla NSS cert/key
888 database. If <path> contains a Mozilla NSS cert/key database and
889 CA cert files, OpenLDAP will use the cert/key database and will
890 ignore the CA cert files.
892 .B olcTLSCertificateFile: <filename>
893 Specifies the file that contains the
897 When using Mozilla NSS, if using a cert/key database (specified with
898 olcTLSCACertificatePath), olcTLSCertificateFile specifies
899 the name of the certificate to use:
901 olcTLSCertificateFile: Server-Cert
903 If using a token other than the internal built in token, specify the
904 token name first, followed by a colon:
906 olcTLSCertificateFile: my hardware device:Server-Cert
908 Use certutil \-L to list the certificates by name:
910 certutil \-d /path/to/certdbdir \-L
913 .B olcTLSCertificateKeyFile: <filename>
914 Specifies the file that contains the
916 server private key that matches the certificate stored in the
917 .B olcTLSCertificateFile
918 file. If the private key is protected with a password, the password must
919 be manually typed in when slapd starts. Usually the private key is not
920 protected with a password, to allow slapd to start without manual
922 it is of critical importance that the file is protected carefully.
924 When using Mozilla NSS, olcTLSCertificateKeyFile specifies the name of
925 a file that contains the password for the key for the certificate specified with
926 olcTLSCertificateFile. The modutil command can be used to turn off password
927 protection for the cert/key database. For example, if olcTLSCACertificatePath
928 specifies /etc/openldap/certdb as the location of the cert/key database, use
929 modutil to change the password to the empty string:
931 modutil \-dbdir /etc/openldap/certdb \-changepw 'NSS Certificate DB'
933 You must have the old password, if any. Ignore the WARNING about the running
934 browser. Press 'Enter' for the new password.
937 .B olcTLSDHParamFile: <filename>
938 This directive specifies the file that contains parameters for Diffie-Hellman
939 ephemeral key exchange. This is required in order to use a DSA certificate on
940 the server, or an RSA certificate missing the "key encipherment" key usage.
941 Note that setting this option may also enable
942 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
943 Anonymous key exchanges should generally be avoided since they provide no
944 actual client or server authentication and provide no protection against
945 man-in-the-middle attacks.
946 You should append "!ADH" to your cipher suites to ensure that these suites
948 When using Mozilla NSS these parameters are always generated randomly
949 so this directive is ignored.
951 .B olcTLSECName: <name>
952 Specify the name of a curve to use for Elliptic curve Diffie-Hellman
953 ephemeral key exchange. This is required to enable ECDHE algorithms in
954 OpenSSL. This option is not used with GnuTLS; the curves may be
955 chosen in the GnuTLS ciphersuite specification. This option is also
956 ignored for Mozilla NSS.
958 .B olcTLSProtocolMin: <major>[.<minor>]
959 Specifies minimum SSL/TLS protocol version that will be negotiated.
960 If the server doesn't support at least that version,
961 the SSL handshake will fail.
962 To require TLS 1.x or higher, set this option to 3.(x+1),
966 olcTLSProtocolMin: 3.2
969 would require TLS 1.1.
970 Specifying a minimum that is higher than that supported by the
971 OpenLDAP implementation will result in it requiring the
972 highest level that it does support.
973 This directive is ignored with GnuTLS.
975 .B olcTLSRandFile: <filename>
976 Specifies the file to obtain random bits from when /dev/[u]random
977 is not available. Generally set to the name of the EGD/PRNGD socket.
978 The environment variable RANDFILE can also be used to specify the filename.
979 This directive is ignored with GnuTLS and Mozilla NSS.
981 .B olcTLSVerifyClient: <level>
982 Specifies what checks to perform on client certificates in an
983 incoming TLS session, if any.
986 can be specified as one of the following keywords:
992 will not ask the client for a certificate.
995 The client certificate is requested. If no certificate is provided,
996 the session proceeds normally. If a bad certificate is provided,
997 it will be ignored and the session proceeds normally.
1000 The client certificate is requested. If no certificate is provided,
1001 the session proceeds normally. If a bad certificate is provided,
1002 the session is immediately terminated.
1004 .B demand | hard | true
1005 These keywords are all equivalent, for compatibility reasons.
1006 The client certificate is requested. If no certificate is provided,
1007 or a bad certificate is provided, the session is immediately terminated.
1009 Note that a valid client certificate is required in order to use the
1010 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1012 .B olcTLSVerifyClient
1013 setting must be chosen to enable SASL EXTERNAL authentication.
1016 .B olcTLSCRLCheck: <level>
1017 Specifies if the Certificate Revocation List (CRL) of the CA should be
1018 used to verify if the client certificates have not been revoked. This
1020 .B olcTLSCACertificatePath
1021 parameter to be set. This parameter is ignored with GnuTLS and Mozilla NSS.
1023 can be specified as one of the following keywords:
1027 No CRL checks are performed
1030 Check the CRL of the peer certificate
1033 Check the CRL for a whole certificate chain
1036 .B olcTLSCRLFile: <filename>
1037 Specifies a file containing a Certificate Revocation List to be used
1038 for verifying that certificates have not been revoked. This parameter
1039 is only valid when using GnuTLS or Mozilla NSS.
1040 .SH DYNAMIC MODULE OPTIONS
1043 is compiled with \-\-enable\-modules then the module-related entries will
1044 be available. These entries are named
1045 .B cn=module{x},cn=config
1047 must have the olcModuleList objectClass. One entry should be created
1050 Normally the config engine generates the "{x}" index in the RDN
1051 automatically, so it can be omitted when initially loading these entries.
1053 .B olcModuleLoad: <filename>
1054 Specify the name of a dynamically loadable module to load. The filename
1055 may be an absolute path name or a simple filename. Non-absolute names
1056 are searched for in the directories specified by the
1060 .B olcModulePath: <pathspec>
1061 Specify a list of directories to search for loadable modules. Typically
1062 the path is colon-separated but this depends on the operating system.
1063 The default is MODULEDIR, which is where the standard OpenLDAP install
1064 will place its modules.
1066 Schema definitions are created as entries in the
1067 .B cn=schema,cn=config
1068 subtree. These entries must have the olcSchemaConfig objectClass.
1069 As noted above, the actual
1070 .B cn=schema,cn=config
1071 entry is predefined and any values specified for it are ignored.
1075 .B olcAttributetypes: "(\ <oid>\
1077 [DESC\ <description>]\
1086 [NO\-USER\-MODIFICATION]\
1087 [USAGE\ <attributeUsage>]\ )"
1089 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
1090 The slapd parser extends the RFC 4512 definition by allowing string
1091 forms as well as numeric OIDs to be used for the attribute OID and
1092 attribute syntax OID.
1094 .B olcObjectIdentifier
1100 .B olcDitContentRules: "(\ <oid>\
1102 [DESC\ <description>]\
1109 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
1110 The slapd parser extends the RFC 4512 definition by allowing string
1111 forms as well as numeric OIDs to be used for the attribute OID and
1112 attribute syntax OID.
1114 .B olcObjectIdentifier
1120 .B olcObjectClasses: "(\ <oid>\
1122 [DESC\ <description>]\
1125 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
1126 [MUST\ <oids>] [MAY\ <oids>] )"
1128 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
1129 The slapd parser extends the RFC 4512 definition by allowing string
1130 forms as well as numeric OIDs to be used for the object class OID.
1134 description.) Object classes are "STRUCTURAL" by default.
1137 .B olcObjectIdentifier: <name> "{ <oid> | <name>[:<suffix>] }"
1138 Define a string name that equates to the given OID. The string can be used
1139 in place of the numeric OID in objectclass and attribute definitions. The
1140 name can also be used with a suffix of the form ":xx" in which case the
1141 value "oid.xx" will be used.
1143 .SH GENERAL BACKEND OPTIONS
1144 Options in these entries only apply to the configuration of a single
1145 type of backend. All backends may support this class of options, but
1147 The entry must be named
1148 .B olcBackend=<databasetype>,cn=config
1149 and must have the olcBackendConfig objectClass.
1169 At present, no backend implements any options of this type, so this
1170 entry should not be used.
1172 .SH DATABASE OPTIONS
1173 Database options are set in entries named
1174 .B olcDatabase={x}<databasetype>,cn=config
1175 and must have the olcDatabaseConfig objectClass. Normally the config
1176 engine generates the "{x}" index in the RDN automatically, so it
1177 can be omitted when initially loading these entries.
1179 The special frontend database is always numbered "{\-1}" and the config
1180 database is always numbered "{0}".
1182 .SH GLOBAL DATABASE OPTIONS
1183 Options in this section may be set in the special "frontend" database
1184 and inherited in all the other databases. These options may be altered
1185 by further settings in each specific database. The frontend entry must
1187 .B olcDatabase=frontend,cn=config
1188 and must have the olcFrontendConfig objectClass.
1190 .B olcAccess: to <what> "[ by <who> <access> <control> ]+"
1191 Grant access (specified by <access>) to a set of entries and/or
1192 attributes (specified by <what>) by one or more requestors (specified
1194 If no access controls are present, the default policy
1195 allows anyone and everyone to read anything but restricts
1196 updates to rootdn. (e.g., "olcAccess: to * by * read").
1198 .BR slapd.access (5)
1199 and the "OpenLDAP Administrator's Guide" for details.
1201 Access controls set in the frontend are appended to any access
1202 controls set on the specific databases.
1203 The rootdn of a database can always read and write EVERYTHING
1206 Extra special care must be taken with the access controls on the
1207 config database. Unlike other databases, the default policy for the
1208 config database is to only allow access to the rootdn. Regular users
1209 should not have read access, and write access should be granted very
1210 carefully to privileged administrators.
1213 .B olcDefaultSearchBase: <dn>
1214 Specify a default search base to use when client submits a
1215 non-base search request with an empty base DN.
1216 Base scoped search requests with an empty base DN are not affected.
1217 This setting is only allowed in the frontend entry.
1219 .B olcExtraAttrs: <attr>
1220 Lists what attributes need to be added to search requests.
1221 Local storage backends return the entire entry to the frontend.
1222 The frontend takes care of only returning the requested attributes
1223 that are allowed by ACLs.
1224 However, features like access checking and so may need specific
1225 attributes that are not automatically returned by remote storage
1226 backends, like proxy backends and so on.
1228 is an attribute that is needed for internal purposes
1229 and thus always needs to be collected, even when not explicitly
1230 requested by clients.
1231 This attribute is multi-valued.
1233 .B olcPasswordHash: <hash> [<hash>...]
1234 This option configures one or more hashes to be used in generation of user
1235 passwords stored in the userPassword attribute during processing of
1236 LDAP Password Modify Extended Operations (RFC 3062).
1237 The <hash> must be one of
1251 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
1256 use the MD5 algorithm (RFC 1321), the latter with a seed.
1263 indicates that the new password should be
1264 added to userPassword as clear text.
1266 Note that this option does not alter the normal user applications
1267 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
1268 This setting is only allowed in the frontend entry.
1270 .B olcReadOnly: TRUE | FALSE
1271 This option puts the database into "read-only" mode. Any attempts to
1272 modify the database will return an "unwilling to perform" error. By
1273 default, olcReadOnly is FALSE. Note that when this option is set
1274 TRUE on the frontend, it cannot be reset without restarting the
1275 server, since further writes to the config database will be rejected.
1277 .B olcRequires: <conditions>
1278 Specify a set of conditions to require (default none).
1279 The directive may be specified globally and/or per-database;
1280 databases inherit global conditions, so per-database specifications
1283 requires bind operation prior to directory operations.
1285 requires session to be using LDAP version 3.
1287 requires authentication prior to directory operations.
1289 requires SASL authentication prior to directory operations.
1291 requires strong authentication prior to directory operations.
1292 The strong keyword allows protected "simple" authentication
1293 as well as SASL authentication.
1295 may be used to require no conditions (useful to clear out globally
1296 set conditions within a particular database); it must occur first
1297 in the list of conditions.
1299 .B olcRestrict: <oplist>
1300 Specify a list of operations that are restricted.
1301 Restrictions on a specific database override any frontend setting.
1302 Operations can be any of
1307 .BR extended[=<OID>] ,
1311 or the special pseudo-operations
1315 which respectively summarize read and write operations.
1319 .I olcReadOnly: TRUE
1323 keyword allows one to indicate the OID of the specific operation
1326 .B olcSchemaDN: <dn>
1327 Specify the distinguished name for the subschema subentry that
1328 controls the entries on this server. The default is "cn=Subschema".
1330 .B olcSecurity: <factors>
1331 Specify a set of security strength factors (separated by white space)
1333 .BR olcSaslSecprops 's
1335 option for a description of security strength factors).
1336 The directive may be specified globally and/or per-database.
1338 specifies the overall security strength factor.
1340 specifies the transport security strength factor.
1342 specifies the TLS security strength factor.
1344 specifies the SASL security strength factor.
1346 specifies the overall security strength factor to require for
1348 .B update_transport=<n>
1349 specifies the transport security strength factor to require for
1352 specifies the TLS security strength factor to require for
1355 specifies the SASL security strength factor to require for
1358 specifies the security strength factor required for
1360 username/password authentication.
1363 factor is measure of security provided by the underlying transport,
1364 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
1366 .B olcSizeLimit: {<integer>|unlimited}
1368 .B olcSizeLimit: size[.{soft|hard|unchecked}]=<integer> [...]
1369 Specify the maximum number of entries to return from a search operation.
1370 The default size limit is 500.
1373 to specify no limits.
1374 The second format allows a fine grain setting of the size limits.
1375 Extra args can be added in the same value or as additional values.
1378 for an explanation of the different flags.
1380 .B olcSortVals: <attr> [...]
1381 Specify a list of multi-valued attributes whose values will always
1382 be maintained in sorted order. Using this option will allow Modify,
1383 Compare, and filter evaluations on these attributes to be performed
1384 more efficiently. The resulting sort order depends on the
1385 attributes' syntax and matching rules and may not correspond to
1386 lexical order or any other recognizable order.
1387 This setting is only allowed in the frontend entry.
1389 .B olcTimeLimit: {<integer>|unlimited}
1391 .B olcTimeLimit: time[.{soft|hard}]=<integer> [...]
1392 Specify the maximum number of seconds (in real time)
1394 will spend answering a search request. The default time limit is 3600.
1397 to specify no limits.
1398 The second format allows a fine grain setting of the time limits.
1399 Extra args can be added in the same value or as additional values.
1402 for an explanation of the different flags.
1404 .SH GENERAL DATABASE OPTIONS
1405 Options in this section only apply to the specific database for
1406 which they are defined. They are supported by every
1407 type of backend. All of the Global Database Options may also be
1410 .B olcAddContentAcl: TRUE | FALSE
1411 Controls whether Add operations will perform ACL checks on
1412 the content of the entry being added. This check is off
1414 .BR slapd.access (5)
1415 manual page for more details on ACL requirements for
1418 .B olcHidden: TRUE | FALSE
1419 Controls whether the database will be used to answer
1420 queries. A database that is hidden will never be
1421 selected to answer any queries, and any suffix configured
1422 on the database will be ignored in checks for conflicts
1423 with other databases. By default, olcHidden is FALSE.
1425 .B olcLastMod: TRUE | FALSE
1428 will automatically maintain the
1429 modifiersName, modifyTimestamp, creatorsName, and
1430 createTimestamp attributes for entries. It also controls
1431 the entryCSN and entryUUID attributes, which are needed
1432 by the syncrepl provider. By default, olcLastMod is TRUE.
1434 .B olcLimits: <selector> <limit> [<limit> [...]]
1435 Specify time and size limits based on the operation's initiator or
1443 anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>
1449 <dnspec> ::= dn[.<type>][.<style>]
1451 <type> ::= self | this
1453 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1458 is the default and means the bound user, while
1460 means the base DN of the operation.
1463 matches all unauthenticated clients.
1466 matches all authenticated clients;
1469 dn pattern is assumed unless otherwise specified by qualifying
1470 the (optional) key string
1476 (which are synonyms), to require an exact match; with
1478 to require exactly one level of depth match; with
1480 to allow any level of depth match, including the exact match; with
1482 to allow any level of depth match, not including the exact match;
1484 explicitly requires the (default) match based on POSIX (''extended'')
1485 regular expression pattern.
1488 matches unbound operations; the
1491 The same behavior is obtained by using the
1498 with the optional objectClass
1504 sets the limits for any DN listed in the values of the
1510 group objectClass (default
1512 whose DN exactly matches
1515 The currently supported limits are
1520 The syntax for time limits is
1521 .BR time[.{soft|hard}]=<integer> ,
1524 is the number of seconds slapd will spend answering a search request.
1525 If no time limit is explicitly requested by the client, the
1527 limit is used; if the requested time limit exceeds the
1530 .\".I "Administrative limit exceeded"
1531 .\"error is returned.
1532 limit, the value of the limit is used instead.
1535 limit is set to the keyword
1537 the soft limit is used in either case; if it is set to the keyword
1539 no hard limit is enforced.
1540 Explicit requests for time limits smaller or equal to the
1543 If no limit specifier is set, the value is assigned to the
1549 to preserve the original behavior.
1551 The syntax for size limits is
1552 .BR size[.{soft|hard|unchecked}]=<integer> ,
1555 is the maximum number of entries slapd will return answering a search
1557 If no size limit is explicitly requested by the client, the
1559 limit is used; if the requested size limit exceeds the
1562 .\".I "Administrative limit exceeded"
1563 .\"error is returned.
1564 limit, the value of the limit is used instead.
1567 limit is set to the keyword
1569 the soft limit is used in either case; if it is set to the keyword
1571 no hard limit is enforced.
1572 Explicit requests for size limits smaller or equal to the
1577 specifier sets a limit on the number of candidates a search request is allowed
1579 The rationale behind it is that searches for non-properly indexed
1580 attributes may result in large sets of candidates, which must be
1583 to determine whether they match the search filter or not.
1586 limit provides a means to drop such operations before they are even
1588 If the selected candidates exceed the
1590 limit, the search will abort with
1591 .IR "Unwilling to perform" .
1592 If it is set to the keyword
1594 no limit is applied (the default).
1597 the search is not even performed; this can be used to disallow searches
1598 for a specific set of users.
1599 If no limit specifier is set, the value is assigned to the
1605 to preserve the original behavior.
1607 In case of no match, the global limits are used.
1608 The default values are the same as for
1617 control is requested, the
1619 size limit is used by default, because the request of a specific page size
1620 is considered an explicit request for a limitation on the number
1621 of entries to be returned.
1622 However, the size limit applies to the total count of entries returned within
1623 the search, and not to a single page.
1624 Additional size limits may be enforced; the syntax is
1625 .BR size.pr={<integer>|noEstimate|unlimited} ,
1628 is the max page size if no explicit limit is set; the keyword
1630 inhibits the server from returning an estimate of the total number
1631 of entries that might be returned
1632 (note: the current implementation does not return any estimate).
1635 indicates that no limit is applied to the pagedResults control page size.
1637 .B size.prtotal={<integer>|unlimited|disabled}
1638 allows one to set a limit on the total number of entries that the pagedResults
1639 control will return.
1640 By default it is set to the
1645 is the max number of entries that the whole search with pagedResults control
1649 to allow unlimited number of entries to be returned, e.g. to allow
1650 the use of the pagedResults control as a means to circumvent size
1651 limitations on regular searches; the keyword
1653 disables the control, i.e. no paged results can be returned.
1654 Note that the total number of entries returned when the pagedResults control
1655 is requested cannot exceed the
1657 size limit of regular searches unless extended by the
1662 .B olcMaxDerefDepth: <depth>
1663 Specifies the maximum number of aliases to dereference when trying to
1664 resolve an entry, used to avoid infinite alias loops. The default is 15.
1666 .B olcMirrorMode: TRUE | FALSE
1667 This option puts a replica database into "mirror" mode. Update
1668 operations will be accepted from any user, not just the updatedn. The
1669 database must already be configured as syncrepl consumer
1670 before this keyword may be set. This mode also requires a
1672 (see above) to be configured.
1673 By default, this setting is FALSE.
1675 .B olcPlugin: <plugin_type> <lib_path> <init_function> [<arguments>]
1676 Configure a SLAPI plugin. See the
1677 .BR slapd.plugin (5)
1678 manpage for more details.
1681 Specify the distinguished name that is not subject to access control
1682 or administrative limit restrictions for operations on this database.
1683 This DN may or may not be associated with an entry. An empty root
1684 DN (the default) specifies no root access is to be granted. It is
1685 recommended that the rootdn only be specified when needed (such as
1686 when initially populating a database). If the rootdn is within
1687 a namingContext (suffix) of the database, a simple bind password
1688 may also be provided using the
1690 directive. Note that the rootdn is always needed when using syncrepl.
1695 database defaults to
1699 .B olcRootPW: <password>
1700 Specify a password (or hash of the password) for the rootdn. The
1701 password can only be set if the rootdn is within the namingContext
1702 (suffix) of the database.
1703 This option accepts all RFC 2307 userPassword formats known to
1706 description) as well as cleartext.
1708 may be used to generate a hash of a password. Cleartext
1709 and \fB{CRYPT}\fP passwords are not recommended. If empty
1710 (the default), authentication of the root DN is by other means
1711 (e.g. SASL). Use of SASL is encouraged.
1713 .B olcSubordinate: [TRUE | FALSE | advertise]
1714 Specify that the current backend database is a subordinate of another
1715 backend database. A subordinate database may have only one suffix. This
1716 option may be used to glue multiple databases into a single namingContext.
1717 If the suffix of the current database is within the namingContext of a
1718 superior database, searches against the superior database will be
1719 propagated to the subordinate as well. All of the databases
1720 associated with a single namingContext should have identical rootdns.
1721 Behavior of other LDAP operations is unaffected by this setting. In
1722 particular, it is not possible to use moddn to move an entry from
1723 one subordinate to another subordinate within the namingContext.
1725 If the optional \fBadvertise\fP flag is supplied, the naming context of
1726 this database is advertised in the root DSE. The default is to hide this
1727 database context, so that only the superior context is visible.
1734 are used on the superior database, any glued subordinates that support
1735 these tools are opened as well.
1737 Databases that are glued together should usually be configured with the
1738 same indices (assuming they support indexing), even for attributes that
1739 only exist in some of these databases. In general, all of the glued
1740 databases should be configured as similarly as possible, since the intent
1741 is to provide the appearance of a single directory.
1743 Note that the subordinate functionality is implemented internally
1744 by the \fIglue\fP overlay and as such its behavior will interact with other
1745 overlays in use. By default, the glue overlay is automatically configured as
1746 the last overlay on the superior database. Its position on the database
1747 can be explicitly configured by setting an \fBoverlay glue\fP directive
1748 at the desired position. This explicit configuration is necessary e.g.
1749 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1750 in order to work over all of the glued databases. E.g.
1753 dn: olcDatabase={1}mdb,cn=config
1754 olcSuffix: dc=example,dc=com
1757 dn: olcOverlay={0}glue,olcDatabase={1}mdb,cn=config
1760 dn: olcOverlay={1}syncprov,olcDatabase={1}mdb,cn=config
1764 See the Overlays section below for more details.
1766 .B olcSuffix: <dn suffix>
1767 Specify the DN suffix of queries that will be passed to this
1768 backend database. Multiple suffix lines can be given and at least one is
1769 required for each database definition.
1771 If the suffix of one database is "inside" that of another, the database
1772 with the inner suffix must come first in the configuration file.
1773 You may also want to glue such databases together with the
1777 .B olcSyncUseSubentry: TRUE | FALSE
1778 Store the syncrepl contextCSN in a subentry instead of the context entry
1779 of the database. The subentry's RDN will be "cn=ldapsync". The default is
1780 FALSE, meaning the contextCSN is stored in the context entry.
1783 .B olcSyncrepl: rid=<replica ID>
1784 .B provider=ldap[s]://<hostname>[:port]
1785 .B searchbase=<base DN>
1786 .B [type=refreshOnly|refreshAndPersist]
1787 .B [interval=dd:hh:mm:ss]
1788 .B [retry=[<retry interval> <# of retries>]+]
1789 .B [filter=<filter str>]
1790 .B [scope=sub|one|base|subord]
1791 .B [attrs=<attr list>]
1792 .B [exattrs=<attr list>]
1794 .B [sizelimit=<limit>]
1795 .B [timelimit=<limit>]
1796 .B [schemachecking=on|off]
1797 .B [network\-timeout=<seconds>]
1798 .B [timeout=<seconds>]
1799 .B [bindmethod=simple|sasl]
1801 .B [saslmech=<mech>]
1802 .B [authcid=<identity>]
1803 .B [authzid=<identity>]
1804 .B [credentials=<passwd>]
1806 .B [secprops=<properties>]
1807 .B [keepalive=<idle>:<probes>:<interval>]
1808 .B [starttls=yes|critical]
1809 .B [tls_cert=<file>]
1811 .B [tls_cacert=<file>]
1812 .B [tls_cacertdir=<path>]
1813 .B [tls_reqcert=never|allow|try|demand]
1814 .B [tls_cipher_suite=<ciphers>]
1815 .B [tls_crlcheck=none|peer|all]
1816 .B [tls_protocol_min=<major>[.<minor>]]
1817 .B [suffixmassage=<real DN>]
1818 .B [logbase=<base DN>]
1819 .B [logfilter=<filter str>]
1820 .B [syncdata=default|accesslog|changelog]
1823 Specify the current database as a replica which is kept up-to-date with the
1824 master content by establishing the current
1826 as a replication consumer site running a
1829 The replica content is kept synchronized to the master content using
1830 the LDAP Content Synchronization protocol. Refer to the
1831 "OpenLDAP Administrator's Guide" for detailed information on
1832 setting up a replicated
1834 directory service using the
1839 identifies the current
1841 directive within the replication consumer site.
1842 It is a non-negative integer having no more than three decimal digits.
1845 specifies the replication provider site containing the master content
1846 as an LDAP URI. If <port> is not given, the standard LDAP port number
1847 (389 or 636) is used.
1851 replica is defined using a search
1852 specification as its result set. The consumer
1854 will send search requests to the provider
1856 according to the search specification. The search specification includes
1857 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1860 parameters as in the normal search specification. The
1862 option may also be used to specify attributes that should be omitted
1863 from incoming entries.
1864 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1865 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1866 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1867 attributes, and \fBattrsonly\fP and \fBexattrs\fP are unset by default.
1868 The \fBsizelimit\fP and \fBtimelimit\fP only
1869 accept "unlimited" and positive integers, and both default to "unlimited".
1870 Note, however, that any provider-side limits for the replication identity
1871 will be enforced by the provider regardless of the limits requested
1872 by the LDAP Content Synchronization operation, much like for any other
1875 The LDAP Content Synchronization protocol has two operation types.
1878 operation, the next synchronization search operation
1879 is periodically rescheduled at an interval time (specified by
1881 parameter; 1 day by default)
1882 after each synchronization operation finishes.
1884 .B refreshAndPersist
1885 operation, a synchronization search remains persistent in the provider slapd.
1886 Further updates to the master replica will generate
1887 .B searchResultEntry
1888 to the consumer slapd as the search responses to the persistent
1889 synchronization search. If the initial search fails due to an error, the
1890 next synchronization search operation is periodically rescheduled at an
1891 interval time (specified by
1893 parameter; 1 day by default)
1895 If an error occurs during replication, the consumer will attempt to
1896 reconnect according to the
1898 parameter which is a list of the <retry interval> and <# of retries> pairs.
1899 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1900 for the first 10 times and then retry every 300 seconds for the next 3
1901 times before stop retrying. The `+' in <# of retries> means indefinite
1902 number of retries until success.
1904 The schema checking can be enforced at the LDAP Sync
1905 consumer site by turning on the
1907 parameter. The default is off.
1911 parameter sets how long the consumer will wait to establish a
1912 network connection to the provider. Once a connection is
1915 parameter determines how long the consumer will wait for the initial
1916 Bind request to complete. The defaults for these parameters come
1924 requires the options
1928 and should only be used when adequate security services
1929 (e.g. TLS or IPSEC) are in place.
1936 Depending on the mechanism, an authentication identity and/or
1937 credentials can be specified using
1943 parameter may be used to specify an authorization identity.
1944 Specific security properties (as with the
1946 keyword above) for a SASL bind can be set with the
1948 option. A non default SASL realm can be set with the
1951 The provider, other than allow authentication of the syncrepl identity,
1952 should grant that identity appropriate access privileges to the data
1953 that is being replicated (\fBaccess\fP directive), and appropriate time
1954 and size limits (\fBlimits\fP directive).
1958 parameter sets the values of \fIidle\fP, \fIprobes\fP, and \fIinterval\fP
1959 used to check whether a socket is alive;
1961 is the number of seconds a connection needs to remain idle before TCP
1962 starts sending keepalive probes;
1964 is the maximum number of keepalive probes TCP should send before dropping
1967 is interval in seconds between individual keepalive probes.
1968 Only some systems support the customization of these values;
1971 parameter is ignored otherwise, and system-wide settings are used.
1975 parameter specifies use of the StartTLS extended operation
1976 to establish a TLS session before Binding to the provider. If the
1978 argument is supplied, the session will be aborted if the StartTLS request
1979 fails. Otherwise the syncrepl session continues without TLS. The
1980 tls_reqcert setting defaults to "demand" and the other TLS settings
1981 default to the same as the main slapd TLS settings.
1985 parameter allows the consumer to pull entries from a remote directory
1986 whose DN suffix differs from the local directory. The portion of the
1987 remote entries' DNs that matches the \fIsearchbase\fP will be replaced
1988 with the suffixmassage DN.
1990 Rather than replicating whole entries, the consumer can query logs of
1991 data modifications. This mode of operation is referred to as \fIdelta
1992 syncrepl\fP. In addition to the above parameters, the
1996 parameters must be set appropriately for the log that will be used. The
1998 parameter must be set to either "accesslog" if the log conforms to the
1999 .BR slapo\-accesslog (5)
2000 log format, or "changelog" if the log conforms
2001 to the obsolete \fIchangelog\fP format. If the
2003 parameter is omitted or set to "default" then the log parameters are
2008 parameter tells the underlying database that it can store changes without
2009 performing a full flush after each change. This may improve performance
2010 for the consumer, while sacrificing safety or durability.
2013 .B olcUpdateDN: <dn>
2014 This option is only applicable in a slave
2016 It specifies the DN permitted to update (subject to access controls)
2017 the replica. It is only needed in certain push-mode
2018 replication scenarios. Generally, this DN
2024 .B olcUpdateRef: <url>
2025 Specify the referral to pass back when
2027 is asked to modify a replicated local database.
2028 If multiple values are specified, each url is provided.
2030 .SH DATABASE-SPECIFIC OPTIONS
2031 Each database may allow specific configuration options; they are
2032 documented separately in the backends' manual pages. See the
2033 .BR slapd.backends (5)
2034 manual page for an overview of available backends.
2036 An overlay is a piece of
2037 code that intercepts database operations in order to extend or change
2038 them. Overlays are pushed onto
2039 a stack over the database, and so they will execute in the reverse
2040 of the order in which they were configured and the database itself
2041 will receive control last of all.
2043 Overlays must be configured as child entries of a specific database. The
2044 entry's RDN must be of the form
2045 .B olcOverlay={x}<overlaytype>
2046 and the entry must have the olcOverlayConfig objectClass. Normally the
2047 config engine generates the "{x}" index in the RDN automatically, so
2048 it can be omitted when initially loading these entries.
2051 .BR slapd.overlays (5)
2052 manual page for an overview of available overlays.
2055 Here is a short example of a configuration in LDIF suitable for use with
2062 objectClass: olcGlobal
2064 olcPidFile: LOCALSTATEDIR/run/slapd.pid
2065 olcAttributeOptions: x\-hidden lang\-
2067 dn: cn=schema,cn=config
2068 objectClass: olcSchemaConfig
2071 include: file://SYSCONFDIR/schema/core.ldif
2073 dn: olcDatabase=frontend,cn=config
2074 objectClass: olcDatabaseConfig
2075 objectClass: olcFrontendConfig
2076 olcDatabase: frontend
2077 # Subtypes of "name" (e.g. "cn" and "ou") with the
2078 # option ";x\-hidden" can be searched for/compared,
2079 # but are not shown. See \fBslapd.access\fP(5).
2080 olcAccess: to attrs=name;x\-hidden by * =cs
2081 # Protect passwords. See \fBslapd.access\fP(5).
2082 olcAccess: to attrs=userPassword by * auth
2083 # Read access to other attributes and entries.
2084 olcAccess: to * by * read
2086 # set a rootpw for the config database so we can bind.
2087 # deny access to everyone else.
2088 dn: olcDatabase=config,cn=config
2089 objectClass: olcDatabaseConfig
2091 olcRootPW: {SSHA}XKYnrjvGT3wZFQrDD5040US592LxsdLy
2092 olcAccess: to * by * none
2094 dn: olcDatabase=bdb,cn=config
2095 objectClass: olcDatabaseConfig
2096 objectClass: olcBdbConfig
2098 olcSuffix: "dc=our\-domain,dc=com"
2099 # The database directory MUST exist prior to
2100 # running slapd AND should only be accessible
2101 # by the slapd/tools. Mode 0700 recommended.
2102 olcDbDirectory: LOCALSTATEDIR/openldap\-data
2103 # Indices to maintain
2104 olcDbIndex: objectClass eq
2105 olcDbIndex: cn,sn,mail pres,eq,approx,sub
2107 # We serve small clients that do not handle referrals,
2108 # so handle remote lookups on their behalf.
2109 dn: olcDatabase=ldap,cn=config
2110 objectClass: olcDatabaseConfig
2111 objectClass: olcLdapConfig
2114 olcDbUri: ldap://ldap.some\-server.com/
2118 Assuming the above data was saved in a file named "config.ldif" and the
2119 ETCDIR/slapd.d directory has been created, this command will initialize
2123 slapadd \-F ETCDIR/slapd.d \-n 0 \-l config.ldif
2128 "OpenLDAP Administrator's Guide" contains a longer annotated
2129 example of a slapd configuration.
2131 Alternatively, an existing slapd.conf file can be converted to the new
2132 format using slapd or any of the slap tools:
2135 slaptest \-f ETCDIR/slapd.conf \-F ETCDIR/slapd.d
2142 default slapd configuration file
2145 default slapd configuration directory
2149 .BR gnutls\-cli (1),
2150 .BR slapd.access (5),
2151 .BR slapd.backends (5),
2153 .BR slapd.overlays (5),
2154 .BR slapd.plugin (5),
2165 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
2166 .SH ACKNOWLEDGEMENTS