1 .TH SLAPD-CONFIG 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd-config \- configuration backend to slapd
12 backend manages all of the configuration information for the
14 daemon. This configuration information is also used by the SLAPD tools
26 backend is backward compatible with the older
28 file but provides the ability to change the configuration dynamically
29 at runtime. If slapd is run with only a
31 file dynamic changes will be allowed but they will not persist across
32 a server restart. Dynamic changes are only saved when slapd is running
35 configuration directory.
38 Unlike other backends, there can only be one instance of the
40 backend, and most of its structure is predefined. The root of the
41 database is hardcoded to
43 and this root entry contains
44 global settings for slapd. Multiple child entries underneath the
45 root entry are used to carry various other settings:
49 dynamically loaded modules
55 backend-specific settings
58 database-specific settings
63 entries will only appear in configurations where slapd
64 was built with support for dynamically loaded modules. There can be
65 multiple entries, one for each configured module path. Within each
66 entry there will be values recorded for each module loaded on a
67 given path. These entries have no children.
71 entry contains all of the hardcoded schema elements.
72 The children of this entry contain all user-defined schema elements.
73 In schema that were loaded from include files, the child entry will
74 be named after the include file from which the schema was loaded.
75 Typically the first child in this subtree will be
76 .BR cn=core,cn=schema,cn=config .
79 entries are for storing settings specific to a single
80 backend type (and thus global to all database instances of that type).
81 At present there are no backends that implement settings of this
82 nature, so usually there will not be any olcBackend entries.
85 entries store settings specific to a single database
86 instance. These entries may have
88 child entries corresponding
89 to any overlays configured on the database. The olcDatabase and
90 olcOverlay entries may also have miscellaneous child entries for
91 other settings as needed. There are two special database entries
92 that are predefined - one is an entry for the config database itself,
93 and the other is for the "frontend" database. Settings in the
94 frontend database are inherited by the other databases, unless
95 they are explicitly overridden in a specific database.
97 The specific configuration options available are discussed below in the
98 Global Configuration Options, General Backend Options, and General Database
99 Options. Options are set by defining LDAP attributes with specific values.
100 In general the names of the LDAP attributes are the same as the corresponding
102 keyword, with an "olc" prefix added on.
104 The parser for many of these attributes is the same as used for parsing
105 the slapd.conf keywords. As such, slapd.conf keywords that allow multiple
106 items to be specified on one line, separated by whitespace, will allow
107 multiple items to be specified in one attribute value. However, when
108 reading the attribute via LDAP, the items will be returned as individual
111 Backend-specific options are discussed in the
112 .B slapd-<backend>(5)
113 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
114 details on configuring slapd.
115 .SH GLOBAL CONFIGURATION OPTIONS
116 Options described in this section apply to the server as a whole.
117 Arguments that should be replaced by
118 actual text are shown in brackets <>.
120 These options may only be specified in the
122 entry. This entry must have an objectClass of
126 .B olcAllows: <features>
127 Specify a set of features to allow (default none).
129 allows acceptance of LDAPv2 bind requests. Note that
131 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
133 allows anonymous bind when credentials are not empty (e.g.
136 allows unauthenticated (anonymous) bind when DN is not empty.
138 allows unauthenticated (anonymous) update operations to be processed
139 (subject to access controls and other administrative limits).
141 allows unauthenticated (anonymous) proxy authorization control to be processed
142 (subject to access controls, authorization and other administrative limits).
144 .B olcArgsFile: <filename>
145 The ( absolute ) name of a file that will hold the
147 server's command line options
148 if started without the debugging command line option.
150 .B olcAttributeOptions: <option-name>...
151 Define tagging attribute options or option tag/range prefixes.
152 Options must not end with `-', prefixes must end with `-'.
153 The `lang-' prefix is predefined.
155 .B olcAttributeOptions
156 directive, `lang-' will no longer be defined and you must specify it
157 explicitly if you want it defined.
159 An attribute description with a tagging option is a subtype of that
160 attribute description without the option.
161 Except for that, options defined this way have no special semantics.
162 Prefixes defined this way work like the `lang-' options:
163 They define a prefix for tagging options starting with the prefix.
164 That is, if you define the prefix `x-foo-', you can use the option
166 Furthermore, in a search or compare, a prefix or range name (with
167 a trailing `-') matches all options starting with that name, as well
168 as the option with the range name sans the trailing `-'.
169 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
171 RFC 4520 reserves options beginning with `x-' for private experiments.
172 Other options should be registered with IANA, see RFC 4520 section 3.5.
173 OpenLDAP also has the `binary' option built in, but this is a transfer
174 option, not a tagging option.
176 .B olcAuthzPolicy: <policy>
177 Used to specify which rules to use for Proxy Authorization. Proxy
178 authorization allows a client to authenticate to the server using one
179 user's credentials, but specify a different identity to use for authorization
180 and access control purposes. It essentially allows user A to login as user
181 B, using user A's password.
184 flag disables proxy authorization. This is the default setting.
187 flag will use rules in the
189 attribute of the authorization DN.
192 flag will use rules in the
194 attribute of the authentication DN.
197 flag, an alias for the deprecated value of
199 will allow any of the above, whatever succeeds first (checked in
205 flag requires both authorizations to succeed.
208 The rules are mechanisms to specify which identities are allowed
209 to perform proxy authorization.
212 attribute in an entry specifies which other users
213 are allowed to proxy login to this entry. The
216 an entry specifies which other users this user can authorize as. Use of
219 abused if users are allowed to write arbitrary values to this attribute.
222 attribute must be protected with ACLs such that
223 only privileged users can modify it.
230 or a set of identities; it can take five forms:
233 .B ldap:///<base>??[<scope>]?<filter>
236 .B dn[.<dnstyle>]:<pattern>
239 .B u[<mech>[<realm>]]:<pattern>
242 .B group[/objectClass[/attributeType]]:<pattern>
249 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
252 The first form is a valid LDAP
260 portions must be absent, so that the search occurs locally on either
266 with the optional style modifiers
272 for exact, onelevel, children and subtree matches, which cause
274 to be normalized according to the DN normalization rules, or the special
276 style, which causes the
278 to be treated as a POSIX (''extended'') regular expression, as
285 means any non-anonymous DN.
286 The third form is a SASL
288 with the optional fields
292 that allow to specify a SASL
294 and eventually a SASL
296 for those mechanisms that support one.
297 The need to allow the specification of a mechanism is still debated,
298 and users are strongly discouraged to rely on this possibility.
299 The fourth form is a group specification, consisting of the keyword
301 optionally followed by the specification of the group
307 is searched with base scope, and in case of match, the values of the
310 are searched for the asserted DN.
311 For backwards compatibility, if no identity type is provided, i.e. only
315 is assumed; as a consequence,
317 is subjected to DN normalization.
318 Since the interpretation of
322 can impact security, users are strongly encouraged
323 to explicitly set the type of identity specification that is being used.
324 A subset of these rules can be used as third arg in the
326 statement (see below); significantly, the
333 .B olcAuthzRegexp: <match> <replace>
334 Used by the authentication framework to convert simple user names,
335 such as provided by SASL subsystem, to an LDAP DN used for
336 authorization purposes. Note that the resultant DN need not refer
337 to an existing entry to be considered valid. When an authorization
338 request is received from the SASL subsystem, the SASL
343 are taken, when available, and combined into a name of the form
347 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
350 This name is then compared against the
352 POSIX (''extended'') regular expression, and if the match is successful,
353 the name is replaced with the
355 string. If there are wildcard strings in the
357 regular expression that are enclosed in parenthesis, e.g.
363 then the portion of the name that matched the wildcard will be stored
364 in the numbered placeholder variable $1. If there are other wildcard strings
365 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
366 placeholders can then be used in the
371 .B UID=$1,OU=Accounts,DC=example,DC=com
374 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
376 If the latter, the server will use the URI to search its own database(s)
377 and, if the search returns exactly one entry, the name is
378 replaced by the DN of that entry. The LDAP URI must have no
379 hostport, attrs, or extensions components, but the filter is mandatory,
383 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
386 The protocol portion of the URI must be strictly
388 Note that this search is subject to access controls. Specifically,
389 the authentication identity must have "auth" access in the subject.
393 values can be specified to allow for multiple matching
394 and replacement patterns. The matching patterns are checked in the order they
395 appear in the attribute, stopping at the first successful match.
398 .\"Because the plus sign + is a character recognized by the regular expression engine,
399 .\"and it will appear in names that include a REALM, be careful to escape the
400 .\"plus sign with a backslash \\+ to remove the character's special meaning.
403 .B olcConcurrency: <integer>
404 Specify a desired level of concurrency. Provided to the underlying
405 thread system as a hint. The default is not to provide any hint. This setting
406 is only meaningful on some platforms where there is not a one to one
407 correspondence between user threads and kernel threads.
409 .B olcConnMaxPending: <integer>
410 Specify the maximum number of pending requests for an anonymous session.
411 If requests are submitted faster than the server can process them, they
412 will be queued up to this limit. If the limit is exceeded, the session
413 is closed. The default is 100.
415 .B olcConnMaxPendingAuth: <integer>
416 Specify the maximum number of pending requests for an authenticated session.
419 .B olcDisallows: <features>
420 Specify a set of features to disallow (default none).
422 disables acceptance of anonymous bind requests. Note that this setting
423 does not prohibit anonymous directory access (See "require authc").
425 disables simple (bind) authentication.
427 disables forcing session to anonymous status (see also
429 upon StartTLS operation receipt.
431 disallows the StartTLS operation if authenticated (see also
434 .B olcGentleHUP: { TRUE | FALSE }
435 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
437 will stop listening for new connections, but will not close the
438 connections to the current clients. Future write operations return
439 unwilling-to-perform, though. Slapd terminates when all clients
440 have closed their connections (if they ever do), or \- as before \-
441 if it receives a SIGTERM signal. This can be useful if you wish to
442 terminate the server and start a new
445 .B with another database,
446 without disrupting the currently active clients.
447 The default is FALSE. You may wish to use
449 along with this option.
451 .B olcIdleTimeout: <integer>
452 Specify the number of seconds to wait before forcibly closing
453 an idle client connection. A setting of 0 disables this
454 feature. The default is 0.
456 .B olcIndexSubstrIfMaxlen: <integer>
457 Specify the maximum length for subinitial and subfinal indices. Only
458 this many characters of an attribute value will be processed by the
459 indexing functions; any excess characters are ignored. The default is 4.
461 .B olcIndexSubstrIfMinlen: <integer>
462 Specify the minimum length for subinitial and subfinal indices. An
463 attribute value must have at least this many characters in order to be
464 processed by the indexing functions. The default is 2.
466 .B olcIndexSubstrAnyLen: <integer>
467 Specify the length used for subany indices. An attribute value must have
468 at least this many characters in order to be processed. Attribute values
469 longer than this length will be processed in segments of this length. The
470 default is 4. The subany index will also be used in subinitial and
471 subfinal index lookups when the filter string is longer than the
472 .I olcIndexSubstrIfMaxlen
475 .B olcIndexSubstrAnyStep: <integer>
476 Specify the steps used in subany index lookups. This value sets the offset
477 for the segments of a filter string that are processed for a subany index
478 lookup. The default is 2. For example, with the default values, a search
479 using this filter "cn=*abcdefgh*" would generate index lookups for
480 "abcd", "cdef", and "efgh".
483 .B olcLocalSSF: <SSF>
484 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
485 such as those to the ldapi:// listener. For a description of SSF values,
487 .BR olcSaslSecProps 's
489 option description. The default is 71.
491 .B olcLogFile: <filename>
492 Specify a file for recording debug log messages. By default these messages
493 only go to stderr and are not recorded anywhere else. Specifying a logfile
494 copies messages to both stderr and the logfile.
496 .B olcLogLevel: <integer> [...]
497 Specify the level at which debugging statements and operation
498 statistics should be syslogged (currently logged to the
500 LOG_LOCAL4 facility).
501 They must be considered subsystems rather than increasingly verbose
503 Some messages with higher priority are logged regardless
504 of the configured loglevel as soon as any logging is configured.
505 Log levels are additive, and available levels are:
516 debug packet handling
520 heavy trace debugging (function args)
524 connection management
528 print out packets sent and received
532 search filter processing
536 configuration file processing
540 access control list processing
544 stats log connections/operations/results
548 stats log entries sent
552 print communication with shell backends
564 \"data indexing (unused)
572 only messages that get logged whatever log level is set
575 The desired log level can be input as a single integer that combines
576 the (ORed) desired levels, both in decimal or in hexadecimal notation,
577 as a list of integers (that are ORed internally),
578 or as a list of the names that are shown between brackets, such that
584 olcLogLevel: 0x80 0x1
585 olcLogLevel: acl trace
591 can be used as a shortcut to enable logging at all levels (equivalent to -1).
594 or the equivalent integer representation, causes those messages
595 that are logged regardless of the configured olcLogLevel to be logged.
596 In fact, if no olcLogLevel (or a 0 level) is defined, no logging occurs,
599 level is required to have high priority messages logged.
602 .B olcPasswordCryptSaltFormat: <format>
603 Specify the format of the salt passed to
605 when generating {CRYPT} passwords (see
606 .BR olcPasswordHash )
607 during processing of LDAP Password Modify Extended Operations (RFC 3062).
609 This string needs to be in
611 format and may include one (and only one) %s conversion.
612 This conversion will be substituted with a string of random
613 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
614 provides a two character salt and "$1$%.8s" tells some
615 versions of crypt(3) to use an MD5 algorithm and provides
616 8 random characters of salt. The default is "%s", which
617 provides 31 characters of salt.
619 .B olcPasswordHash: <hash> [<hash>...]
620 This option configures one or more hashes to be used in generation of user
621 passwords stored in the userPassword attribute during processing of
622 LDAP Password Modify Extended Operations (RFC 3062).
623 The <hash> must be one of
637 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
642 use the MD5 algorithm (RFC 1321), the latter with a seed.
649 indicates that the new password should be
650 added to userPassword as clear text.
652 Note that this option does not alter the normal user applications
653 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
655 .B olcPidFile: <filename>
656 The ( absolute ) name of a file that will hold the
658 server's process ID ( see
660 ) if started without the debugging command line option.
662 .B olcPluginLogFile: <filename>
663 The ( absolute ) name of a file that will contain log
670 .B olcReferral: <url>
671 Specify the referral to pass back when
673 cannot find a local database to handle a request.
674 If multiple values are specified, each url is provided.
676 .B olcReverseLookup: TRUE | FALSE
677 Enable/disable client name unverified reverse lookup (default is
679 if compiled with --enable-rlookups).
681 .B olcRootDSE: <file>
682 Specify the name of an LDIF(5) file containing user defined attributes
683 for the root DSE. These attributes are returned in addition to the
684 attributes normally produced by slapd.
686 The root DSE is an entry with information about the server and its
687 capabilities, in operational attributes.
688 It has the empty DN, and can be read with e.g.:
690 ldapsearch -x -b "" -s base "+"
692 See RFC 4512 section 5.1 for details.
694 .B olcSaslHost: <fqdn>
695 Used to specify the fully qualified domain name used for SASL processing.
697 .B olcSaslRealm: <realm>
698 Specify SASL realm. Default is empty.
700 .B olcSaslSecProps: <properties>
701 Used to specify Cyrus SASL security properties.
704 flag (without any other properties) causes the flag properties
705 default, "noanonymous,noplain", to be cleared.
708 flag disables mechanisms susceptible to simple passive attacks.
711 flag disables mechanisms susceptible to active attacks.
714 flag disables mechanisms susceptible to passive dictionary attacks.
717 flag disables mechanisms which support anonymous login.
720 flag require forward secrecy between sessions.
723 require mechanisms which pass client credentials (and allow
724 mechanisms which can pass credentials to do so).
727 property specifies the minimum acceptable
728 .I security strength factor
729 as an integer approximate to effective key length used for
730 encryption. 0 (zero) implies no protection, 1 implies integrity
731 protection only, 56 allows DES or other weak ciphers, 112
732 allows triple DES and other strong ciphers, 128 allows RC4,
733 Blowfish and other modern strong ciphers. The default is 0.
736 property specifies the maximum acceptable
737 .I security strength factor
738 as an integer (see minssf description). The default is INT_MAX.
741 property specifies the maximum security layer receive buffer
742 size allowed. 0 disables security layers. The default is 65536.
744 .B olcServerID: <integer> [<URL>]
745 Specify an integer ID from 0 to 4095 for this server. These IDs are
746 required when using multimaster replication and each master must have a
747 unique ID. If the URL is provided, this directive may be specified
748 multiple times, providing a complete list of participating servers
749 and their IDs. The fully qualified hostname of each server should be
750 used in the supplied URLs. The IDs are used in the "replica id" field
751 of all CSNs generated by the specified server. The default value is zero.
755 olcServerID: 1 ldap://ldap1.example.com
756 olcServerID: 2 ldap://ldap2.example.com
759 .B olcSockbufMaxIncoming: <integer>
760 Specify the maximum incoming LDAP PDU size for anonymous sessions.
761 The default is 262143.
763 .B olcSockbufMaxIncomingAuth: <integer>
764 Specify the maximum incoming LDAP PDU size for authenticated sessions.
765 The default is 4194303.
767 .B olcThreads: <integer>
768 Specify the maximum size of the primary thread pool.
769 The default is 16; the minimum value is 2.
771 .B olcToolThreads: <integer>
772 Specify the maximum number of threads to use in tool mode.
773 This should not be greater than the number of CPUs in the system.
775 .\"ucdata-path is obsolete / ignored...
777 .\".B ucdata-path <path>
778 .\"Specify the path to the directory containing the Unicode character
779 .\"tables. The default path is DATADIR/ucdata.
783 is built with support for Transport Layer Security, there are more options
786 .B olcTLSCipherSuite: <cipher-suite-spec>
787 Permits configuring what ciphers will be accepted and the preference order.
788 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
790 olcTLSCipherSuite: HIGH:MEDIUM:+SSLv2
792 To check what ciphers a given spec selects in OpenSSL, use:
795 openssl ciphers -v <cipher-suite-spec>
798 To obtain the list of ciphers in GNUtls use:
804 .B olcTLSCACertificateFile: <filename>
805 Specifies the file that contains certificates for all of the Certificate
810 .B olcTLSCACertificatePath: <path>
811 Specifies the path of a directory that contains Certificate Authority
812 certificates in separate individual files. Usually only one of this
813 or the olcTLSCACertificateFile is defined. If both are specified, both
814 locations will be used. This directive is not supported
817 .B olcTLSCertificateFile: <filename>
818 Specifies the file that contains the
822 .B olcTLSCertificateKeyFile: <filename>
823 Specifies the file that contains the
825 server private key that matches the certificate stored in the
826 .B olcTLSCertificateFile
827 file. If the private key is protected with a password, the password must
828 be manually typed in when slapd starts. Usually the private key is not
829 protected with a password, to allow slapd to start without manual
831 it is of critical importance that the file is protected carefully.
833 .B olcTLSDHParamFile: <filename>
834 This directive specifies the file that contains parameters for Diffie-Hellman
835 ephemeral key exchange. This is required in order to use a DSA certificate on
836 the server. If multiple sets of parameters are present in the file, all of
837 them will be processed. Note that setting this option may also enable
838 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
839 You should append "!ADH" to your cipher suites if you have changed them
840 from the default, otherwise no certificate exchanges or verification will
841 be done. When using GNUtls these parameters are always generated randomly
842 so this directive is ignored.
844 .B olcTLSRandFile: <filename>
845 Specifies the file to obtain random bits from when /dev/[u]random
846 is not available. Generally set to the name of the EGD/PRNGD socket.
847 The environment variable RANDFILE can also be used to specify the filename.
848 This directive is ignored with GNUtls.
850 .B olcTLSVerifyClient: <level>
851 Specifies what checks to perform on client certificates in an
852 incoming TLS session, if any.
855 can be specified as one of the following keywords:
861 will not ask the client for a certificate.
864 The client certificate is requested. If no certificate is provided,
865 the session proceeds normally. If a bad certificate is provided,
866 it will be ignored and the session proceeds normally.
869 The client certificate is requested. If no certificate is provided,
870 the session proceeds normally. If a bad certificate is provided,
871 the session is immediately terminated.
873 .B demand | hard | true
874 These keywords are all equivalent, for compatibility reasons.
875 The client certificate is requested. If no certificate is provided,
876 or a bad certificate is provided, the session is immediately terminated.
878 Note that a valid client certificate is required in order to use the
879 SASL EXTERNAL authentication mechanism with a TLS session. As such,
881 .B olcTLSVerifyClient
882 setting must be chosen to enable SASL EXTERNAL authentication.
885 .B olcTLSCRLCheck: <level>
886 Specifies if the Certificate Revocation List (CRL) of the CA should be
887 used to verify if the client certificates have not been revoked. This
889 .B olcTLSCACertificatePath
890 parameter to be set. This parameter is ignored with GNUtls.
892 can be specified as one of the following keywords:
896 No CRL checks are performed
899 Check the CRL of the peer certificate
902 Check the CRL for a whole certificate chain
905 .B olcTLSCRLFile: <filename>
906 Specifies a file containing a Certificate Revocation List to be used
907 for verifying that certificates have not been revoked. This parameter
908 is only valid when using GNUtls.
909 .SH DYNAMIC MODULE OPTIONS
912 is compiled with --enable-modules then the module-related entries will
913 be available. These entries are named
914 .B cn=module{x},cn=config
916 must have the olcModuleList objectClass. One entry should be created
919 Normally the config engine generates the "{x}" index in the RDN
920 automatically, so it can be omitted when initially loading these entries.
922 .B olcModuleLoad: <filename>
923 Specify the name of a dynamically loadable module to load. The filename
924 may be an absolute path name or a simple filename. Non-absolute names
925 are searched for in the directories specified by the
929 .B olcModulePath: <pathspec>
930 Specify a list of directories to search for loadable modules. Typically
931 the path is colon-separated but this depends on the operating system.
933 Schema definitions are created as entries in the
934 .B cn=schema,cn=config
935 subtree. These entries must have the olcSchemaConfig objectClass.
936 As noted above, the actual
937 .B cn=schema,cn=config
938 entry is predefined and any values specified for it are ignored.
942 .B olcAttributetypes: "(\ <oid>\
944 [DESC\ <description>]\
953 [NO\-USER\-MODIFICATION]\
954 [USAGE\ <attributeUsage>]\ )"
956 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
957 The slapd parser extends the RFC 4512 definition by allowing string
958 forms as well as numeric OIDs to be used for the attribute OID and
959 attribute syntax OID.
961 .B olcObjectIdentifier
967 .B olcDitContentRules: "(\ <oid>\
969 [DESC\ <description>]\
976 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
977 The slapd parser extends the RFC 4512 definition by allowing string
978 forms as well as numeric OIDs to be used for the attribute OID and
979 attribute syntax OID.
981 .B olcObjectIdentifier
987 .B olcObjectClasses: "(\ <oid>\
989 [DESC\ <description>]\
992 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
993 [MUST\ <oids>] [MAY\ <oids>] )"
995 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
996 The slapd parser extends the RFC 4512 definition by allowing string
997 forms as well as numeric OIDs to be used for the object class OID.
1001 description.) Object classes are "STRUCTURAL" by default.
1004 .B olcObjectIdentifier: <name> "{ <oid> | <name>[:<suffix>] }"
1005 Define a string name that equates to the given OID. The string can be used
1006 in place of the numeric OID in objectclass and attribute definitions. The
1007 name can also be used with a suffix of the form ":xx" in which case the
1008 value "oid.xx" will be used.
1010 .SH GENERAL BACKEND OPTIONS
1011 Options in these entries only apply to the configuration of a single
1012 type of backend. All backends may support this class of options.
1013 The entry must be named
1014 .B olcBackend=<databasetype>,cn=config
1015 and must have the olcBackendConfig objectClass.
1033 At present, no backend implements any options of this type.
1035 .SH DATABASE OPTIONS
1036 Database options are set in entries named
1037 .B olcDatabase={x}<databasetype>,cn=config
1038 and must have the olcDatabaseConfig objectClass. Normally the config
1039 engine generates the "{x}" index in the RDN automatically, so it
1040 can be omitted when initially loading these entries.
1042 The special frontend database is always numbered "{-1}" and the config
1043 database is always numbered "{0}".
1045 .SH GLOBAL DATABASE OPTIONS
1046 Options in this section may be set in the special "frontend" database
1047 and inherited in all the other databases. These options may be altered
1048 by further settings in each specific database. The frontend entry must
1050 .B olcDatabase=frontend,cn=config
1051 and must have the olcFrontendConfig objectClass.
1053 .B olcAccess: to <what> "[ by <who> <access> <control> ]+"
1054 Grant access (specified by <access>) to a set of entries and/or
1055 attributes (specified by <what>) by one or more requestors (specified
1057 If no access controls are present, the default policy
1058 allows anyone and everyone to read anything but restricts
1059 updates to rootdn. (e.g., "olcAccess: to * by * read").
1061 .BR slapd.access (5)
1062 and the "OpenLDAP Administrator's Guide" for details.
1064 Access controls set in the frontend are appended to any access
1065 controls set on the specific databases.
1066 The rootdn of a database can always read and write EVERYTHING
1069 Extra special care must be taken with the access controls on the
1070 config database. Unlike other databases, the default policy for the
1071 config database is to only allow access to the rootdn. Regular users
1072 should not have read access, and write access should be granted very
1073 carefully to privileged administrators.
1076 .B olcDefaultSearchBase: <dn>
1077 Specify a default search base to use when client submits a
1078 non-base search request with an empty base DN.
1079 Base scoped search requests with an empty base DN are not affected.
1080 This setting is only allowed in the frontend entry.
1082 .B olcReadOnly: TRUE | FALSE
1083 This option puts the database into "read-only" mode. Any attempts to
1084 modify the database will return an "unwilling to perform" error. By
1085 default, olcReadOnly is FALSE. Note that when this option is set
1086 TRUE on the frontend, it cannot be reset without restarting the
1087 server, since further writes to the config database will be rejected.
1089 .B olcRequires: <conditions>
1090 Specify a set of conditions to require (default none).
1091 The directive may be specified globally and/or per-database;
1092 databases inherit global conditions, so per-database specifications
1095 requires bind operation prior to directory operations.
1097 requires session to be using LDAP version 3.
1099 requires authentication prior to directory operations.
1101 requires SASL authentication prior to directory operations.
1103 requires strong authentication prior to directory operations.
1104 The strong keyword allows protected "simple" authentication
1105 as well as SASL authentication.
1107 may be used to require no conditions (useful to clear out globally
1108 set conditions within a particular database); it must occur first
1109 in the list of conditions.
1111 .B olcRestrict: <oplist>
1112 Specify a list of operations that are restricted.
1113 Restrictions on a specific database override any frontend setting.
1114 Operations can be any of
1119 .BR extended[=<OID>] ,
1123 or the special pseudo-operations
1127 which respectively summarize read and write operations.
1131 .I olcReadOnly: TRUE
1135 keyword allows to indicate the OID of the specific operation
1138 .B olcSchemaDN: <dn>
1139 Specify the distinguished name for the subschema subentry that
1140 controls the entries on this server. The default is "cn=Subschema".
1142 .B olcSecurity: <factors>
1143 Specify a set of security strength factors (separated by white space)
1145 .BR olcSaslSecprops 's
1147 option for a description of security strength factors).
1148 The directive may be specified globally and/or per-database.
1150 specifies the overall security strength factor.
1152 specifies the transport security strength factor.
1154 specifies the TLS security strength factor.
1156 specifies the SASL security strength factor.
1158 specifies the overall security strength factor to require for
1160 .B update_transport=<n>
1161 specifies the transport security strength factor to require for
1164 specifies the TLS security strength factor to require for
1167 specifies the SASL security strength factor to require for
1170 specifies the security strength factor required for
1172 username/password authentication.
1175 factor is measure of security provided by the underlying transport,
1176 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
1178 .B olcSizeLimit: {<integer>|unlimited}
1180 .B olcSizeLimit: size[.{soft|hard|unchecked}]=<integer> [...]
1181 Specify the maximum number of entries to return from a search operation.
1182 The default size limit is 500.
1185 to specify no limits.
1186 The second format allows a fine grain setting of the size limits.
1187 Extra args can be added in the same value or as additional values.
1190 for an explanation of the different flags.
1192 .B olcTimeLimit: {<integer>|unlimited}
1194 .B olcTimeLimit: time[.{soft|hard}]=<integer> [...]
1195 Specify the maximum number of seconds (in real time)
1197 will spend answering a search request. The default time limit is 3600.
1200 to specify no limits.
1201 The second format allows a fine grain setting of the time limits.
1202 Extra args can be added in the same value or as additional values.
1205 for an explanation of the different flags.
1207 .SH GENERAL DATABASE OPTIONS
1208 Options in this section only apply to the specific database for
1209 which they are defined. They are supported by every
1210 type of backend. All of the Global Database Options may also be
1213 .B olcHidden: TRUE | FALSE
1214 Controls whether the database will be used to answer
1215 queries. A database that is hidden will never be
1216 selected to answer any queries, and any suffix configured
1217 on the database will be ignored in checks for conflicts
1218 with other databases. By default, olcHidden is FALSE.
1220 .B olcLastMod: TRUE | FALSE
1223 will automatically maintain the
1224 modifiersName, modifyTimestamp, creatorsName, and
1225 createTimestamp attributes for entries. It also controls
1226 the entryCSN and entryUUID attributes, which are needed
1227 by the syncrepl provider. By default, olcLastMod is TRUE.
1229 .B olcLimits: <who> <limit> [<limit> [...]]
1230 Specify time and size limits based on who initiated an operation.
1237 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1243 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1248 matches all unauthenticated clients.
1251 matches all authenticated clients;
1254 dn pattern is assumed unless otherwise specified by qualifying
1255 the (optional) key string
1261 (which are synonyms), to require an exact match; with
1263 to require exactly one level of depth match; with
1265 to allow any level of depth match, including the exact match; with
1267 to allow any level of depth match, not including the exact match;
1269 explicitly requires the (default) match based on POSIX (''extended'')
1270 regular expression pattern.
1273 matches unbound operations; the
1276 The same behavior is obtained by using the
1283 with the optional objectClass
1289 sets the limits for any DN listed in the values of the
1295 group objectClass (default
1297 whose DN exactly matches
1300 The currently supported limits are
1305 The syntax for time limits is
1306 .BR time[.{soft|hard}]=<integer> ,
1309 is the number of seconds slapd will spend answering a search request.
1310 If no time limit is explicitly requested by the client, the
1312 limit is used; if the requested time limit exceeds the
1315 .\".I "Administrative limit exceeded"
1316 .\"error is returned.
1317 limit, the value of the limit is used instead.
1320 limit is set to the keyword
1322 the soft limit is used in either case; if it is set to the keyword
1324 no hard limit is enforced.
1325 Explicit requests for time limits smaller or equal to the
1328 If no limit specifier is set, the value is assigned to the
1334 to preserve the original behavior.
1336 The syntax for size limits is
1337 .BR size[.{soft|hard|unchecked}]=<integer> ,
1340 is the maximum number of entries slapd will return answering a search
1342 If no size limit is explicitly requested by the client, the
1344 limit is used; if the requested size limit exceeds the
1347 .\".I "Administrative limit exceeded"
1348 .\"error is returned.
1349 limit, the value of the limit is used instead.
1352 limit is set to the keyword
1354 the soft limit is used in either case; if it is set to the keyword
1356 no hard limit is enforced.
1357 Explicit requests for size limits smaller or equal to the
1362 specifier sets a limit on the number of candidates a search request is allowed
1364 The rationale behind it is that searches for non-properly indexed
1365 attributes may result in large sets of candidates, which must be
1368 to determine whether they match the search filter or not.
1371 limit provides a means to drop such operations before they are even
1373 If the selected candidates exceed the
1375 limit, the search will abort with
1376 .IR "Unwilling to perform" .
1377 If it is set to the keyword
1379 no limit is applied (the default).
1382 the search is not even performed; this can be used to disallow searches
1383 for a specific set of users.
1384 If no limit specifier is set, the value is assigned to the
1390 to preserve the original behavior.
1392 In case of no match, the global limits are used.
1393 The default values are the same as
1402 control is requested, the
1404 size limit is used by default, because the request of a specific page size
1405 is considered an explicit request for a limitation on the number
1406 of entries to be returned.
1407 However, the size limit applies to the total count of entries returned within
1408 the search, and not to a single page.
1409 Additional size limits may be enforced; the syntax is
1410 .BR size.pr={<integer>|noEstimate|unlimited} ,
1413 is the max page size if no explicit limit is set; the keyword
1415 inhibits the server from returning an estimate of the total number
1416 of entries that might be returned
1417 (note: the current implementation does not return any estimate).
1420 indicates that no limit is applied to the pagedResults control page size.
1422 .B size.prtotal={<integer>|unlimited|disabled}
1423 allows to set a limit on the total number of entries that a pagedResults
1424 control allows to return.
1425 By default it is set to the
1430 is the max number of entries that the whole search with pagedResults control
1434 to allow unlimited number of entries to be returned, e.g. to allow
1435 the use of the pagedResults control as a means to circumvent size
1436 limitations on regular searches; the keyword
1438 disables the control, i.e. no paged results can be returned.
1439 Note that the total number of entries returned when the pagedResults control
1440 is requested cannot exceed the
1442 size limit of regular searches unless extended by the
1447 .B olcMaxDerefDepth: <depth>
1448 Specifies the maximum number of aliases to dereference when trying to
1449 resolve an entry, used to avoid infinite alias loops. The default is 1.
1451 .B olcMirrorMode: TRUE | FALSE
1452 This option puts a replica database into "mirror" mode. Update
1453 operations will be accepted from any user, not just the updatedn. The
1454 database must already be configured as syncrepl consumer
1455 before this keyword may be set. This mode also requires a
1457 (see above) to be configured.
1458 By default, this setting is FALSE.
1460 .B olcPlugin: <plugin_type> <lib_path> <init_function> [<arguments>]
1461 Configure a SLAPI plugin. See the
1462 .BR slapd.plugin (5)
1463 manpage for more details.
1466 Specify the distinguished name that is not subject to access control
1467 or administrative limit restrictions for operations on this database.
1468 This DN may or may not be associated with an entry. An empty root
1469 DN (the default) specifies no root access is to be granted. It is
1470 recommended that the rootdn only be specified when needed (such as
1471 when initially populating a database). If the rootdn is within
1472 a namingContext (suffix) of the database, a simple bind password
1473 may also be provided using the
1475 directive. Note that the rootdn is always needed when using syncrepl.
1477 .B olcRootPW: <password>
1478 Specify a password (or hash of the password) for the rootdn. The
1479 password can only be set if the rootdn is within the namingContext
1480 (suffix) of the database.
1481 This option accepts all RFC 2307 userPassword formats known to
1484 description) as well as cleartext.
1486 may be used to generate a hash of a password. Cleartext
1487 and \fB{CRYPT}\fP passwords are not recommended. If empty
1488 (the default), authentication of the root DN is by other means
1489 (e.g. SASL). Use of SASL is encouraged.
1491 .B olcSubordinate: [TRUE | FALSE | advertise]
1492 Specify that the current backend database is a subordinate of another
1493 backend database. A subordinate database may have only one suffix. This
1494 option may be used to glue multiple databases into a single namingContext.
1495 If the suffix of the current database is within the namingContext of a
1496 superior database, searches against the superior database will be
1497 propagated to the subordinate as well. All of the databases
1498 associated with a single namingContext should have identical rootdns.
1499 Behavior of other LDAP operations is unaffected by this setting. In
1500 particular, it is not possible to use moddn to move an entry from
1501 one subordinate to another subordinate within the namingContext.
1503 If the optional \fBadvertise\fP flag is supplied, the naming context of
1504 this database is advertised in the root DSE. The default is to hide this
1505 database context, so that only the superior context is visible.
1512 are used on the superior database, any glued subordinates that support
1513 these tools are opened as well.
1515 Databases that are glued together should usually be configured with the
1516 same indices (assuming they support indexing), even for attributes that
1517 only exist in some of these databases. In general, all of the glued
1518 databases should be configured as similarly as possible, since the intent
1519 is to provide the appearance of a single directory.
1521 Note that the subordinate functionality is implemented internally
1522 by the \fIglue\fP overlay and as such its behavior will interact with other
1523 overlays in use. By default, the glue overlay is automatically configured as
1524 the last overlay on the superior database. Its position on the database
1525 can be explicitly configured by setting an \fBoverlay glue\fP directive
1526 at the desired position. This explicit configuration is necessary e.g.
1527 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1528 in order to work over all of the glued databases. E.g.
1531 dn: olcDatabase={1}bdb,cn=config
1532 olcSuffix: dc=example,dc=com
1535 dn: olcOverlay={0}glue,olcDatabase={1}bdb,cn=config
1538 dn: olcOverlay={1}syncprov,olcDatabase={1}bdb,cn=config
1542 See the Overlays section below for more details.
1544 .B olcSuffix: <dn suffix>
1545 Specify the DN suffix of queries that will be passed to this
1546 backend database. Multiple suffix lines can be given and at least one is
1547 required for each database definition.
1548 If the suffix of one database is "inside" that of another, the database
1549 with the inner suffix must come first in the configuration file.
1552 .B olcSyncrepl: rid=<replica ID>
1553 .B provider=ldap[s]://<hostname>[:port]
1554 .B searchbase=<base DN>
1555 .B [type=refreshOnly|refreshAndPersist]
1556 .B [interval=dd:hh:mm:ss]
1557 .B [retry=[<retry interval> <# of retries>]+]
1558 .B [filter=<filter str>]
1559 .B [scope=sub|one|base|subord]
1560 .B [attrs=<attr list>]
1561 .B [exattrs=<attr list>]
1563 .B [sizelimit=<limit>]
1564 .B [timelimit=<limit>]
1565 .B [schemachecking=on|off]
1566 .B [bindmethod=simple|sasl]
1568 .B [saslmech=<mech>]
1569 .B [authcid=<identity>]
1570 .B [authzid=<identity>]
1571 .B [credentials=<passwd>]
1573 .B [secprops=<properties>]
1574 .B [starttls=yes|critical]
1575 .B [tls_cert=<file>]
1577 .B [tls_cacert=<file>]
1578 .B [tls_cacertdir=<path>]
1579 .B [tls_reqcert=never|allow|try|demand]
1580 .B [tls_ciphersuite=<ciphers>]
1581 .B [tls_crlcheck=none|peer|all]
1582 .B [logbase=<base DN>]
1583 .B [logfilter=<filter str>]
1584 .B [syncdata=default|accesslog|changelog]
1586 Specify the current database as a replica which is kept up-to-date with the
1587 master content by establishing the current
1589 as a replication consumer site running a
1592 The replica content is kept synchronized to the master content using
1593 the LDAP Content Synchronization protocol. Refer to the
1594 "OpenLDAP Administrator's Guide" for detailed information on
1595 setting up a replicated
1597 directory service using the
1602 identifies the current
1604 directive within the replication consumer site.
1605 It is a non-negative integer having no more than three digits.
1608 specifies the replication provider site containing the master content
1609 as an LDAP URI. If <port> is not given, the standard LDAP port number
1610 (389 or 636) is used.
1614 replica is defined using a search
1615 specification as its result set. The consumer
1617 will send search requests to the provider
1619 according to the search specification. The search specification includes
1620 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1623 parameters as in the normal search specification. The
1625 option may also be used to specify attributes that should be omitted
1626 from incoming entries.
1627 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1628 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1629 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1630 attributes, and \fBattrsonly\fP and \fBexattrs\fP are unset by default.
1631 The \fBsizelimit\fP and \fBtimelimit\fP only
1632 accept "unlimited" and positive integers, and both default to "unlimited".
1633 Note, however, that any provider-side limits for the replication identity
1634 will be enforced by the provider regardless of the limits requested
1635 by the LDAP Content Synchronization operation, much like for any other
1638 The LDAP Content Synchronization protocol has two operation types.
1641 operation, the next synchronization search operation
1642 is periodically rescheduled at an interval time (specified by
1644 parameter; 1 day by default)
1645 after each synchronization operation finishes.
1647 .B refreshAndPersist
1648 operation, a synchronization search remains persistent in the provider slapd.
1649 Further updates to the master replica will generate
1650 .B searchResultEntry
1651 to the consumer slapd as the search responses to the persistent
1652 synchronization search.
1654 If an error occurs during replication, the consumer will attempt to
1655 reconnect according to the
1657 parameter which is a list of the <retry interval> and <# of retries> pairs.
1658 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1659 for the first 10 times and then retry every 300 seconds for the next 3
1660 times before stop retrying. The `+' in <# of retries> means indefinite
1661 number of retries until success.
1663 The schema checking can be enforced at the LDAP Sync
1664 consumer site by turning on the
1666 parameter. The default is off.
1672 requires the options
1676 and should only be used when adequate security services
1677 (e.g. TLS or IPSEC) are in place.
1684 Depending on the mechanism, an authentication identity and/or
1685 credentials can be specified using
1691 parameter may be used to specify an authorization identity.
1692 Specific security properties (as with the
1694 keyword above) for a SASL bind can be set with the
1696 option. A non default SASL realm can be set with the
1699 The provider, other than allow authentication of the syncrepl identity,
1700 should grant that identity appropriate access privileges to the data
1701 that is being replicated (\fBaccess\fP directive), and appropriate time
1702 and size limits (\fBlimits\fP directive).
1707 parameter specifies use of the StartTLS extended operation
1708 to establish a TLS session before Binding to the provider. If the
1710 argument is supplied, the session will be aborted if the StartTLS request
1711 fails. Otherwise the syncrepl session continues without TLS. The
1712 tls_reqcert setting defaults to "demand" and the other TLS settings
1713 default to the same as the main slapd TLS settings.
1715 Rather than replicating whole entries, the consumer can query logs of
1716 data modifications. This mode of operation is referred to as \fIdelta
1717 syncrepl\fP. In addition to the above parameters, the
1721 parameters must be set appropriately for the log that will be used. The
1723 parameter must be set to either "accesslog" if the log conforms to the
1724 .BR slapo-accesslog (5)
1725 log format, or "changelog" if the log conforms
1726 to the obsolete \fIchangelog\fP format. If the
1728 parameter is omitted or set to "default" then the log parameters are
1732 .B olcUpdateDN: <dn>
1733 This option is only applicable in a slave
1735 It specifies the DN permitted to update (subject to access controls)
1736 the replica. It is only needed in certain push-mode
1737 replication scenarios. Generally, this DN
1743 .B olcUpdateRef: <url>
1744 Specify the referral to pass back when
1746 is asked to modify a replicated local database.
1747 If multiple values are specified, each url is provided.
1749 .SH DATABASE-SPECIFIC OPTIONS
1750 Each database may allow specific configuration options; they are
1751 documented separately in the backends' manual pages. See the
1752 .BR slapd.backends (5)
1753 manual page for an overview of available backends.
1755 An overlay is a piece of
1756 code that intercepts database operations in order to extend or change
1757 them. Overlays are pushed onto
1758 a stack over the database, and so they will execute in the reverse
1759 of the order in which they were configured and the database itself
1760 will receive control last of all.
1762 Overlays must be configured as child entries of a specific database. The
1763 entry's RDN must be of the form
1764 .B olcOverlay={x}<overlaytype>
1765 and the entry must have the olcOverlayConfig objectClass. Normally the
1766 config engine generates the "{x}" index in the RDN automatically, so
1767 it can be omitted when initially loading these entries.
1770 .BR slapd.overlays (5)
1771 manual page for an overview of available overlays.
1774 Here is a short example of a configuration in LDIF suitable for use with
1781 objectClass: olcGlobal
1783 olcPidFile: LOCALSTATEDIR/run/slapd.pid
1784 olcAttributeOptions: x-hidden lang-
1786 dn: cn=schema,cn=config
1787 objectClass: olcSchemaConfig
1790 include: SYSCONFDIR/schema/core.ldif
1792 dn: olcDatabase=frontend,cn=config
1793 objectClass: olcDatabaseConfig
1794 objectClass: olcFrontendConfig
1795 olcDatabase: frontend
1796 # Subtypes of "name" (e.g. "cn" and "ou") with the
1797 # option ";x-hidden" can be searched for/compared,
1798 # but are not shown. See \fBslapd.access\fP(5).
1799 olcAccess: to attrs=name;x-hidden by * =cs
1800 # Protect passwords. See \fBslapd.access\fP(5).
1801 olcAccess: to attrs=userPassword by * auth
1802 # Read access to other attributes and entries.
1803 olcAccess: to * by * read
1805 # set a rootpw for the config database so we can bind.
1806 # deny access to everyone else.
1807 dn: olcDatabase=config,cn=config
1808 objectClass: olcDatabaseConfig
1810 olcRootPW: {SSHA}XKYnrjvGT3wZFQrDD5040US592LxsdLy
1811 olcAccess: to * by * none
1813 dn: olcDatabase=bdb,cn=config
1814 objectClass: olcDatabaseConfig
1815 objectClass: olcBdbConfig
1817 olcSuffix: "dc=our-domain,dc=com"
1818 # The database directory MUST exist prior to
1819 # running slapd AND should only be accessible
1820 # by the slapd/tools. Mode 0700 recommended.
1821 olcDbDirectory: LOCALSTATEDIR/openldap-data
1822 # Indices to maintain
1823 olcDbIndex: objectClass eq
1824 olcDbIndex: cn,sn,mail pres,eq,approx,sub
1826 # We serve small clients that do not handle referrals,
1827 # so handle remote lookups on their behalf.
1828 dn: olcDatabase=ldap,cn=config
1829 objectClass: olcDatabaseConfig
1830 objectClass: olcLdapConfig
1833 olcDbUri: ldap://ldap.some-server.com/
1837 Assuming the above data was saved in a file named "config.ldif" and the
1838 ETCDIR/slapd.d directory has been created, this command will initialize
1842 slapadd -F ETCDIR/slapd.d -n 0 -l config.ldif
1847 "OpenLDAP Administrator's Guide" contains a longer annotated
1848 example of a slapd configuration.
1850 Alternatively, an existing slapd.conf file can be converted to the new
1851 format using slapd or any of the slap tools:
1854 slaptest -f ETCDIR/slapd.conf -F ETCDIR/slapd.d
1861 default slapd configuration file
1864 default slapd configuration directory
1868 .BR slapd.access (5),
1869 .BR slapd.backends (5),
1871 .BR slapd.overlays (5),
1872 .BR slapd.plugin (5),
1873 .BR slapd.replog (5),
1884 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1885 .SH ACKNOWLEDGEMENTS
projects / openldap / blob