1 .TH SLAPD-CONFIG 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2012 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
821 the TLS library in use (OpenSSL, GnuTLS, or Mozilla NSS).
827 olcTLSCipherSuite: HIGH:MEDIUM:+SSLv2
830 TLSCiphersuite SECURE256:!AES-128-CBC
833 To check what ciphers a given spec selects in OpenSSL, use:
836 openssl ciphers \-v <cipher-suite-spec>
839 With GnuTLS the available specs can be found in the manual page of
841 (see the description of the
845 In older versions of GnuTLS, where gnutls\-cli does not support the option
846 \-\-priority, you can obtain the \(em more limited \(em list of ciphers by calling:
852 When using Mozilla NSS, the OpenSSL cipher suite specifications are used and
853 translated into the format used internally by Mozilla NSS. There isn't an easy
854 way to list the cipher suites from the command line. The authoritative list
855 is in the source code for Mozilla NSS in the file sslinfo.c in the structure
857 static const SSLCipherSuiteInfo suiteInfo[]
861 .B olcTLSCACertificateFile: <filename>
862 Specifies the file that contains certificates for all of the Certificate
867 .B olcTLSCACertificatePath: <path>
868 Specifies the path of a directory that contains Certificate Authority
869 certificates in separate individual files. Usually only one of this
870 or the olcTLSCACertificateFile is defined. If both are specified, both
871 locations will be used. This directive is not supported
874 When using Mozilla NSS, <path> may contain a Mozilla NSS cert/key
875 database. If <path> contains a Mozilla NSS cert/key database and
876 CA cert files, OpenLDAP will use the cert/key database and will
877 ignore the CA cert files.
879 .B olcTLSCertificateFile: <filename>
880 Specifies the file that contains the
884 When using Mozilla NSS, if using a cert/key database (specified with
885 olcTLSCACertificatePath), olcTLSCertificateFile specifies
886 the name of the certificate to use:
888 olcTLSCertificateFile: Server-Cert
890 If using a token other than the internal built in token, specify the
891 token name first, followed by a colon:
893 olcTLSCertificateFile: my hardware device:Server-Cert
895 Use certutil -L to list the certificates by name:
897 certutil -d /path/to/certdbdir -L
900 .B olcTLSCertificateKeyFile: <filename>
901 Specifies the file that contains the
903 server private key that matches the certificate stored in the
904 .B olcTLSCertificateFile
905 file. If the private key is protected with a password, the password must
906 be manually typed in when slapd starts. Usually the private key is not
907 protected with a password, to allow slapd to start without manual
909 it is of critical importance that the file is protected carefully.
911 When using Mozilla NSS, olcTLSCertificateKeyFile specifies the name of
912 a file that contains the password for the key for the certificate specified with
913 olcTLSCertificateFile. The modutil command can be used to turn off password
914 protection for the cert/key database. For example, if olcTLSCACertificatePath
915 specifes /etc/openldap/certdb as the location of the cert/key database, use
916 modutil to change the password to the empty string:
918 modutil -dbdir /etc/openldap/certdb -changepw 'NSS Certificate DB'
920 You must have the old password, if any. Ignore the WARNING about the running
921 browser. Press 'Enter' for the new password.
924 .B olcTLSDHParamFile: <filename>
925 This directive specifies the file that contains parameters for Diffie-Hellman
926 ephemeral key exchange. This is required in order to use a DSA certificate on
927 the server. If multiple sets of parameters are present in the file, all of
928 them will be processed. Note that setting this option may also enable
929 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
930 You should append "!ADH" to your cipher suites if you have changed them
931 from the default, otherwise no certificate exchanges or verification will
932 be done. When using GnuTLS or Mozilla NSS these parameters are always generated randomly
933 so this directive is ignored.
935 .B olcTLSRandFile: <filename>
936 Specifies the file to obtain random bits from when /dev/[u]random
937 is not available. Generally set to the name of the EGD/PRNGD socket.
938 The environment variable RANDFILE can also be used to specify the filename.
939 This directive is ignored with GnuTLS and Mozilla NSS.
941 .B olcTLSVerifyClient: <level>
942 Specifies what checks to perform on client certificates in an
943 incoming TLS session, if any.
946 can be specified as one of the following keywords:
952 will not ask the client for a certificate.
955 The client certificate is requested. If no certificate is provided,
956 the session proceeds normally. If a bad certificate is provided,
957 it will be ignored and the session proceeds normally.
960 The client certificate is requested. If no certificate is provided,
961 the session proceeds normally. If a bad certificate is provided,
962 the session is immediately terminated.
964 .B demand | hard | true
965 These keywords are all equivalent, for compatibility reasons.
966 The client certificate is requested. If no certificate is provided,
967 or a bad certificate is provided, the session is immediately terminated.
969 Note that a valid client certificate is required in order to use the
970 SASL EXTERNAL authentication mechanism with a TLS session. As such,
972 .B olcTLSVerifyClient
973 setting must be chosen to enable SASL EXTERNAL authentication.
976 .B olcTLSCRLCheck: <level>
977 Specifies if the Certificate Revocation List (CRL) of the CA should be
978 used to verify if the client certificates have not been revoked. This
980 .B olcTLSCACertificatePath
981 parameter to be set. This parameter is ignored with GnuTLS and Mozilla NSS.
983 can be specified as one of the following keywords:
987 No CRL checks are performed
990 Check the CRL of the peer certificate
993 Check the CRL for a whole certificate chain
996 .B olcTLSCRLFile: <filename>
997 Specifies a file containing a Certificate Revocation List to be used
998 for verifying that certificates have not been revoked. This parameter
999 is only valid when using GnuTLS or Mozilla NSS.
1000 .SH DYNAMIC MODULE OPTIONS
1003 is compiled with \-\-enable\-modules then the module-related entries will
1004 be available. These entries are named
1005 .B cn=module{x},cn=config
1007 must have the olcModuleList objectClass. One entry should be created
1010 Normally the config engine generates the "{x}" index in the RDN
1011 automatically, so it can be omitted when initially loading these entries.
1013 .B olcModuleLoad: <filename>
1014 Specify the name of a dynamically loadable module to load. The filename
1015 may be an absolute path name or a simple filename. Non-absolute names
1016 are searched for in the directories specified by the
1020 .B olcModulePath: <pathspec>
1021 Specify a list of directories to search for loadable modules. Typically
1022 the path is colon-separated but this depends on the operating system.
1023 The default is MODULEDIR, which is where the standard OpenLDAP install
1024 will place its modules.
1026 Schema definitions are created as entries in the
1027 .B cn=schema,cn=config
1028 subtree. These entries must have the olcSchemaConfig objectClass.
1029 As noted above, the actual
1030 .B cn=schema,cn=config
1031 entry is predefined and any values specified for it are ignored.
1035 .B olcAttributetypes: "(\ <oid>\
1037 [DESC\ <description>]\
1046 [NO\-USER\-MODIFICATION]\
1047 [USAGE\ <attributeUsage>]\ )"
1049 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
1050 The slapd parser extends the RFC 4512 definition by allowing string
1051 forms as well as numeric OIDs to be used for the attribute OID and
1052 attribute syntax OID.
1054 .B olcObjectIdentifier
1060 .B olcDitContentRules: "(\ <oid>\
1062 [DESC\ <description>]\
1069 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
1070 The slapd parser extends the RFC 4512 definition by allowing string
1071 forms as well as numeric OIDs to be used for the attribute OID and
1072 attribute syntax OID.
1074 .B olcObjectIdentifier
1080 .B olcObjectClasses: "(\ <oid>\
1082 [DESC\ <description>]\
1085 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
1086 [MUST\ <oids>] [MAY\ <oids>] )"
1088 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
1089 The slapd parser extends the RFC 4512 definition by allowing string
1090 forms as well as numeric OIDs to be used for the object class OID.
1094 description.) Object classes are "STRUCTURAL" by default.
1097 .B olcObjectIdentifier: <name> "{ <oid> | <name>[:<suffix>] }"
1098 Define a string name that equates to the given OID. The string can be used
1099 in place of the numeric OID in objectclass and attribute definitions. The
1100 name can also be used with a suffix of the form ":xx" in which case the
1101 value "oid.xx" will be used.
1103 .SH GENERAL BACKEND OPTIONS
1104 Options in these entries only apply to the configuration of a single
1105 type of backend. All backends may support this class of options.
1106 The entry must be named
1107 .B olcBackend=<databasetype>,cn=config
1108 and must have the olcBackendConfig objectClass.
1126 At present, no backend implements any options of this type.
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 olcPasswordHash: <hash> [<hash>...]
1176 This option configures one or more hashes to be used in generation of user
1177 passwords stored in the userPassword attribute during processing of
1178 LDAP Password Modify Extended Operations (RFC 3062).
1179 The <hash> must be one of
1193 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
1198 use the MD5 algorithm (RFC 1321), the latter with a seed.
1205 indicates that the new password should be
1206 added to userPassword as clear text.
1208 Note that this option does not alter the normal user applications
1209 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
1210 This setting is only allowed in the frontend entry.
1212 .B olcReadOnly: TRUE | FALSE
1213 This option puts the database into "read-only" mode. Any attempts to
1214 modify the database will return an "unwilling to perform" error. By
1215 default, olcReadOnly is FALSE. Note that when this option is set
1216 TRUE on the frontend, it cannot be reset without restarting the
1217 server, since further writes to the config database will be rejected.
1219 .B olcRequires: <conditions>
1220 Specify a set of conditions to require (default none).
1221 The directive may be specified globally and/or per-database;
1222 databases inherit global conditions, so per-database specifications
1225 requires bind operation prior to directory operations.
1227 requires session to be using LDAP version 3.
1229 requires authentication prior to directory operations.
1231 requires SASL authentication prior to directory operations.
1233 requires strong authentication prior to directory operations.
1234 The strong keyword allows protected "simple" authentication
1235 as well as SASL authentication.
1237 may be used to require no conditions (useful to clear out globally
1238 set conditions within a particular database); it must occur first
1239 in the list of conditions.
1241 .B olcRestrict: <oplist>
1242 Specify a list of operations that are restricted.
1243 Restrictions on a specific database override any frontend setting.
1244 Operations can be any of
1249 .BR extended[=<OID>] ,
1253 or the special pseudo-operations
1257 which respectively summarize read and write operations.
1261 .I olcReadOnly: TRUE
1265 keyword allows to indicate the OID of the specific operation
1268 .B olcSchemaDN: <dn>
1269 Specify the distinguished name for the subschema subentry that
1270 controls the entries on this server. The default is "cn=Subschema".
1272 .B olcSecurity: <factors>
1273 Specify a set of security strength factors (separated by white space)
1275 .BR olcSaslSecprops 's
1277 option for a description of security strength factors).
1278 The directive may be specified globally and/or per-database.
1280 specifies the overall security strength factor.
1282 specifies the transport security strength factor.
1284 specifies the TLS security strength factor.
1286 specifies the SASL security strength factor.
1288 specifies the overall security strength factor to require for
1290 .B update_transport=<n>
1291 specifies the transport security strength factor to require for
1294 specifies the TLS security strength factor to require for
1297 specifies the SASL security strength factor to require for
1300 specifies the security strength factor required for
1302 username/password authentication.
1305 factor is measure of security provided by the underlying transport,
1306 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
1308 .B olcSizeLimit: {<integer>|unlimited}
1310 .B olcSizeLimit: size[.{soft|hard|unchecked}]=<integer> [...]
1311 Specify the maximum number of entries to return from a search operation.
1312 The default size limit is 500.
1315 to specify no limits.
1316 The second format allows a fine grain setting of the size limits.
1317 Extra args can be added in the same value or as additional values.
1320 for an explanation of the different flags.
1322 .B olcSortVals: <attr> [...]
1323 Specify a list of multi-valued attributes whose values will always
1324 be maintained in sorted order. Using this option will allow Modify,
1325 Compare, and filter evaluations on these attributes to be performed
1326 more efficiently. The resulting sort order depends on the
1327 attributes' syntax and matching rules and may not correspond to
1328 lexical order or any other recognizable order.
1329 This setting is only allowed in the frontend entry.
1331 .B olcTimeLimit: {<integer>|unlimited}
1333 .B olcTimeLimit: time[.{soft|hard}]=<integer> [...]
1334 Specify the maximum number of seconds (in real time)
1336 will spend answering a search request. The default time limit is 3600.
1339 to specify no limits.
1340 The second format allows a fine grain setting of the time limits.
1341 Extra args can be added in the same value or as additional values.
1344 for an explanation of the different flags.
1346 .SH GENERAL DATABASE OPTIONS
1347 Options in this section only apply to the specific database for
1348 which they are defined. They are supported by every
1349 type of backend. All of the Global Database Options may also be
1352 .B olcAddContentAcl: TRUE | FALSE
1353 Controls whether Add operations will perform ACL checks on
1354 the content of the entry being added. This check is off
1356 .BR slapd.access (5)
1357 manual page for more details on ACL requirements for
1360 .B olcHidden: TRUE | FALSE
1361 Controls whether the database will be used to answer
1362 queries. A database that is hidden will never be
1363 selected to answer any queries, and any suffix configured
1364 on the database will be ignored in checks for conflicts
1365 with other databases. By default, olcHidden is FALSE.
1367 .B olcLastMod: TRUE | FALSE
1370 will automatically maintain the
1371 modifiersName, modifyTimestamp, creatorsName, and
1372 createTimestamp attributes for entries. It also controls
1373 the entryCSN and entryUUID attributes, which are needed
1374 by the syncrepl provider. By default, olcLastMod is TRUE.
1376 .B olcLimits: <selector> <limit> [<limit> [...]]
1377 Specify time and size limits based on the operation's initiator or
1385 anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>
1391 <dnspec> ::= dn[.<type>][.<style>]
1393 <type> ::= self | this
1395 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1400 is the default and means the bound user, while
1402 means the base DN of the operation.
1405 matches all unauthenticated clients.
1408 matches all authenticated clients;
1411 dn pattern is assumed unless otherwise specified by qualifying
1412 the (optional) key string
1418 (which are synonyms), to require an exact match; with
1420 to require exactly one level of depth match; with
1422 to allow any level of depth match, including the exact match; with
1424 to allow any level of depth match, not including the exact match;
1426 explicitly requires the (default) match based on POSIX (''extended'')
1427 regular expression pattern.
1430 matches unbound operations; the
1433 The same behavior is obtained by using the
1440 with the optional objectClass
1446 sets the limits for any DN listed in the values of the
1452 group objectClass (default
1454 whose DN exactly matches
1457 The currently supported limits are
1462 The syntax for time limits is
1463 .BR time[.{soft|hard}]=<integer> ,
1466 is the number of seconds slapd will spend answering a search request.
1467 If no time limit is explicitly requested by the client, the
1469 limit is used; if the requested time limit exceeds the
1472 .\".I "Administrative limit exceeded"
1473 .\"error is returned.
1474 limit, the value of the limit is used instead.
1477 limit is set to the keyword
1479 the soft limit is used in either case; if it is set to the keyword
1481 no hard limit is enforced.
1482 Explicit requests for time limits smaller or equal to the
1485 If no limit specifier is set, the value is assigned to the
1491 to preserve the original behavior.
1493 The syntax for size limits is
1494 .BR size[.{soft|hard|unchecked}]=<integer> ,
1497 is the maximum number of entries slapd will return answering a search
1499 If no size limit is explicitly requested by the client, the
1501 limit is used; if the requested size limit exceeds the
1504 .\".I "Administrative limit exceeded"
1505 .\"error is returned.
1506 limit, the value of the limit is used instead.
1509 limit is set to the keyword
1511 the soft limit is used in either case; if it is set to the keyword
1513 no hard limit is enforced.
1514 Explicit requests for size limits smaller or equal to the
1519 specifier sets a limit on the number of candidates a search request is allowed
1521 The rationale behind it is that searches for non-properly indexed
1522 attributes may result in large sets of candidates, which must be
1525 to determine whether they match the search filter or not.
1528 limit provides a means to drop such operations before they are even
1530 If the selected candidates exceed the
1532 limit, the search will abort with
1533 .IR "Unwilling to perform" .
1534 If it is set to the keyword
1536 no limit is applied (the default).
1539 the search is not even performed; this can be used to disallow searches
1540 for a specific set of users.
1541 If no limit specifier is set, the value is assigned to the
1547 to preserve the original behavior.
1549 In case of no match, the global limits are used.
1550 The default values are the same as for
1559 control is requested, the
1561 size limit is used by default, because the request of a specific page size
1562 is considered an explicit request for a limitation on the number
1563 of entries to be returned.
1564 However, the size limit applies to the total count of entries returned within
1565 the search, and not to a single page.
1566 Additional size limits may be enforced; the syntax is
1567 .BR size.pr={<integer>|noEstimate|unlimited} ,
1570 is the max page size if no explicit limit is set; the keyword
1572 inhibits the server from returning an estimate of the total number
1573 of entries that might be returned
1574 (note: the current implementation does not return any estimate).
1577 indicates that no limit is applied to the pagedResults control page size.
1579 .B size.prtotal={<integer>|unlimited|disabled}
1580 allows to set a limit on the total number of entries that a pagedResults
1581 control allows to return.
1582 By default it is set to the
1587 is the max number of entries that the whole search with pagedResults control
1591 to allow unlimited number of entries to be returned, e.g. to allow
1592 the use of the pagedResults control as a means to circumvent size
1593 limitations on regular searches; the keyword
1595 disables the control, i.e. no paged results can be returned.
1596 Note that the total number of entries returned when the pagedResults control
1597 is requested cannot exceed the
1599 size limit of regular searches unless extended by the
1604 .B olcMaxDerefDepth: <depth>
1605 Specifies the maximum number of aliases to dereference when trying to
1606 resolve an entry, used to avoid infinite alias loops. The default is 15.
1608 .B olcMirrorMode: TRUE | FALSE
1609 This option puts a replica database into "mirror" mode. Update
1610 operations will be accepted from any user, not just the updatedn. The
1611 database must already be configured as syncrepl consumer
1612 before this keyword may be set. This mode also requires a
1614 (see above) to be configured.
1615 By default, this setting is FALSE.
1617 .B olcPlugin: <plugin_type> <lib_path> <init_function> [<arguments>]
1618 Configure a SLAPI plugin. See the
1619 .BR slapd.plugin (5)
1620 manpage for more details.
1623 Specify the distinguished name that is not subject to access control
1624 or administrative limit restrictions for operations on this database.
1625 This DN may or may not be associated with an entry. An empty root
1626 DN (the default) specifies no root access is to be granted. It is
1627 recommended that the rootdn only be specified when needed (such as
1628 when initially populating a database). If the rootdn is within
1629 a namingContext (suffix) of the database, a simple bind password
1630 may also be provided using the
1632 directive. Note that the rootdn is always needed when using syncrepl.
1637 database defaults to
1641 .B olcRootPW: <password>
1642 Specify a password (or hash of the password) for the rootdn. The
1643 password can only be set if the rootdn is within the namingContext
1644 (suffix) of the database.
1645 This option accepts all RFC 2307 userPassword formats known to
1648 description) as well as cleartext.
1650 may be used to generate a hash of a password. Cleartext
1651 and \fB{CRYPT}\fP passwords are not recommended. If empty
1652 (the default), authentication of the root DN is by other means
1653 (e.g. SASL). Use of SASL is encouraged.
1655 .B olcSubordinate: [TRUE | FALSE | advertise]
1656 Specify that the current backend database is a subordinate of another
1657 backend database. A subordinate database may have only one suffix. This
1658 option may be used to glue multiple databases into a single namingContext.
1659 If the suffix of the current database is within the namingContext of a
1660 superior database, searches against the superior database will be
1661 propagated to the subordinate as well. All of the databases
1662 associated with a single namingContext should have identical rootdns.
1663 Behavior of other LDAP operations is unaffected by this setting. In
1664 particular, it is not possible to use moddn to move an entry from
1665 one subordinate to another subordinate within the namingContext.
1667 If the optional \fBadvertise\fP flag is supplied, the naming context of
1668 this database is advertised in the root DSE. The default is to hide this
1669 database context, so that only the superior context is visible.
1676 are used on the superior database, any glued subordinates that support
1677 these tools are opened as well.
1679 Databases that are glued together should usually be configured with the
1680 same indices (assuming they support indexing), even for attributes that
1681 only exist in some of these databases. In general, all of the glued
1682 databases should be configured as similarly as possible, since the intent
1683 is to provide the appearance of a single directory.
1685 Note that the subordinate functionality is implemented internally
1686 by the \fIglue\fP overlay and as such its behavior will interact with other
1687 overlays in use. By default, the glue overlay is automatically configured as
1688 the last overlay on the superior database. Its position on the database
1689 can be explicitly configured by setting an \fBoverlay glue\fP directive
1690 at the desired position. This explicit configuration is necessary e.g.
1691 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1692 in order to work over all of the glued databases. E.g.
1695 dn: olcDatabase={1}bdb,cn=config
1696 olcSuffix: dc=example,dc=com
1699 dn: olcOverlay={0}glue,olcDatabase={1}bdb,cn=config
1702 dn: olcOverlay={1}syncprov,olcDatabase={1}bdb,cn=config
1706 See the Overlays section below for more details.
1708 .B olcSuffix: <dn suffix>
1709 Specify the DN suffix of queries that will be passed to this
1710 backend database. Multiple suffix lines can be given and at least one is
1711 required for each database definition.
1713 If the suffix of one database is "inside" that of another, the database
1714 with the inner suffix must come first in the configuration file.
1715 You may also want to glue such databases together with the
1719 .B olcSyncUseSubentry: TRUE | FALSE
1720 Store the syncrepl contextCSN in a subentry instead of the context entry
1721 of the database. The subentry's RDN will be "cn=ldapsync". The default is
1722 FALSE, meaning the contextCSN is stored in the context entry.
1725 .B olcSyncrepl: rid=<replica ID>
1726 .B provider=ldap[s]://<hostname>[:port]
1727 .B searchbase=<base DN>
1728 .B [type=refreshOnly|refreshAndPersist]
1729 .B [interval=dd:hh:mm:ss]
1730 .B [retry=[<retry interval> <# of retries>]+]
1731 .B [filter=<filter str>]
1732 .B [scope=sub|one|base|subord]
1733 .B [attrs=<attr list>]
1734 .B [exattrs=<attr list>]
1736 .B [sizelimit=<limit>]
1737 .B [timelimit=<limit>]
1738 .B [schemachecking=on|off]
1739 .B [network\-timeout=<seconds>]
1740 .B [timeout=<seconds>]
1741 .B [bindmethod=simple|sasl]
1743 .B [saslmech=<mech>]
1744 .B [authcid=<identity>]
1745 .B [authzid=<identity>]
1746 .B [credentials=<passwd>]
1748 .B [secprops=<properties>]
1749 .B [keepalive=<idle>:<probes>:<interval>]
1750 .B [starttls=yes|critical]
1751 .B [tls_cert=<file>]
1753 .B [tls_cacert=<file>]
1754 .B [tls_cacertdir=<path>]
1755 .B [tls_reqcert=never|allow|try|demand]
1756 .B [tls_ciphersuite=<ciphers>]
1757 .B [tls_crlcheck=none|peer|all]
1758 .B [suffixmassage=<real DN>]
1759 .B [logbase=<base DN>]
1760 .B [logfilter=<filter str>]
1761 .B [syncdata=default|accesslog|changelog]
1763 Specify the current database as a replica which is kept up-to-date with the
1764 master content by establishing the current
1766 as a replication consumer site running a
1769 The replica content is kept synchronized to the master content using
1770 the LDAP Content Synchronization protocol. Refer to the
1771 "OpenLDAP Administrator's Guide" for detailed information on
1772 setting up a replicated
1774 directory service using the
1779 identifies the current
1781 directive within the replication consumer site.
1782 It is a non-negative integer having no more than three decimal digits.
1785 specifies the replication provider site containing the master content
1786 as an LDAP URI. If <port> is not given, the standard LDAP port number
1787 (389 or 636) is used.
1791 replica is defined using a search
1792 specification as its result set. The consumer
1794 will send search requests to the provider
1796 according to the search specification. The search specification includes
1797 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1800 parameters as in the normal search specification. The
1802 option may also be used to specify attributes that should be omitted
1803 from incoming entries.
1804 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1805 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1806 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1807 attributes, and \fBattrsonly\fP and \fBexattrs\fP are unset by default.
1808 The \fBsizelimit\fP and \fBtimelimit\fP only
1809 accept "unlimited" and positive integers, and both default to "unlimited".
1810 Note, however, that any provider-side limits for the replication identity
1811 will be enforced by the provider regardless of the limits requested
1812 by the LDAP Content Synchronization operation, much like for any other
1815 The LDAP Content Synchronization protocol has two operation types.
1818 operation, the next synchronization search operation
1819 is periodically rescheduled at an interval time (specified by
1821 parameter; 1 day by default)
1822 after each synchronization operation finishes.
1824 .B refreshAndPersist
1825 operation, a synchronization search remains persistent in the provider slapd.
1826 Further updates to the master replica will generate
1827 .B searchResultEntry
1828 to the consumer slapd as the search responses to the persistent
1829 synchronization search.
1831 If an error occurs during replication, the consumer will attempt to
1832 reconnect according to the
1834 parameter which is a list of the <retry interval> and <# of retries> pairs.
1835 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1836 for the first 10 times and then retry every 300 seconds for the next 3
1837 times before stop retrying. The `+' in <# of retries> means indefinite
1838 number of retries until success.
1840 The schema checking can be enforced at the LDAP Sync
1841 consumer site by turning on the
1843 parameter. The default is off.
1847 parameter sets how long the consumer will wait to establish a
1848 network connection to the provider. Once a connection is
1851 parameter determines how long the consumer will wait for the initial
1852 Bind request to complete. The defaults for these parameters come
1860 requires the options
1864 and should only be used when adequate security services
1865 (e.g. TLS or IPSEC) are in place.
1872 Depending on the mechanism, an authentication identity and/or
1873 credentials can be specified using
1879 parameter may be used to specify an authorization identity.
1880 Specific security properties (as with the
1882 keyword above) for a SASL bind can be set with the
1884 option. A non default SASL realm can be set with the
1887 The provider, other than allow authentication of the syncrepl identity,
1888 should grant that identity appropriate access privileges to the data
1889 that is being replicated (\fBaccess\fP directive), and appropriate time
1890 and size limits (\fBlimits\fP directive).
1894 parameter sets the values of \fIidle\fP, \fIprobes\fP, and \fIinterval\fP
1895 used to check whether a socket is alive;
1897 is the number of seconds a connection needs to remain idle before TCP
1898 starts sending keepalive probes;
1900 is the maximum number of keepalive probes TCP should send before dropping
1903 is interval in seconds between individual keepalive probes.
1904 Only some systems support the customization of these values;
1907 parameter is ignored otherwise, and system-wide settings are used.
1911 parameter specifies use of the StartTLS extended operation
1912 to establish a TLS session before Binding to the provider. If the
1914 argument is supplied, the session will be aborted if the StartTLS request
1915 fails. Otherwise the syncrepl session continues without TLS. The
1916 tls_reqcert setting defaults to "demand" and the other TLS settings
1917 default to the same as the main slapd TLS settings.
1921 parameter allows the consumer to pull entries from a remote directory
1922 whose DN suffix differs from the local directory. The portion of the
1923 remote entries' DNs that matches the \fIsearchbase\fP will be replaced
1924 with the suffixmassage DN.
1926 Rather than replicating whole entries, the consumer can query logs of
1927 data modifications. This mode of operation is referred to as \fIdelta
1928 syncrepl\fP. In addition to the above parameters, the
1932 parameters must be set appropriately for the log that will be used. The
1934 parameter must be set to either "accesslog" if the log conforms to the
1935 .BR slapo\-accesslog (5)
1936 log format, or "changelog" if the log conforms
1937 to the obsolete \fIchangelog\fP format. If the
1939 parameter is omitted or set to "default" then the log parameters are
1943 .B olcUpdateDN: <dn>
1944 This option is only applicable in a slave
1946 It specifies the DN permitted to update (subject to access controls)
1947 the replica. It is only needed in certain push-mode
1948 replication scenarios. Generally, this DN
1954 .B olcUpdateRef: <url>
1955 Specify the referral to pass back when
1957 is asked to modify a replicated local database.
1958 If multiple values are specified, each url is provided.
1960 .SH DATABASE-SPECIFIC OPTIONS
1961 Each database may allow specific configuration options; they are
1962 documented separately in the backends' manual pages. See the
1963 .BR slapd.backends (5)
1964 manual page for an overview of available backends.
1966 An overlay is a piece of
1967 code that intercepts database operations in order to extend or change
1968 them. Overlays are pushed onto
1969 a stack over the database, and so they will execute in the reverse
1970 of the order in which they were configured and the database itself
1971 will receive control last of all.
1973 Overlays must be configured as child entries of a specific database. The
1974 entry's RDN must be of the form
1975 .B olcOverlay={x}<overlaytype>
1976 and the entry must have the olcOverlayConfig objectClass. Normally the
1977 config engine generates the "{x}" index in the RDN automatically, so
1978 it can be omitted when initially loading these entries.
1981 .BR slapd.overlays (5)
1982 manual page for an overview of available overlays.
1985 Here is a short example of a configuration in LDIF suitable for use with
1992 objectClass: olcGlobal
1994 olcPidFile: LOCALSTATEDIR/run/slapd.pid
1995 olcAttributeOptions: x\-hidden lang\-
1997 dn: cn=schema,cn=config
1998 objectClass: olcSchemaConfig
2001 include: file://SYSCONFDIR/schema/core.ldif
2003 dn: olcDatabase=frontend,cn=config
2004 objectClass: olcDatabaseConfig
2005 objectClass: olcFrontendConfig
2006 olcDatabase: frontend
2007 # Subtypes of "name" (e.g. "cn" and "ou") with the
2008 # option ";x\-hidden" can be searched for/compared,
2009 # but are not shown. See \fBslapd.access\fP(5).
2010 olcAccess: to attrs=name;x\-hidden by * =cs
2011 # Protect passwords. See \fBslapd.access\fP(5).
2012 olcAccess: to attrs=userPassword by * auth
2013 # Read access to other attributes and entries.
2014 olcAccess: to * by * read
2016 # set a rootpw for the config database so we can bind.
2017 # deny access to everyone else.
2018 dn: olcDatabase=config,cn=config
2019 objectClass: olcDatabaseConfig
2021 olcRootPW: {SSHA}XKYnrjvGT3wZFQrDD5040US592LxsdLy
2022 olcAccess: to * by * none
2024 dn: olcDatabase=bdb,cn=config
2025 objectClass: olcDatabaseConfig
2026 objectClass: olcBdbConfig
2028 olcSuffix: "dc=our\-domain,dc=com"
2029 # The database directory MUST exist prior to
2030 # running slapd AND should only be accessible
2031 # by the slapd/tools. Mode 0700 recommended.
2032 olcDbDirectory: LOCALSTATEDIR/openldap\-data
2033 # Indices to maintain
2034 olcDbIndex: objectClass eq
2035 olcDbIndex: cn,sn,mail pres,eq,approx,sub
2037 # We serve small clients that do not handle referrals,
2038 # so handle remote lookups on their behalf.
2039 dn: olcDatabase=ldap,cn=config
2040 objectClass: olcDatabaseConfig
2041 objectClass: olcLdapConfig
2044 olcDbUri: ldap://ldap.some\-server.com/
2048 Assuming the above data was saved in a file named "config.ldif" and the
2049 ETCDIR/slapd.d directory has been created, this command will initialize
2053 slapadd \-F ETCDIR/slapd.d \-n 0 \-l config.ldif
2058 "OpenLDAP Administrator's Guide" contains a longer annotated
2059 example of a slapd configuration.
2061 Alternatively, an existing slapd.conf file can be converted to the new
2062 format using slapd or any of the slap tools:
2065 slaptest \-f ETCDIR/slapd.conf \-F ETCDIR/slapd.d
2072 default slapd configuration file
2075 default slapd configuration directory
2079 .BR gnutls\-cli (1),
2080 .BR slapd.access (5),
2081 .BR slapd.backends (5),
2083 .BR slapd.overlays (5),
2084 .BR slapd.plugin (5),
2085 .BR slapd.replog (5),
2096 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
2097 .SH ACKNOWLEDGEMENTS
projects / openldap / blob