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, separate 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 idletimeout 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 index_substr_if_maxlen
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
678 .B olcReferral: <url>
679 Specify the referral to pass back when
681 cannot find a local database to handle a request.
682 If multiple values are specified, each url is provided.
683 .\" slurpd-related keywords are all deprecated
685 .\".B replica-argsfile
686 .\"The ( absolute ) name of a file that will hold the
688 .\"server's command line options
689 .\"if started without the debugging command line option.
690 .\"If it appears after a
692 .\"directive, the args file is specific to the
694 .\"instance that handles that replication log.
696 .\".B replica-pidfile
697 .\"The ( absolute ) name of a file that will hold the
699 .\"server's process ID ( see
701 .\") if started without the debugging command line option.
702 .\"If it appears after a
704 .\"directive, the pid file is specific to the
706 .\"instance that handles that replication log.
708 .\".B replicationinterval
709 .\"The number of seconds
711 .\"waits before checking the replogfile for changes.
712 .\"If it appears after a
714 .\"directive, the replication interval is specific to the
716 .\"instance that handles that replication log.
718 .B olcReverseLookup: TRUE | FALSE
719 Enable/disable client name unverified reverse lookup (default is
721 if compiled with --enable-rlookups).
723 .B olcRootDSE: <file>
724 Specify the name of an LDIF(5) file containing user defined attributes
725 for the root DSE. These attributes are returned in addition to the
726 attributes normally produced by slapd.
728 .B olcSaslHost: <fqdn>
729 Used to specify the fully qualified domain name used for SASL processing.
731 .B olcSaslRealm: <realm>
732 Specify SASL realm. Default is empty.
734 .B olcSaslSecProps: <properties>
735 Used to specify Cyrus SASL security properties.
738 flag (without any other properties) causes the flag properties
739 default, "noanonymous,noplain", to be cleared.
742 flag disables mechanisms susceptible to simple passive attacks.
745 flag disables mechanisms susceptible to active attacks.
748 flag disables mechanisms susceptible to passive dictionary attacks.
751 flag disables mechanisms which support anonymous login.
754 flag require forward secrecy between sessions.
757 require mechanisms which pass client credentials (and allow
758 mechanisms which can pass credentials to do so).
761 property specifies the minimum acceptable
762 .I security strength factor
763 as an integer approximate to effective key length used for
764 encryption. 0 (zero) implies no protection, 1 implies integrity
765 protection only, 56 allows DES or other weak ciphers, 112
766 allows triple DES and other strong ciphers, 128 allows RC4,
767 Blowfish and other modern strong ciphers. The default is 0.
770 property specifies the maximum acceptable
771 .I security strength factor
772 as an integer (see minssf description). The default is INT_MAX.
775 property specifies the maximum security layer receive buffer
776 size allowed. 0 disables security layers. The default is 65536.
778 .B olcSockbufMaxIncoming: <integer>
779 Specify the maximum incoming LDAP PDU size for anonymous sessions.
780 The default is 262143.
782 .B olcSockbufMaxIncomingAuth: <integer>
783 Specify the maximum incoming LDAP PDU size for authenticated sessions.
784 The default is 4194303.
786 .B olcThreads: <integer>
787 Specify the maximum size of the primary thread pool.
788 The default is 16; the minimum value is 2.
790 .B olcToolThreads: <integer>
791 Specify the maximum number of threads to use in tool mode.
792 This should not be greater than the number of CPUs in the system.
794 .\"ucdata-path is obsolete / ignored...
796 .\".B ucdata-path <path>
797 .\"Specify the path to the directory containing the Unicode character
798 .\"tables. The default path is DATADIR/ucdata.
802 is built with support for Transport Layer Security, there are more options
805 .B olcTLSCipherSuite: <cipher-suite-spec>
806 Permits configuring what ciphers will be accepted and the preference order.
807 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
809 olcTLSCipherSuite: HIGH:MEDIUM:+SSLv2
811 To check what ciphers a given spec selects, use:
813 openssl ciphers -v <cipher-suite-spec>
815 .B olcTLSCACertificateFile: <filename>
816 Specifies the file that contains certificates for all of the Certificate
821 .B olcTLSCACertificatePath: <path>
822 Specifies the path of a directory that contains Certificate Authority
823 certificates in separate individual files. Usually only one of this
824 or the olcTLSCACertificateFile is used.
826 .B olcTLSCertificateFile: <filename>
827 Specifies the file that contains the
831 .B olcTLSCertificateKeyFile: <filename>
832 Specifies the file that contains the
834 server private key that matches the certificate stored in the
835 .B olcTLSCertificateFile
836 file. Currently, the private key must not be protected with a password, so
837 it is of critical importance that it is protected carefully.
839 .B olcTLSDHParamFile: <filename>
840 This directive specifies the file that contains parameters for Diffie-Hellman
841 ephemeral key exchange. This is required in order to use a DSA certificate on
842 the server. If multiple sets of parameters are present in the file, all of
843 them will be processed. Note that setting this option may also enable
844 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
845 You should append "!ADH" to your cipher suites if you have changed them
846 from the default, otherwise no certificate exchanges or verification will
849 .B olcTLSRandFile: <filename>
850 Specifies the file to obtain random bits from when /dev/[u]random
851 is not available. Generally set to the name of the EGD/PRNGD socket.
852 The environment variable RANDFILE can also be used to specify the filename.
854 .B olcTLSVerifyClient: <level>
855 Specifies what checks to perform on client certificates in an
856 incoming TLS session, if any.
859 can be specified as one of the following keywords:
865 will not ask the client for a certificate.
868 The client certificate is requested. If no certificate is provided,
869 the session proceeds normally. If a bad certificate is provided,
870 it will be ignored and the session proceeds normally.
873 The client certificate is requested. If no certificate is provided,
874 the session proceeds normally. If a bad certificate is provided,
875 the session is immediately terminated.
877 .B demand | hard | true
878 These keywords are all equivalent, for compatibility reasons.
879 The client certificate is requested. If no certificate is provided,
880 or a bad certificate is provided, the session is immediately terminated.
882 Note that a valid client certificate is required in order to use the
883 SASL EXTERNAL authentication mechanism with a TLS session. As such,
885 .B olcTLSVerifyClient
886 setting must be chosen to enable SASL EXTERNAL authentication.
889 .B olcTLSCRLCheck: <level>
890 Specifies if the Certificate Revocation List (CRL) of the CA should be
891 used to verify if the client certificates have not been revoked. This
893 .B olcTLSCACertificatePath
896 can be specified as one of the following keywords:
900 No CRL checks are performed
903 Check the CRL of the peer certificate
906 Check the CRL for a whole certificate chain
908 .SH DYNAMIC MODULE OPTIONS
911 is compiled with --enable-modules then the module-related entries will
912 be available. These entries are named
913 .B cn=module{x},cn=config
915 must have the olcModuleList objectClass. One entry should be created
918 Normally the config engine generates the "{x}" index in the RDN
919 automatically, so it can be omitted when initially loading these entries.
921 .B olcModuleLoad: <filename>
922 Specify the name of a dynamically loadable module to load. The filename
923 may be an absolute path name or a simple filename. Non-absolute names
924 are searched for in the directories specified by the
928 .B olcModulePath: <pathspec>
929 Specify a list of directories to search for loadable modules. Typically
930 the path is colon-separated but this depends on the operating system.
932 Schema definitions are created as entries in the
933 .B cn=schema,cn=config
934 subtree. These entries must have the olcSchemaConfig objectClass.
935 As noted above, the actual
936 .B cn=schema,cn=config
937 entry is predefined and any values specified for it are ignored.
941 .B olcAttributetypes: "(\ <oid>\
943 [DESC\ <description>]\
952 [NO\-USER\-MODIFICATION]\
953 [USAGE\ <attributeUsage>]\ )"
955 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
956 The slapd parser extends the RFC 4512 definition by allowing string
957 forms as well as numeric OIDs to be used for the attribute OID and
958 attribute syntax OID.
960 .B olcObjectIdentifier
966 .B olcDitContentRules: "(\ <oid>\
968 [DESC\ <description>]\
975 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
976 The slapd parser extends the RFC 4512 definition by allowing string
977 forms as well as numeric OIDs to be used for the attribute OID and
978 attribute syntax OID.
980 .B olcObjectIdentifier
986 .B olcObjectClasses: "(\ <oid>\
988 [DESC\ <description>]\
991 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
992 [MUST\ <oids>] [MAY\ <oids>] )"
994 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
995 The slapd parser extends the RFC 4512 definition by allowing string
996 forms as well as numeric OIDs to be used for the object class OID.
1000 description.) Object classes are "STRUCTURAL" by default.
1003 .B olcObjectIdentifier: <name> "{ <oid> | <name>[:<suffix>] }"
1004 Define a string name that equates to the given OID. The string can be used
1005 in place of the numeric OID in objectclass and attribute definitions. The
1006 name can also be used with a suffix of the form ":xx" in which case the
1007 value "oid.xx" will be used.
1009 .SH GENERAL BACKEND OPTIONS
1010 Options in these entries only apply to the configuration of a single
1011 type of backend. All backends may support this class of options.
1012 The entry must be named
1013 .B olcBackend=<databasetype>,cn=config
1014 and must have the olcBackendConfig objectClass.
1032 At present, no backend implements any options of this type.
1034 .SH DATABASE OPTIONS
1035 Database options are set in entries named
1036 .B olcDatabase={x}<databasetype>,cn=config
1037 and must have the olcDatabaseConfig objectClass. Normally the config
1038 engine generates the "{x}" index in the RDN automatically, so it
1039 can be omitted when initially loading these entries.
1041 The special frontend database is always numbered "{-1}" and the config
1042 database is always numbered "{0}".
1044 .SH GLOBAL DATABASE OPTIONS
1045 Options in this section may be set in the special "frontend" database
1046 and inherited in all the other databases. These options may be altered
1047 by further settings in each specific database. The frontend entry must
1049 .B olcDatabase=frontend,cn=config
1050 and must have the olcFrontendConfig objectClass.
1052 .B olcAccess: to <what> "[ by <who> <access> <control> ]+"
1053 Grant access (specified by <access>) to a set of entries and/or
1054 attributes (specified by <what>) by one or more requestors (specified
1056 If no access controls are present, the default policy
1057 allows anyone and everyone to read anything but restricts
1058 updates to rootdn. (e.g., "olcAccess: to * by * read"). Access
1059 controls set in the frontend are inherited by all other databases.
1060 Access controls set in specific databases do not override these
1061 global settings; they are appended to the global settings.
1062 The rootdn of a database can always read and write EVERYTHING
1065 .BR slapd.access (5)
1066 and the "OpenLDAP Administrator's Guide" for details.
1068 .B olcDefaultSearchBase: <dn>
1069 Specify a default search base to use when client submits a
1070 non-base search request with an empty base DN.
1071 Base scoped search requests with an empty base DN are not affected.
1072 This setting is only allowed in the frontend entry.
1074 .B olcReadOnly: TRUE | FALSE
1075 This option puts the database into "read-only" mode. Any attempts to
1076 modify the database will return an "unwilling to perform" error. By
1077 default, olcReadOnly is FALSE. Note that when this option is set
1078 TRUE on the frontend, it cannot be reset without restarting the
1079 server, since further writes to tne config database will be rejected.
1081 .B olcRequires: <conditions>
1082 Specify a set of conditions to require (default none).
1083 The directive may be specified globally and/or per-database;
1084 databases inherit global conditions, so per-database specifications
1087 requires bind operation prior to directory operations.
1089 requires session to be using LDAP version 3.
1091 requires authentication prior to directory operations.
1093 requires SASL authentication prior to directory operations.
1095 requires strong authentication prior to directory operations.
1096 The strong keyword allows protected "simple" authentication
1097 as well as SASL authentication.
1099 may be used to require no conditions (useful to clear out globally
1100 set conditions within a particular database); it must occur first
1101 in the list of conditions.
1103 .B olcRestrict: <oplist>
1104 Specify a list of operations that are restricted.
1105 Restrictions on a specific database override any frontend setting.
1106 Operations can be any of
1111 .BR extended[=<OID>] ,
1115 or the special pseudo-operations
1119 which respectively summarize read and write operations.
1123 .I olcReadOnly: TRUE
1127 keyword allows to indicate the OID of the specific operation
1130 .B olcSchemaDN: <dn>
1131 Specify the distinguished name for the subschema subentry that
1132 controls the entries on this server. The default is "cn=Subschema".
1134 .B olcSecurity: <factors>
1135 Specify a set of security strength factors (separated by white space)
1137 .BR olcSaslSecprops 's
1139 option for a description of security strength factors).
1140 The directive may be specified globally and/or per-database.
1142 specifies the overall security strength factor.
1144 specifies the transport security strength factor.
1146 specifies the TLS security strength factor.
1148 specifies the SASL security strength factor.
1150 specifies the overall security strength factor to require for
1152 .B update_transport=<n>
1153 specifies the transport security strength factor to require for
1156 specifies the TLS security strength factor to require for
1159 specifies the SASL security strength factor to require for
1162 specifies the security strength factor required for
1164 username/password authentication.
1167 factor is measure of security provided by the underlying transport,
1168 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
1170 .B olcSizeLimit: {<integer>|unlimited}
1172 .B olcSizeLimit: size[.{soft|hard|unchecked}]=<integer> [...]
1173 Specify the maximum number of entries to return from a search operation.
1174 The default size limit is 500.
1177 to specify no limits.
1178 The second format allows a fine grain setting of the size limits.
1179 Extra args can be added in the same value or as additional values.
1182 for an explanation of the different flags.
1184 .B olcTimeLimit: {<integer>|unlimited}
1186 .B olcTimeLimit: time[.{soft|hard}]=<integer> [...]
1187 Specify the maximum number of seconds (in real time)
1189 will spend answering a search request. The default time limit is 3600.
1192 to specify no limits.
1193 The second format allows a fine grain setting of the time limits.
1194 Extra args can be added in the same value or as additional values.
1197 for an explanation of the different flags.
1199 .SH GENERAL DATABASE OPTIONS
1200 Options in this section only apply to the specific database for
1201 which they are defined. They are supported by every
1202 type of backend. All of the Global Database Options may also be
1205 .B olcLastMod: TRUE | FALSE
1208 will automatically maintain the
1209 modifiersName, modifyTimestamp, creatorsName, and
1210 createTimestamp attributes for entries. It also controls
1211 the entryCSN and entryUUID attributes, which are needed
1212 by the syncrepl provider. By default, olcLastMod is TRUE.
1214 .B olcLimits: <who> <limit> [<limit> [...]]
1215 Specify time and size limits based on who initiated an operation.
1222 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1228 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1233 matches all unauthenticated clients.
1236 matches all authenticated clients;
1239 dn pattern is assumed unless otherwise specified by qualifying
1240 the (optional) key string
1246 (which are synonyms), to require an exact match; with
1248 to require exactly one level of depth match; with
1250 to allow any level of depth match, including the exact match; with
1252 to allow any level of depth match, not including the exact match;
1254 explicitly requires the (default) match based on POSIX (''extended'')
1255 regular expression pattern.
1258 matches unbound operations; the
1261 The same behavior is obtained by using the
1268 with the optional objectClass
1274 sets the limits for any DN listed in the values of the
1280 group objectClass (default
1282 whose DN exactly matches
1285 The currently supported limits are
1290 The syntax for time limits is
1291 .BR time[.{soft|hard}]=<integer> ,
1294 is the number of seconds slapd will spend answering a search request.
1295 If no time limit is explicitly requested by the client, the
1297 limit is used; if the requested time limit exceeds the
1300 .\".I "Administrative limit exceeded"
1301 .\"error is returned.
1302 limit, the value of the limit is used instead.
1305 limit is set to the keyword
1307 the soft limit is used in either case; if it is set to the keyword
1309 no hard limit is enforced.
1310 Explicit requests for time limits smaller or equal to the
1313 If no limit specifier is set, the value is assigned to the
1319 to preserve the original behavior.
1321 The syntax for size limits is
1322 .BR size[.{soft|hard|unchecked}]=<integer> ,
1325 is the maximum number of entries slapd will return answering a search
1327 If no size limit is explicitly requested by the client, the
1329 limit is used; if the requested size limit exceeds the
1332 .\".I "Administrative limit exceeded"
1333 .\"error is returned.
1334 limit, the value of the limit is used instead.
1337 limit is set to the keyword
1339 the soft limit is used in either case; if it is set to the keyword
1341 no hard limit is enforced.
1342 Explicit requests for size limits smaller or equal to the
1347 specifier sets a limit on the number of candidates a search request is allowed
1349 The rationale behind it is that searches for non-properly indexed
1350 attributes may result in large sets of candidates, which must be
1353 to determine whether they match the search filter or not.
1356 limit provides a means to drop such operations before they are even
1358 If the selected candidates exceed the
1360 limit, the search will abort with
1361 .IR "Unwilling to perform" .
1362 If it is set to the keyword
1364 no limit is applied (the default).
1367 the search is not even performed; this can be used to disallow searches
1368 for a specific set of users.
1369 If no limit specifier is set, the value is assigned to the
1375 to preserve the original behavior.
1377 In case of no match, the global limits are used.
1378 The default values are the same as
1387 control is requested, the
1389 size limit is used by default, because the request of a specific page size
1390 is considered an explicit request for a limitation on the number
1391 of entries to be returned.
1392 However, the size limit applies to the total count of entries returned within
1393 the search, and not to a single page.
1394 Additional size limits may be enforced; the syntax is
1395 .BR size.pr={<integer>|noEstimate|unlimited} ,
1398 is the max page size if no explicit limit is set; the keyword
1400 inhibits the server from returning an estimate of the total number
1401 of entries that might be returned
1402 (note: the current implementation does not return any estimate).
1405 indicates that no limit is applied to the pagedResults control page size.
1407 .B size.prtotal={<integer>|unlimited|disabled}
1408 allows to set a limit on the total number of entries that a pagedResults
1409 control allows to return.
1410 By default it is set to the
1415 is the max number of entries that the whole search with pagedResults control
1419 to allow unlimited number of entries to be returned, e.g. to allow
1420 the use of the pagedResults control as a means to circumvent size
1421 limitations on regular searches; the keyword
1423 disables the control, i.e. no paged results can be returned.
1424 Note that the total number of entries returned when the pagedResults control
1425 is requested cannot exceed the
1427 size limit of regular searches unless extended by the
1432 .B olcMaxDerefDepth: <depth>
1433 Specifies the maximum number of aliases to dereference when trying to
1434 resolve an entry, used to avoid infinite alias loops. The default is 1.
1436 .B olcMirrorMode: TRUE | FALSE
1437 This option puts a replica database into "mirror" mode. Update
1438 operations will be accepted from any user, not just the updatedn. The
1439 database must already be configured as syncrepl consumer
1440 before this keyword may be set. This mode must be used with extreme
1441 care, as it does not offer any consistency guarantees. This feature
1442 is intended to be used with an external frontend that guarantees that
1443 writes are only directed to a single master, switching to an alternate
1444 server only if the original master goes down.
1445 By default, mirrormode is FALSE.
1447 .B olcPlugin: <plugin_type> <lib_path> <init_function> [<arguments>]
1448 Configure a SLAPI plugin. The SLAPI plugin architecture is defined
1449 by Netscape/Sun/iPlanet/RedHat and is not documented here.
1452 .\".B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1453 .\".B [starttls=yes|critical]
1454 .\".B [suffix=<suffix> [...]]
1455 .\".B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1456 .\".B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1457 .\".B [authcId=<authentication ID>] [authzId=<authorization ID>]
1458 .\".B [attrs[!]=<attr list>]
1460 .\"Specify a replication site for this database. Refer to the "OpenLDAP
1461 .\"Administrator's Guide" for detailed information on setting up a replicated
1463 .\"directory service. Zero or more
1465 .\"instances can be used to select the subtrees that will be replicated
1466 .\"(defaults to all the database).
1468 .\"is deprecated in favor of the
1472 .\"allows the replica LDAP server to be specified as an LDAP URI.
1477 .\"requires the options
1481 .\"and should only be used when adequate security services
1482 .\"(e.g TLS or IPSEC) are in place. A
1486 .\"requires the option
1488 .\"Specific security properties (as with the
1490 .\"keyword above) for a SASL bind can be set with the
1492 .\"option. A non-default SASL realm can be set with the
1497 .\"will use Kerberos, a kerberos instance should be given in
1501 .\"can be given after the
1503 .\"keyword to allow the selective replication of the listed attributes only;
1506 .\"mark is used, the list is considered exclusive, i.e. the listed attributes
1507 .\"are not replicated.
1508 .\"If an objectClass is listed, all the related attributes
1509 .\"are (are not) replicated.
1512 .\".B replogfile <filename>
1513 .\"Specify the name of the replication log file to log changes to.
1514 .\"The replication log is typically written by
1519 .\".BR slapd.replog (5)
1520 .\"for more information. The specified file should be located
1521 .\"in a directory with limited read/write/execute access as the replication
1522 .\"logs may contain sensitive information.
1525 Specify the distinguished name that is not subject to access control
1526 or administrative limit restrictions for operations on this database.
1527 This DN may or may not be associated with an entry. An empty root
1528 DN (the default) specifies no root access is to be granted. It is
1529 recommended that the rootdn only be specified when needed (such as
1530 when initially populating a database). If the rootdn is within
1531 a namingContext (suffix) of the database, a simple bind password
1532 may also be provided using the
1534 directive. Note that the rootdn is always needed when using syncrepl.
1536 .B olcRootPW: <password>
1537 Specify a password (or hash of the password) for the rootdn. The
1538 password can only be set if the rootdn is within the namingContext
1539 (suffix) of the database.
1540 This option accepts all RFC 2307 userPassword formats known to
1543 description) as well as cleartext.
1545 may be used to generate a hash of a password. Cleartext
1546 and \fB{CRYPT}\fP passwords are not recommended. If empty
1547 (the default), authentication of the root DN is by other means
1548 (e.g. SASL). Use of SASL is encouraged.
1550 .B olcSubordinate: [TRUE | FALSE | advertise]
1551 Specify that the current backend database is a subordinate of another
1552 backend database. A subordinate database may have only one suffix. This
1553 option may be used to glue multiple databases into a single namingContext.
1554 If the suffix of the current database is within the namingContext of a
1555 superior database, searches against the superior database will be
1556 propagated to the subordinate as well. All of the databases
1557 associated with a single namingContext should have identical rootdns.
1558 Behavior of other LDAP operations is unaffected by this setting. In
1559 particular, it is not possible to use moddn to move an entry from
1560 one subordinate to another subordinate within the namingContext.
1562 If the optional \fBadvertise\fP flag is supplied, the naming context of
1563 this database is advertised in the root DSE. The default is to hide this
1564 database context, so that only the superior context is visible.
1571 are used on the superior database, any glued subordinates that support
1572 these tools are opened as well.
1574 Databases that are glued together should usually be configured with the
1575 same indices (assuming they support indexing), even for attributes that
1576 only exist in some of these databases. In general, all of the glued
1577 databases should be configured as similarly as possible, since the intent
1578 is to provide the appearance of a single directory.
1580 Note that the \fIsubordinate\fP functionality is implemented internally
1581 by the \fIglue\fP overlay and as such its behavior will interact with other
1582 overlays in use. By default, the glue overlay is automatically configured as
1583 the last overlay on the superior backend. Its position on the backend
1584 can be explicitly configured by setting an \fBoverlay glue\fP directive
1585 at the desired position. This explicit configuration is necessary e.g.
1586 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1587 in order to work over all of the glued databases. E.g.
1590 dn: olcDatabase={1}bdb,cn=config
1591 olcSuffix: dc=example,dc=com
1594 dn: olcOverlay={0}glue,olcDatabase={1}bdb,cn=config
1597 dn: olcOverlay={1}syncprov,olcDatabase={1}bdb,cn=config
1601 See the Overlays section below for more details.
1603 .B olcSuffix: <dn suffix>
1604 Specify the DN suffix of queries that will be passed to this
1605 backend database. Multiple suffix lines can be given and at least one is
1606 required for each database definition.
1607 If the suffix of one database is "inside" that of another, the database
1608 with the inner suffix must come first in the configuration file.
1611 .B olcSyncrepl: rid=<replica ID>
1612 .B provider=ldap[s]://<hostname>[:port]
1613 .B searchbase=<base DN>
1614 .B [type=refreshOnly|refreshAndPersist]
1615 .B [interval=dd:hh:mm:ss]
1616 .B [retry=[<retry interval> <# of retries>]+]
1617 .B [filter=<filter str>]
1618 .B [scope=sub|one|base|subord]
1619 .B [attrs=<attr list>]
1620 .B [exattrs=<attr list>]
1622 .B [sizelimit=<limit>]
1623 .B [timelimit=<limit>]
1624 .B [schemachecking=on|off]
1625 .B [bindmethod=simple|sasl]
1627 .B [saslmech=<mech>]
1628 .B [authcid=<identity>]
1629 .B [authzid=<identity>]
1630 .B [credentials=<passwd>]
1632 .B [secprops=<properties>]
1633 .B [starttls=yes|critical]
1634 .B [tls_cert=<file>]
1636 .B [tls_cacert=<file>]
1637 .B [tls_cacertdir=<path>]
1638 .B [tls_reqcert=never|allow|try|demand]
1639 .B [tls_ciphersuite=<ciphers>]
1640 .B [tls_crlcheck=none|peer|all]
1641 .B [logbase=<base DN>]
1642 .B [logfilter=<filter str>]
1643 .B [syncdata=default|accesslog|changelog]
1645 Specify the current database as a replica which is kept up-to-date with the
1646 master content by establishing the current
1648 as a replication consumer site running a
1651 The replica content is kept synchronized to the master content using
1652 the LDAP Content Synchronization protocol. Refer to the
1653 "OpenLDAP Administrator's Guide" for detailed information on
1654 setting up a replicated
1656 directory service using the
1661 identifies the current
1663 directive within the replication consumer site.
1664 It is a non-negative integer having no more than three digits.
1667 specifies the replication provider site containing the master content
1668 as an LDAP URI. If <port> is not given, the standard LDAP port number
1669 (389 or 636) is used.
1673 replica is defined using a search
1674 specification as its result set. The consumer
1676 will send search requests to the provider
1678 according to the search specification. The search specification includes
1679 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1682 parameters as in the normal search specification. The
1684 option may also be used to specify attributes that should be omitted
1685 from incoming entries.
1686 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1687 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1688 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1689 attributes, and \fBattrsonly\fP and \fBexattrs\fP are unset by default.
1690 The \fBsizelimit\fP and \fBtimelimit\fP only
1691 accept "unlimited" and positive integers, and both default to "unlimited".
1692 Note, however, that any provider-side limits for the replication identity
1693 will be enforced by the provider regardless of the limits requested
1694 by the LDAP Content Synchronization operation, much like for any other
1697 The LDAP Content Synchronization protocol has two operation types.
1700 operation, the next synchronization search operation
1701 is periodically rescheduled at an interval time (specified by
1703 parameter; 1 day by default)
1704 after each synchronization operation finishes.
1706 .B refreshAndPersist
1707 operation, a synchronization search remains persistent in the provider slapd.
1708 Further updates to the master replica will generate
1709 .B searchResultEntry
1710 to the consumer slapd as the search responses to the persistent
1711 synchronization search.
1713 If an error occurs during replication, the consumer will attempt to
1714 reconnect according to the
1716 parameter which is a list of the <retry interval> and <# of retries> pairs.
1717 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1718 for the first 10 times and then retry every 300 seconds for the next 3
1719 times before stop retrying. The `+' in <# of retries> means indefinite
1720 number of retries until success.
1722 The schema checking can be enforced at the LDAP Sync
1723 consumer site by turning on the
1725 parameter. The default is off.
1731 requires the options
1735 and should only be used when adequate security services
1736 (e.g. TLS or IPSEC) are in place.
1743 Depending on the mechanism, an authentication identity and/or
1744 credentials can be specified using
1750 parameter may be used to specify an authorization identity.
1751 Specific security properties (as with the
1753 keyword above) for a SASL bind can be set with the
1755 option. A non default SASL realm can be set with the
1758 The provider, other than allow authentication of the syncrepl identity,
1759 should grant that identity appropriate access privileges to the data
1760 that is being replicated (\fBaccess\fP directive), and appropriate time
1761 and size limits (\fBlimits\fP directive).
1766 parameter specifies use of the StartTLS extended operation
1767 to establish a TLS session before Binding to the provider. If the
1769 argument is supplied, the session will be aborted if the StartTLS request
1770 fails. Otherwise the syncrepl session continues without TLS. Note that the
1771 main slapd TLS settings are not used by the syncrepl engine;
1772 by default the TLS parameters from ETCDIR/ldap.conf will be used.
1773 TLS settings may be specified here, in which case the ldap.conf settings
1774 will be completely ignored.
1776 Rather than replicating whole entries, the consumer can query logs of
1777 data modifications. This mode of operation is referred to as \fIdelta
1778 syncrepl\fP. In addition to the above parameters, the
1782 parameters must be set appropriately for the log that will be used. The
1784 parameter must be set to either "accesslog" if the log conforms to the
1785 .BR slapo-accesslog (5)
1786 log format, or "changelog" if the log conforms
1787 to the obsolete \fIchangelog\fP format. If the
1789 parameter is omitted or set to "default" then the log parameters are
1794 .\"This option is only applicable in a slave
1795 .\"database updated using
1797 .\"It specifies the DN permitted to update (subject to access controls)
1798 .\"the replica (typically, this is the DN
1800 .\"binds to update the replica). Generally, this DN
1802 .\"be the same as the
1804 .\"used at the master.
1806 .B olcUpdateRef: <url>
1807 Specify the referral to pass back when
1809 is asked to modify a replicated local database.
1810 If multiple values are specified, each url is provided.
1812 .SH DATABASE-SPECIFIC OPTIONS
1813 Each database may allow specific configuration options; they are
1814 documented separately in the backends' manual pages.
1816 The following backends can be compiled into slapd.
1817 They are documented in the
1818 .BR slapd-<backend> (5)
1822 This is the recommended primary backend for a normal slapd database.
1823 It takes care to configure it properly.
1824 It uses the transactional database interface of the Sleepycat Berkeley
1825 DB (BDB) package to store data.
1828 This backend is used to manage the configuration of slapd run-time.
1831 This backend is experimental.
1832 It serves up referrals based upon SRV resource records held in the
1836 This is a variant of the BDB backend that uses a hierarchical database
1837 layout which supports subtree renames.
1840 This backend acts as a proxy to forward incoming requests to another
1844 This database uses the filesystem to build the tree structure
1845 of the database, using plain ascii files to store data.
1846 Its usage should be limited to very simple databases, where performance
1847 is not a requirement.
1850 This backend performs basic LDAP proxying with respect to a set of
1851 remote LDAP servers. It is an enhancement of the ldap backend.
1854 This backend provides information about the running status of the slapd
1858 Operations in this backend succeed but do nothing.
1861 This backend is provided for demonstration purposes only.
1862 It serves up user account information from the system
1867 This backend embeds a
1869 interpreter into slapd.
1870 It runs Perl subroutines to implement LDAP operations.
1873 This backend is experimental.
1874 It redirects LDAP operations to another database
1875 in the same server, based on the naming context of the request.
1876 Its use requires the
1880 for details) to rewrite the naming context of the request.
1881 It is primarily intended to implement virtual views on databases
1882 that actually store data.
1885 This backend executes external programs to implement LDAP operations.
1886 It is primarily intended to be used in prototypes.
1889 This backend is experimental.
1890 It services LDAP requests from an SQL database.
1892 An overlay is a piece of
1893 code that intercepts database operations in order to extend or change
1894 them. Overlays are pushed onto
1895 a stack over the database, and so they will execute in the reverse
1896 of the order in which they were configured and the database itself
1897 will receive control last of all.
1899 Overlays must be configured as child entries of a specific database. The
1900 entry's RDN must be of the form
1901 .B olcOverlay={x}<overlaytype>
1902 and the entry must have the olcOverlayConfig objectClass. Normally the
1903 config engine generates the "{x}" index in the RDN automatically, so
1904 it can be omitted when initially loading these entries.
1906 The following overlays can be compiled into slapd.
1907 They are documented in the
1908 .BR slapo-<overlay> (5)
1913 This overlay can record accesses to a given backend database on another
1918 This overlay records changes on a given backend database to an LDIF log
1920 By default it is not built.
1924 This overlay allows automatic referral chasing when a referral would
1925 have been returned, either when configured by the server or when
1926 requested by the client.
1930 This overlay allows selected operations to be denied, similar to the
1931 \fBolcRestrict\fP option.
1935 This is a demo overlay which extends the Compare operation to detect
1936 members of a dynamic group.
1937 It has no effect on any other operations.
1941 This overlay allows expansion of dynamic groups and more.
1945 This overlay maintains a service entry in the database with the DN,
1946 modification type, modifiersName and modifyTimestamp of the last write
1947 operation performed on that database.
1951 This overlay allows caching of LDAP search requests in a local database.
1952 It is most often used with the ldap or meta backends.
1956 This overlay provides a variety of password control mechanisms,
1957 e.g. password aging, password reuse and duplication control, mandatory
1958 password resets, etc.
1961 Referential Integrity.
1962 This overlay can be used with a backend database such as
1964 to maintain the cohesiveness of a schema which utilizes reference
1969 This overlay is useful to test the behavior of clients when
1970 server-generated erroneous and/or unusual responses occur.
1974 This overlay is experimental.
1975 It performs basic DN/data rewrite and
1976 objectClass/attributeType mapping.
1980 This overlay implements the provider-side support for
1982 replication, including persistent search functionality.
1986 This overlay can be used with a backend database such as
1988 to create a "translucent proxy".
1989 Content of entries retrieved from a remote LDAP server can be partially
1990 overridden by the database.
1993 Attribute Uniqueness.
1994 This overlay can be used with a backend database such as
1996 to enforce the uniqueness of some or all attributes within a subtree.
1999 Here is a short example of a configuration in LDIF suitable for use with
2006 objectClass: olcGlobal
2008 olcPidFile: LOCALSTATEDIR/slapd.pid
2009 olcAttributeOptions: x-hidden lang-
2011 dn: cn=schema,cn=config
2012 objectClass: olcSchemaConfig
2015 include: SYSCONFDIR/schema/core.ldif
2017 dn: olcDatabase=frontend,cn=config
2018 objectClass: olcDatabaseConfig
2019 objectClass: olcFrontendConfig
2020 olcDatabase: frontend
2021 # Subtypes of "name" (e.g. "cn" and "ou") with the
2022 # option ";x-hidden" can be searched for/compared,
2023 # but are not shown. See \fBslapd.access\fP(5).
2024 olcAccess: to attrs=name;x-hidden by * =cs
2025 # Protect passwords. See \fBslapd.access\fP(5).
2026 olcAccess: to attrs=userPassword by * auth
2027 # Read access to other attributes and entries.
2028 olcAccess: to * by * read
2030 dn: olcDatabase=bdb,cn=config
2031 objectClass: olcDatabaseConfig
2032 objectClass: olcBdbConfig
2034 olcSuffix: "dc=our-domain,dc=com"
2035 # The database directory MUST exist prior to
2036 # running slapd AND should only be accessible
2037 # by the slapd/tools. Mode 0700 recommended.
2038 olcDbDirectory: LOCALSTATEDIR/openldap-data
2039 # Indices to maintain
2040 olcDbIndex: objectClass eq
2041 olcDbIndex: cn,sn,mail pres,eq,approx,sub
2043 # We serve small clients that do not handle referrals,
2044 # so handle remote lookups on their behalf.
2045 dn: olcDatabase=ldap,cn=config
2046 objectClass: olcDatabaseConfig
2047 objectClass: olcLdapConfig
2050 olcDbUri: ldap://ldap.some-server.com/
2054 Assuming the above data was saved in a file named "config.ldif" and the
2055 ETCDIR/slapd.d directory has been created, this command will initialize
2059 slapadd -F ETCDIR/slapd.d -n 0 -l config.ldif
2064 "OpenLDAP Administrator's Guide" contains a longer annotated
2065 example of a slapd configuration.
2069 default slapd configuration directory
2074 .BR slapd\-dnssrv (5),
2076 .BR slapd\-ldap (5),
2077 .BR slapd\-ldif (5),
2078 .BR slapd\-meta (5),
2079 .BR slapd\-monitor (5),
2080 .BR slapd\-null (5),
2081 .BR slapd\-passwd (5),
2082 .BR slapd\-perl (5),
2083 .BR slapd\-relay (5),
2084 .BR slapd\-shell (5),
2086 .BR slapd.access (5),
2087 .BR slapd.plugin (5),
2088 .BR slapd.replog (5),
2100 Known overlays are documented in
2101 .BR slapo\-accesslog (5),
2102 .BR slapo\-auditlog (5),
2103 .BR slapo\-chain (5),
2104 .BR slapo\-dynlist (5),
2105 .BR slapo\-lastmod (5),
2106 .BR slapo\-pcache (5),
2107 .BR slapo\-ppolicy (5),
2108 .BR slapo\-refint (5),
2109 .BR slapo\-retcode (5),
2111 .BR slapo\-syncprov (5),
2112 .BR slapo\-translucent (5),
2113 .BR slapo\-unique (5).
2115 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
2116 .SH ACKNOWLEDGEMENTS
2118 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
2120 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob