1 .TH SLAPD-CONFIG 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2011 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 olcExtraAttrs: <attr>
450 Lists what attributes need to be added to search requests.
451 Local storage backends return the entire entry to the frontend.
452 The frontend takes care of only returning the requested attributes
453 that are allowed by ACLs.
454 However, features like access checking and so may need specific
455 attributes that are not automatically returned by remote storage
456 backends, like proxy backends and so on.
458 is an attribute that is needed for internal purposes
459 and thus always needs to be collected, even when not explicitly
460 requested by clients.
461 This attribute is multi-valued.
463 .B olcGentleHUP: { TRUE | FALSE }
464 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
466 will stop listening for new connections, but will not close the
467 connections to the current clients. Future write operations return
468 unwilling-to-perform, though. Slapd terminates when all clients
469 have closed their connections (if they ever do), or - as before -
470 if it receives a SIGTERM signal. This can be useful if you wish to
471 terminate the server and start a new
474 .B with another database,
475 without disrupting the currently active clients.
476 The default is FALSE. You may wish to use
478 along with this option.
480 .B olcIdleTimeout: <integer>
481 Specify the number of seconds to wait before forcibly closing
482 an idle client connection. A setting of 0 disables this
483 feature. The default is 0. You may also want to set the
487 .B olcIndexIntLen: <integer>
488 Specify the key length for ordered integer indices. The most significant
489 bytes of the binary integer will be used for index keys. The default
490 value is 4, which provides exact indexing for 31 bit values.
491 A floating point representation is used to index too large values.
493 .B olcIndexSubstrIfMaxlen: <integer>
494 Specify the maximum length for subinitial and subfinal indices. Only
495 this many characters of an attribute value will be processed by the
496 indexing functions; any excess characters are ignored. The default is 4.
498 .B olcIndexSubstrIfMinlen: <integer>
499 Specify the minimum length for subinitial and subfinal indices. An
500 attribute value must have at least this many characters in order to be
501 processed by the indexing functions. The default is 2.
503 .B olcIndexSubstrAnyLen: <integer>
504 Specify the length used for subany indices. An attribute value must have
505 at least this many characters in order to be processed. Attribute values
506 longer than this length will be processed in segments of this length. The
507 default is 4. The subany index will also be used in subinitial and
508 subfinal index lookups when the filter string is longer than the
509 .I olcIndexSubstrIfMaxlen
512 .B olcIndexSubstrAnyStep: <integer>
513 Specify the steps used in subany index lookups. This value sets the offset
514 for the segments of a filter string that are processed for a subany index
515 lookup. The default is 2. For example, with the default values, a search
516 using this filter "cn=*abcdefgh*" would generate index lookups for
517 "abcd", "cdef", and "efgh".
520 Note: Indexing support depends on the particular backend in use. Also,
521 changing these settings will generally require deleting any indices that
522 depend on these parameters and recreating them with
526 .B olcListenerThreads: <integer>
527 Specify the number of threads to use for the connection manager.
528 The default is 1 and this is typically adequate for up to 16 CPU cores.
529 The value should be set to a power of 2.
531 .B olcLocalSSF: <SSF>
532 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
533 such as those to the ldapi:// listener. For a description of SSF values,
535 .BR olcSaslSecProps 's
537 option description. The default is 71.
539 .B olcLogFile: <filename>
540 Specify a file for recording debug log messages. By default these messages
541 only go to stderr and are not recorded anywhere else. Specifying a logfile
542 copies messages to both stderr and the logfile.
544 .B olcLogLevel: <integer> [...]
545 Specify the level at which debugging statements and operation
546 statistics should be syslogged (currently logged to the
548 LOG_LOCAL4 facility).
549 They must be considered subsystems rather than increasingly verbose
551 Some messages with higher priority are logged regardless
552 of the configured loglevel as soon as any logging is configured.
553 Log levels are additive, and available levels are:
564 debug packet handling
568 heavy trace debugging (function args)
572 connection management
576 print out packets sent and received
580 search filter processing
584 configuration file processing
588 access control list processing
592 stats log connections/operations/results
596 stats log entries sent
600 print communication with shell backends
612 \"data indexing (unused)
620 only messages that get logged whatever log level is set
623 The desired log level can be input as a single integer that combines
624 the (ORed) desired levels, both in decimal or in hexadecimal notation,
625 as a list of integers (that are ORed internally),
626 or as a list of the names that are shown between brackets, such that
632 olcLogLevel: 0x80 0x1
633 olcLogLevel: acl trace
639 can be used as a shortcut to enable logging at all levels (equivalent to \-1).
642 or the equivalent integer representation, causes those messages
643 that are logged regardless of the configured olcLogLevel to be logged.
644 In fact, if no olcLogLevel (or a 0 level) is defined, no logging occurs,
647 level is required to have high priority messages logged.
650 .B olcPasswordCryptSaltFormat: <format>
651 Specify the format of the salt passed to
653 when generating {CRYPT} passwords (see
654 .BR olcPasswordHash )
655 during processing of LDAP Password Modify Extended Operations (RFC 3062).
657 This string needs to be in
659 format and may include one (and only one) %s conversion.
660 This conversion will be substituted with a string of random
661 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
662 provides a two character salt and "$1$%.8s" tells some
663 versions of crypt(3) to use an MD5 algorithm and provides
664 8 random characters of salt. The default is "%s", which
665 provides 31 characters of salt.
667 .B olcPidFile: <filename>
668 The (absolute) name of a file that will hold the
670 server's process ID (see
673 .B olcPluginLogFile: <filename>
674 The ( absolute ) name of a file that will contain log
681 .B olcReferral: <url>
682 Specify the referral to pass back when
684 cannot find a local database to handle a request.
685 If multiple values are specified, each url is provided.
687 .B olcReverseLookup: TRUE | FALSE
688 Enable/disable client name unverified reverse lookup (default is
690 if compiled with \-\-enable\-rlookups).
692 .B olcRootDSE: <file>
693 Specify the name of an LDIF(5) file containing user defined attributes
694 for the root DSE. These attributes are returned in addition to the
695 attributes normally produced by slapd.
697 The root DSE is an entry with information about the server and its
698 capabilities, in operational attributes.
699 It has the empty DN, and can be read with e.g.:
701 ldapsearch \-x \-b "" \-s base "+"
703 See RFC 4512 section 5.1 for details.
705 .B olcSaslAuxprops: <plugin> [...]
706 Specify which auxprop plugins to use for authentication lookups. The
707 default is empty, which just uses slapd's internal support. Usually
708 no other auxprop plugins are needed.
710 .B olcSaslHost: <fqdn>
711 Used to specify the fully qualified domain name used for SASL processing.
713 .B olcSaslRealm: <realm>
714 Specify SASL realm. Default is empty.
716 .B olcSaslSecProps: <properties>
717 Used to specify Cyrus SASL security properties.
720 flag (without any other properties) causes the flag properties
721 default, "noanonymous,noplain", to be cleared.
724 flag disables mechanisms susceptible to simple passive attacks.
727 flag disables mechanisms susceptible to active attacks.
730 flag disables mechanisms susceptible to passive dictionary attacks.
733 flag disables mechanisms which support anonymous login.
736 flag require forward secrecy between sessions.
739 require mechanisms which pass client credentials (and allow
740 mechanisms which can pass credentials to do so).
743 property specifies the minimum acceptable
744 .I security strength factor
745 as an integer approximate to effective key length used for
746 encryption. 0 (zero) implies no protection, 1 implies integrity
747 protection only, 56 allows DES or other weak ciphers, 112
748 allows triple DES and other strong ciphers, 128 allows RC4,
749 Blowfish and other modern strong ciphers. The default is 0.
752 property specifies the maximum acceptable
753 .I security strength factor
754 as an integer (see minssf description). The default is INT_MAX.
757 property specifies the maximum security layer receive buffer
758 size allowed. 0 disables security layers. The default is 65536.
760 .B olcServerID: <integer> [<URL>]
761 Specify an integer ID from 0 to 4095 for this server (limited
762 to 3 hexadecimal digits). The ID may also be specified as a
763 hexadecimal ID by prefixing the value with "0x".
765 required when using multimaster replication and each master must have a
766 unique ID. Note that this requirement also applies to separate masters
767 contributing to a glued set of databases.
768 If the URL is provided, this directive may be specified
769 multiple times, providing a complete list of participating servers
770 and their IDs. The fully qualified hostname of each server should be
771 used in the supplied URLs. The IDs are used in the "replica id" field
772 of all CSNs generated by the specified server. The default value is zero.
776 olcServerID: 1 ldap://ldap1.example.com
777 olcServerID: 2 ldap://ldap2.example.com
780 .B olcSockbufMaxIncoming: <integer>
781 Specify the maximum incoming LDAP PDU size for anonymous sessions.
782 The default is 262143.
784 .B olcSockbufMaxIncomingAuth: <integer>
785 Specify the maximum incoming LDAP PDU size for authenticated sessions.
786 The default is 4194303.
788 .B olcTCPBuffer [listener=<URL>] [{read|write}=]<size>
789 Specify the size of the TCP buffer.
790 A global value for both read and write TCP buffers related to any listener
791 is defined, unless the listener is explicitly specified,
792 or either the read or write qualifiers are used.
796 Note that some OS-es implement automatic TCP buffer tuning.
798 .B olcThreads: <integer>
799 Specify the maximum size of the primary thread pool.
800 The default is 16; the minimum value is 2.
802 .B olcToolThreads: <integer>
803 Specify the maximum number of threads to use in tool mode.
804 This should not be greater than the number of CPUs in the system.
807 .B olcWriteTimeout: <integer>
808 Specify the number of seconds to wait before forcibly closing
809 a connection with an outstanding write. This allows recovery from
810 various network hang conditions. A setting of 0 disables this
811 feature. The default is 0.
815 is built with support for Transport Layer Security, there are more options
818 .B olcTLSCipherSuite: <cipher-suite-spec>
819 Permits configuring what ciphers will be accepted and the preference order.
820 <cipher-suite-spec> should be a cipher specification for OpenSSL resp. GNUtls.
826 olcTLSCipherSuite: HIGH:MEDIUM:+SSLv2
829 TLSCiphersuite SECURE256:!AES-128-CBC
832 To check what ciphers a given spec selects in OpenSSL, use:
835 openssl ciphers \-v <cipher-suite-spec>
838 With GNUtls the available specs can be found in the manual page of
840 (see the description of the
844 In older versions of GNUtls, where gnutls\-cli does not support the option
845 \-\-priority, you can obtain the \(em more limited \(em list of ciphers by calling:
850 When using Mozilla NSS, the OpenSSL cipher suite specifications are used and
851 translated into the format used internally by Mozilla NSS. There isn't an easy
852 way to list the cipher suites from the command line. The authoritative list
853 is in the source code for Mozilla NSS in the file sslinfo.c in the structure
855 static const SSLCipherSuiteInfo suiteInfo[]
859 .B olcTLSCACertificateFile: <filename>
860 Specifies the file that contains certificates for all of the Certificate
865 .B olcTLSCACertificatePath: <path>
866 Specifies the path of a directory that contains Certificate Authority
867 certificates in separate individual files. Usually only one of this
868 or the olcTLSCACertificateFile is defined. If both are specified, both
869 locations will be used. This directive is not supported
871 When using Mozilla NSS, <path> may contain a Mozilla NSS cert/key
872 database. If <path> contains a Mozilla NSS cert/key database and
873 CA cert files, OpenLDAP will use the cert/key database and will
874 ignore the CA cert files.
876 .B olcTLSCertificateFile: <filename>
877 Specifies the file that contains the
880 When using Mozilla NSS, if using a cert/key database (specified with
881 olcTLSCACertificatePath), olcTLSCertificateFile specifies
882 the name of the certificate to use:
884 olcTLSCertificateFile: Server-Cert
886 If using a token other than the internal built in token, specify the
887 token name first, followed by a colon:
889 olcTLSCertificateFile: my hardware device:Server-Cert
891 Use certutil -L to list the certificates by name:
893 certutil -d /path/to/certdbdir -L
896 .B olcTLSCertificateKeyFile: <filename>
897 Specifies the file that contains the
899 server private key that matches the certificate stored in the
900 .B olcTLSCertificateFile
901 file. If the private key is protected with a password, the password must
902 be manually typed in when slapd starts. Usually the private key is not
903 protected with a password, to allow slapd to start without manual
905 it is of critical importance that the file is protected carefully.
906 When using Mozilla NSS, olcTLSCertificateKeyFile specifies the name of
907 a file that contains the password for the key for the certificate specified with
908 olcTLSCertificateFile. The modutil command can be used to turn off password
909 protection for the cert/key database. For example, if olcTLSCACertificatePath
910 specifes /etc/openldap/certdb as the location of the cert/key database, use
911 modutil to change the password to the empty string:
913 modutil -dbdir /etc/openldap/certdb -changepw 'NSS Certificate DB'
915 You must have the old password, if any. Ignore the WARNING about the running
916 browser. Press 'Enter' for the new password.
919 .B olcTLSDHParamFile: <filename>
920 This directive specifies the file that contains parameters for Diffie-Hellman
921 ephemeral key exchange. This is required in order to use a DSA certificate on
922 the server. If multiple sets of parameters are present in the file, all of
923 them will be processed. Note that setting this option may also enable
924 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
925 You should append "!ADH" to your cipher suites if you have changed them
926 from the default, otherwise no certificate exchanges or verification will
927 be done. When using GNUtls or Mozilla NSS these parameters are always generated randomly
928 so this directive is ignored.
930 .B olcTLSRandFile: <filename>
931 Specifies the file to obtain random bits from when /dev/[u]random
932 is not available. Generally set to the name of the EGD/PRNGD socket.
933 The environment variable RANDFILE can also be used to specify the filename.
934 This directive is ignored with GNUtls and Mozilla NSS.
936 .B olcTLSVerifyClient: <level>
937 Specifies what checks to perform on client certificates in an
938 incoming TLS session, if any.
941 can be specified as one of the following keywords:
947 will not ask the client for a certificate.
950 The client certificate is requested. If no certificate is provided,
951 the session proceeds normally. If a bad certificate is provided,
952 it will be ignored and the session proceeds normally.
955 The client certificate is requested. If no certificate is provided,
956 the session proceeds normally. If a bad certificate is provided,
957 the session is immediately terminated.
959 .B demand | hard | true
960 These keywords are all equivalent, for compatibility reasons.
961 The client certificate is requested. If no certificate is provided,
962 or a bad certificate is provided, the session is immediately terminated.
964 Note that a valid client certificate is required in order to use the
965 SASL EXTERNAL authentication mechanism with a TLS session. As such,
967 .B olcTLSVerifyClient
968 setting must be chosen to enable SASL EXTERNAL authentication.
971 .B olcTLSCRLCheck: <level>
972 Specifies if the Certificate Revocation List (CRL) of the CA should be
973 used to verify if the client certificates have not been revoked. This
975 .B olcTLSCACertificatePath
976 parameter to be set. This parameter is ignored with GNUtls and Mozilla NSS.
978 can be specified as one of the following keywords:
982 No CRL checks are performed
985 Check the CRL of the peer certificate
988 Check the CRL for a whole certificate chain
991 .B olcTLSCRLFile: <filename>
992 Specifies a file containing a Certificate Revocation List to be used
993 for verifying that certificates have not been revoked. This parameter
994 is only valid when using GNUtls.
995 .SH DYNAMIC MODULE OPTIONS
998 is compiled with \-\-enable\-modules then the module-related entries will
999 be available. These entries are named
1000 .B cn=module{x},cn=config
1002 must have the olcModuleList objectClass. One entry should be created
1005 Normally the config engine generates the "{x}" index in the RDN
1006 automatically, so it can be omitted when initially loading these entries.
1008 .B olcModuleLoad: <filename>
1009 Specify the name of a dynamically loadable module to load. The filename
1010 may be an absolute path name or a simple filename. Non-absolute names
1011 are searched for in the directories specified by the
1015 .B olcModulePath: <pathspec>
1016 Specify a list of directories to search for loadable modules. Typically
1017 the path is colon-separated but this depends on the operating system.
1018 The default is MODULEDIR, which is where the standard OpenLDAP install
1019 will place its modules.
1021 Schema definitions are created as entries in the
1022 .B cn=schema,cn=config
1023 subtree. These entries must have the olcSchemaConfig objectClass.
1024 As noted above, the actual
1025 .B cn=schema,cn=config
1026 entry is predefined and any values specified for it are ignored.
1030 .B olcAttributetypes: "(\ <oid>\
1032 [DESC\ <description>]\
1041 [NO\-USER\-MODIFICATION]\
1042 [USAGE\ <attributeUsage>]\ )"
1044 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
1045 The slapd parser extends the RFC 4512 definition by allowing string
1046 forms as well as numeric OIDs to be used for the attribute OID and
1047 attribute syntax OID.
1049 .B olcObjectIdentifier
1055 .B olcDitContentRules: "(\ <oid>\
1057 [DESC\ <description>]\
1064 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
1065 The slapd parser extends the RFC 4512 definition by allowing string
1066 forms as well as numeric OIDs to be used for the attribute OID and
1067 attribute syntax OID.
1069 .B olcObjectIdentifier
1075 .B olcObjectClasses: "(\ <oid>\
1077 [DESC\ <description>]\
1080 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
1081 [MUST\ <oids>] [MAY\ <oids>] )"
1083 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
1084 The slapd parser extends the RFC 4512 definition by allowing string
1085 forms as well as numeric OIDs to be used for the object class OID.
1089 description.) Object classes are "STRUCTURAL" by default.
1092 .B olcObjectIdentifier: <name> "{ <oid> | <name>[:<suffix>] }"
1093 Define a string name that equates to the given OID. The string can be used
1094 in place of the numeric OID in objectclass and attribute definitions. The
1095 name can also be used with a suffix of the form ":xx" in which case the
1096 value "oid.xx" will be used.
1098 .SH GENERAL BACKEND OPTIONS
1099 Options in these entries only apply to the configuration of a single
1100 type of backend. All backends may support this class of options.
1101 The entry must be named
1102 .B olcBackend=<databasetype>,cn=config
1103 and must have the olcBackendConfig objectClass.
1121 At present, no backend implements any options of this type.
1123 .SH DATABASE OPTIONS
1124 Database options are set in entries named
1125 .B olcDatabase={x}<databasetype>,cn=config
1126 and must have the olcDatabaseConfig objectClass. Normally the config
1127 engine generates the "{x}" index in the RDN automatically, so it
1128 can be omitted when initially loading these entries.
1130 The special frontend database is always numbered "{\-1}" and the config
1131 database is always numbered "{0}".
1133 .SH GLOBAL DATABASE OPTIONS
1134 Options in this section may be set in the special "frontend" database
1135 and inherited in all the other databases. These options may be altered
1136 by further settings in each specific database. The frontend entry must
1138 .B olcDatabase=frontend,cn=config
1139 and must have the olcFrontendConfig objectClass.
1141 .B olcAccess: to <what> "[ by <who> <access> <control> ]+"
1142 Grant access (specified by <access>) to a set of entries and/or
1143 attributes (specified by <what>) by one or more requestors (specified
1145 If no access controls are present, the default policy
1146 allows anyone and everyone to read anything but restricts
1147 updates to rootdn. (e.g., "olcAccess: to * by * read").
1149 .BR slapd.access (5)
1150 and the "OpenLDAP Administrator's Guide" for details.
1152 Access controls set in the frontend are appended to any access
1153 controls set on the specific databases.
1154 The rootdn of a database can always read and write EVERYTHING
1157 Extra special care must be taken with the access controls on the
1158 config database. Unlike other databases, the default policy for the
1159 config database is to only allow access to the rootdn. Regular users
1160 should not have read access, and write access should be granted very
1161 carefully to privileged administrators.
1164 .B olcDefaultSearchBase: <dn>
1165 Specify a default search base to use when client submits a
1166 non-base search request with an empty base DN.
1167 Base scoped search requests with an empty base DN are not affected.
1168 This setting is only allowed in the frontend entry.
1170 .B olcPasswordHash: <hash> [<hash>...]
1171 This option configures one or more hashes to be used in generation of user
1172 passwords stored in the userPassword attribute during processing of
1173 LDAP Password Modify Extended Operations (RFC 3062).
1174 The <hash> must be one of
1188 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
1193 use the MD5 algorithm (RFC 1321), the latter with a seed.
1200 indicates that the new password should be
1201 added to userPassword as clear text.
1203 Note that this option does not alter the normal user applications
1204 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
1205 This setting is only allowed in the frontend entry.
1207 .B olcReadOnly: TRUE | FALSE
1208 This option puts the database into "read-only" mode. Any attempts to
1209 modify the database will return an "unwilling to perform" error. By
1210 default, olcReadOnly is FALSE. Note that when this option is set
1211 TRUE on the frontend, it cannot be reset without restarting the
1212 server, since further writes to the config database will be rejected.
1214 .B olcRequires: <conditions>
1215 Specify a set of conditions to require (default none).
1216 The directive may be specified globally and/or per-database;
1217 databases inherit global conditions, so per-database specifications
1220 requires bind operation prior to directory operations.
1222 requires session to be using LDAP version 3.
1224 requires authentication prior to directory operations.
1226 requires SASL authentication prior to directory operations.
1228 requires strong authentication prior to directory operations.
1229 The strong keyword allows protected "simple" authentication
1230 as well as SASL authentication.
1232 may be used to require no conditions (useful to clear out globally
1233 set conditions within a particular database); it must occur first
1234 in the list of conditions.
1236 .B olcRestrict: <oplist>
1237 Specify a list of operations that are restricted.
1238 Restrictions on a specific database override any frontend setting.
1239 Operations can be any of
1244 .BR extended[=<OID>] ,
1248 or the special pseudo-operations
1252 which respectively summarize read and write operations.
1256 .I olcReadOnly: TRUE
1260 keyword allows to indicate the OID of the specific operation
1263 .B olcSchemaDN: <dn>
1264 Specify the distinguished name for the subschema subentry that
1265 controls the entries on this server. The default is "cn=Subschema".
1267 .B olcSecurity: <factors>
1268 Specify a set of security strength factors (separated by white space)
1270 .BR olcSaslSecprops 's
1272 option for a description of security strength factors).
1273 The directive may be specified globally and/or per-database.
1275 specifies the overall security strength factor.
1277 specifies the transport security strength factor.
1279 specifies the TLS security strength factor.
1281 specifies the SASL security strength factor.
1283 specifies the overall security strength factor to require for
1285 .B update_transport=<n>
1286 specifies the transport security strength factor to require for
1289 specifies the TLS security strength factor to require for
1292 specifies the SASL security strength factor to require for
1295 specifies the security strength factor required for
1297 username/password authentication.
1300 factor is measure of security provided by the underlying transport,
1301 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
1303 .B olcSizeLimit: {<integer>|unlimited}
1305 .B olcSizeLimit: size[.{soft|hard|unchecked}]=<integer> [...]
1306 Specify the maximum number of entries to return from a search operation.
1307 The default size limit is 500.
1310 to specify no limits.
1311 The second format allows a fine grain setting of the size limits.
1312 Extra args can be added in the same value or as additional values.
1315 for an explanation of the different flags.
1317 .B olcSortVals: <attr> [...]
1318 Specify a list of multi-valued attributes whose values will always
1319 be maintained in sorted order. Using this option will allow Modify,
1320 Compare, and filter evaluations on these attributes to be performed
1321 more efficiently. The resulting sort order depends on the
1322 attributes' syntax and matching rules and may not correspond to
1323 lexical order or any other recognizable order.
1324 This setting is only allowed in the frontend entry.
1326 .B olcTimeLimit: {<integer>|unlimited}
1328 .B olcTimeLimit: time[.{soft|hard}]=<integer> [...]
1329 Specify the maximum number of seconds (in real time)
1331 will spend answering a search request. The default time limit is 3600.
1334 to specify no limits.
1335 The second format allows a fine grain setting of the time limits.
1336 Extra args can be added in the same value or as additional values.
1339 for an explanation of the different flags.
1341 .SH GENERAL DATABASE OPTIONS
1342 Options in this section only apply to the specific database for
1343 which they are defined. They are supported by every
1344 type of backend. All of the Global Database Options may also be
1347 .B olcAddContentAcl: TRUE | FALSE
1348 Controls whether Add operations will perform ACL checks on
1349 the content of the entry being added. This check is off
1351 .BR slapd.access (5)
1352 manual page for more details on ACL requirements for
1355 .B olcHidden: TRUE | FALSE
1356 Controls whether the database will be used to answer
1357 queries. A database that is hidden will never be
1358 selected to answer any queries, and any suffix configured
1359 on the database will be ignored in checks for conflicts
1360 with other databases. By default, olcHidden is FALSE.
1362 .B olcLastMod: TRUE | FALSE
1365 will automatically maintain the
1366 modifiersName, modifyTimestamp, creatorsName, and
1367 createTimestamp attributes for entries. It also controls
1368 the entryCSN and entryUUID attributes, which are needed
1369 by the syncrepl provider. By default, olcLastMod is TRUE.
1371 .B olcLimits: <selector> <limit> [<limit> [...]]
1372 Specify time and size limits based on the operation's initiator or
1380 anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>
1386 <dnspec> ::= dn[.<type>][.<style>]
1388 <type> ::= self | this
1390 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1395 is the default and means the bound user, while
1397 means the base DN of the operation.
1400 matches all unauthenticated clients.
1403 matches all authenticated clients;
1406 dn pattern is assumed unless otherwise specified by qualifying
1407 the (optional) key string
1413 (which are synonyms), to require an exact match; with
1415 to require exactly one level of depth match; with
1417 to allow any level of depth match, including the exact match; with
1419 to allow any level of depth match, not including the exact match;
1421 explicitly requires the (default) match based on POSIX (''extended'')
1422 regular expression pattern.
1425 matches unbound operations; the
1428 The same behavior is obtained by using the
1435 with the optional objectClass
1441 sets the limits for any DN listed in the values of the
1447 group objectClass (default
1449 whose DN exactly matches
1452 The currently supported limits are
1457 The syntax for time limits is
1458 .BR time[.{soft|hard}]=<integer> ,
1461 is the number of seconds slapd will spend answering a search request.
1462 If no time limit is explicitly requested by the client, the
1464 limit is used; if the requested time limit exceeds the
1467 .\".I "Administrative limit exceeded"
1468 .\"error is returned.
1469 limit, the value of the limit is used instead.
1472 limit is set to the keyword
1474 the soft limit is used in either case; if it is set to the keyword
1476 no hard limit is enforced.
1477 Explicit requests for time limits smaller or equal to the
1480 If no limit specifier is set, the value is assigned to the
1486 to preserve the original behavior.
1488 The syntax for size limits is
1489 .BR size[.{soft|hard|unchecked}]=<integer> ,
1492 is the maximum number of entries slapd will return answering a search
1494 If no size limit is explicitly requested by the client, the
1496 limit is used; if the requested size limit exceeds the
1499 .\".I "Administrative limit exceeded"
1500 .\"error is returned.
1501 limit, the value of the limit is used instead.
1504 limit is set to the keyword
1506 the soft limit is used in either case; if it is set to the keyword
1508 no hard limit is enforced.
1509 Explicit requests for size limits smaller or equal to the
1514 specifier sets a limit on the number of candidates a search request is allowed
1516 The rationale behind it is that searches for non-properly indexed
1517 attributes may result in large sets of candidates, which must be
1520 to determine whether they match the search filter or not.
1523 limit provides a means to drop such operations before they are even
1525 If the selected candidates exceed the
1527 limit, the search will abort with
1528 .IR "Unwilling to perform" .
1529 If it is set to the keyword
1531 no limit is applied (the default).
1534 the search is not even performed; this can be used to disallow searches
1535 for a specific set of users.
1536 If no limit specifier is set, the value is assigned to the
1542 to preserve the original behavior.
1544 In case of no match, the global limits are used.
1545 The default values are the same as for
1554 control is requested, the
1556 size limit is used by default, because the request of a specific page size
1557 is considered an explicit request for a limitation on the number
1558 of entries to be returned.
1559 However, the size limit applies to the total count of entries returned within
1560 the search, and not to a single page.
1561 Additional size limits may be enforced; the syntax is
1562 .BR size.pr={<integer>|noEstimate|unlimited} ,
1565 is the max page size if no explicit limit is set; the keyword
1567 inhibits the server from returning an estimate of the total number
1568 of entries that might be returned
1569 (note: the current implementation does not return any estimate).
1572 indicates that no limit is applied to the pagedResults control page size.
1574 .B size.prtotal={<integer>|unlimited|disabled}
1575 allows to set a limit on the total number of entries that a pagedResults
1576 control allows to return.
1577 By default it is set to the
1582 is the max number of entries that the whole search with pagedResults control
1586 to allow unlimited number of entries to be returned, e.g. to allow
1587 the use of the pagedResults control as a means to circumvent size
1588 limitations on regular searches; the keyword
1590 disables the control, i.e. no paged results can be returned.
1591 Note that the total number of entries returned when the pagedResults control
1592 is requested cannot exceed the
1594 size limit of regular searches unless extended by the
1599 .B olcMaxDerefDepth: <depth>
1600 Specifies the maximum number of aliases to dereference when trying to
1601 resolve an entry, used to avoid infinite alias loops. The default is 15.
1603 .B olcMirrorMode: TRUE | FALSE
1604 This option puts a replica database into "mirror" mode. Update
1605 operations will be accepted from any user, not just the updatedn. The
1606 database must already be configured as syncrepl consumer
1607 before this keyword may be set. This mode also requires a
1609 (see above) to be configured.
1610 By default, this setting is FALSE.
1612 .B olcPlugin: <plugin_type> <lib_path> <init_function> [<arguments>]
1613 Configure a SLAPI plugin. See the
1614 .BR slapd.plugin (5)
1615 manpage for more details.
1618 Specify the distinguished name that is not subject to access control
1619 or administrative limit restrictions for operations on this database.
1620 This DN may or may not be associated with an entry. An empty root
1621 DN (the default) specifies no root access is to be granted. It is
1622 recommended that the rootdn only be specified when needed (such as
1623 when initially populating a database). If the rootdn is within
1624 a namingContext (suffix) of the database, a simple bind password
1625 may also be provided using the
1627 directive. Note that the rootdn is always needed when using syncrepl.
1632 database defaults to
1636 .B olcRootPW: <password>
1637 Specify a password (or hash of the password) for the rootdn. The
1638 password can only be set if the rootdn is within the namingContext
1639 (suffix) of the database.
1640 This option accepts all RFC 2307 userPassword formats known to
1643 description) as well as cleartext.
1645 may be used to generate a hash of a password. Cleartext
1646 and \fB{CRYPT}\fP passwords are not recommended. If empty
1647 (the default), authentication of the root DN is by other means
1648 (e.g. SASL). Use of SASL is encouraged.
1650 .B olcSubordinate: [TRUE | FALSE | advertise]
1651 Specify that the current backend database is a subordinate of another
1652 backend database. A subordinate database may have only one suffix. This
1653 option may be used to glue multiple databases into a single namingContext.
1654 If the suffix of the current database is within the namingContext of a
1655 superior database, searches against the superior database will be
1656 propagated to the subordinate as well. All of the databases
1657 associated with a single namingContext should have identical rootdns.
1658 Behavior of other LDAP operations is unaffected by this setting. In
1659 particular, it is not possible to use moddn to move an entry from
1660 one subordinate to another subordinate within the namingContext.
1662 If the optional \fBadvertise\fP flag is supplied, the naming context of
1663 this database is advertised in the root DSE. The default is to hide this
1664 database context, so that only the superior context is visible.
1671 are used on the superior database, any glued subordinates that support
1672 these tools are opened as well.
1674 Databases that are glued together should usually be configured with the
1675 same indices (assuming they support indexing), even for attributes that
1676 only exist in some of these databases. In general, all of the glued
1677 databases should be configured as similarly as possible, since the intent
1678 is to provide the appearance of a single directory.
1680 Note that the subordinate functionality is implemented internally
1681 by the \fIglue\fP overlay and as such its behavior will interact with other
1682 overlays in use. By default, the glue overlay is automatically configured as
1683 the last overlay on the superior database. Its position on the database
1684 can be explicitly configured by setting an \fBoverlay glue\fP directive
1685 at the desired position. This explicit configuration is necessary e.g.
1686 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1687 in order to work over all of the glued databases. E.g.
1690 dn: olcDatabase={1}bdb,cn=config
1691 olcSuffix: dc=example,dc=com
1694 dn: olcOverlay={0}glue,olcDatabase={1}bdb,cn=config
1697 dn: olcOverlay={1}syncprov,olcDatabase={1}bdb,cn=config
1701 See the Overlays section below for more details.
1703 .B olcSuffix: <dn suffix>
1704 Specify the DN suffix of queries that will be passed to this
1705 backend database. Multiple suffix lines can be given and at least one is
1706 required for each database definition.
1708 If the suffix of one database is "inside" that of another, the database
1709 with the inner suffix must come first in the configuration file.
1710 You may also want to glue such databases together with the
1714 .B olcSyncUseSubentry: TRUE | FALSE
1715 Store the syncrepl contextCSN in a subentry instead of the context entry
1716 of the database. The subentry's RDN will be "cn=ldapsync". The default is
1717 FALSE, meaning the contextCSN is stored in the context entry.
1720 .B olcSyncrepl: rid=<replica ID>
1721 .B provider=ldap[s]://<hostname>[:port]
1722 .B searchbase=<base DN>
1723 .B [type=refreshOnly|refreshAndPersist]
1724 .B [interval=dd:hh:mm:ss]
1725 .B [retry=[<retry interval> <# of retries>]+]
1726 .B [filter=<filter str>]
1727 .B [scope=sub|one|base|subord]
1728 .B [attrs=<attr list>]
1729 .B [exattrs=<attr list>]
1731 .B [sizelimit=<limit>]
1732 .B [timelimit=<limit>]
1733 .B [schemachecking=on|off]
1734 .B [network\-timeout=<seconds>]
1735 .B [timeout=<seconds>]
1736 .B [bindmethod=simple|sasl]
1738 .B [saslmech=<mech>]
1739 .B [authcid=<identity>]
1740 .B [authzid=<identity>]
1741 .B [credentials=<passwd>]
1743 .B [secprops=<properties>]
1744 .B [keepalive=<idle>:<probes>:<interval>]
1745 .B [starttls=yes|critical]
1746 .B [tls_cert=<file>]
1748 .B [tls_cacert=<file>]
1749 .B [tls_cacertdir=<path>]
1750 .B [tls_reqcert=never|allow|try|demand]
1751 .B [tls_ciphersuite=<ciphers>]
1752 .B [tls_crlcheck=none|peer|all]
1753 .B [suffixmassage=<real DN>]
1754 .B [logbase=<base DN>]
1755 .B [logfilter=<filter str>]
1756 .B [syncdata=default|accesslog|changelog]
1758 Specify the current database as a replica which is kept up-to-date with the
1759 master content by establishing the current
1761 as a replication consumer site running a
1764 The replica content is kept synchronized to the master content using
1765 the LDAP Content Synchronization protocol. Refer to the
1766 "OpenLDAP Administrator's Guide" for detailed information on
1767 setting up a replicated
1769 directory service using the
1774 identifies the current
1776 directive within the replication consumer site.
1777 It is a non-negative integer having no more than three decimal digits.
1780 specifies the replication provider site containing the master content
1781 as an LDAP URI. If <port> is not given, the standard LDAP port number
1782 (389 or 636) is used.
1786 replica is defined using a search
1787 specification as its result set. The consumer
1789 will send search requests to the provider
1791 according to the search specification. The search specification includes
1792 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1795 parameters as in the normal search specification. The
1797 option may also be used to specify attributes that should be omitted
1798 from incoming entries.
1799 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1800 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1801 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1802 attributes, and \fBattrsonly\fP and \fBexattrs\fP are unset by default.
1803 The \fBsizelimit\fP and \fBtimelimit\fP only
1804 accept "unlimited" and positive integers, and both default to "unlimited".
1805 Note, however, that any provider-side limits for the replication identity
1806 will be enforced by the provider regardless of the limits requested
1807 by the LDAP Content Synchronization operation, much like for any other
1810 The LDAP Content Synchronization protocol has two operation types.
1813 operation, the next synchronization search operation
1814 is periodically rescheduled at an interval time (specified by
1816 parameter; 1 day by default)
1817 after each synchronization operation finishes.
1819 .B refreshAndPersist
1820 operation, a synchronization search remains persistent in the provider slapd.
1821 Further updates to the master replica will generate
1822 .B searchResultEntry
1823 to the consumer slapd as the search responses to the persistent
1824 synchronization search.
1826 If an error occurs during replication, the consumer will attempt to
1827 reconnect according to the
1829 parameter which is a list of the <retry interval> and <# of retries> pairs.
1830 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1831 for the first 10 times and then retry every 300 seconds for the next 3
1832 times before stop retrying. The `+' in <# of retries> means indefinite
1833 number of retries until success.
1835 The schema checking can be enforced at the LDAP Sync
1836 consumer site by turning on the
1838 parameter. The default is off.
1842 parameter sets how long the consumer will wait to establish a
1843 network connection to the provider. Once a connection is
1846 parameter determines how long the consumer will wait for the initial
1847 Bind request to complete. The defaults for these parameters come
1855 requires the options
1859 and should only be used when adequate security services
1860 (e.g. TLS or IPSEC) are in place.
1867 Depending on the mechanism, an authentication identity and/or
1868 credentials can be specified using
1874 parameter may be used to specify an authorization identity.
1875 Specific security properties (as with the
1877 keyword above) for a SASL bind can be set with the
1879 option. A non default SASL realm can be set with the
1882 The provider, other than allow authentication of the syncrepl identity,
1883 should grant that identity appropriate access privileges to the data
1884 that is being replicated (\fBaccess\fP directive), and appropriate time
1885 and size limits (\fBlimits\fP directive).
1889 parameter sets the values of \fIidle\fP, \fIprobes\fP, and \fIinterval\fP
1890 used to check whether a socket is alive;
1892 is the number of seconds a connection needs to remain idle before TCP
1893 starts sending keepalive probes;
1895 is the maximum number of keepalive probes TCP should send before dropping
1898 is interval in seconds between individual keepalive probes.
1899 Only some systems support the customization of these values;
1902 parameter is ignored otherwise, and system-wide settings are used.
1906 parameter specifies use of the StartTLS extended operation
1907 to establish a TLS session before Binding to the provider. If the
1909 argument is supplied, the session will be aborted if the StartTLS request
1910 fails. Otherwise the syncrepl session continues without TLS. The
1911 tls_reqcert setting defaults to "demand" and the other TLS settings
1912 default to the same as the main slapd TLS settings.
1916 parameter allows the consumer to pull entries from a remote directory
1917 whose DN suffix differs from the local directory. The portion of the
1918 remote entries' DNs that matches the \fIsearchbase\fP will be replaced
1919 with the suffixmassage DN.
1921 Rather than replicating whole entries, the consumer can query logs of
1922 data modifications. This mode of operation is referred to as \fIdelta
1923 syncrepl\fP. In addition to the above parameters, the
1927 parameters must be set appropriately for the log that will be used. The
1929 parameter must be set to either "accesslog" if the log conforms to the
1930 .BR slapo\-accesslog (5)
1931 log format, or "changelog" if the log conforms
1932 to the obsolete \fIchangelog\fP format. If the
1934 parameter is omitted or set to "default" then the log parameters are
1938 .B olcUpdateDN: <dn>
1939 This option is only applicable in a slave
1941 It specifies the DN permitted to update (subject to access controls)
1942 the replica. It is only needed in certain push-mode
1943 replication scenarios. Generally, this DN
1949 .B olcUpdateRef: <url>
1950 Specify the referral to pass back when
1952 is asked to modify a replicated local database.
1953 If multiple values are specified, each url is provided.
1955 .SH DATABASE-SPECIFIC OPTIONS
1956 Each database may allow specific configuration options; they are
1957 documented separately in the backends' manual pages. See the
1958 .BR slapd.backends (5)
1959 manual page for an overview of available backends.
1961 An overlay is a piece of
1962 code that intercepts database operations in order to extend or change
1963 them. Overlays are pushed onto
1964 a stack over the database, and so they will execute in the reverse
1965 of the order in which they were configured and the database itself
1966 will receive control last of all.
1968 Overlays must be configured as child entries of a specific database. The
1969 entry's RDN must be of the form
1970 .B olcOverlay={x}<overlaytype>
1971 and the entry must have the olcOverlayConfig objectClass. Normally the
1972 config engine generates the "{x}" index in the RDN automatically, so
1973 it can be omitted when initially loading these entries.
1976 .BR slapd.overlays (5)
1977 manual page for an overview of available overlays.
1980 Here is a short example of a configuration in LDIF suitable for use with
1987 objectClass: olcGlobal
1989 olcPidFile: LOCALSTATEDIR/run/slapd.pid
1990 olcAttributeOptions: x\-hidden lang\-
1992 dn: cn=schema,cn=config
1993 objectClass: olcSchemaConfig
1996 include: SYSCONFDIR/schema/core.ldif
1998 dn: olcDatabase=frontend,cn=config
1999 objectClass: olcDatabaseConfig
2000 objectClass: olcFrontendConfig
2001 olcDatabase: frontend
2002 # Subtypes of "name" (e.g. "cn" and "ou") with the
2003 # option ";x\-hidden" can be searched for/compared,
2004 # but are not shown. See \fBslapd.access\fP(5).
2005 olcAccess: to attrs=name;x\-hidden by * =cs
2006 # Protect passwords. See \fBslapd.access\fP(5).
2007 olcAccess: to attrs=userPassword by * auth
2008 # Read access to other attributes and entries.
2009 olcAccess: to * by * read
2011 # set a rootpw for the config database so we can bind.
2012 # deny access to everyone else.
2013 dn: olcDatabase=config,cn=config
2014 objectClass: olcDatabaseConfig
2016 olcRootPW: {SSHA}XKYnrjvGT3wZFQrDD5040US592LxsdLy
2017 olcAccess: to * by * none
2019 dn: olcDatabase=bdb,cn=config
2020 objectClass: olcDatabaseConfig
2021 objectClass: olcBdbConfig
2023 olcSuffix: "dc=our\-domain,dc=com"
2024 # The database directory MUST exist prior to
2025 # running slapd AND should only be accessible
2026 # by the slapd/tools. Mode 0700 recommended.
2027 olcDbDirectory: LOCALSTATEDIR/openldap\-data
2028 # Indices to maintain
2029 olcDbIndex: objectClass eq
2030 olcDbIndex: cn,sn,mail pres,eq,approx,sub
2032 # We serve small clients that do not handle referrals,
2033 # so handle remote lookups on their behalf.
2034 dn: olcDatabase=ldap,cn=config
2035 objectClass: olcDatabaseConfig
2036 objectClass: olcLdapConfig
2039 olcDbUri: ldap://ldap.some\-server.com/
2043 Assuming the above data was saved in a file named "config.ldif" and the
2044 ETCDIR/slapd.d directory has been created, this command will initialize
2048 slapadd \-F ETCDIR/slapd.d \-n 0 \-l config.ldif
2053 "OpenLDAP Administrator's Guide" contains a longer annotated
2054 example of a slapd configuration.
2056 Alternatively, an existing slapd.conf file can be converted to the new
2057 format using slapd or any of the slap tools:
2060 slaptest \-f ETCDIR/slapd.conf \-F ETCDIR/slapd.d
2067 default slapd configuration file
2070 default slapd configuration directory
2074 .BR gnutls\-cli (1),
2075 .BR slapd.access (5),
2076 .BR slapd.backends (5),
2078 .BR slapd.overlays (5),
2079 .BR slapd.plugin (5),
2080 .BR slapd.replog (5),
2091 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
2092 .SH ACKNOWLEDGEMENTS