1 .TH SLAPD-CONFIG 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2013 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 brackets, 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 olcSaslHost: <fqdn>
707 Used to specify the fully qualified domain name used for SASL processing.
709 .B olcSaslRealm: <realm>
710 Specify SASL realm. Default is empty.
712 .B olcSaslSecProps: <properties>
713 Used to specify Cyrus SASL security properties.
716 flag (without any other properties) causes the flag properties
717 default, "noanonymous,noplain", to be cleared.
720 flag disables mechanisms susceptible to simple passive attacks.
723 flag disables mechanisms susceptible to active attacks.
726 flag disables mechanisms susceptible to passive dictionary attacks.
729 flag disables mechanisms which support anonymous login.
732 flag require forward secrecy between sessions.
735 require mechanisms which pass client credentials (and allow
736 mechanisms which can pass credentials to do so).
739 property specifies the minimum acceptable
740 .I security strength factor
741 as an integer approximate to effective key length used for
742 encryption. 0 (zero) implies no protection, 1 implies integrity
743 protection only, 56 allows DES or other weak ciphers, 112
744 allows triple DES and other strong ciphers, 128 allows RC4,
745 Blowfish and other modern strong ciphers. The default is 0.
748 property specifies the maximum acceptable
749 .I security strength factor
750 as an integer (see minssf description). The default is INT_MAX.
753 property specifies the maximum security layer receive buffer
754 size allowed. 0 disables security layers. The default is 65536.
756 .B olcServerID: <integer> [<URL>]
757 Specify an integer ID from 0 to 4095 for this server (limited
758 to 3 hexadecimal digits). The ID may also be specified as a
759 hexadecimal ID by prefixing the value with "0x".
761 required when using multimaster replication and each master must have a
762 unique ID. Note that this requirement also applies to separate masters
763 contributing to a glued set of databases.
764 If the URL is provided, this directive may be specified
765 multiple times, providing a complete list of participating servers
766 and their IDs. The fully qualified hostname of each server should be
767 used in the supplied URLs. The IDs are used in the "replica id" field
768 of all CSNs generated by the specified server. The default value is zero.
772 olcServerID: 1 ldap://ldap1.example.com
773 olcServerID: 2 ldap://ldap2.example.com
776 .B olcSockbufMaxIncoming: <integer>
777 Specify the maximum incoming LDAP PDU size for anonymous sessions.
778 The default is 262143.
780 .B olcSockbufMaxIncomingAuth: <integer>
781 Specify the maximum incoming LDAP PDU size for authenticated sessions.
782 The default is 4194303.
784 .B olcTCPBuffer [listener=<URL>] [{read|write}=]<size>
785 Specify the size of the TCP buffer.
786 A global value for both read and write TCP buffers related to any listener
787 is defined, unless the listener is explicitly specified,
788 or either the read or write qualifiers are used.
792 Note that some OS-es implement automatic TCP buffer tuning.
794 .B olcThreads: <integer>
795 Specify the maximum size of the primary thread pool.
796 The default is 16; the minimum value is 2.
798 .B olcToolThreads: <integer>
799 Specify the maximum number of threads to use in tool mode.
800 This should not be greater than the number of CPUs in the system.
803 .B olcWriteTimeout: <integer>
804 Specify the number of seconds to wait before forcibly closing
805 a connection with an outstanding write. This allows recovery from
806 various network hang conditions. A setting of 0 disables this
807 feature. The default is 0.
811 is built with support for Transport Layer Security, there are more options
814 .B olcTLSCipherSuite: <cipher-suite-spec>
815 Permits configuring what ciphers will be accepted and the preference order.
816 <cipher-suite-spec> should be a cipher specification for
817 the TLS library in use (OpenSSL, GnuTLS, or Mozilla NSS).
823 olcTLSCipherSuite: HIGH:MEDIUM:+SSLv2
826 TLSCiphersuite SECURE256:!AES-128-CBC
829 To check what ciphers a given spec selects in OpenSSL, use:
832 openssl ciphers \-v <cipher-suite-spec>
835 With GnuTLS the available specs can be found in the manual page of
837 (see the description of the
841 In older versions of GnuTLS, where gnutls\-cli does not support the option
842 \-\-priority, you can obtain the \(em more limited \(em list of ciphers by calling:
848 When using Mozilla NSS, the OpenSSL cipher suite specifications are used and
849 translated into the format used internally by Mozilla NSS. There isn't an easy
850 way to list the cipher suites from the command line. The authoritative list
851 is in the source code for Mozilla NSS in the file sslinfo.c in the structure
853 static const SSLCipherSuiteInfo suiteInfo[]
857 .B olcTLSCACertificateFile: <filename>
858 Specifies the file that contains certificates for all of the Certificate
863 .B olcTLSCACertificatePath: <path>
864 Specifies the path of a directory that contains Certificate Authority
865 certificates in separate individual files. Usually only one of this
866 or the olcTLSCACertificateFile is defined. If both are specified, both
867 locations will be used. This directive is not supported
870 When using Mozilla NSS, <path> may contain a Mozilla NSS cert/key
871 database. If <path> contains a Mozilla NSS cert/key database and
872 CA cert files, OpenLDAP will use the cert/key database and will
873 ignore the CA cert files.
875 .B olcTLSCertificateFile: <filename>
876 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.
907 When using Mozilla NSS, olcTLSCertificateKeyFile specifies the name of
908 a file that contains the password for the key for the certificate specified with
909 olcTLSCertificateFile. The modutil command can be used to turn off password
910 protection for the cert/key database. For example, if olcTLSCACertificatePath
911 specifes /etc/openldap/certdb as the location of the cert/key database, use
912 modutil to change the password to the empty string:
914 modutil -dbdir /etc/openldap/certdb -changepw 'NSS Certificate DB'
916 You must have the old password, if any. Ignore the WARNING about the running
917 browser. Press 'Enter' for the new password.
920 .B olcTLSDHParamFile: <filename>
921 This directive specifies the file that contains parameters for Diffie-Hellman
922 ephemeral key exchange. This is required in order to use a DSA certificate on
923 the server. If multiple sets of parameters are present in the file, all of
924 them will be processed. Note that setting this option may also enable
925 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
926 You should append "!ADH" to your cipher suites if you have changed them
927 from the default, otherwise no certificate exchanges or verification will
928 be done. When using GnuTLS or Mozilla NSS these parameters are always generated randomly
929 so this directive is ignored.
931 .B olcTLSRandFile: <filename>
932 Specifies the file to obtain random bits from when /dev/[u]random
933 is not available. Generally set to the name of the EGD/PRNGD socket.
934 The environment variable RANDFILE can also be used to specify the filename.
935 This directive is ignored with GnuTLS and Mozilla NSS.
937 .B olcTLSVerifyClient: <level>
938 Specifies what checks to perform on client certificates in an
939 incoming TLS session, if any.
942 can be specified as one of the following keywords:
948 will not ask the client for a certificate.
951 The client certificate is requested. If no certificate is provided,
952 the session proceeds normally. If a bad certificate is provided,
953 it will be ignored and the session proceeds normally.
956 The client certificate is requested. If no certificate is provided,
957 the session proceeds normally. If a bad certificate is provided,
958 the session is immediately terminated.
960 .B demand | hard | true
961 These keywords are all equivalent, for compatibility reasons.
962 The client certificate is requested. If no certificate is provided,
963 or a bad certificate is provided, the session is immediately terminated.
965 Note that a valid client certificate is required in order to use the
966 SASL EXTERNAL authentication mechanism with a TLS session. As such,
968 .B olcTLSVerifyClient
969 setting must be chosen to enable SASL EXTERNAL authentication.
972 .B olcTLSCRLCheck: <level>
973 Specifies if the Certificate Revocation List (CRL) of the CA should be
974 used to verify if the client certificates have not been revoked. This
976 .B olcTLSCACertificatePath
977 parameter to be set. This parameter is ignored with GnuTLS and Mozilla NSS.
979 can be specified as one of the following keywords:
983 No CRL checks are performed
986 Check the CRL of the peer certificate
989 Check the CRL for a whole certificate chain
992 .B olcTLSCRLFile: <filename>
993 Specifies a file containing a Certificate Revocation List to be used
994 for verifying that certificates have not been revoked. This parameter
995 is only valid when using GnuTLS or Mozilla NSS.
996 .SH DYNAMIC MODULE OPTIONS
999 is compiled with \-\-enable\-modules then the module-related entries will
1000 be available. These entries are named
1001 .B cn=module{x},cn=config
1003 must have the olcModuleList objectClass. One entry should be created
1006 Normally the config engine generates the "{x}" index in the RDN
1007 automatically, so it can be omitted when initially loading these entries.
1009 .B olcModuleLoad: <filename>
1010 Specify the name of a dynamically loadable module to load. The filename
1011 may be an absolute path name or a simple filename. Non-absolute names
1012 are searched for in the directories specified by the
1016 .B olcModulePath: <pathspec>
1017 Specify a list of directories to search for loadable modules. Typically
1018 the path is colon-separated but this depends on the operating system.
1019 The default is MODULEDIR, which is where the standard OpenLDAP install
1020 will place its modules.
1022 Schema definitions are created as entries in the
1023 .B cn=schema,cn=config
1024 subtree. These entries must have the olcSchemaConfig objectClass.
1025 As noted above, the actual
1026 .B cn=schema,cn=config
1027 entry is predefined and any values specified for it are ignored.
1031 .B olcAttributetypes: "(\ <oid>\
1033 [DESC\ <description>]\
1042 [NO\-USER\-MODIFICATION]\
1043 [USAGE\ <attributeUsage>]\ )"
1045 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
1046 The slapd parser extends the RFC 4512 definition by allowing string
1047 forms as well as numeric OIDs to be used for the attribute OID and
1048 attribute syntax OID.
1050 .B olcObjectIdentifier
1056 .B olcDitContentRules: "(\ <oid>\
1058 [DESC\ <description>]\
1065 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
1066 The slapd parser extends the RFC 4512 definition by allowing string
1067 forms as well as numeric OIDs to be used for the attribute OID and
1068 attribute syntax OID.
1070 .B olcObjectIdentifier
1076 .B olcObjectClasses: "(\ <oid>\
1078 [DESC\ <description>]\
1081 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
1082 [MUST\ <oids>] [MAY\ <oids>] )"
1084 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
1085 The slapd parser extends the RFC 4512 definition by allowing string
1086 forms as well as numeric OIDs to be used for the object class OID.
1090 description.) Object classes are "STRUCTURAL" by default.
1093 .B olcObjectIdentifier: <name> "{ <oid> | <name>[:<suffix>] }"
1094 Define a string name that equates to the given OID. The string can be used
1095 in place of the numeric OID in objectclass and attribute definitions. The
1096 name can also be used with a suffix of the form ":xx" in which case the
1097 value "oid.xx" will be used.
1099 .SH GENERAL BACKEND OPTIONS
1100 Options in these entries only apply to the configuration of a single
1101 type of backend. All backends may support this class of options, but
1103 The entry must be named
1104 .B olcBackend=<databasetype>,cn=config
1105 and must have the olcBackendConfig objectClass.
1125 At present, no backend implements any options of this type, so this
1126 entry should not be used.
1128 .SH DATABASE OPTIONS
1129 Database options are set in entries named
1130 .B olcDatabase={x}<databasetype>,cn=config
1131 and must have the olcDatabaseConfig objectClass. Normally the config
1132 engine generates the "{x}" index in the RDN automatically, so it
1133 can be omitted when initially loading these entries.
1135 The special frontend database is always numbered "{\-1}" and the config
1136 database is always numbered "{0}".
1138 .SH GLOBAL DATABASE OPTIONS
1139 Options in this section may be set in the special "frontend" database
1140 and inherited in all the other databases. These options may be altered
1141 by further settings in each specific database. The frontend entry must
1143 .B olcDatabase=frontend,cn=config
1144 and must have the olcFrontendConfig objectClass.
1146 .B olcAccess: to <what> "[ by <who> <access> <control> ]+"
1147 Grant access (specified by <access>) to a set of entries and/or
1148 attributes (specified by <what>) by one or more requestors (specified
1150 If no access controls are present, the default policy
1151 allows anyone and everyone to read anything but restricts
1152 updates to rootdn. (e.g., "olcAccess: to * by * read").
1154 .BR slapd.access (5)
1155 and the "OpenLDAP Administrator's Guide" for details.
1157 Access controls set in the frontend are appended to any access
1158 controls set on the specific databases.
1159 The rootdn of a database can always read and write EVERYTHING
1162 Extra special care must be taken with the access controls on the
1163 config database. Unlike other databases, the default policy for the
1164 config database is to only allow access to the rootdn. Regular users
1165 should not have read access, and write access should be granted very
1166 carefully to privileged administrators.
1169 .B olcDefaultSearchBase: <dn>
1170 Specify a default search base to use when client submits a
1171 non-base search request with an empty base DN.
1172 Base scoped search requests with an empty base DN are not affected.
1173 This setting is only allowed in the frontend entry.
1175 .B olcExtraAttrs: <attr>
1176 Lists what attributes need to be added to search requests.
1177 Local storage backends return the entire entry to the frontend.
1178 The frontend takes care of only returning the requested attributes
1179 that are allowed by ACLs.
1180 However, features like access checking and so may need specific
1181 attributes that are not automatically returned by remote storage
1182 backends, like proxy backends and so on.
1184 is an attribute that is needed for internal purposes
1185 and thus always needs to be collected, even when not explicitly
1186 requested by clients.
1187 This attribute is multi-valued.
1189 .B olcPasswordHash: <hash> [<hash>...]
1190 This option configures one or more hashes to be used in generation of user
1191 passwords stored in the userPassword attribute during processing of
1192 LDAP Password Modify Extended Operations (RFC 3062).
1193 The <hash> must be one of
1207 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
1212 use the MD5 algorithm (RFC 1321), the latter with a seed.
1219 indicates that the new password should be
1220 added to userPassword as clear text.
1222 Note that this option does not alter the normal user applications
1223 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
1224 This setting is only allowed in the frontend entry.
1226 .B olcReadOnly: TRUE | FALSE
1227 This option puts the database into "read-only" mode. Any attempts to
1228 modify the database will return an "unwilling to perform" error. By
1229 default, olcReadOnly is FALSE. Note that when this option is set
1230 TRUE on the frontend, it cannot be reset without restarting the
1231 server, since further writes to the config database will be rejected.
1233 .B olcRequires: <conditions>
1234 Specify a set of conditions to require (default none).
1235 The directive may be specified globally and/or per-database;
1236 databases inherit global conditions, so per-database specifications
1239 requires bind operation prior to directory operations.
1241 requires session to be using LDAP version 3.
1243 requires authentication prior to directory operations.
1245 requires SASL authentication prior to directory operations.
1247 requires strong authentication prior to directory operations.
1248 The strong keyword allows protected "simple" authentication
1249 as well as SASL authentication.
1251 may be used to require no conditions (useful to clear out globally
1252 set conditions within a particular database); it must occur first
1253 in the list of conditions.
1255 .B olcRestrict: <oplist>
1256 Specify a list of operations that are restricted.
1257 Restrictions on a specific database override any frontend setting.
1258 Operations can be any of
1263 .BR extended[=<OID>] ,
1267 or the special pseudo-operations
1271 which respectively summarize read and write operations.
1275 .I olcReadOnly: TRUE
1279 keyword allows to indicate the OID of the specific operation
1282 .B olcSchemaDN: <dn>
1283 Specify the distinguished name for the subschema subentry that
1284 controls the entries on this server. The default is "cn=Subschema".
1286 .B olcSecurity: <factors>
1287 Specify a set of security strength factors (separated by white space)
1289 .BR olcSaslSecprops 's
1291 option for a description of security strength factors).
1292 The directive may be specified globally and/or per-database.
1294 specifies the overall security strength factor.
1296 specifies the transport security strength factor.
1298 specifies the TLS security strength factor.
1300 specifies the SASL security strength factor.
1302 specifies the overall security strength factor to require for
1304 .B update_transport=<n>
1305 specifies the transport security strength factor to require for
1308 specifies the TLS security strength factor to require for
1311 specifies the SASL security strength factor to require for
1314 specifies the security strength factor required for
1316 username/password authentication.
1319 factor is measure of security provided by the underlying transport,
1320 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
1322 .B olcSizeLimit: {<integer>|unlimited}
1324 .B olcSizeLimit: size[.{soft|hard|unchecked}]=<integer> [...]
1325 Specify the maximum number of entries to return from a search operation.
1326 The default size limit is 500.
1329 to specify no limits.
1330 The second format allows a fine grain setting of the size limits.
1331 Extra args can be added in the same value or as additional values.
1334 for an explanation of the different flags.
1336 .B olcSortVals: <attr> [...]
1337 Specify a list of multi-valued attributes whose values will always
1338 be maintained in sorted order. Using this option will allow Modify,
1339 Compare, and filter evaluations on these attributes to be performed
1340 more efficiently. The resulting sort order depends on the
1341 attributes' syntax and matching rules and may not correspond to
1342 lexical order or any other recognizable order.
1343 This setting is only allowed in the frontend entry.
1345 .B olcTimeLimit: {<integer>|unlimited}
1347 .B olcTimeLimit: time[.{soft|hard}]=<integer> [...]
1348 Specify the maximum number of seconds (in real time)
1350 will spend answering a search request. The default time limit is 3600.
1353 to specify no limits.
1354 The second format allows a fine grain setting of the time limits.
1355 Extra args can be added in the same value or as additional values.
1358 for an explanation of the different flags.
1360 .SH GENERAL DATABASE OPTIONS
1361 Options in this section only apply to the specific database for
1362 which they are defined. They are supported by every
1363 type of backend. All of the Global Database Options may also be
1366 .B olcAddContentAcl: TRUE | FALSE
1367 Controls whether Add operations will perform ACL checks on
1368 the content of the entry being added. This check is off
1370 .BR slapd.access (5)
1371 manual page for more details on ACL requirements for
1374 .B olcHidden: TRUE | FALSE
1375 Controls whether the database will be used to answer
1376 queries. A database that is hidden will never be
1377 selected to answer any queries, and any suffix configured
1378 on the database will be ignored in checks for conflicts
1379 with other databases. By default, olcHidden is FALSE.
1381 .B olcLastMod: TRUE | FALSE
1384 will automatically maintain the
1385 modifiersName, modifyTimestamp, creatorsName, and
1386 createTimestamp attributes for entries. It also controls
1387 the entryCSN and entryUUID attributes, which are needed
1388 by the syncrepl provider. By default, olcLastMod is TRUE.
1390 .B olcLimits: <selector> <limit> [<limit> [...]]
1391 Specify time and size limits based on the operation's initiator or
1399 anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>
1405 <dnspec> ::= dn[.<type>][.<style>]
1407 <type> ::= self | this
1409 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1414 is the default and means the bound user, while
1416 means the base DN of the operation.
1419 matches all unauthenticated clients.
1422 matches all authenticated clients;
1425 dn pattern is assumed unless otherwise specified by qualifying
1426 the (optional) key string
1432 (which are synonyms), to require an exact match; with
1434 to require exactly one level of depth match; with
1436 to allow any level of depth match, including the exact match; with
1438 to allow any level of depth match, not including the exact match;
1440 explicitly requires the (default) match based on POSIX (''extended'')
1441 regular expression pattern.
1444 matches unbound operations; the
1447 The same behavior is obtained by using the
1454 with the optional objectClass
1460 sets the limits for any DN listed in the values of the
1466 group objectClass (default
1468 whose DN exactly matches
1471 The currently supported limits are
1476 The syntax for time limits is
1477 .BR time[.{soft|hard}]=<integer> ,
1480 is the number of seconds slapd will spend answering a search request.
1481 If no time limit is explicitly requested by the client, the
1483 limit is used; if the requested time limit exceeds the
1486 .\".I "Administrative limit exceeded"
1487 .\"error is returned.
1488 limit, the value of the limit is used instead.
1491 limit is set to the keyword
1493 the soft limit is used in either case; if it is set to the keyword
1495 no hard limit is enforced.
1496 Explicit requests for time limits smaller or equal to the
1499 If no limit specifier is set, the value is assigned to the
1505 to preserve the original behavior.
1507 The syntax for size limits is
1508 .BR size[.{soft|hard|unchecked}]=<integer> ,
1511 is the maximum number of entries slapd will return answering a search
1513 If no size limit is explicitly requested by the client, the
1515 limit is used; if the requested size limit exceeds the
1518 .\".I "Administrative limit exceeded"
1519 .\"error is returned.
1520 limit, the value of the limit is used instead.
1523 limit is set to the keyword
1525 the soft limit is used in either case; if it is set to the keyword
1527 no hard limit is enforced.
1528 Explicit requests for size limits smaller or equal to the
1533 specifier sets a limit on the number of candidates a search request is allowed
1535 The rationale behind it is that searches for non-properly indexed
1536 attributes may result in large sets of candidates, which must be
1539 to determine whether they match the search filter or not.
1542 limit provides a means to drop such operations before they are even
1544 If the selected candidates exceed the
1546 limit, the search will abort with
1547 .IR "Unwilling to perform" .
1548 If it is set to the keyword
1550 no limit is applied (the default).
1553 the search is not even performed; this can be used to disallow searches
1554 for a specific set of users.
1555 If no limit specifier is set, the value is assigned to the
1561 to preserve the original behavior.
1563 In case of no match, the global limits are used.
1564 The default values are the same as for
1573 control is requested, the
1575 size limit is used by default, because the request of a specific page size
1576 is considered an explicit request for a limitation on the number
1577 of entries to be returned.
1578 However, the size limit applies to the total count of entries returned within
1579 the search, and not to a single page.
1580 Additional size limits may be enforced; the syntax is
1581 .BR size.pr={<integer>|noEstimate|unlimited} ,
1584 is the max page size if no explicit limit is set; the keyword
1586 inhibits the server from returning an estimate of the total number
1587 of entries that might be returned
1588 (note: the current implementation does not return any estimate).
1591 indicates that no limit is applied to the pagedResults control page size.
1593 .B size.prtotal={<integer>|unlimited|disabled}
1594 allows to set a limit on the total number of entries that a pagedResults
1595 control allows to return.
1596 By default it is set to the
1601 is the max number of entries that the whole search with pagedResults control
1605 to allow unlimited number of entries to be returned, e.g. to allow
1606 the use of the pagedResults control as a means to circumvent size
1607 limitations on regular searches; the keyword
1609 disables the control, i.e. no paged results can be returned.
1610 Note that the total number of entries returned when the pagedResults control
1611 is requested cannot exceed the
1613 size limit of regular searches unless extended by the
1618 .B olcMaxDerefDepth: <depth>
1619 Specifies the maximum number of aliases to dereference when trying to
1620 resolve an entry, used to avoid infinite alias loops. The default is 15.
1622 .B olcMirrorMode: TRUE | FALSE
1623 This option puts a replica database into "mirror" mode. Update
1624 operations will be accepted from any user, not just the updatedn. The
1625 database must already be configured as syncrepl consumer
1626 before this keyword may be set. This mode also requires a
1628 (see above) to be configured.
1629 By default, this setting is FALSE.
1631 .B olcPlugin: <plugin_type> <lib_path> <init_function> [<arguments>]
1632 Configure a SLAPI plugin. See the
1633 .BR slapd.plugin (5)
1634 manpage for more details.
1637 Specify the distinguished name that is not subject to access control
1638 or administrative limit restrictions for operations on this database.
1639 This DN may or may not be associated with an entry. An empty root
1640 DN (the default) specifies no root access is to be granted. It is
1641 recommended that the rootdn only be specified when needed (such as
1642 when initially populating a database). If the rootdn is within
1643 a namingContext (suffix) of the database, a simple bind password
1644 may also be provided using the
1646 directive. Note that the rootdn is always needed when using syncrepl.
1651 database defaults to
1655 .B olcRootPW: <password>
1656 Specify a password (or hash of the password) for the rootdn. The
1657 password can only be set if the rootdn is within the namingContext
1658 (suffix) of the database.
1659 This option accepts all RFC 2307 userPassword formats known to
1662 description) as well as cleartext.
1664 may be used to generate a hash of a password. Cleartext
1665 and \fB{CRYPT}\fP passwords are not recommended. If empty
1666 (the default), authentication of the root DN is by other means
1667 (e.g. SASL). Use of SASL is encouraged.
1669 .B olcSubordinate: [TRUE | FALSE | advertise]
1670 Specify that the current backend database is a subordinate of another
1671 backend database. A subordinate database may have only one suffix. This
1672 option may be used to glue multiple databases into a single namingContext.
1673 If the suffix of the current database is within the namingContext of a
1674 superior database, searches against the superior database will be
1675 propagated to the subordinate as well. All of the databases
1676 associated with a single namingContext should have identical rootdns.
1677 Behavior of other LDAP operations is unaffected by this setting. In
1678 particular, it is not possible to use moddn to move an entry from
1679 one subordinate to another subordinate within the namingContext.
1681 If the optional \fBadvertise\fP flag is supplied, the naming context of
1682 this database is advertised in the root DSE. The default is to hide this
1683 database context, so that only the superior context is visible.
1690 are used on the superior database, any glued subordinates that support
1691 these tools are opened as well.
1693 Databases that are glued together should usually be configured with the
1694 same indices (assuming they support indexing), even for attributes that
1695 only exist in some of these databases. In general, all of the glued
1696 databases should be configured as similarly as possible, since the intent
1697 is to provide the appearance of a single directory.
1699 Note that the subordinate functionality is implemented internally
1700 by the \fIglue\fP overlay and as such its behavior will interact with other
1701 overlays in use. By default, the glue overlay is automatically configured as
1702 the last overlay on the superior database. Its position on the database
1703 can be explicitly configured by setting an \fBoverlay glue\fP directive
1704 at the desired position. This explicit configuration is necessary e.g.
1705 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1706 in order to work over all of the glued databases. E.g.
1709 dn: olcDatabase={1}bdb,cn=config
1710 olcSuffix: dc=example,dc=com
1713 dn: olcOverlay={0}glue,olcDatabase={1}bdb,cn=config
1716 dn: olcOverlay={1}syncprov,olcDatabase={1}bdb,cn=config
1720 See the Overlays section below for more details.
1722 .B olcSuffix: <dn suffix>
1723 Specify the DN suffix of queries that will be passed to this
1724 backend database. Multiple suffix lines can be given and at least one is
1725 required for each database definition.
1727 If the suffix of one database is "inside" that of another, the database
1728 with the inner suffix must come first in the configuration file.
1729 You may also want to glue such databases together with the
1733 .B olcSyncUseSubentry: TRUE | FALSE
1734 Store the syncrepl contextCSN in a subentry instead of the context entry
1735 of the database. The subentry's RDN will be "cn=ldapsync". The default is
1736 FALSE, meaning the contextCSN is stored in the context entry.
1739 .B olcSyncrepl: rid=<replica ID>
1740 .B provider=ldap[s]://<hostname>[:port]
1741 .B searchbase=<base DN>
1742 .B [type=refreshOnly|refreshAndPersist]
1743 .B [interval=dd:hh:mm:ss]
1744 .B [retry=[<retry interval> <# of retries>]+]
1745 .B [filter=<filter str>]
1746 .B [scope=sub|one|base|subord]
1747 .B [attrs=<attr list>]
1748 .B [exattrs=<attr list>]
1750 .B [sizelimit=<limit>]
1751 .B [timelimit=<limit>]
1752 .B [schemachecking=on|off]
1753 .B [network\-timeout=<seconds>]
1754 .B [timeout=<seconds>]
1755 .B [bindmethod=simple|sasl]
1757 .B [saslmech=<mech>]
1758 .B [authcid=<identity>]
1759 .B [authzid=<identity>]
1760 .B [credentials=<passwd>]
1762 .B [secprops=<properties>]
1763 .B [keepalive=<idle>:<probes>:<interval>]
1764 .B [starttls=yes|critical]
1765 .B [tls_cert=<file>]
1767 .B [tls_cacert=<file>]
1768 .B [tls_cacertdir=<path>]
1769 .B [tls_reqcert=never|allow|try|demand]
1770 .B [tls_ciphersuite=<ciphers>]
1771 .B [tls_crlcheck=none|peer|all]
1772 .B [suffixmassage=<real DN>]
1773 .B [logbase=<base DN>]
1774 .B [logfilter=<filter str>]
1775 .B [syncdata=default|accesslog|changelog]
1777 Specify the current database as a replica which is kept up-to-date with the
1778 master content by establishing the current
1780 as a replication consumer site running a
1783 The replica content is kept synchronized to the master content using
1784 the LDAP Content Synchronization protocol. Refer to the
1785 "OpenLDAP Administrator's Guide" for detailed information on
1786 setting up a replicated
1788 directory service using the
1793 identifies the current
1795 directive within the replication consumer site.
1796 It is a non-negative integer having no more than three decimal digits.
1799 specifies the replication provider site containing the master content
1800 as an LDAP URI. If <port> is not given, the standard LDAP port number
1801 (389 or 636) is used.
1805 replica is defined using a search
1806 specification as its result set. The consumer
1808 will send search requests to the provider
1810 according to the search specification. The search specification includes
1811 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1814 parameters as in the normal search specification. The
1816 option may also be used to specify attributes that should be omitted
1817 from incoming entries.
1818 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1819 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1820 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1821 attributes, and \fBattrsonly\fP and \fBexattrs\fP are unset by default.
1822 The \fBsizelimit\fP and \fBtimelimit\fP only
1823 accept "unlimited" and positive integers, and both default to "unlimited".
1824 Note, however, that any provider-side limits for the replication identity
1825 will be enforced by the provider regardless of the limits requested
1826 by the LDAP Content Synchronization operation, much like for any other
1829 The LDAP Content Synchronization protocol has two operation types.
1832 operation, the next synchronization search operation
1833 is periodically rescheduled at an interval time (specified by
1835 parameter; 1 day by default)
1836 after each synchronization operation finishes.
1838 .B refreshAndPersist
1839 operation, a synchronization search remains persistent in the provider slapd.
1840 Further updates to the master replica will generate
1841 .B searchResultEntry
1842 to the consumer slapd as the search responses to the persistent
1843 synchronization search.
1845 If an error occurs during replication, the consumer will attempt to
1846 reconnect according to the
1848 parameter which is a list of the <retry interval> and <# of retries> pairs.
1849 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1850 for the first 10 times and then retry every 300 seconds for the next 3
1851 times before stop retrying. The `+' in <# of retries> means indefinite
1852 number of retries until success.
1854 The schema checking can be enforced at the LDAP Sync
1855 consumer site by turning on the
1857 parameter. The default is off.
1861 parameter sets how long the consumer will wait to establish a
1862 network connection to the provider. Once a connection is
1865 parameter determines how long the consumer will wait for the initial
1866 Bind request to complete. The defaults for these parameters come
1874 requires the options
1878 and should only be used when adequate security services
1879 (e.g. TLS or IPSEC) are in place.
1886 Depending on the mechanism, an authentication identity and/or
1887 credentials can be specified using
1893 parameter may be used to specify an authorization identity.
1894 Specific security properties (as with the
1896 keyword above) for a SASL bind can be set with the
1898 option. A non default SASL realm can be set with the
1901 The provider, other than allow authentication of the syncrepl identity,
1902 should grant that identity appropriate access privileges to the data
1903 that is being replicated (\fBaccess\fP directive), and appropriate time
1904 and size limits (\fBlimits\fP directive).
1908 parameter sets the values of \fIidle\fP, \fIprobes\fP, and \fIinterval\fP
1909 used to check whether a socket is alive;
1911 is the number of seconds a connection needs to remain idle before TCP
1912 starts sending keepalive probes;
1914 is the maximum number of keepalive probes TCP should send before dropping
1917 is interval in seconds between individual keepalive probes.
1918 Only some systems support the customization of these values;
1921 parameter is ignored otherwise, and system-wide settings are used.
1925 parameter specifies use of the StartTLS extended operation
1926 to establish a TLS session before Binding to the provider. If the
1928 argument is supplied, the session will be aborted if the StartTLS request
1929 fails. Otherwise the syncrepl session continues without TLS. The
1930 tls_reqcert setting defaults to "demand" and the other TLS settings
1931 default to the same as the main slapd TLS settings.
1935 parameter allows the consumer to pull entries from a remote directory
1936 whose DN suffix differs from the local directory. The portion of the
1937 remote entries' DNs that matches the \fIsearchbase\fP will be replaced
1938 with the suffixmassage DN.
1940 Rather than replicating whole entries, the consumer can query logs of
1941 data modifications. This mode of operation is referred to as \fIdelta
1942 syncrepl\fP. In addition to the above parameters, the
1946 parameters must be set appropriately for the log that will be used. The
1948 parameter must be set to either "accesslog" if the log conforms to the
1949 .BR slapo\-accesslog (5)
1950 log format, or "changelog" if the log conforms
1951 to the obsolete \fIchangelog\fP format. If the
1953 parameter is omitted or set to "default" then the log parameters are
1957 .B olcUpdateDN: <dn>
1958 This option is only applicable in a slave
1960 It specifies the DN permitted to update (subject to access controls)
1961 the replica. It is only needed in certain push-mode
1962 replication scenarios. Generally, this DN
1968 .B olcUpdateRef: <url>
1969 Specify the referral to pass back when
1971 is asked to modify a replicated local database.
1972 If multiple values are specified, each url is provided.
1974 .SH DATABASE-SPECIFIC OPTIONS
1975 Each database may allow specific configuration options; they are
1976 documented separately in the backends' manual pages. See the
1977 .BR slapd.backends (5)
1978 manual page for an overview of available backends.
1980 An overlay is a piece of
1981 code that intercepts database operations in order to extend or change
1982 them. Overlays are pushed onto
1983 a stack over the database, and so they will execute in the reverse
1984 of the order in which they were configured and the database itself
1985 will receive control last of all.
1987 Overlays must be configured as child entries of a specific database. The
1988 entry's RDN must be of the form
1989 .B olcOverlay={x}<overlaytype>
1990 and the entry must have the olcOverlayConfig objectClass. Normally the
1991 config engine generates the "{x}" index in the RDN automatically, so
1992 it can be omitted when initially loading these entries.
1995 .BR slapd.overlays (5)
1996 manual page for an overview of available overlays.
1999 Here is a short example of a configuration in LDIF suitable for use with
2006 objectClass: olcGlobal
2008 olcPidFile: LOCALSTATEDIR/run/slapd.pid
2009 olcAttributeOptions: x\-hidden lang\-
2011 dn: cn=schema,cn=config
2012 objectClass: olcSchemaConfig
2015 include: file://SYSCONFDIR/schema/core.ldif
2017 dn: olcDatabase=frontend,cn=config
2018 objectClass: olcDatabaseConfig
2019 objectClass: olcFrontendConfig
2020 olcDatabase: frontend
2021 # Subtypes of "name" (e.g. "cn" and "ou") with the
2022 # option ";x\-hidden" can be searched for/compared,
2023 # but are not shown. See \fBslapd.access\fP(5).
2024 olcAccess: to attrs=name;x\-hidden by * =cs
2025 # Protect passwords. See \fBslapd.access\fP(5).
2026 olcAccess: to attrs=userPassword by * auth
2027 # Read access to other attributes and entries.
2028 olcAccess: to * by * read
2030 # set a rootpw for the config database so we can bind.
2031 # deny access to everyone else.
2032 dn: olcDatabase=config,cn=config
2033 objectClass: olcDatabaseConfig
2035 olcRootPW: {SSHA}XKYnrjvGT3wZFQrDD5040US592LxsdLy
2036 olcAccess: to * by * none
2038 dn: olcDatabase=bdb,cn=config
2039 objectClass: olcDatabaseConfig
2040 objectClass: olcBdbConfig
2042 olcSuffix: "dc=our\-domain,dc=com"
2043 # The database directory MUST exist prior to
2044 # running slapd AND should only be accessible
2045 # by the slapd/tools. Mode 0700 recommended.
2046 olcDbDirectory: LOCALSTATEDIR/openldap\-data
2047 # Indices to maintain
2048 olcDbIndex: objectClass eq
2049 olcDbIndex: cn,sn,mail pres,eq,approx,sub
2051 # We serve small clients that do not handle referrals,
2052 # so handle remote lookups on their behalf.
2053 dn: olcDatabase=ldap,cn=config
2054 objectClass: olcDatabaseConfig
2055 objectClass: olcLdapConfig
2058 olcDbUri: ldap://ldap.some\-server.com/
2062 Assuming the above data was saved in a file named "config.ldif" and the
2063 ETCDIR/slapd.d directory has been created, this command will initialize
2067 slapadd \-F ETCDIR/slapd.d \-n 0 \-l config.ldif
2072 "OpenLDAP Administrator's Guide" contains a longer annotated
2073 example of a slapd configuration.
2075 Alternatively, an existing slapd.conf file can be converted to the new
2076 format using slapd or any of the slap tools:
2079 slaptest \-f ETCDIR/slapd.conf \-F ETCDIR/slapd.d
2086 default slapd configuration file
2089 default slapd configuration directory
2093 .BR gnutls\-cli (1),
2094 .BR slapd.access (5),
2095 .BR slapd.backends (5),
2097 .BR slapd.overlays (5),
2098 .BR slapd.plugin (5),
2109 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
2110 .SH ACKNOWLEDGEMENTS
projects / openldap / blob