1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2004 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
12 contains configuration information for the
14 daemon. This configuration file is also used by the
16 replication daemon and by the SLAPD tools
24 file consists of a series of global configuration options that apply to
26 as a whole (including all backends), followed by zero or more database
27 backend definitions that contain information specific to a backend
35 # comment - these options apply to every database
36 <global configuration options>
37 # first database definition & configuration options
38 database <backend 1 type>
39 <configuration options specific to backend 1>
40 # subsequent database definitions & configuration options
44 As many backend-specific sections as desired may be included. Global
45 options can be overridden in a backend (for options that appear more
46 than once, the last appearance in the
50 If a line begins with white space, it is considered a continuation
51 of the previous line. Blank lines and comment lines beginning with
52 a `#' character are ignored. (Note: continuation lines are unwrapped
53 before comment processing is applied.)
55 Arguments on configuration lines are separated by white space. If an
56 argument contains white space, the argument should be enclosed in
57 double quotes. If an argument contains a double quote (`"') or a
58 backslash character (`\\'), the character should be preceded by a
61 The specific configuration options available are discussed below in the
62 Global Configuration Options, General Backend Options, and General Database
63 Options. Backend-specific options are discussed in the
65 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
66 details on the slapd configuration file.
67 .SH GLOBAL CONFIGURATION OPTIONS
68 Options described in this section apply to all backends, unless specifically
69 overridden in a backend definition. Arguments that should be replaced by
70 actual text are shown in brackets <>.
72 .B access to <what> "[ by <who> <access> <control> ]+"
73 Grant access (specified by <access>) to a set of entries and/or
74 attributes (specified by <what>) by one or more requestors (specified
78 and the "OpenLDAP's Administrator's Guide" for details.
81 Specify a set of features (separated by white space) to
84 allows acceptance of LDAPv2 bind requests. Note that
86 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
88 allows anonymous bind when credentials are not empty (e.g.
91 allows unauthenticated (anonymous) bind when DN is not empty.
93 allow unauthenticated (anonymous) update operations to be processed
94 (subject to access controls and other administrative limits).
96 .B argsfile <filename>
97 The ( absolute ) name of a file that will hold the
99 server's command line options
100 if started without the debugging command line option.
102 .B attributeoptions [option-name]...
103 Define tagging attribute options or option tag/range prefixes.
104 Options must not end with `-', prefixes must end with `-'.
105 The `lang-' prefix is predefined.
108 directive, `lang-' will no longer be defined and you must specify it
109 explicitly if you want it defined.
111 An attribute description with a tagging option is a subtype of that
112 attribute description without the option.
113 Except for that, options defined this way have no special semantics.
114 Prefixes defined this way work like the `lang-' options:
115 They define a prefix for tagging options starting with the prefix.
116 That is, if you define the prefix `x-foo-', you can use the option
118 Furthermore, in a search or compare, a prefix or range name (with
119 a trailing `-') matches all options starting with that name, as well
120 as the option with the range name sans the trailing `-'.
121 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
123 RFC 2251 reserves options beginning with `x-' for private experiments.
124 Other options should be registered with IANA, see RFC 3383 section 3.4.
125 OpenLDAP also has the `binary' option built in, but this is a transfer
126 option, not a tagging option.
129 .B attributetype "(\ <oid>\
131 [DESC\ <description>]\
140 [NO\-USER\-MODIFICATION]\
141 [USAGE\ <attributeUsage>]\ )"
143 Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
144 The slapd parser extends the RFC 2252 definition by allowing string
145 forms as well as numeric OIDs to be used for the attribute OID and
146 attribute syntax OID.
152 .B authz-policy <policy>
153 Used to specify which rules to use for Proxy Authorization. Proxy
154 authorization allows a client to authenticate to the server using one
155 user's credentials, but specify a different identity to use for authorization
156 and access control purposes. It essentially allows user A to login as user
157 B, using user A's password.
160 flag disables proxy authorization. This is the default setting.
163 flag will use rules in the
165 attribute of the authorization DN.
168 flag will use rules in the
170 attribute of the authentication DN.
173 flag, an alias for the deprecated value of
175 will allow any of the above, whatever succeeds first (checked in
181 flag requires both authorizations to succeed.
182 The rules are simply regular expressions specifying which DNs are allowed
183 to perform proxy authorization.
186 attribute in an entry specifies which other users
187 are allowed to proxy login to this entry. The
190 an entry specifies which other users this user can authorize as. Use of
193 abused if users are allowed to write arbitrary values to this attribute.
196 attribute must be protected with ACLs such that
197 only privileged users can modify it.
204 or a set of identities; it can take three forms:
208 .B ldap:///<base>??[<scope>]?<filter>
211 .B dn[.<dnstyle>]:<pattern>
214 .B u[<mech>[<realm>]]:<pattern>
217 .B group[/objectClass[/attributeType]]:<pattern>
224 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
227 The first form is a valid LDAP
235 portions must be absent, so that the search occurs locally on either
241 with the optional style modifiers
247 for exact, onelevel, children and subtree matches, which cause
249 to be normalized according to the DN normalization rules, or the special
253 to be compiled according to
255 The third form is a SASL
257 with the optional fields
261 that allow to specify a SASL
263 and eventually a SASL
265 for those mechanisms that support one.
266 The need to allow the specification of a mechanism is still debated,
267 and users are strongly discouraged to rely on this possibility.
268 The fourth form is a group specification, consisting of the keyword
270 optionally followed by the specification of the group
276 is searched with base scope, and in case of match, the values of the
279 are searched for the asserted DN.
280 For backwards compatibility, if no identity type is provided, i.e. only
284 is assumed; as a consequence,
286 is subjected to DN normalization.
287 Since the interpretation of
291 can impact security, users are strongly encouraged
292 to explicitly set the type of identity specification that is being used.
295 .B authz-regexp <match> <replace>
296 Used by the authentication framework to convert simple user names,
297 such as provided by SASL subsystem, to an LDAP DN used for
298 authorization purposes. Note that the resultant DN need not refer
299 to an existing entry to be considered valid. When an authorization
300 request is received from the SASL subsystem, the SASL
305 are taken, when available, and combined into a name of the form
309 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
312 This name is then compared against the
314 regular expression, and if the match is successful, the name is
317 string. If there are wildcard strings in the
319 regular expression that are enclosed in parenthesis, e.g.
325 then the portion of the name that matched the wildcard will be stored
326 in the numbered placeholder variable $1. If there are other wildcard strings
327 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
328 placeholders can then be used in the
333 .B UID=$1,OU=Accounts,DC=example,DC=com
336 The replaced name can be either a DN or an LDAP URI. If the
337 latter, the server will use the URI to search its own database(s)
338 and, if the search returns exactly one entry, the name is
339 replaced by the DN of that entry. The LDAP URI must have no
340 hostport, attrs, or extensions components, e.g.
343 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
348 options can be given in the configuration file to allow for multiple matching
349 and replacement patterns. The matching patterns are checked in the order they
350 appear in the file, stopping at the first successful match.
353 .\"Because the plus sign + is a character recognized by the regular expression engine,
354 .\"and it will appear in names that include a REALM, be careful to escape the
355 .\"plus sign with a backslash \\+ to remove the character's special meaning.
358 .B concurrency <integer>
359 Specify a desired level of concurrency. Provided to the underlying
360 thread system as a hint. The default is not to provide any hint.
362 .B conn_max_pending <integer>
363 Specify the maximum number of pending requests for an anonymous session.
364 If requests are submitted faster than the server can process them, they
365 will be queued up to this limit. If the limit is exceeded, the session
366 is closed. The default is 100.
368 .B conn_max_pending_auth <integer>
369 Specify the maximum number of pending requests for an authenticated session.
371 .\"-- NEW_LOGGING option --
373 .\".B debug <subsys> <level>
374 .\"Specify a logging level for a particular subsystem. The subsystems include
376 .\"a global level for all subsystems,
380 .\"the backend databases,
382 .\"the entry cache manager,
384 .\"the config file reader,
386 .\"the connection manager,
388 .\"the Cyrus SASL library interface,
390 .\"the search filter processor,
392 .\"the DN normalization library,
394 .\"the database indexer,
396 .\"the ASN.1 BER library,
398 .\"the dynamic module loader,
400 .\"the LDAP operation processors,
402 .\"the SASL authentication subsystem,
404 .\"the schema processor, and
406 .\"the TLS library interface. This is not an exhaustive list; there are many
407 .\"other subsystems and more are added over time.
409 .\"The levels are, in order of decreasing priority:
410 .\".B emergency, alert, critical, error, warning, notice, information, entry,
411 .\".B args, results, detail1, detail2
412 .\"An integer may be used instead, with 0 corresponding to
418 .\"level logs function entry points,
420 .\"adds function call parameters, and
422 .\"adds the function results to the logs.
427 .\"levels add even more low level detail from individual functions.
429 .B defaultsearchbase <dn>
430 Specify a default search base to use when client submits a
431 non-base search request with an empty base DN.
433 .B disallow <features>
434 Specify a set of features (separated by white space) to
435 disallow (default none).
437 disables acceptance of anonymous bind requests.
439 disables simple (bind) authentication.
441 disables Kerberos V4 (bind) authentication.
443 disables Start TLS from forcing session to anonymous status (see also
446 disables StartTLS if authenticated (see also
450 .B ditcontentrule "(\ <oid>\
452 [DESC\ <description>]\
459 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
460 The slapd parser extends the RFC 2252 definition by allowing string
461 forms as well as numeric OIDs to be used for the attribute OID and
462 attribute syntax OID.
468 .B gentlehup { on | off }
469 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
471 will stop listening for new connections, but will not close the
472 connections to the current clients. Future write operations return
473 unwilling-to-perform, though. Slapd terminates when all clients
474 have closed their connections (if they ever do), or \- as before \-
475 if it receives a SIGTERM signal. This can be useful if you wish to
476 terminate the server and start a new
479 .B with another database,
480 without disrupting the currently active clients.
481 The default is off. You may wish to use
483 along with this option.
485 .B idletimeout <integer>
486 Specify the number of seconds to wait before forcibly closing
487 an idle client connection. A idletimeout of 0 disables this
488 feature. The default is 0.
490 .B include <filename>
491 Read additional configuration information from the given file before
492 continuing with the next line of the current file.
493 .\"-- NEW_LOGGING option --
495 .\".B logfile <filename>
496 .\"Specify a file for recording debug log messages. By default these messages
497 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
498 .\"copies messages to both stderr and the logfile.
500 .B loglevel <integer>
501 Specify the level at which debugging statements and operation
502 statistics should be syslogged (currently logged to the
504 LOG_LOCAL4 facility). Log levels are additive, and available levels
514 debug packet handling
517 heavy trace debugging
520 connection management
523 print out packets sent and received
526 search filter processing
529 configuration file processing
532 access control list processing
535 stats log connections/operations/results
538 stats log entries sent
541 print communication with shell backends
549 .B moduleload <filename>
550 Specify the name of a dynamically loadable module to load. The filename
551 may be an absolute path name or a simple filename. Non-absolute names
552 are searched for in the directories specified by the
554 option. This option and the
556 option are only usable if slapd was compiled with --enable-modules.
558 .B modulepath <pathspec>
559 Specify a list of directories to search for loadable modules. Typically
560 the path is colon-separated but this depends on the operating system.
563 .B objectclass "(\ <oid>\
565 [DESC\ <description]\
568 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
569 [MUST\ <oids>] [MAY\ <oids>] )"
571 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
572 The slapd parser extends the RFC 2252 definition by allowing string
573 forms as well as numeric OIDs to be used for the object class OID.
577 description.) Object classes are "STRUCTURAL" by default.
580 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
581 Define a string name that equates to the given OID. The string can be used
582 in place of the numeric OID in objectclass and attribute definitions. The
583 name can also be used with a suffix of the form ":xx" in which case the
584 value "oid.xx" will be used.
586 .B password-hash <hash> [<hash>...]
587 This option configures one or more hashes to be used in generation of user
588 passwords stored in the userPassword attribute during processing of
589 LDAP Password Modify Extended Operations (RFC 3062).
590 The <hash> must be one of
604 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
609 use the MD5 algorithm (RFC 1321), the latter with a seed.
616 indicates that the new password should be
617 added to userPassword as clear text.
619 Note that this option does not alter the normal user applications
620 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
622 .B password\-crypt\-salt\-format <format>
623 Specify the format of the salt passed to
625 when generating {CRYPT} passwords (see
627 during processing of LDAP Password Modify Extended Operations (RFC 3062).
629 This string needs to be in
631 format and may include one (and only one) %s conversion.
632 This conversion will be substituted with a string random
633 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
634 provides a two character salt and "$1$%.8s" tells some
635 versions of crypt(3) to use an MD5 algorithm and provides
636 8 random characters of salt. The default is "%s", which
637 provides 31 characters of salt.
639 .B pidfile <filename>
640 The ( absolute ) name of a file that will hold the
642 server's process ID ( see
644 ) if started without the debugging command line option.
647 Specify the referral to pass back when
649 cannot find a local database to handle a request.
650 If specified multiple times, each url is provided.
653 The ( absolute ) name of a file that will hold the
655 server's command line options
656 if started without the debugging command line option.
659 The ( absolute ) name of a file that will hold the
661 server's process ID ( see
663 ) if started without the debugging command line option.
665 .B replicationinterval
666 The number of seconds
668 waits before checking the replogfile for changes.
670 .B require <conditions>
671 Specify a set of conditions (separated by white space) to
672 require (default none).
673 The directive may be specified globally and/or per-database.
675 requires bind operation prior to directory operations.
677 requires session to be using LDAP version 3.
679 requires authentication prior to directory operations.
681 requires SASL authentication prior to directory operations.
683 requires strong authentication prior to directory operations.
684 The strong keyword allows protected "simple" authentication
685 as well as SASL authentication.
687 may be used to require no conditions (useful for clearly globally
688 set conditions within a particular database).
690 .B reverse-lookup on | off
691 Enable/disable client name unverified reverse lookup (default is
693 if compiled with --enable-rlookups).
696 Specify the name of an LDIF(5) file containing user defined attributes
697 for the root DSE. These attributes are returned in addition to the
698 attributes normally produced by slapd.
701 Used to specify the fully qualified domain name used for SASL processing.
703 .B sasl-realm <realm>
704 Specify SASL realm. Default is empty.
706 .B sasl-secprops <properties>
707 Used to specify Cyrus SASL security properties.
710 flag (without any other properties) causes the flag properties
711 default, "noanonymous,noplain", to be cleared.
714 flag disables mechanisms susceptible to simple passive attacks.
717 flag disables mechanisms susceptible to active attacks.
720 flag disables mechanisms susceptible to passive dictionary attacks.
723 flag disables mechanisms which support anonymous login.
726 flag require forward secrecy between sessions.
729 require mechanisms which pass client credentials (and allow
730 mechanisms which can pass credentials to do so).
733 property specifies the minimum acceptable
734 .I security strength factor
735 as an integer approximate to effective key length used for
736 encryption. 0 (zero) implies no protection, 1 implies integrity
737 protection only, 56 allows DES or other weak ciphers, 112
738 allows triple DES and other strong ciphers, 128 allows RC4,
739 Blowfish and other modern strong ciphers. The default is 0.
742 property specifies the maximum acceptable
743 .I security strength factor
744 as an integer (see minssf description). The default is INT_MAX.
747 property specifies the maximum security layer receive buffer
748 size allowed. 0 disables security layers. The default is 65536.
751 Specify the distinguished name for the subschema subentry that
752 controls the entries on this server. The default is "cn=Subschema".
754 .B security <factors>
755 Specify a set of factors (separated by white space) to require.
756 An integer value is associated with each factor and is roughly
757 equivalent of the encryption key length to require. A value
758 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
759 The directive may be specified globally and/or per-database.
761 specifies the overall security strength factor.
763 specifies the transport security strength factor.
765 specifies the TLS security strength factor.
767 specifies the SASL security strength factor.
769 specifies the overall security strength factor to require for
771 .B update_transport=<n>
772 specifies the transport security strength factor to require for
775 specifies the TLS security strength factor to require for
778 specifies the SASL security strength factor to require for
781 specifies the security strength factor required for
783 username/password authentication.
786 factor is measure of security provided by the underlying transport,
787 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
789 .B sizelimit {<integer>|unlimited}
791 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
792 Specify the maximum number of entries to return from a search operation.
793 The default size limit is 500.
798 to specify no limits.
799 The second format allows a fine grain setting of the size limits.
800 Extra args can be added on the same line.
803 for an explanation of the different flags.
805 .B sockbuf_max_incoming <integer>
806 Specify the maximum incoming LDAP PDU size for anonymous sessions.
807 The default is 262143.
809 .B sockbuf_max_incoming_auth <integer>
810 Specify the maximum incoming LDAP PDU size for authenticated sessions.
811 The default is 4194303.
814 Specify the srvtab file in which the kerberos keys necessary for
815 authenticating clients using kerberos can be found. This option is only
816 meaningful if you are using Kerberos authentication.
819 Specify the maximum size of the primary thread pool.
822 .B timelimit {<integer>|unlimited}
824 .B timelimit time[.{soft|hard}]=<integer> [...]
825 Specify the maximum number of seconds (in real time)
827 will spend answering a search request. The default time limit is 3600.
832 to specify no limits.
833 The second format allows a fine grain setting of the time limits.
834 Extra args can be added on the same line.
837 for an explanation of the different flags.
839 .B ucdata-path <path>
840 Specify the path to the directory containing the Unicode character
841 tables. The default path is DATADIR/ucdata.
845 is built with support for Transport Layer Security, there are more options
848 .B TLSCipherSuite <cipher-suite-spec>
849 Permits configuring what ciphers will be accepted and the preference order.
850 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
852 TLSCipherSuite HIGH:MEDIUM:+SSLv2
854 To check what ciphers a given spec selects, use:
856 openssl ciphers -v <cipher-suite-spec>
858 .B TLSCACertificateFile <filename>
859 Specifies the file that contains certificates for all of the Certificate
864 .B TLSCACertificatePath <path>
865 Specifies the path of a directory that contains Certificate Authority
866 certificates in separate individual files. Usually only one of this
867 or the TLSCACertificateFile is used.
869 .B TLSCertificateFile <filename>
870 Specifies the file that contains the
874 .B TLSCertificateKeyFile <filename>
875 Specifies the file that contains the
877 server private key that matches the certificate stored in the
878 .B TLSCertificateFile
879 file. Currently, the private key must not be protected with a password, so
880 it is of critical importance that it is protected carefully.
882 .B TLSRandFile <filename>
883 Specifies the file to obtain random bits from when /dev/[u]random
884 is not available. Generally set to the name of the EGD/PRNGD socket.
885 The environment variable RANDFILE can also be used to specify the filename.
887 .B TLSVerifyClient <level>
888 Specifies what checks to perform on client certificates in an
889 incoming TLS session, if any.
892 can be specified as one of the following keywords:
898 will not ask the client for a certificate.
901 The client certificate is requested. If no certificate is provided,
902 the session proceeds normally. If a bad certificate is provided,
903 it will be ignored and the session proceeds normally.
906 The client certificate is requested. If no certificate is provided,
907 the session proceeds normally. If a bad certificate is provided,
908 the session is immediately terminated.
910 .B demand | hard | true
911 These keywords are all equivalent, for compatibility reasons.
912 The client certificate is requested. If no certificate is provided,
913 or a bad certificate is provided, the session is immediately terminated.
915 Note that a valid client certificate is required in order to use the
916 SASL EXTERNAL authentication mechanism with a TLS session. As such,
919 setting must be chosen to enable SASL EXTERNAL authentication.
921 .SH GENERAL BACKEND OPTIONS
922 Options in this section only apply to the configuration file section
923 for the specified backend. They are supported by every
926 .B backend <databasetype>
927 Mark the beginning of a backend definition. <databasetype>
942 depending on which backend will serve the database.
944 .SH GENERAL DATABASE OPTIONS
945 Options in this section only apply to the configuration file section
946 for the database in which they are defined. They are supported by every
947 type of backend. Note that the
951 option are mandatory for each database.
953 .B database <databasetype>
954 Mark the beginning of a new database instance definition. <databasetype>
969 depending on which backend will serve the database.
974 will automatically maintain the
975 modifiersName, modifyTimestamp, creatorsName, and
976 createTimestamp attributes for entries. By default, lastmod is on.
978 .B limits <who> <limit> [<limit> [...]]
979 Specify time and size limits based on who initiated an operation.
986 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
992 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
997 matches all unauthenticated clients.
1000 matches all authenticated clients;
1003 dn pattern is assumed unless otherwise specified by qualifying
1004 the (optional) key string
1010 (which are synonyms), to require an exact match; with
1012 to require exactly one level of depth match; with
1014 to allow any level of depth match, including the exact match; with
1016 to allow any level of depth match, not including the exact match;
1018 explicitly requires the (default) match based on regular expression
1019 pattern, as detailed in
1023 matches unbound operations; the
1026 The same behavior is obtained by using the
1033 with the optional objectClass
1039 sets the limits for any DN listed in the values of the
1045 group objectClass (default
1047 whose DN exactly matches
1050 The currently supported limits are
1055 The syntax for time limits is
1056 .BR time[.{soft|hard}]=<integer> ,
1059 is the number of seconds slapd will spend answering a search request.
1060 If no time limit is explicitly requested by the client, the
1062 limit is used; if the requested time limit exceeds the
1065 .I \"Administrative limit exceeded\"
1069 limit is set to 0 or to the keyword
1071 the soft limit is used in either case; if it is set to
1075 no hard limit is enforced.
1076 Explicit requests for time limits smaller or equal to the
1079 If no flag is set, the value is assigned to the
1083 limit is set to zero, to preserve the original behavior.
1085 The syntax for size limits is
1086 .BR size[.{soft|hard|unchecked}]=<integer> ,
1089 is the maximum number of entries slapd will return answering a search
1091 If no size limit is explicitly requested by the client, the
1093 limit is used; if the requested size limit exceeds the
1096 .I \"Administrative limit exceeded\"
1100 limit is set to 0 or to the keyword
1102 the soft limit is used in either case; if it is set to
1106 no hard limit is enforced.
1107 Explicit requests for size limits smaller or equal to the
1112 flag sets a limit on the number of candidates a search request is allowed
1114 If the selected candidates exceed the
1116 limit, the search will abort with
1117 .IR \"Unwilling to perform\" .
1122 no limit is applied (the default).
1125 the search is not even performed; this can be used to disallow searches
1126 for a specific set of users.
1127 If no flag is set, the value is assigned to the
1131 limit is set to zero, to preserve the original behavior.
1133 In case of no match, the global limits are used.
1134 The default values are the same of
1143 control is requested, the
1145 size limit is used by default, because the request of a specific page size
1146 is considered as an explicit request for a limitation on the number
1147 of entries to be returned.
1148 However, the size limit applies to the total count of entries returned within
1149 the search, and not to a single page.
1150 Additional size limits may be enforced; the syntax is
1151 .BR size.pr={<integer>|noEstimate|none} ,
1154 is the max page size if no explicit limit is set; the keyword
1156 inhibits the server to return an estimate of the total number
1157 of entries that will be returned; the keyword
1159 indicates that no limit is applied to the pagedResults control page size.
1161 .B size.prtotal={<integer>|none|disabled}
1162 allows to set a limit on the total number of entries that a pagedResults
1163 control allows to return.
1164 By default it is set to the
1169 is the max number of entries that the whole search with pagedResults control
1173 to allow unlimited number of entries to be returned, i.e. to use
1174 pagedResults as a means to allow clients to circumvent size limitations
1175 on regular searches; the keyword
1177 disables the control, i.e. no paged results can be returned.
1178 Note that the total number of entries returned when the pagedResults control
1179 is requested cannot exceed the
1181 size limit of regular searches unless extended by the
1186 .B maxderefdepth <depth>
1187 Specifies the maximum number of aliases to dereference when trying to
1188 resolve an entry, used to avoid infinite alias loops. The default is 1.
1190 .B overlay <overlay-name>
1191 Add the specified overlay to this database. An overlay is a piece of
1192 code that intercepts database operations in order to extend or change
1193 them. Overlays are pushed onto
1194 a stack over the database, and so they will execute in the reverse
1195 of the order in which they were configured and the database itself
1196 will receive control last of all.
1198 .B readonly on | off
1199 This option puts the database into "read-only" mode. Any attempts to
1200 modify the database will return an "unwilling to perform" error. By
1201 default, readonly is off.
1204 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1205 .B [starttls=yes|critical]
1206 .B [suffix=<suffix> [...]]
1207 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1208 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1209 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1210 .B [attr[!]=<attr list>]
1212 Specify a replication site for this database. Refer to the "OpenLDAP
1213 Administrator's Guide" for detailed information on setting up a replicated
1215 directory service. Zero or more
1217 instances can be used to select the subtrees that will be replicated
1218 (defaults to all the database).
1220 is deprecated in favor of the
1224 allows the replica LDAP server to be specified as an LDAP URI.
1229 requires the options
1233 and should only be used when adequate security services
1234 (e.g TLS or IPSEC) are in place. A
1240 Specific security properties (as with the
1242 keyword above) for a SASL bind can be set with the
1244 option. A non-default SASL realm can be set with the
1249 will use Kerberos, a kerberos instance should be given in
1253 can be given after the
1255 keyword to allow the selective replication of the listed attributes only;
1258 mark is used, the list is considered exclusive, i.e. the listed attributes
1260 If an objectClass is listed, all the related attributes
1261 are (are not) replicated.
1264 .B replogfile <filename>
1265 Specify the name of the replication log file to log changes to.
1266 The replication log is typically written by
1271 .BR slapd.replog (5)
1272 for more information. The specified file should be located
1273 in a directory with limited read/write/execute access as the replication
1274 logs may contain sensitive information.
1277 Specify the distinguished name that is not subject to access control
1278 or administrative limit restrictions for operations on this database.
1279 This DN may or may not be associated with an entry. An empty root
1280 DN (the default) specifies no root access is to be granted. It is
1281 recommended that the rootdn only be specified when needed (such as
1282 when initially populating a database). If the rootdn is within
1283 a namingContext (suffix) of the database, a simple bind password
1284 may also be provided using the
1288 .B rootpw <password>
1289 Specify a password (or hash of the password) for the rootdn. The
1290 password can only be set if the rootdn is within the namingContext
1291 (suffix) of the database.
1292 This option accepts all RFC 2307 userPassword formats known to
1295 description) as well as cleartext.
1297 may be used to generate a hash of a password. Cleartext
1298 and \fB{CRYPT}\fP passwords are not recommended. If empty
1299 (the default), authentication of the root DN is by other means
1300 (e.g. SASL). Use of SASL is encouraged.
1302 .B suffix <dn suffix>
1303 Specify the DN suffix of queries that will be passed to this
1304 backend database. Multiple suffix lines can be given and at least one is
1305 required for each database definition.
1306 If the suffix of one database is "inside" that of another, the database
1307 with the inner suffix must come first in the configuration file.
1310 Specify that the current backend database is a subordinate of another
1311 backend database. A subordinate database may have only one suffix. This
1312 option may be used to glue multiple databases into a single namingContext.
1313 If the suffix of the current database is within the namingContext of a
1314 superior database, searches against the superior database will be
1315 propagated to the subordinate as well. All of the databases
1316 associated with a single namingContext should have identical rootdns.
1317 Behavior of other LDAP operations is unaffected by this setting. In
1318 particular, it is not possible to use moddn to move an entry from
1319 one subordinate to another subordinate within the namingContext.
1322 .B syncrepl rid=<replica ID>
1323 .B provider=ldap[s]://<hostname>[:port]
1324 .B [type=refreshOnly|refreshAndPersist]
1325 .B [interval=dd:hh:mm:ss]
1326 .B [searchbase=<base DN>]
1327 .B [filter=<filter str>]
1328 .B [scope=sub|one|base]
1329 .B [attrs=<attr list>]
1331 .B [sizelimit=<limit>]
1332 .B [timelimit=<limit>]
1333 .B [schemachecking=on|off]
1335 .B [bindmethod=simple|sasl]
1337 .B [saslmech=<mech>]
1338 .B [authcid=<identity>]
1339 .B [authzid=<identity>]
1340 .B [credentials=<passwd>]
1342 .B [secprops=<properties>]
1344 Specify the current database as a replica which is kept up-to-date with the
1345 master content by establishing the current
1347 as a replication consumer site running a
1350 The replica content is kept synchronized to the master content using
1351 the LDAP Content Synchronization protocol. Refer to the
1352 "OpenLDAP Administrator's Guide" for detailed information on
1353 setting up a replicated
1355 directory service using the
1359 identifies the current
1361 directive within the replication consumer site.
1362 It is a non-negative integer having no more than three digits.
1364 specifies the replication provider site containing the master content
1365 as an LDAP URI. If <port> is not given, the standard LDAP port number
1366 (389 or 636) is used. The content of the
1368 replica is defined using a search
1369 specification as its result set. The consumer
1371 will send search requests to the provider
1373 according to the search specification. The search specification includes
1374 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1377 parameters as in the normal search specification.
1378 The search specification for the LDAP Content Synchronization operation
1379 has the same value syntax and the same default values as in the
1382 The LDAP Content Synchronization protocol has two operation types.
1385 operation, the next synchronization search operation
1386 is periodically rescheduled at an interval time (specified by
1388 parameter; 1 day by default)
1389 after each synchronization operation finishes.
1391 .B refreshAndPersist
1392 operation, a synchronization search remains persistent in the provider slapd.
1393 Further updates to the master replica will generate
1394 .B searchResultEntry
1395 to the consumer slapd as the search responses to the persistent
1396 synchronization search. The schema checking can be enforced at the LDAP Sync
1397 consumer site by turning on the
1399 parameter. The default is off.
1402 parameter specifies the DN in the consumer site
1403 which is allowed to make changes to the replica.
1404 The DN should have read/write access to the replica database.
1409 of the master database.
1414 requires the options
1418 and should only be used when adequate security services
1419 (e.g. TLS or IPSEC) are in place.
1426 Depending on the mechanism, an authentication identity and/or
1427 credentials can be specified using
1433 parameter may be used to specify an authorization identity.
1434 Specific security properties (as with the
1436 keyword above) for a SASL bind can be set with the
1438 option. A non default SASL realm can be set with the
1444 This option is only applicable in a slave
1445 database updated using
1447 It specifies the DN permitted to update (subject to access controls)
1448 the replica (typically, this is the DN
1450 binds to update the replica). Generally, this DN
1457 Specify the referral to pass back when
1459 is asked to modify a replicated local database.
1460 If specified multiple times, each url is provided.
1462 .SH DATABASE-SPECIFIC OPTIONS
1463 Each database may allow specific configuration options; they are
1464 documented separately in the backends' manual pages.
1466 The following backends can be compiled into slapd.
1467 They are documented in the
1468 .BR slapd-<backend> (5)
1472 This is the recommended backend for a normal slapd database.
1473 However, it takes more care than with the LDBM backend to configure
1475 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1478 This is the database backend which is easiest to configure.
1479 However, it does not offer the data durability features of the BDB
1481 It uses Berkeley DB or GDBM to store data.
1484 This backend is experimental.
1485 It serves up referrals based upon SRV resource records held in the
1489 This backend acts as a proxy to forward incoming requests to another
1493 This backend performs basic LDAP proxying with respect to a set of
1494 remote LDAP servers. It is an enhancement of the ldap backend. The
1495 proxy cache extension of meta backend provides answering of search
1496 requests from the proxy using results of previously cached requests.
1499 This backend provides information about the running status of the slapd
1503 Operations in this backend succeed but do nothing.
1506 This backend is provided for demonstration purposes only.
1507 It serves up user account information from the system
1512 This backend embeds a
1514 interpreter into slapd.
1515 It runs Perl subroutines to implement LDAP operations.
1518 This backend executes external programs to implement LDAP operations.
1519 It is is primarily intended to be used in prototypes.
1522 This backend is experimental.
1523 It services LDAP requests from an SQL database.
1526 This backend is experimental.
1529 interpreter into slapd.
1530 It runs Tcl commands to implement LDAP operations.
1533 Here is a short example of a configuration file:
1537 include SYSCONFDIR/schema/core.schema
1538 pidfile LOCALSTATEDIR/slapd.pid
1540 # Subtypes of "name" (e.g. "cn" and "ou") with the
1541 # option ";x-hidden" can be searched for/compared,
1542 # but are not shown. See \fBslapd.access\fP(5).
1543 attributeoptions x-hidden lang-
1544 access to attr=name;x-hidden by * =cs
1547 suffix "dc=our-domain,dc=com"
1548 # The database directory MUST exist prior to
1549 # running slapd AND should only be accessible
1550 # by the slapd/tools. Mode 0700 recommended.
1551 directory LOCALSTATEDIR/openldap-data
1552 # Indices to maintain
1553 index objectClass eq
1554 index cn,sn,mail pres,eq,approx,sub
1556 # We serve small clients that do not handle referrals,
1557 # so handle remote lookups on their behalf.
1560 uri ldap://ldap.some-server.com/
1565 "OpenLDAP Administrator's Guide" contains a longer annotated
1566 example of a configuration file.
1567 The original ETCDIR/slapd.conf is another example.
1571 default slapd configuration file
1575 .BR slapd-dnssrv (5),
1579 .BR slapd-monitor (5),
1581 .BR slapd-passwd (5),
1583 .BR slapd-shell (5),
1586 .BR slapd.access (5),
1587 .BR slapd.plugin (5),
1588 .BR slapd.replog (5),
1596 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1597 .SH ACKNOWLEDGEMENTS
1599 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1601 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob