1 .TH SLAPD-CONFIG 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd-config \- configuration backend
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 old-style include files
52 dynamically loaded modules
58 backend-specific settings
61 database-specific settings
66 entries will only appear in configurations that were
67 converted from slapd.conf format. There can be multiple entries, one
68 for each included file. These entries only serve as placeholders to
69 document the fact that files were previously included. After those
70 files have been read and parsed, their content is merged into the
71 main configuration and then the include files are ignored thereafter.
72 These entries may form an arbitrarily deep subtree, reflecting any
73 nesting of the original include files.
77 entries will only appear in configurations where slapd
78 was built with support for dynamically loaded modules. There can be
79 multiple entries, one for each configured module path. Within each
80 entry there will be values recorded for each module loaded on a
81 given path. These entries have no children.
85 entry contains all of the hardcoded schema elements.
86 The children of this entry contain all user-defined schema elements.
87 In schema that were loaded from include files, the child entry will
88 be named after the include file from which the schema was loaded.
89 Typically the first child in this subtree will be
90 .BR cn=core,cn=schema,cn=config .
93 entries are for storing settings specific to a single
94 backend type (and thus global to all database instances of that type).
95 At present there are no backends that implement settings of this
96 nature, so usually there will not be any olcBackend entries.
99 entries store settings specific to a single database
100 instance. These entries may have
102 child entries corresponding
103 to any overlays configured on the database. The olcDatabase and
104 olcOverlay entries may also have miscellaneous child entries for
105 other settings as needed. There are two special database entries
106 that are predefined - one is an entry for the config database itself,
107 and the other is for the "frontend" database. Settings in the
108 frontend database are inherited by the other databases, unless
109 they are explicitly overridden in a specific database.
111 The specific configuration options available are discussed below in the
112 Global Configuration Options, General Backend Options, and General Database
113 Options. Options are set by defining LDAP attributes with specific values.
114 In general the names of the LDAP attributes are the same as the corresponding
116 keyword, with an "olc" prefix added on.
118 The parser for many of these attributes is the same as used for parsing
119 the slapd.conf keywords. As such, slapd.conf keywords that allow multiple
120 items to be specified on one line, separated by whitespace, will allow
121 multiple items to be specified in one attribute value. However, when
122 reading the attribute via LDAP, the items will be returned as individual
125 Backend-specific options are discussed in the
126 .B slapd-<backend>(5)
127 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
128 details on configuring slapd.
129 .SH GLOBAL CONFIGURATION OPTIONS
130 Options described in this section apply to the server as a whole.
131 Arguments that should be replaced by
132 actual text are shown in brackets <>.
134 These options may only be specified in the
136 entry. This entry must have an objectClass of
140 .B olcAllows: <features>
141 Specify a set of features to allow (default none).
143 allows acceptance of LDAPv2 bind requests. Note that
145 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
147 allows anonymous bind when credentials are not empty (e.g.
150 allows unauthenticated (anonymous) bind when DN is not empty.
152 allows unauthenticated (anonymous) update operations to be processed
153 (subject to access controls and other administrative limits).
155 allows unauthenticated (anonymous) proxy authorization control to be processed
156 (subject to access controls, authorization and other administrative limits).
158 .B olcArgsFile: <filename>
159 The ( absolute ) name of a file that will hold the
161 server's command line options
162 if started without the debugging command line option.
164 .B olcAttributeOptions: <option-name>...
165 Define tagging attribute options or option tag/range prefixes.
166 Options must not end with `-', prefixes must end with `-'.
167 The `lang-' prefix is predefined.
169 .B olcAttributeOptions
170 directive, `lang-' will no longer be defined and you must specify it
171 explicitly if you want it defined.
173 An attribute description with a tagging option is a subtype of that
174 attribute description without the option.
175 Except for that, options defined this way have no special semantics.
176 Prefixes defined this way work like the `lang-' options:
177 They define a prefix for tagging options starting with the prefix.
178 That is, if you define the prefix `x-foo-', you can use the option
180 Furthermore, in a search or compare, a prefix or range name (with
181 a trailing `-') matches all options starting with that name, as well
182 as the option with the range name sans the trailing `-'.
183 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
185 RFC 4520 reserves options beginning with `x-' for private experiments.
186 Other options should be registered with IANA, see RFC 4520 section 3.5.
187 OpenLDAP also has the `binary' option built in, but this is a transfer
188 option, not a tagging option.
190 .B olcAuthzPolicy: <policy>
191 Used to specify which rules to use for Proxy Authorization. Proxy
192 authorization allows a client to authenticate to the server using one
193 user's credentials, but specify a different identity to use for authorization
194 and access control purposes. It essentially allows user A to login as user
195 B, using user A's password.
198 flag disables proxy authorization. This is the default setting.
201 flag will use rules in the
203 attribute of the authorization DN.
206 flag will use rules in the
208 attribute of the authentication DN.
211 flag, an alias for the deprecated value of
213 will allow any of the above, whatever succeeds first (checked in
219 flag requires both authorizations to succeed.
222 The rules are mechanisms to specify which identities are allowed
223 to perform proxy authorization.
226 attribute in an entry specifies which other users
227 are allowed to proxy login to this entry. The
230 an entry specifies which other users this user can authorize as. Use of
233 abused if users are allowed to write arbitrary values to this attribute.
236 attribute must be protected with ACLs such that
237 only privileged users can modify it.
244 or a set of identities; it can take five forms:
247 .B ldap:///<base>??[<scope>]?<filter>
250 .B dn[.<dnstyle>]:<pattern>
253 .B u[<mech>[<realm>]]:<pattern>
256 .B group[/objectClass[/attributeType]]:<pattern>
263 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
266 The first form is a valid LDAP
274 portions must be absent, so that the search occurs locally on either
280 with the optional style modifiers
286 for exact, onelevel, children and subtree matches, which cause
288 to be normalized according to the DN normalization rules, or the special
290 style, which causes the
292 to be treated as a POSIX (''extended'') regular expression, as
299 means any non-anonymous DN.
300 The third form is a SASL
302 with the optional fields
306 that allow to specify a SASL
308 and eventually a SASL
310 for those mechanisms that support one.
311 The need to allow the specification of a mechanism is still debated,
312 and users are strongly discouraged to rely on this possibility.
313 The fourth form is a group specification, consisting of the keyword
315 optionally followed by the specification of the group
321 is searched with base scope, and in case of match, the values of the
324 are searched for the asserted DN.
325 For backwards compatibility, if no identity type is provided, i.e. only
329 is assumed; as a consequence,
331 is subjected to DN normalization.
332 Since the interpretation of
336 can impact security, users are strongly encouraged
337 to explicitly set the type of identity specification that is being used.
338 A subset of these rules can be used as third arg in the
340 statement (see below); significantly, the
347 .B olcAuthzRegexp: <match> <replace>
348 Used by the authentication framework to convert simple user names,
349 such as provided by SASL subsystem, to an LDAP DN used for
350 authorization purposes. Note that the resultant DN need not refer
351 to an existing entry to be considered valid. When an authorization
352 request is received from the SASL subsystem, the SASL
357 are taken, when available, and combined into a name of the form
361 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
364 This name is then compared against the
366 POSIX (''extended'') regular expression, and if the match is successful,
367 the name is replaced with the
369 string. If there are wildcard strings in the
371 regular expression that are enclosed in parenthesis, e.g.
377 then the portion of the name that matched the wildcard will be stored
378 in the numbered placeholder variable $1. If there are other wildcard strings
379 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
380 placeholders can then be used in the
385 .B UID=$1,OU=Accounts,DC=example,DC=com
388 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
390 If the latter, the server will use the URI to search its own database(s)
391 and, if the search returns exactly one entry, the name is
392 replaced by the DN of that entry. The LDAP URI must have no
393 hostport, attrs, or extensions components, but the filter is mandatory,
397 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
400 The protocol portion of the URI must be strictly
402 Note that this search is subject to access controls. Specifically,
403 the authentication identity must have "auth" access in the subject.
407 values can be given in the configuration file to allow for multiple matching
408 and replacement patterns. The matching patterns are checked in the order they
409 appear in the file, stopping at the first successful match.
412 .\"Because the plus sign + is a character recognized by the regular expression engine,
413 .\"and it will appear in names that include a REALM, be careful to escape the
414 .\"plus sign with a backslash \\+ to remove the character's special meaning.
417 .B olcConcurrency: <integer>
418 Specify a desired level of concurrency. Provided to the underlying
419 thread system as a hint. The default is not to provide any hint. This setting
420 is only meaningful on some platforms where there is not a one to one
421 correspondence between user threads and kernel threads.
423 .B olcConnMaxPending: <integer>
424 Specify the maximum number of pending requests for an anonymous session.
425 If requests are submitted faster than the server can process them, they
426 will be queued up to this limit. If the limit is exceeded, the session
427 is closed. The default is 100.
429 .B olcConnMaxPendingAuth: <integer>
430 Specify the maximum number of pending requests for an authenticated session.
433 .B olcDisallows: <features>
434 Specify a set of features to disallow (default none).
436 disables acceptance of anonymous bind requests. Note that this setting
437 does not prohibit anonymous directory access (See "require authc").
439 disables simple (bind) authentication.
441 disables forcing session to anonymous status (see also
443 upon StartTLS operation receipt.
445 disallows the StartTLS operation if authenticated (see also
448 .B olcGentleHUP: { TRUE | FALSE }
449 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
451 will stop listening for new connections, but will not close the
452 connections to the current clients. Future write operations return
453 unwilling-to-perform, though. Slapd terminates when all clients
454 have closed their connections (if they ever do), or \- as before \-
455 if it receives a SIGTERM signal. This can be useful if you wish to
456 terminate the server and start a new
459 .B with another database,
460 without disrupting the currently active clients.
461 The default is FALSE. You may wish to use
463 along with this option.
465 .B olcIdleTimeout: <integer>
466 Specify the number of seconds to wait before forcibly closing
467 an idle client connection. A setting of 0 disables this
468 feature. The default is 0.
470 .B olcIndexSubstrIfMaxlen: <integer>
471 Specify the maximum length for subinitial and subfinal indices. Only
472 this many characters of an attribute value will be processed by the
473 indexing functions; any excess characters are ignored. The default is 4.
475 .B olcIndexSubstrIfMinlen: <integer>
476 Specify the minimum length for subinitial and subfinal indices. An
477 attribute value must have at least this many characters in order to be
478 processed by the indexing functions. The default is 2.
480 .B olcIndexSubstrAnyLen: <integer>
481 Specify the length used for subany indices. An attribute value must have
482 at least this many characters in order to be processed. Attribute values
483 longer than this length will be processed in segments of this length. The
484 default is 4. The subany index will also be used in subinitial and
485 subfinal index lookups when the filter string is longer than the
486 .I olcIndexSubstrIfMaxlen
489 .B olcIndexSubstrAnyStep: <integer>
490 Specify the steps used in subany index lookups. This value sets the offset
491 for the segments of a filter string that are processed for a subany index
492 lookup. The default is 2. For example, with the default values, a search
493 using this filter "cn=*abcdefgh*" would generate index lookups for
494 "abcd", "cdef", and "efgh".
497 .B olcLocalSSF: <SSF>
498 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
499 such as those to the ldapi:// listener. For a description of SSF values,
501 .BR olcSaslSecProps 's
503 option description. The default is 71.
505 .B olcLogLevel: <integer> [...]
506 Specify the level at which debugging statements and operation
507 statistics should be syslogged (currently logged to the
509 LOG_LOCAL4 facility).
510 They must be considered subsystems rather than increasingly verbose
512 Some messages with higher priority are logged regardless
513 of the configured loglevel as soon as some logging is configured,
514 otherwise anything is logged at all.
515 Log levels are additive, and available levels are:
526 debug packet handling
530 heavy trace debugging (function args)
534 connection management
538 print out packets sent and received
542 search filter processing
546 configuration file processing
550 access control list processing
554 stats log connections/operations/results
558 stats log entries sent
562 print communication with shell backends
574 \"data indexing (unused)
582 only messages that get logged whatever log level is set
585 The desired log level can be input as a single integer that combines
586 the (ORed) desired levels, both in decimal or in hexadecimal notation,
587 as a list of integers (that are ORed internally),
588 or as a list of the names that are shown between brackets, such that
595 olcLogLevel acl trace
601 can be used as a shortcut to enable logging at all levels (equivalent to -1).
604 or the equivalent integer representation, causes those messages
605 that are logged regardless of the configured loglevel to be logged.
606 In fact, if no loglevel (or a 0 level) is defined, no logging occurs,
609 level is required to have high priority messages logged.
612 .B olcPasswordCryptSaltFormat: <format>
613 Specify the format of the salt passed to
615 when generating {CRYPT} passwords (see
616 .BR olcPasswordHash )
617 during processing of LDAP Password Modify Extended Operations (RFC 3062).
619 This string needs to be in
621 format and may include one (and only one) %s conversion.
622 This conversion will be substituted with a string of random
623 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
624 provides a two character salt and "$1$%.8s" tells some
625 versions of crypt(3) to use an MD5 algorithm and provides
626 8 random characters of salt. The default is "%s", which
627 provides 31 characters of salt.
629 .B olcPasswordHash: <hash> [<hash>...]
630 This option configures one or more hashes to be used in generation of user
631 passwords stored in the userPassword attribute during processing of
632 LDAP Password Modify Extended Operations (RFC 3062).
633 The <hash> must be one of
647 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
652 use the MD5 algorithm (RFC 1321), the latter with a seed.
659 indicates that the new password should be
660 added to userPassword as clear text.
662 Note that this option does not alter the normal user applications
663 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
665 .B olcPidFile: <filename>
666 The ( absolute ) name of a file that will hold the
668 server's process ID ( see
670 ) if started without the debugging command line option.
672 .B olcPluginLogFile: <filename>
673 The ( absolute ) name of a file that will contain log
680 .B olcReferral: <url>
681 Specify the referral to pass back when
683 cannot find a local database to handle a request.
684 If multiple values are specified, each url is provided.
685 .\" slurpd-related keywords are all deprecated
687 .\".B replica-argsfile
688 .\"The ( absolute ) name of a file that will hold the
690 .\"server's command line options
691 .\"if started without the debugging command line option.
692 .\"If it appears after a
694 .\"directive, the args file is specific to the
696 .\"instance that handles that replication log.
698 .\".B replica-pidfile
699 .\"The ( absolute ) name of a file that will hold the
701 .\"server's process ID ( see
703 .\") if started without the debugging command line option.
704 .\"If it appears after a
706 .\"directive, the pid file is specific to the
708 .\"instance that handles that replication log.
710 .\".B replicationinterval
711 .\"The number of seconds
713 .\"waits before checking the replogfile for changes.
714 .\"If it appears after a
716 .\"directive, the replication interval is specific to the
718 .\"instance that handles that replication log.
720 .B olcReverseLookup: TRUE | FALSE
721 Enable/disable client name unverified reverse lookup (default is
723 if compiled with --enable-rlookups).
725 .B olcRootDSE: <file>
726 Specify the name of an LDIF(5) file containing user defined attributes
727 for the root DSE. These attributes are returned in addition to the
728 attributes normally produced by slapd.
730 .B olcSaslHost: <fqdn>
731 Used to specify the fully qualified domain name used for SASL processing.
733 .B olcSaslRealm: <realm>
734 Specify SASL realm. Default is empty.
736 .B olcSaslSecProps: <properties>
737 Used to specify Cyrus SASL security properties.
740 flag (without any other properties) causes the flag properties
741 default, "noanonymous,noplain", to be cleared.
744 flag disables mechanisms susceptible to simple passive attacks.
747 flag disables mechanisms susceptible to active attacks.
750 flag disables mechanisms susceptible to passive dictionary attacks.
753 flag disables mechanisms which support anonymous login.
756 flag require forward secrecy between sessions.
759 require mechanisms which pass client credentials (and allow
760 mechanisms which can pass credentials to do so).
763 property specifies the minimum acceptable
764 .I security strength factor
765 as an integer approximate to effective key length used for
766 encryption. 0 (zero) implies no protection, 1 implies integrity
767 protection only, 56 allows DES or other weak ciphers, 112
768 allows triple DES and other strong ciphers, 128 allows RC4,
769 Blowfish and other modern strong ciphers. The default is 0.
772 property specifies the maximum acceptable
773 .I security strength factor
774 as an integer (see minssf description). The default is INT_MAX.
777 property specifies the maximum security layer receive buffer
778 size allowed. 0 disables security layers. The default is 65536.
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 olcThreads: <integer>
789 Specify the maximum size of the primary thread pool.
790 The default is 16; the minimum value is 2.
792 .B olcToolThreads: <integer>
793 Specify the maximum number of threads to use in tool mode.
794 This should not be greater than the number of CPUs in the system.
796 .\"ucdata-path is obsolete / ignored...
798 .\".B ucdata-path <path>
799 .\"Specify the path to the directory containing the Unicode character
800 .\"tables. The default path is DATADIR/ucdata.
804 is built with support for Transport Layer Security, there are more options
807 .B olcTLSCipherSuite: <cipher-suite-spec>
808 Permits configuring what ciphers will be accepted and the preference order.
809 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
811 olcTLSCipherSuite: HIGH:MEDIUM:+SSLv2
813 To check what ciphers a given spec selects, use:
815 openssl ciphers -v <cipher-suite-spec>
817 .B olcTLSCACertificateFile: <filename>
818 Specifies the file that contains certificates for all of the Certificate
823 .B olcTLSCACertificatePath: <path>
824 Specifies the path of a directory that contains Certificate Authority
825 certificates in separate individual files. Usually only one of this
826 or the olcTLSCACertificateFile is defined. If both are specified, both
827 locations will be used.
829 .B olcTLSCertificateFile: <filename>
830 Specifies the file that contains the
834 .B olcTLSCertificateKeyFile: <filename>
835 Specifies the file that contains the
837 server private key that matches the certificate stored in the
838 .B olcTLSCertificateFile
839 file. Currently, the private key must not be protected with a password, so
840 it is of critical importance that it is protected carefully.
842 .B olcTLSDHParamFile: <filename>
843 This directive specifies the file that contains parameters for Diffie-Hellman
844 ephemeral key exchange. This is required in order to use a DSA certificate on
845 the server. If multiple sets of parameters are present in the file, all of
846 them will be processed. Note that setting this option may also enable
847 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
848 You should append "!ADH" to your cipher suites if you have changed them
849 from the default, otherwise no certificate exchanges or verification will
852 .B olcTLSRandFile: <filename>
853 Specifies the file to obtain random bits from when /dev/[u]random
854 is not available. Generally set to the name of the EGD/PRNGD socket.
855 The environment variable RANDFILE can also be used to specify the filename.
857 .B olcTLSVerifyClient: <level>
858 Specifies what checks to perform on client certificates in an
859 incoming TLS session, if any.
862 can be specified as one of the following keywords:
868 will not ask the client for a certificate.
871 The client certificate is requested. If no certificate is provided,
872 the session proceeds normally. If a bad certificate is provided,
873 it will be ignored and the session proceeds normally.
876 The client certificate is requested. If no certificate is provided,
877 the session proceeds normally. If a bad certificate is provided,
878 the session is immediately terminated.
880 .B demand | hard | true
881 These keywords are all equivalent, for compatibility reasons.
882 The client certificate is requested. If no certificate is provided,
883 or a bad certificate is provided, the session is immediately terminated.
885 Note that a valid client certificate is required in order to use the
886 SASL EXTERNAL authentication mechanism with a TLS session. As such,
888 .B olcTLSVerifyClient
889 setting must be chosen to enable SASL EXTERNAL authentication.
892 .B olcTLSCRLCheck: <level>
893 Specifies if the Certificate Revocation List (CRL) of the CA should be
894 used to verify if the client certificates have not been revoked. This
896 .B olcTLSCACertificatePath
899 can be specified as one of the following keywords:
903 No CRL checks are performed
906 Check the CRL of the peer certificate
909 Check the CRL for a whole certificate chain
911 .SH DYNAMIC MODULE OPTIONS
914 is compiled with --enable-modules then the module-related entries will
915 be available. These entries are named
916 .B cn=module{x},cn=config
918 must have the olcModuleList objectClass. One entry should be created
921 Normally the config engine generates the "{x}" index in the RDN
922 automatically, so it can be omitted when initially loading these entries.
924 .B olcModuleLoad: <filename>
925 Specify the name of a dynamically loadable module to load. The filename
926 may be an absolute path name or a simple filename. Non-absolute names
927 are searched for in the directories specified by the
931 .B olcModulePath: <pathspec>
932 Specify a list of directories to search for loadable modules. Typically
933 the path is colon-separated but this depends on the operating system.
935 Schema definitions are created as entries in the
936 .B cn=schema,cn=config
937 subtree. These entries must have the olcSchemaConfig objectClass.
938 As noted above, the actual
939 .B cn=schema,cn=config
940 entry is predefined and any values specified for it are ignored.
944 .B olcAttributetypes: "(\ <oid>\
946 [DESC\ <description>]\
955 [NO\-USER\-MODIFICATION]\
956 [USAGE\ <attributeUsage>]\ )"
958 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
959 The slapd parser extends the RFC 4512 definition by allowing string
960 forms as well as numeric OIDs to be used for the attribute OID and
961 attribute syntax OID.
963 .B olcObjectIdentifier
969 .B olcDitContentRules: "(\ <oid>\
971 [DESC\ <description>]\
978 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
979 The slapd parser extends the RFC 4512 definition by allowing string
980 forms as well as numeric OIDs to be used for the attribute OID and
981 attribute syntax OID.
983 .B olcObjectIdentifier
989 .B olcObjectClasses: "(\ <oid>\
991 [DESC\ <description>]\
994 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
995 [MUST\ <oids>] [MAY\ <oids>] )"
997 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
998 The slapd parser extends the RFC 4512 definition by allowing string
999 forms as well as numeric OIDs to be used for the object class OID.
1003 description.) Object classes are "STRUCTURAL" by default.
1006 .B olcObjectIdentifier: <name> "{ <oid> | <name>[:<suffix>] }"
1007 Define a string name that equates to the given OID. The string can be used
1008 in place of the numeric OID in objectclass and attribute definitions. The
1009 name can also be used with a suffix of the form ":xx" in which case the
1010 value "oid.xx" will be used.
1012 .SH GENERAL BACKEND OPTIONS
1013 Options in these entries only apply to the configuration of a single
1014 type of backend. All backends may support this class of options.
1015 The entry must be named
1016 .B olcBackend=<databasetype>,cn=config
1017 and must have the olcBackendConfig objectClass.
1035 At present, no backend implements any options of this type.
1037 .SH DATABASE OPTIONS
1038 Database options are set in entries named
1039 .B olcDatabase={x}<databasetype>,cn=config
1040 and must have the olcDatabaseConfig objectClass. Normally the config
1041 engine generates the "{x}" index in the RDN automatically, so it
1042 can be omitted when initially loading these entries.
1044 The special frontend database is always numbered "{-1}" and the config
1045 database is always numbered "{0}".
1047 .SH GLOBAL DATABASE OPTIONS
1048 Options in this section may be set in the special "frontend" database
1049 and inherited in all the other databases. These options may be altered
1050 by further settings in each specific database. The frontend entry must
1052 .B olcDatabase=frontend,cn=config
1053 and must have the olcFrontendConfig objectClass.
1055 .B olcAccess: to <what> "[ by <who> <access> <control> ]+"
1056 Grant access (specified by <access>) to a set of entries and/or
1057 attributes (specified by <what>) by one or more requestors (specified
1059 If no access controls are present, the default policy
1060 allows anyone and everyone to read anything but restricts
1061 updates to rootdn. (e.g., "olcAccess: to * by * read").
1063 .BR slapd.access (5)
1064 and the "OpenLDAP Administrator's Guide" for details.
1066 Access controls set in the frontend are appended to any access
1067 controls set on the specific databases.
1068 The rootdn of a database can always read and write EVERYTHING
1071 Extra special care must be taken with the access controls on the
1072 config database. Unlike other databases, the default policy for the
1073 config database is to only allow access to the rootdn. Regular users
1074 should not have read access, and write access should be granted very
1075 carefully to privileged administrators.
1078 .B olcDefaultSearchBase: <dn>
1079 Specify a default search base to use when client submits a
1080 non-base search request with an empty base DN.
1081 Base scoped search requests with an empty base DN are not affected.
1082 This setting is only allowed in the frontend entry.
1084 .B olcReadOnly: TRUE | FALSE
1085 This option puts the database into "read-only" mode. Any attempts to
1086 modify the database will return an "unwilling to perform" error. By
1087 default, olcReadOnly is FALSE. Note that when this option is set
1088 TRUE on the frontend, it cannot be reset without restarting the
1089 server, since further writes to the config database will be rejected.
1091 .B olcRequires: <conditions>
1092 Specify a set of conditions to require (default none).
1093 The directive may be specified globally and/or per-database;
1094 databases inherit global conditions, so per-database specifications
1097 requires bind operation prior to directory operations.
1099 requires session to be using LDAP version 3.
1101 requires authentication prior to directory operations.
1103 requires SASL authentication prior to directory operations.
1105 requires strong authentication prior to directory operations.
1106 The strong keyword allows protected "simple" authentication
1107 as well as SASL authentication.
1109 may be used to require no conditions (useful to clear out globally
1110 set conditions within a particular database); it must occur first
1111 in the list of conditions.
1113 .B olcRestrict: <oplist>
1114 Specify a list of operations that are restricted.
1115 Restrictions on a specific database override any frontend setting.
1116 Operations can be any of
1121 .BR extended[=<OID>] ,
1125 or the special pseudo-operations
1129 which respectively summarize read and write operations.
1133 .I olcReadOnly: TRUE
1137 keyword allows to indicate the OID of the specific operation
1140 .B olcSchemaDN: <dn>
1141 Specify the distinguished name for the subschema subentry that
1142 controls the entries on this server. The default is "cn=Subschema".
1144 .B olcSecurity: <factors>
1145 Specify a set of security strength factors (separated by white space)
1147 .BR olcSaslSecprops 's
1149 option for a description of security strength factors).
1150 The directive may be specified globally and/or per-database.
1152 specifies the overall security strength factor.
1154 specifies the transport security strength factor.
1156 specifies the TLS security strength factor.
1158 specifies the SASL security strength factor.
1160 specifies the overall security strength factor to require for
1162 .B update_transport=<n>
1163 specifies the transport security strength factor to require for
1166 specifies the TLS security strength factor to require for
1169 specifies the SASL security strength factor to require for
1172 specifies the security strength factor required for
1174 username/password authentication.
1177 factor is measure of security provided by the underlying transport,
1178 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
1180 .B olcSizeLimit: {<integer>|unlimited}
1182 .B olcSizeLimit: size[.{soft|hard|unchecked}]=<integer> [...]
1183 Specify the maximum number of entries to return from a search operation.
1184 The default size limit is 500.
1187 to specify no limits.
1188 The second format allows a fine grain setting of the size limits.
1189 Extra args can be added in the same value or as additional values.
1192 for an explanation of the different flags.
1194 .B olcTimeLimit: {<integer>|unlimited}
1196 .B olcTimeLimit: time[.{soft|hard}]=<integer> [...]
1197 Specify the maximum number of seconds (in real time)
1199 will spend answering a search request. The default time limit is 3600.
1202 to specify no limits.
1203 The second format allows a fine grain setting of the time limits.
1204 Extra args can be added in the same value or as additional values.
1207 for an explanation of the different flags.
1209 .SH GENERAL DATABASE OPTIONS
1210 Options in this section only apply to the specific database for
1211 which they are defined. They are supported by every
1212 type of backend. All of the Global Database Options may also be
1215 .B olcLastMod: TRUE | FALSE
1218 will automatically maintain the
1219 modifiersName, modifyTimestamp, creatorsName, and
1220 createTimestamp attributes for entries. It also controls
1221 the entryCSN and entryUUID attributes, which are needed
1222 by the syncrepl provider. By default, olcLastMod is TRUE.
1224 .B olcLimits: <who> <limit> [<limit> [...]]
1225 Specify time and size limits based on who initiated an operation.
1232 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1238 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1243 matches all unauthenticated clients.
1246 matches all authenticated clients;
1249 dn pattern is assumed unless otherwise specified by qualifying
1250 the (optional) key string
1256 (which are synonyms), to require an exact match; with
1258 to require exactly one level of depth match; with
1260 to allow any level of depth match, including the exact match; with
1262 to allow any level of depth match, not including the exact match;
1264 explicitly requires the (default) match based on POSIX (''extended'')
1265 regular expression pattern.
1268 matches unbound operations; the
1271 The same behavior is obtained by using the
1278 with the optional objectClass
1284 sets the limits for any DN listed in the values of the
1290 group objectClass (default
1292 whose DN exactly matches
1295 The currently supported limits are
1300 The syntax for time limits is
1301 .BR time[.{soft|hard}]=<integer> ,
1304 is the number of seconds slapd will spend answering a search request.
1305 If no time limit is explicitly requested by the client, the
1307 limit is used; if the requested time limit exceeds the
1310 .\".I "Administrative limit exceeded"
1311 .\"error is returned.
1312 limit, the value of the limit is used instead.
1315 limit is set to the keyword
1317 the soft limit is used in either case; if it is set to the keyword
1319 no hard limit is enforced.
1320 Explicit requests for time limits smaller or equal to the
1323 If no limit specifier is set, the value is assigned to the
1329 to preserve the original behavior.
1331 The syntax for size limits is
1332 .BR size[.{soft|hard|unchecked}]=<integer> ,
1335 is the maximum number of entries slapd will return answering a search
1337 If no size limit is explicitly requested by the client, the
1339 limit is used; if the requested size limit exceeds the
1342 .\".I "Administrative limit exceeded"
1343 .\"error is returned.
1344 limit, the value of the limit is used instead.
1347 limit is set to the keyword
1349 the soft limit is used in either case; if it is set to the keyword
1351 no hard limit is enforced.
1352 Explicit requests for size limits smaller or equal to the
1357 specifier sets a limit on the number of candidates a search request is allowed
1359 The rationale behind it is that searches for non-properly indexed
1360 attributes may result in large sets of candidates, which must be
1363 to determine whether they match the search filter or not.
1366 limit provides a means to drop such operations before they are even
1368 If the selected candidates exceed the
1370 limit, the search will abort with
1371 .IR "Unwilling to perform" .
1372 If it is set to the keyword
1374 no limit is applied (the default).
1377 the search is not even performed; this can be used to disallow searches
1378 for a specific set of users.
1379 If no limit specifier is set, the value is assigned to the
1385 to preserve the original behavior.
1387 In case of no match, the global limits are used.
1388 The default values are the same as
1397 control is requested, the
1399 size limit is used by default, because the request of a specific page size
1400 is considered an explicit request for a limitation on the number
1401 of entries to be returned.
1402 However, the size limit applies to the total count of entries returned within
1403 the search, and not to a single page.
1404 Additional size limits may be enforced; the syntax is
1405 .BR size.pr={<integer>|noEstimate|unlimited} ,
1408 is the max page size if no explicit limit is set; the keyword
1410 inhibits the server from returning an estimate of the total number
1411 of entries that might be returned
1412 (note: the current implementation does not return any estimate).
1415 indicates that no limit is applied to the pagedResults control page size.
1417 .B size.prtotal={<integer>|unlimited|disabled}
1418 allows to set a limit on the total number of entries that a pagedResults
1419 control allows to return.
1420 By default it is set to the
1425 is the max number of entries that the whole search with pagedResults control
1429 to allow unlimited number of entries to be returned, e.g. to allow
1430 the use of the pagedResults control as a means to circumvent size
1431 limitations on regular searches; the keyword
1433 disables the control, i.e. no paged results can be returned.
1434 Note that the total number of entries returned when the pagedResults control
1435 is requested cannot exceed the
1437 size limit of regular searches unless extended by the
1442 .B olcMaxDerefDepth: <depth>
1443 Specifies the maximum number of aliases to dereference when trying to
1444 resolve an entry, used to avoid infinite alias loops. The default is 1.
1446 .B olcMirrorMode: TRUE | FALSE
1447 This option puts a replica database into "mirror" mode. Update
1448 operations will be accepted from any user, not just the updatedn. The
1449 database must already be configured as syncrepl consumer
1450 before this keyword may be set. This mode must be used with extreme
1451 care, as it does not offer any consistency guarantees. This feature
1452 is intended to be used with an external frontend that guarantees that
1453 writes are only directed to a single master, switching to an alternate
1454 server only if the original master goes down.
1455 By default, this setting is FALSE.
1457 .B olcPlugin: <plugin_type> <lib_path> <init_function> [<arguments>]
1458 Configure a SLAPI plugin. See the
1459 .BR slapd.plugin (5)
1460 manpage for more details.
1463 .\".B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1464 .\".B [starttls=yes|critical]
1465 .\".B [suffix=<suffix> [...]]
1466 .\".B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1467 .\".B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1468 .\".B [authcId=<authentication ID>] [authzId=<authorization ID>]
1469 .\".B [attrs[!]=<attr list>]
1471 .\"Specify a replication site for this database. Refer to the "OpenLDAP
1472 .\"Administrator's Guide" for detailed information on setting up a replicated
1474 .\"directory service. Zero or more
1476 .\"instances can be used to select the subtrees that will be replicated
1477 .\"(defaults to all the database).
1479 .\"is deprecated in favor of the
1483 .\"allows the replica LDAP server to be specified as an LDAP URI.
1488 .\"requires the options
1492 .\"and should only be used when adequate security services
1493 .\"(e.g TLS or IPSEC) are in place. A
1497 .\"requires the option
1499 .\"Specific security properties (as with the
1501 .\"keyword above) for a SASL bind can be set with the
1503 .\"option. A non-default SASL realm can be set with the
1508 .\"will use Kerberos, a kerberos instance should be given in
1512 .\"can be given after the
1514 .\"keyword to allow the selective replication of the listed attributes only;
1517 .\"mark is used, the list is considered exclusive, i.e. the listed attributes
1518 .\"are not replicated.
1519 .\"If an objectClass is listed, all the related attributes
1520 .\"are (are not) replicated.
1523 .\".B replogfile <filename>
1524 .\"Specify the name of the replication log file to log changes to.
1525 .\"The replication log is typically written by
1530 .\".BR slapd.replog (5)
1531 .\"for more information. The specified file should be located
1532 .\"in a directory with limited read/write/execute access as the replication
1533 .\"logs may contain sensitive information.
1536 Specify the distinguished name that is not subject to access control
1537 or administrative limit restrictions for operations on this database.
1538 This DN may or may not be associated with an entry. An empty root
1539 DN (the default) specifies no root access is to be granted. It is
1540 recommended that the rootdn only be specified when needed (such as
1541 when initially populating a database). If the rootdn is within
1542 a namingContext (suffix) of the database, a simple bind password
1543 may also be provided using the
1545 directive. Note that the rootdn is always needed when using syncrepl.
1547 .B olcRootPW: <password>
1548 Specify a password (or hash of the password) for the rootdn. The
1549 password can only be set if the rootdn is within the namingContext
1550 (suffix) of the database.
1551 This option accepts all RFC 2307 userPassword formats known to
1554 description) as well as cleartext.
1556 may be used to generate a hash of a password. Cleartext
1557 and \fB{CRYPT}\fP passwords are not recommended. If empty
1558 (the default), authentication of the root DN is by other means
1559 (e.g. SASL). Use of SASL is encouraged.
1561 .B olcSubordinate: [TRUE | FALSE | advertise]
1562 Specify that the current backend database is a subordinate of another
1563 backend database. A subordinate database may have only one suffix. This
1564 option may be used to glue multiple databases into a single namingContext.
1565 If the suffix of the current database is within the namingContext of a
1566 superior database, searches against the superior database will be
1567 propagated to the subordinate as well. All of the databases
1568 associated with a single namingContext should have identical rootdns.
1569 Behavior of other LDAP operations is unaffected by this setting. In
1570 particular, it is not possible to use moddn to move an entry from
1571 one subordinate to another subordinate within the namingContext.
1573 If the optional \fBadvertise\fP flag is supplied, the naming context of
1574 this database is advertised in the root DSE. The default is to hide this
1575 database context, so that only the superior context is visible.
1582 are used on the superior database, any glued subordinates that support
1583 these tools are opened as well.
1585 Databases that are glued together should usually be configured with the
1586 same indices (assuming they support indexing), even for attributes that
1587 only exist in some of these databases. In general, all of the glued
1588 databases should be configured as similarly as possible, since the intent
1589 is to provide the appearance of a single directory.
1591 Note that the \fIsubordinate\fP functionality is implemented internally
1592 by the \fIglue\fP overlay and as such its behavior will interact with other
1593 overlays in use. By default, the glue overlay is automatically configured as
1594 the last overlay on the superior backend. Its position on the backend
1595 can be explicitly configured by setting an \fBoverlay glue\fP directive
1596 at the desired position. This explicit configuration is necessary e.g.
1597 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1598 in order to work over all of the glued databases. E.g.
1601 dn: olcDatabase={1}bdb,cn=config
1602 olcSuffix: dc=example,dc=com
1605 dn: olcOverlay={0}glue,olcDatabase={1}bdb,cn=config
1608 dn: olcOverlay={1}syncprov,olcDatabase={1}bdb,cn=config
1612 See the Overlays section below for more details.
1614 .B olcSuffix: <dn suffix>
1615 Specify the DN suffix of queries that will be passed to this
1616 backend database. Multiple suffix lines can be given and at least one is
1617 required for each database definition.
1618 If the suffix of one database is "inside" that of another, the database
1619 with the inner suffix must come first in the configuration file.
1622 .B olcSyncrepl: rid=<replica ID>
1623 .B provider=ldap[s]://<hostname>[:port]
1624 .B searchbase=<base DN>
1625 .B [type=refreshOnly|refreshAndPersist]
1626 .B [interval=dd:hh:mm:ss]
1627 .B [retry=[<retry interval> <# of retries>]+]
1628 .B [filter=<filter str>]
1629 .B [scope=sub|one|base|subord]
1630 .B [attrs=<attr list>]
1631 .B [exattrs=<attr list>]
1633 .B [sizelimit=<limit>]
1634 .B [timelimit=<limit>]
1635 .B [schemachecking=on|off]
1636 .B [bindmethod=simple|sasl]
1638 .B [saslmech=<mech>]
1639 .B [authcid=<identity>]
1640 .B [authzid=<identity>]
1641 .B [credentials=<passwd>]
1643 .B [secprops=<properties>]
1644 .B [starttls=yes|critical]
1645 .B [tls_cert=<file>]
1647 .B [tls_cacert=<file>]
1648 .B [tls_cacertdir=<path>]
1649 .B [tls_reqcert=never|allow|try|demand]
1650 .B [tls_ciphersuite=<ciphers>]
1651 .B [tls_crlcheck=none|peer|all]
1652 .B [logbase=<base DN>]
1653 .B [logfilter=<filter str>]
1654 .B [syncdata=default|accesslog|changelog]
1656 Specify the current database as a replica which is kept up-to-date with the
1657 master content by establishing the current
1659 as a replication consumer site running a
1662 The replica content is kept synchronized to the master content using
1663 the LDAP Content Synchronization protocol. Refer to the
1664 "OpenLDAP Administrator's Guide" for detailed information on
1665 setting up a replicated
1667 directory service using the
1672 identifies the current
1674 directive within the replication consumer site.
1675 It is a non-negative integer having no more than three digits.
1678 specifies the replication provider site containing the master content
1679 as an LDAP URI. If <port> is not given, the standard LDAP port number
1680 (389 or 636) is used.
1684 replica is defined using a search
1685 specification as its result set. The consumer
1687 will send search requests to the provider
1689 according to the search specification. The search specification includes
1690 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1693 parameters as in the normal search specification. The
1695 option may also be used to specify attributes that should be omitted
1696 from incoming entries.
1697 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1698 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1699 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1700 attributes, and \fBattrsonly\fP and \fBexattrs\fP are unset by default.
1701 The \fBsizelimit\fP and \fBtimelimit\fP only
1702 accept "unlimited" and positive integers, and both default to "unlimited".
1703 Note, however, that any provider-side limits for the replication identity
1704 will be enforced by the provider regardless of the limits requested
1705 by the LDAP Content Synchronization operation, much like for any other
1708 The LDAP Content Synchronization protocol has two operation types.
1711 operation, the next synchronization search operation
1712 is periodically rescheduled at an interval time (specified by
1714 parameter; 1 day by default)
1715 after each synchronization operation finishes.
1717 .B refreshAndPersist
1718 operation, a synchronization search remains persistent in the provider slapd.
1719 Further updates to the master replica will generate
1720 .B searchResultEntry
1721 to the consumer slapd as the search responses to the persistent
1722 synchronization search.
1724 If an error occurs during replication, the consumer will attempt to
1725 reconnect according to the
1727 parameter which is a list of the <retry interval> and <# of retries> pairs.
1728 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1729 for the first 10 times and then retry every 300 seconds for the next 3
1730 times before stop retrying. The `+' in <# of retries> means indefinite
1731 number of retries until success.
1733 The schema checking can be enforced at the LDAP Sync
1734 consumer site by turning on the
1736 parameter. The default is off.
1742 requires the options
1746 and should only be used when adequate security services
1747 (e.g. TLS or IPSEC) are in place.
1754 Depending on the mechanism, an authentication identity and/or
1755 credentials can be specified using
1761 parameter may be used to specify an authorization identity.
1762 Specific security properties (as with the
1764 keyword above) for a SASL bind can be set with the
1766 option. A non default SASL realm can be set with the
1769 The provider, other than allow authentication of the syncrepl identity,
1770 should grant that identity appropriate access privileges to the data
1771 that is being replicated (\fBaccess\fP directive), and appropriate time
1772 and size limits (\fBlimits\fP directive).
1777 parameter specifies use of the StartTLS extended operation
1778 to establish a TLS session before Binding to the provider. If the
1780 argument is supplied, the session will be aborted if the StartTLS request
1781 fails. Otherwise the syncrepl session continues without TLS. Note that the
1782 main slapd TLS settings are not used by the syncrepl engine;
1783 by default the TLS parameters from ETCDIR/ldap.conf will be used.
1784 TLS settings may be specified here, in which case the ldap.conf settings
1785 will be completely ignored.
1787 Rather than replicating whole entries, the consumer can query logs of
1788 data modifications. This mode of operation is referred to as \fIdelta
1789 syncrepl\fP. In addition to the above parameters, the
1793 parameters must be set appropriately for the log that will be used. The
1795 parameter must be set to either "accesslog" if the log conforms to the
1796 .BR slapo-accesslog (5)
1797 log format, or "changelog" if the log conforms
1798 to the obsolete \fIchangelog\fP format. If the
1800 parameter is omitted or set to "default" then the log parameters are
1805 .\"This option is only applicable in a slave
1806 .\"database updated using
1808 .\"It specifies the DN permitted to update (subject to access controls)
1809 .\"the replica (typically, this is the DN
1811 .\"binds to update the replica). Generally, this DN
1813 .\"be the same as the
1815 .\"used at the master.
1817 .B olcUpdateRef: <url>
1818 Specify the referral to pass back when
1820 is asked to modify a replicated local database.
1821 If multiple values are specified, each url is provided.
1823 .SH DATABASE-SPECIFIC OPTIONS
1824 Each database may allow specific configuration options; they are
1825 documented separately in the backends' manual pages.
1827 The following backends can be compiled into slapd.
1828 They are documented in the
1829 .BR slapd-<backend> (5)
1833 This is the recommended primary backend for a normal slapd database.
1834 It takes care to configure it properly.
1835 It uses the transactional database interface of the Sleepycat Berkeley
1836 DB (BDB) package to store data.
1839 This backend is used to manage the configuration of slapd run-time.
1842 This backend is experimental.
1843 It serves up referrals based upon SRV resource records held in the
1847 This is a variant of the BDB backend that uses a hierarchical database
1848 layout which supports subtree renames.
1851 This backend acts as a proxy to forward incoming requests to another
1855 This database uses the filesystem to build the tree structure
1856 of the database, using plain ascii files to store data.
1857 Its usage should be limited to very simple databases, where performance
1858 is not a requirement.
1861 This backend performs basic LDAP proxying with respect to a set of
1862 remote LDAP servers. It is an enhancement of the ldap backend.
1865 This backend provides information about the running status of the slapd
1869 Operations in this backend succeed but do nothing.
1872 This backend is provided for demonstration purposes only.
1873 It serves up user account information from the system
1878 This backend embeds a
1880 interpreter into slapd.
1881 It runs Perl subroutines to implement LDAP operations.
1884 This backend is experimental.
1885 It redirects LDAP operations to another database
1886 in the same server, based on the naming context of the request.
1887 Its use requires the
1891 for details) to rewrite the naming context of the request.
1892 It is primarily intended to implement virtual views on databases
1893 that actually store data.
1896 This backend executes external programs to implement LDAP operations.
1897 It is primarily intended to be used in prototypes.
1900 This backend is experimental.
1901 It services LDAP requests from an SQL database.
1903 An overlay is a piece of
1904 code that intercepts database operations in order to extend or change
1905 them. Overlays are pushed onto
1906 a stack over the database, and so they will execute in the reverse
1907 of the order in which they were configured and the database itself
1908 will receive control last of all.
1910 Overlays must be configured as child entries of a specific database. The
1911 entry's RDN must be of the form
1912 .B olcOverlay={x}<overlaytype>
1913 and the entry must have the olcOverlayConfig objectClass. Normally the
1914 config engine generates the "{x}" index in the RDN automatically, so
1915 it can be omitted when initially loading these entries.
1917 The following overlays can be compiled into slapd.
1918 They are documented in the
1919 .BR slapo-<overlay> (5)
1924 This overlay can record accesses to a given backend database on another
1929 This overlay records changes on a given backend database to an LDIF log
1931 By default it is not built.
1935 This overlay allows automatic referral chasing when a referral would
1936 have been returned, either when configured by the server or when
1937 requested by the client.
1941 This overlay allows selected operations to be denied, similar to the
1942 \fBolcRestrict\fP option.
1946 This is a demo overlay which extends the Compare operation to detect
1947 members of a dynamic group.
1948 It has no effect on any other operations.
1952 This overlay allows expansion of dynamic groups and more.
1956 This overlay maintains a service entry in the database with the DN,
1957 modification type, modifiersName and modifyTimestamp of the last write
1958 operation performed on that database.
1962 This overlay allows caching of LDAP search requests in a local database.
1963 It is most often used with the ldap or meta backends.
1967 This overlay provides a variety of password control mechanisms,
1968 e.g. password aging, password reuse and duplication control, mandatory
1969 password resets, etc.
1972 Referential Integrity.
1973 This overlay can be used with a backend database such as
1975 to maintain the cohesiveness of a schema which utilizes reference
1980 This overlay is useful to test the behavior of clients when
1981 server-generated erroneous and/or unusual responses occur.
1985 This overlay is experimental.
1986 It performs basic DN/data rewrite and
1987 objectClass/attributeType mapping.
1991 This overlay implements the provider-side support for
1993 replication, including persistent search functionality.
1997 This overlay can be used with a backend database such as
1999 to create a "translucent proxy".
2000 Content of entries retrieved from a remote LDAP server can be partially
2001 overridden by the database.
2004 Attribute Uniqueness.
2005 This overlay can be used with a backend database such as
2007 to enforce the uniqueness of some or all attributes within a subtree.
2010 Here is a short example of a configuration in LDIF suitable for use with
2017 objectClass: olcGlobal
2019 olcPidFile: LOCALSTATEDIR/slapd.pid
2020 olcAttributeOptions: x-hidden lang-
2022 dn: cn=schema,cn=config
2023 objectClass: olcSchemaConfig
2026 include: SYSCONFDIR/schema/core.ldif
2028 dn: olcDatabase=frontend,cn=config
2029 objectClass: olcDatabaseConfig
2030 objectClass: olcFrontendConfig
2031 olcDatabase: frontend
2032 # Subtypes of "name" (e.g. "cn" and "ou") with the
2033 # option ";x-hidden" can be searched for/compared,
2034 # but are not shown. See \fBslapd.access\fP(5).
2035 olcAccess: to attrs=name;x-hidden by * =cs
2036 # Protect passwords. See \fBslapd.access\fP(5).
2037 olcAccess: to attrs=userPassword by * auth
2038 # Read access to other attributes and entries.
2039 olcAccess: to * by * read
2041 # set a rootpw for the config database so we can bind.
2042 # deny access to everyone else.
2043 dn: olcDatabase=config,cn=config
2044 objectClass: olcDatabaseConfig
2046 olcRootPW: {SSHA}XKYnrjvGT3wZFQrDD5040US592LxsdLy
2047 olcAccess: to * by * none
2049 dn: olcDatabase=bdb,cn=config
2050 objectClass: olcDatabaseConfig
2051 objectClass: olcBdbConfig
2053 olcSuffix: "dc=our-domain,dc=com"
2054 # The database directory MUST exist prior to
2055 # running slapd AND should only be accessible
2056 # by the slapd/tools. Mode 0700 recommended.
2057 olcDbDirectory: LOCALSTATEDIR/openldap-data
2058 # Indices to maintain
2059 olcDbIndex: objectClass eq
2060 olcDbIndex: cn,sn,mail pres,eq,approx,sub
2062 # We serve small clients that do not handle referrals,
2063 # so handle remote lookups on their behalf.
2064 dn: olcDatabase=ldap,cn=config
2065 objectClass: olcDatabaseConfig
2066 objectClass: olcLdapConfig
2069 olcDbUri: ldap://ldap.some-server.com/
2073 Assuming the above data was saved in a file named "config.ldif" and the
2074 ETCDIR/slapd.d directory has been created, this command will initialize
2078 slapadd -F ETCDIR/slapd.d -n 0 -l config.ldif
2083 "OpenLDAP Administrator's Guide" contains a longer annotated
2084 example of a slapd configuration.
2086 Alternatively, an existing slapd.conf file can be converted to the new
2087 format using slapd or any of the slap tools:
2090 slaptest -f ETCDIR/slapd.conf -F ETCDIR/slapd.d
2097 default slapd configuration file
2100 default slapd configuration directory
2105 .BR slapd\-dnssrv (5),
2107 .BR slapd\-ldap (5),
2108 .BR slapd\-ldif (5),
2109 .BR slapd\-meta (5),
2110 .BR slapd\-monitor (5),
2111 .BR slapd\-null (5),
2112 .BR slapd\-passwd (5),
2113 .BR slapd\-perl (5),
2114 .BR slapd\-relay (5),
2115 .BR slapd\-shell (5),
2117 .BR slapd.access (5),
2118 .BR slapd.plugin (5),
2119 .BR slapd.replog (5),
2131 Known overlays are documented in
2132 .BR slapo\-accesslog (5),
2133 .BR slapo\-auditlog (5),
2134 .BR slapo\-chain (5),
2135 .BR slapo\-dynlist (5),
2136 .BR slapo\-lastmod (5),
2137 .BR slapo\-pcache (5),
2138 .BR slapo\-ppolicy (5),
2139 .BR slapo\-refint (5),
2140 .BR slapo\-retcode (5),
2142 .BR slapo\-syncprov (5),
2143 .BR slapo\-translucent (5),
2144 .BR slapo\-unique (5).
2146 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
2147 .SH ACKNOWLEDGEMENTS
2149 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
2151 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob