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
28 file consists of a series of global configuration options that apply to
30 as a whole (including all backends), followed by zero or more database
31 backend definitions that contain information specific to a backend
39 # comment - these options apply to every database
40 <global configuration options>
41 # first database definition & configuration options
42 database <backend 1 type>
43 <configuration options specific to backend 1>
44 # subsequent database definitions & configuration options
48 As many backend-specific sections as desired may be included. Global
49 options can be overridden in a backend (for options that appear more
50 than once, the last appearance in the
54 If a line begins with white space, it is considered a continuation
55 of the previous line. Blank lines and comment lines beginning with
56 a `#' character are ignored. (Note: continuation lines are unwrapped
57 before comment processing is applied.)
59 Arguments on configuration lines are separated by white space. If an
60 argument contains white space, the argument should be enclosed in
61 double quotes. If an argument contains a double quote (`"') or a
62 backslash character (`\\'), the character should be preceded by a
65 The specific configuration options available are discussed below in the
66 Global Configuration Options, General Backend Options, and General Database
67 Options. Backend-specific options are discussed in the
69 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
70 details on the slapd configuration file.
71 .SH GLOBAL CONFIGURATION OPTIONS
72 Options described in this section apply to all backends, unless specifically
73 overridden in a backend definition. Arguments that should be replaced by
74 actual text are shown in brackets <>.
76 .B access to <what> "[ by <who> <access> <control> ]+"
77 Grant access (specified by <access>) to a set of entries and/or
78 attributes (specified by <what>) by one or more requestors (specified
82 and the "OpenLDAP's Administrator's Guide" for details.
85 Specify a set of features (separated by white space) to
88 allows acceptance of LDAPv2 bind requests. Note that
90 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
92 allows anonymous bind when credentials are not empty (e.g.
95 allows unauthenticated (anonymous) bind when DN is not empty.
97 allow unauthenticated (anonymous) update operations to be processed
98 (subject to access controls and other administrative limits).
100 .B argsfile <filename>
101 The ( absolute ) name of a file that will hold the
103 server's command line options
104 if started without the debugging command line option.
106 .B attributeoptions [option-name]...
107 Define tagging attribute options or option tag/range prefixes.
108 Options must not end with `-', prefixes must end with `-'.
109 The `lang-' prefix is predefined.
112 directive, `lang-' will no longer be defined and you must specify it
113 explicitly if you want it defined.
115 An attribute description with a tagging option is a subtype of that
116 attribute description without the option.
117 Except for that, options defined this way have no special semantics.
118 Prefixes defined this way work like the `lang-' options:
119 They define a prefix for tagging options starting with the prefix.
120 That is, if you define the prefix `x-foo-', you can use the option
122 Furthermore, in a search or compare, a prefix or range name (with
123 a trailing `-') matches all options starting with that name, as well
124 as the option with the range name sans the trailing `-'.
125 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
127 RFC 2251 reserves options beginning with `x-' for private experiments.
128 Other options should be registered with IANA, see RFC 3383 section 3.4.
129 OpenLDAP also has the `binary' option built in, but this is a transfer
130 option, not a tagging option.
133 .B attributetype "(\ <oid>\
135 [DESC\ <description>]\
144 [NO\-USER\-MODIFICATION]\
145 [USAGE\ <attributeUsage>]\ )"
147 Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
148 The slapd parser extends the RFC 2252 definition by allowing string
149 forms as well as numeric OIDs to be used for the attribute OID and
150 attribute syntax OID.
156 .B authz-policy <policy>
157 Used to specify which rules to use for Proxy Authorization. Proxy
158 authorization allows a client to authenticate to the server using one
159 user's credentials, but specify a different identity to use for authorization
160 and access control purposes. It essentially allows user A to login as user
161 B, using user A's password.
164 flag disables proxy authorization. This is the default setting.
167 flag will use rules in the
169 attribute of the authorization DN.
172 flag will use rules in the
174 attribute of the authentication DN.
177 flag, an alias for the deprecated value of
179 will allow any of the above, whatever succeeds first (checked in
185 flag requires both authorizations to succeed.
188 The rules are mechanisms to specify which identities are allowed
189 to perform proxy authorization.
192 attribute in an entry specifies which other users
193 are allowed to proxy login to this entry. The
196 an entry specifies which other users this user can authorize as. Use of
199 abused if users are allowed to write arbitrary values to this attribute.
202 attribute must be protected with ACLs such that
203 only privileged users can modify it.
210 or a set of identities; it can take three forms:
213 .B ldap:///<base>??[<scope>]?<filter>
216 .B dn[.<dnstyle>]:<pattern>
219 .B u[<mech>[<realm>]]:<pattern>
222 .B group[/objectClass[/attributeType]]:<pattern>
229 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
232 The first form is a valid LDAP
240 portions must be absent, so that the search occurs locally on either
246 with the optional style modifiers
252 for exact, onelevel, children and subtree matches, which cause
254 to be normalized according to the DN normalization rules, or the special
258 to be compiled according to
262 means any non-anonymous DN.
263 The third form is a SASL
265 with the optional fields
269 that allow to specify a SASL
271 and eventually a SASL
273 for those mechanisms that support one.
274 The need to allow the specification of a mechanism is still debated,
275 and users are strongly discouraged to rely on this possibility.
276 The fourth form is a group specification, consisting of the keyword
278 optionally followed by the specification of the group
284 is searched with base scope, and in case of match, the values of the
287 are searched for the asserted DN.
288 For backwards compatibility, if no identity type is provided, i.e. only
292 is assumed; as a consequence,
294 is subjected to DN normalization.
295 Since the interpretation of
299 can impact security, users are strongly encouraged
300 to explicitly set the type of identity specification that is being used.
301 A subset of these rules can be used as third arg in the
303 statement (see below); significantly, the
310 .B authz-regexp <match> <replace>
311 Used by the authentication framework to convert simple user names,
312 such as provided by SASL subsystem, to an LDAP DN used for
313 authorization purposes. Note that the resultant DN need not refer
314 to an existing entry to be considered valid. When an authorization
315 request is received from the SASL subsystem, the SASL
320 are taken, when available, and combined into a name of the form
324 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
327 This name is then compared against the
329 regular expression, and if the match is successful, the name is
332 string. If there are wildcard strings in the
334 regular expression that are enclosed in parenthesis, e.g.
340 then the portion of the name that matched the wildcard will be stored
341 in the numbered placeholder variable $1. If there are other wildcard strings
342 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
343 placeholders can then be used in the
348 .B UID=$1,OU=Accounts,DC=example,DC=com
351 The replaced name can be either a DN or an LDAP URI. If the
352 latter, the server will use the URI to search its own database(s)
353 and, if the search returns exactly one entry, the name is
354 replaced by the DN of that entry. The LDAP URI must have no
355 hostport, attrs, or extensions components, e.g.
358 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
363 options can be given in the configuration file to allow for multiple matching
364 and replacement patterns. The matching patterns are checked in the order they
365 appear in the file, stopping at the first successful match.
368 .\"Because the plus sign + is a character recognized by the regular expression engine,
369 .\"and it will appear in names that include a REALM, be careful to escape the
370 .\"plus sign with a backslash \\+ to remove the character's special meaning.
373 .B concurrency <integer>
374 Specify a desired level of concurrency. Provided to the underlying
375 thread system as a hint. The default is not to provide any hint.
377 .B conn_max_pending <integer>
378 Specify the maximum number of pending requests for an anonymous session.
379 If requests are submitted faster than the server can process them, they
380 will be queued up to this limit. If the limit is exceeded, the session
381 is closed. The default is 100.
383 .B conn_max_pending_auth <integer>
384 Specify the maximum number of pending requests for an authenticated session.
386 .\"-- NEW_LOGGING option --
388 .\".B debug <subsys> <level>
389 .\"Specify a logging level for a particular subsystem. The subsystems include
391 .\"a global level for all subsystems,
395 .\"the backend databases,
397 .\"the entry cache manager,
399 .\"the config file reader,
401 .\"the connection manager,
403 .\"the Cyrus SASL library interface,
405 .\"the search filter processor,
407 .\"the DN normalization library,
409 .\"the database indexer,
411 .\"the ASN.1 BER library,
413 .\"the dynamic module loader,
415 .\"the LDAP operation processors,
417 .\"the SASL authentication subsystem,
419 .\"the schema processor, and
421 .\"the TLS library interface. This is not an exhaustive list; there are many
422 .\"other subsystems and more are added over time.
424 .\"The levels are, in order of decreasing priority:
425 .\".B emergency, alert, critical, error, warning, notice, information, entry,
426 .\".B args, results, detail1, detail2
427 .\"An integer may be used instead, with 0 corresponding to
433 .\"level logs function entry points,
435 .\"adds function call parameters, and
437 .\"adds the function results to the logs.
442 .\"levels add even more low level detail from individual functions.
444 .B defaultsearchbase <dn>
445 Specify a default search base to use when client submits a
446 non-base search request with an empty base DN.
448 .B disallow <features>
449 Specify a set of features (separated by white space) to
450 disallow (default none).
452 disables acceptance of anonymous bind requests.
454 disables simple (bind) authentication.
456 disables Kerberos V4 (bind) authentication.
458 disables Start TLS from forcing session to anonymous status (see also
461 disables StartTLS if authenticated (see also
465 .B ditcontentrule "(\ <oid>\
467 [DESC\ <description>]\
474 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 2252.
475 The slapd parser extends the RFC 2252 definition by allowing string
476 forms as well as numeric OIDs to be used for the attribute OID and
477 attribute syntax OID.
483 .B gentlehup { on | off }
484 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
486 will stop listening for new connections, but will not close the
487 connections to the current clients. Future write operations return
488 unwilling-to-perform, though. Slapd terminates when all clients
489 have closed their connections (if they ever do), or \- as before \-
490 if it receives a SIGTERM signal. This can be useful if you wish to
491 terminate the server and start a new
494 .B with another database,
495 without disrupting the currently active clients.
496 The default is off. You may wish to use
498 along with this option.
500 .B idletimeout <integer>
501 Specify the number of seconds to wait before forcibly closing
502 an idle client connection. A idletimeout of 0 disables this
503 feature. The default is 0.
505 .B include <filename>
506 Read additional configuration information from the given file before
507 continuing with the next line of the current file.
508 .\"-- NEW_LOGGING option --
510 .\".B logfile <filename>
511 .\"Specify a file for recording debug log messages. By default these messages
512 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
513 .\"copies messages to both stderr and the logfile.
515 .B loglevel <integer>
516 Specify the level at which debugging statements and operation
517 statistics should be syslogged (currently logged to the
519 LOG_LOCAL4 facility). Log levels are additive, and available levels
529 debug packet handling
532 heavy trace debugging
535 connection management
538 print out packets sent and received
541 search filter processing
544 configuration file processing
547 access control list processing
550 stats log connections/operations/results
553 stats log entries sent
556 print communication with shell backends
564 .B moduleload <filename>
565 Specify the name of a dynamically loadable module to load. The filename
566 may be an absolute path name or a simple filename. Non-absolute names
567 are searched for in the directories specified by the
569 option. This option and the
571 option are only usable if slapd was compiled with --enable-modules.
573 .B modulepath <pathspec>
574 Specify a list of directories to search for loadable modules. Typically
575 the path is colon-separated but this depends on the operating system.
578 .B objectclass "(\ <oid>\
580 [DESC\ <description]\
583 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
584 [MUST\ <oids>] [MAY\ <oids>] )"
586 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
587 The slapd parser extends the RFC 2252 definition by allowing string
588 forms as well as numeric OIDs to be used for the object class OID.
592 description.) Object classes are "STRUCTURAL" by default.
595 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
596 Define a string name that equates to the given OID. The string can be used
597 in place of the numeric OID in objectclass and attribute definitions. The
598 name can also be used with a suffix of the form ":xx" in which case the
599 value "oid.xx" will be used.
601 .B password-hash <hash> [<hash>...]
602 This option configures one or more hashes to be used in generation of user
603 passwords stored in the userPassword attribute during processing of
604 LDAP Password Modify Extended Operations (RFC 3062).
605 The <hash> must be one of
619 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
624 use the MD5 algorithm (RFC 1321), the latter with a seed.
631 indicates that the new password should be
632 added to userPassword as clear text.
634 Note that this option does not alter the normal user applications
635 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
637 .B password\-crypt\-salt\-format <format>
638 Specify the format of the salt passed to
640 when generating {CRYPT} passwords (see
642 during processing of LDAP Password Modify Extended Operations (RFC 3062).
644 This string needs to be in
646 format and may include one (and only one) %s conversion.
647 This conversion will be substituted with a string random
648 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
649 provides a two character salt and "$1$%.8s" tells some
650 versions of crypt(3) to use an MD5 algorithm and provides
651 8 random characters of salt. The default is "%s", which
652 provides 31 characters of salt.
654 .B pidfile <filename>
655 The ( absolute ) name of a file that will hold the
657 server's process ID ( see
659 ) if started without the debugging command line option.
662 Specify the referral to pass back when
664 cannot find a local database to handle a request.
665 If specified multiple times, each url is provided.
668 The ( absolute ) name of a file that will hold the
670 server's command line options
671 if started without the debugging command line option.
674 The ( absolute ) name of a file that will hold the
676 server's process ID ( see
678 ) if started without the debugging command line option.
680 .B replicationinterval
681 The number of seconds
683 waits before checking the replogfile for changes.
685 .B require <conditions>
686 Specify a set of conditions (separated by white space) to
687 require (default none).
688 The directive may be specified globally and/or per-database.
690 requires bind operation prior to directory operations.
692 requires session to be using LDAP version 3.
694 requires authentication prior to directory operations.
696 requires SASL authentication prior to directory operations.
698 requires strong authentication prior to directory operations.
699 The strong keyword allows protected "simple" authentication
700 as well as SASL authentication.
702 may be used to require no conditions (useful for clearly globally
703 set conditions within a particular database).
705 .B reverse-lookup on | off
706 Enable/disable client name unverified reverse lookup (default is
708 if compiled with --enable-rlookups).
711 Specify the name of an LDIF(5) file containing user defined attributes
712 for the root DSE. These attributes are returned in addition to the
713 attributes normally produced by slapd.
716 Used to specify the fully qualified domain name used for SASL processing.
718 .B sasl-realm <realm>
719 Specify SASL realm. Default is empty.
721 .B sasl-secprops <properties>
722 Used to specify Cyrus SASL security properties.
725 flag (without any other properties) causes the flag properties
726 default, "noanonymous,noplain", to be cleared.
729 flag disables mechanisms susceptible to simple passive attacks.
732 flag disables mechanisms susceptible to active attacks.
735 flag disables mechanisms susceptible to passive dictionary attacks.
738 flag disables mechanisms which support anonymous login.
741 flag require forward secrecy between sessions.
744 require mechanisms which pass client credentials (and allow
745 mechanisms which can pass credentials to do so).
748 property specifies the minimum acceptable
749 .I security strength factor
750 as an integer approximate to effective key length used for
751 encryption. 0 (zero) implies no protection, 1 implies integrity
752 protection only, 56 allows DES or other weak ciphers, 112
753 allows triple DES and other strong ciphers, 128 allows RC4,
754 Blowfish and other modern strong ciphers. The default is 0.
757 property specifies the maximum acceptable
758 .I security strength factor
759 as an integer (see minssf description). The default is INT_MAX.
762 property specifies the maximum security layer receive buffer
763 size allowed. 0 disables security layers. The default is 65536.
766 Specify the distinguished name for the subschema subentry that
767 controls the entries on this server. The default is "cn=Subschema".
769 .B security <factors>
770 Specify a set of factors (separated by white space) to require.
771 An integer value is associated with each factor and is roughly
772 equivalent of the encryption key length to require. A value
773 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
774 The directive may be specified globally and/or per-database.
776 specifies the overall security strength factor.
778 specifies the transport security strength factor.
780 specifies the TLS security strength factor.
782 specifies the SASL security strength factor.
784 specifies the overall security strength factor to require for
786 .B update_transport=<n>
787 specifies the transport security strength factor to require for
790 specifies the TLS security strength factor to require for
793 specifies the SASL security strength factor to require for
796 specifies the security strength factor required for
798 username/password authentication.
801 factor is measure of security provided by the underlying transport,
802 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
804 .B sizelimit {<integer>|unlimited}
806 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
807 Specify the maximum number of entries to return from a search operation.
808 The default size limit is 500.
813 to specify no limits.
814 The second format allows a fine grain setting of the size limits.
815 Extra args can be added on the same line.
818 for an explanation of the different flags.
820 .B sockbuf_max_incoming <integer>
821 Specify the maximum incoming LDAP PDU size for anonymous sessions.
822 The default is 262143.
824 .B sockbuf_max_incoming_auth <integer>
825 Specify the maximum incoming LDAP PDU size for authenticated sessions.
826 The default is 4194303.
829 Specify the srvtab file in which the kerberos keys necessary for
830 authenticating clients using kerberos can be found. This option is only
831 meaningful if you are using Kerberos authentication.
834 Specify the maximum size of the primary thread pool.
837 .B timelimit {<integer>|unlimited}
839 .B timelimit time[.{soft|hard}]=<integer> [...]
840 Specify the maximum number of seconds (in real time)
842 will spend answering a search request. The default time limit is 3600.
847 to specify no limits.
848 The second format allows a fine grain setting of the time limits.
849 Extra args can be added on the same line.
852 for an explanation of the different flags.
854 .B ucdata-path <path>
855 Specify the path to the directory containing the Unicode character
856 tables. The default path is DATADIR/ucdata.
860 is built with support for Transport Layer Security, there are more options
863 .B TLSCipherSuite <cipher-suite-spec>
864 Permits configuring what ciphers will be accepted and the preference order.
865 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
867 TLSCipherSuite HIGH:MEDIUM:+SSLv2
869 To check what ciphers a given spec selects, use:
871 openssl ciphers -v <cipher-suite-spec>
873 .B TLSCACertificateFile <filename>
874 Specifies the file that contains certificates for all of the Certificate
879 .B TLSCACertificatePath <path>
880 Specifies the path of a directory that contains Certificate Authority
881 certificates in separate individual files. Usually only one of this
882 or the TLSCACertificateFile is used.
884 .B TLSCertificateFile <filename>
885 Specifies the file that contains the
889 .B TLSCertificateKeyFile <filename>
890 Specifies the file that contains the
892 server private key that matches the certificate stored in the
893 .B TLSCertificateFile
894 file. Currently, the private key must not be protected with a password, so
895 it is of critical importance that it is protected carefully.
897 .B TLSRandFile <filename>
898 Specifies the file to obtain random bits from when /dev/[u]random
899 is not available. Generally set to the name of the EGD/PRNGD socket.
900 The environment variable RANDFILE can also be used to specify the filename.
902 .B TLSVerifyClient <level>
903 Specifies what checks to perform on client certificates in an
904 incoming TLS session, if any.
907 can be specified as one of the following keywords:
913 will not ask the client for a certificate.
916 The client certificate is requested. If no certificate is provided,
917 the session proceeds normally. If a bad certificate is provided,
918 it will be ignored and the session proceeds normally.
921 The client certificate is requested. If no certificate is provided,
922 the session proceeds normally. If a bad certificate is provided,
923 the session is immediately terminated.
925 .B demand | hard | true
926 These keywords are all equivalent, for compatibility reasons.
927 The client certificate is requested. If no certificate is provided,
928 or a bad certificate is provided, the session is immediately terminated.
930 Note that a valid client certificate is required in order to use the
931 SASL EXTERNAL authentication mechanism with a TLS session. As such,
934 setting must be chosen to enable SASL EXTERNAL authentication.
936 .SH GENERAL BACKEND OPTIONS
937 Options in this section only apply to the configuration file section
938 for the specified backend. They are supported by every
941 .B backend <databasetype>
942 Mark the beginning of a backend definition. <databasetype>
957 depending on which backend will serve the database.
959 .SH GENERAL DATABASE OPTIONS
960 Options in this section only apply to the configuration file section
961 for the database in which they are defined. They are supported by every
962 type of backend. Note that the
966 option are mandatory for each database.
968 .B database <databasetype>
969 Mark the beginning of a new database instance definition. <databasetype>
984 depending on which backend will serve the database.
989 will automatically maintain the
990 modifiersName, modifyTimestamp, creatorsName, and
991 createTimestamp attributes for entries. By default, lastmod is on.
993 .B limits <who> <limit> [<limit> [...]]
994 Specify time and size limits based on who initiated an operation.
1001 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1007 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1012 matches all unauthenticated clients.
1015 matches all authenticated clients;
1018 dn pattern is assumed unless otherwise specified by qualifying
1019 the (optional) key string
1025 (which are synonyms), to require an exact match; with
1027 to require exactly one level of depth match; with
1029 to allow any level of depth match, including the exact match; with
1031 to allow any level of depth match, not including the exact match;
1033 explicitly requires the (default) match based on regular expression
1034 pattern, as detailed in
1038 matches unbound operations; the
1041 The same behavior is obtained by using the
1048 with the optional objectClass
1054 sets the limits for any DN listed in the values of the
1060 group objectClass (default
1062 whose DN exactly matches
1065 The currently supported limits are
1070 The syntax for time limits is
1071 .BR time[.{soft|hard}]=<integer> ,
1074 is the number of seconds slapd will spend answering a search request.
1075 If no time limit is explicitly requested by the client, the
1077 limit is used; if the requested time limit exceeds the
1080 .I "Administrative limit exceeded"
1084 limit is set to the keyword
1086 the soft limit is used in either case; if it is set to the keyword
1088 no hard limit is enforced.
1089 Explicit requests for time limits smaller or equal to the
1092 If no limit specifier is set, the value is assigned to the
1096 limit is set to soft, to preserve the original behavior.
1098 The syntax for size limits is
1099 .BR size[.{soft|hard|unchecked}]=<integer> ,
1102 is the maximum number of entries slapd will return answering a search
1104 If no size limit is explicitly requested by the client, the
1106 limit is used; if the requested size limit exceeds the
1109 .I "Administrative limit exceeded"
1113 limit is set to the keyword
1115 the soft limit is used in either case; if it is set to the keyword
1117 no hard limit is enforced.
1118 Explicit requests for size limits smaller or equal to the
1123 specifier sets a limit on the number of candidates a search request is allowed
1125 If the selected candidates exceed the
1127 limit, the search will abort with
1128 .IR "Unwilling to perform" .
1129 If it is set to the keyword
1131 no limit is applied (the default).
1134 the search is not even performed; this can be used to disallow searches
1135 for a specific set of users.
1136 If no limit specifier is set, the value is assigned to the
1140 limit is set to soft, to preserve the original behavior.
1142 In case of no match, the global limits are used.
1143 The default values are the same of
1152 control is requested, the
1154 size limit is used by default, because the request of a specific page size
1155 is considered an explicit request for a limitation on the number
1156 of entries to be returned.
1157 However, the size limit applies to the total count of entries returned within
1158 the search, and not to a single page.
1159 Additional size limits may be enforced; the syntax is
1160 .BR size.pr={<integer>|noEstimate|none} ,
1163 is the max page size if no explicit limit is set; the keyword
1165 inhibits the server from returning an estimate of the total number
1166 of entries that might be returned; the keyword
1168 indicates that no limit is applied to the pagedResults control page size.
1170 .B size.prtotal={<integer>|none|disabled}
1171 allows to set a limit on the total number of entries that a pagedResults
1172 control allows to return.
1173 By default it is set to the
1178 is the max number of entries that the whole search with pagedResults control
1182 to allow unlimited number of entries to be returned, i.e. to use
1183 pagedResults as a means to allow clients to circumvent size limitations
1184 on regular searches; the keyword
1186 disables the control, i.e. no paged results can be returned.
1187 Note that the total number of entries returned when the pagedResults control
1188 is requested cannot exceed the
1190 size limit of regular searches unless extended by the
1195 .B maxderefdepth <depth>
1196 Specifies the maximum number of aliases to dereference when trying to
1197 resolve an entry, used to avoid infinite alias loops. The default is 1.
1199 .B overlay <overlay-name>
1200 Add the specified overlay to this database. An overlay is a piece of
1201 code that intercepts database operations in order to extend or change
1202 them. Overlays are pushed onto
1203 a stack over the database, and so they will execute in the reverse
1204 of the order in which they were configured and the database itself
1205 will receive control last of all.
1207 .B readonly on | off
1208 This option puts the database into "read-only" mode. Any attempts to
1209 modify the database will return an "unwilling to perform" error. By
1210 default, readonly is off.
1213 .B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1214 .B [starttls=yes|critical]
1215 .B [suffix=<suffix> [...]]
1216 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1217 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1218 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
1219 .B [attr[!]=<attr list>]
1221 Specify a replication site for this database. Refer to the "OpenLDAP
1222 Administrator's Guide" for detailed information on setting up a replicated
1224 directory service. Zero or more
1226 instances can be used to select the subtrees that will be replicated
1227 (defaults to all the database).
1229 is deprecated in favor of the
1233 allows the replica LDAP server to be specified as an LDAP URI.
1238 requires the options
1242 and should only be used when adequate security services
1243 (e.g TLS or IPSEC) are in place. A
1249 Specific security properties (as with the
1251 keyword above) for a SASL bind can be set with the
1253 option. A non-default SASL realm can be set with the
1258 will use Kerberos, a kerberos instance should be given in
1262 can be given after the
1264 keyword to allow the selective replication of the listed attributes only;
1267 mark is used, the list is considered exclusive, i.e. the listed attributes
1269 If an objectClass is listed, all the related attributes
1270 are (are not) replicated.
1273 .B replogfile <filename>
1274 Specify the name of the replication log file to log changes to.
1275 The replication log is typically written by
1280 .BR slapd.replog (5)
1281 for more information. The specified file should be located
1282 in a directory with limited read/write/execute access as the replication
1283 logs may contain sensitive information.
1285 .B restrict <oplist>
1286 Specify a whitespace separated list of operations that are restricted.
1287 If defined inside a database specification, restrictions apply only
1288 to that database, otherwise they are global.
1289 Operations can be any of
1294 .BR extended[=<OID>] ,
1298 or the special pseudo-operations
1302 which respectively summarize read and write operations.
1310 keyword allows to indicate the OID of the specific operation
1314 Specify the distinguished name that is not subject to access control
1315 or administrative limit restrictions for operations on this database.
1316 This DN may or may not be associated with an entry. An empty root
1317 DN (the default) specifies no root access is to be granted. It is
1318 recommended that the rootdn only be specified when needed (such as
1319 when initially populating a database). If the rootdn is within
1320 a namingContext (suffix) of the database, a simple bind password
1321 may also be provided using the
1325 .B rootpw <password>
1326 Specify a password (or hash of the password) for the rootdn. The
1327 password can only be set if the rootdn is within the namingContext
1328 (suffix) of the database.
1329 This option accepts all RFC 2307 userPassword formats known to
1332 description) as well as cleartext.
1334 may be used to generate a hash of a password. Cleartext
1335 and \fB{CRYPT}\fP passwords are not recommended. If empty
1336 (the default), authentication of the root DN is by other means
1337 (e.g. SASL). Use of SASL is encouraged.
1339 .B suffix <dn suffix>
1340 Specify the DN suffix of queries that will be passed to this
1341 backend database. Multiple suffix lines can be given and at least one is
1342 required for each database definition.
1343 If the suffix of one database is "inside" that of another, the database
1344 with the inner suffix must come first in the configuration file.
1347 Specify that the current backend database is a subordinate of another
1348 backend database. A subordinate database may have only one suffix. This
1349 option may be used to glue multiple databases into a single namingContext.
1350 If the suffix of the current database is within the namingContext of a
1351 superior database, searches against the superior database will be
1352 propagated to the subordinate as well. All of the databases
1353 associated with a single namingContext should have identical rootdns.
1354 Behavior of other LDAP operations is unaffected by this setting. In
1355 particular, it is not possible to use moddn to move an entry from
1356 one subordinate to another subordinate within the namingContext.
1359 .B syncrepl rid=<replica ID>
1360 .B provider=ldap[s]://<hostname>[:port]
1361 .B [type=refreshOnly|refreshAndPersist]
1362 .B [interval=dd:hh:mm:ss]
1363 .B [searchbase=<base DN>]
1364 .B [filter=<filter str>]
1365 .B [scope=sub|one|base]
1366 .B [attrs=<attr list>]
1368 .B [sizelimit=<limit>]
1369 .B [timelimit=<limit>]
1370 .B [schemachecking=on|off]
1372 .B [bindmethod=simple|sasl]
1374 .B [saslmech=<mech>]
1375 .B [authcid=<identity>]
1376 .B [authzid=<identity>]
1377 .B [credentials=<passwd>]
1379 .B [secprops=<properties>]
1381 Specify the current database as a replica which is kept up-to-date with the
1382 master content by establishing the current
1384 as a replication consumer site running a
1387 The replica content is kept synchronized to the master content using
1388 the LDAP Content Synchronization protocol. Refer to the
1389 "OpenLDAP Administrator's Guide" for detailed information on
1390 setting up a replicated
1392 directory service using the
1396 identifies the current
1398 directive within the replication consumer site.
1399 It is a non-negative integer having no more than three digits.
1401 specifies the replication provider site containing the master content
1402 as an LDAP URI. If <port> is not given, the standard LDAP port number
1403 (389 or 636) is used. The content of the
1405 replica is defined using a search
1406 specification as its result set. The consumer
1408 will send search requests to the provider
1410 according to the search specification. The search specification includes
1411 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1414 parameters as in the normal search specification.
1415 The search specification for the LDAP Content Synchronization operation
1416 has the same value syntax and the same default values as in the
1419 The LDAP Content Synchronization protocol has two operation types.
1422 operation, the next synchronization search operation
1423 is periodically rescheduled at an interval time (specified by
1425 parameter; 1 day by default)
1426 after each synchronization operation finishes.
1428 .B refreshAndPersist
1429 operation, a synchronization search remains persistent in the provider slapd.
1430 Further updates to the master replica will generate
1431 .B searchResultEntry
1432 to the consumer slapd as the search responses to the persistent
1433 synchronization search. If the connection is lost, the consumer will
1434 attempt to reconnect at an interval time (specified by
1436 parameter; 60 seconds by default) until the session is re-established.
1437 The schema checking can be enforced at the LDAP Sync
1438 consumer site by turning on the
1440 parameter. The default is off.
1443 parameter specifies the DN in the consumer site
1444 which is allowed to make changes to the replica.
1445 The DN should have read/write access to the replica database.
1450 of the master database.
1455 requires the options
1459 and should only be used when adequate security services
1460 (e.g. TLS or IPSEC) are in place.
1467 Depending on the mechanism, an authentication identity and/or
1468 credentials can be specified using
1474 parameter may be used to specify an authorization identity.
1475 Specific security properties (as with the
1477 keyword above) for a SASL bind can be set with the
1479 option. A non default SASL realm can be set with the
1485 This option is only applicable in a slave
1486 database updated using
1488 It specifies the DN permitted to update (subject to access controls)
1489 the replica (typically, this is the DN
1491 binds to update the replica). Generally, this DN
1498 Specify the referral to pass back when
1500 is asked to modify a replicated local database.
1501 If specified multiple times, each url is provided.
1503 .SH DATABASE-SPECIFIC OPTIONS
1504 Each database may allow specific configuration options; they are
1505 documented separately in the backends' manual pages.
1507 The following backends can be compiled into slapd.
1508 They are documented in the
1509 .BR slapd-<backend> (5)
1513 This is the recommended backend for a normal slapd database.
1514 However, it takes more care than with the LDBM backend to configure
1516 It uses the Sleepycat Berkeley DB (BDB) package to store data.
1519 This is the database backend which is easiest to configure.
1520 However, it does not offer the data durability features of the BDB
1522 It uses Berkeley DB or GDBM to store data.
1525 This backend is experimental.
1526 It serves up referrals based upon SRV resource records held in the
1530 This backend acts as a proxy to forward incoming requests to another
1534 This backend performs basic LDAP proxying with respect to a set of
1535 remote LDAP servers. It is an enhancement of the ldap backend. The
1536 proxy cache extension of meta backend provides answering of search
1537 requests from the proxy using results of previously cached requests.
1540 This backend provides information about the running status of the slapd
1544 Operations in this backend succeed but do nothing.
1547 This backend is provided for demonstration purposes only.
1548 It serves up user account information from the system
1553 This backend embeds a
1555 interpreter into slapd.
1556 It runs Perl subroutines to implement LDAP operations.
1559 This backend executes external programs to implement LDAP operations.
1560 It is is primarily intended to be used in prototypes.
1563 This backend is experimental.
1564 It services LDAP requests from an SQL database.
1567 This backend is experimental.
1570 interpreter into slapd.
1571 It runs Tcl commands to implement LDAP operations.
1574 Here is a short example of a configuration file:
1578 include SYSCONFDIR/schema/core.schema
1579 pidfile LOCALSTATEDIR/slapd.pid
1581 # Subtypes of "name" (e.g. "cn" and "ou") with the
1582 # option ";x-hidden" can be searched for/compared,
1583 # but are not shown. See \fBslapd.access\fP(5).
1584 attributeoptions x-hidden lang-
1585 access to attr=name;x-hidden by * =cs
1588 suffix "dc=our-domain,dc=com"
1589 # The database directory MUST exist prior to
1590 # running slapd AND should only be accessible
1591 # by the slapd/tools. Mode 0700 recommended.
1592 directory LOCALSTATEDIR/openldap-data
1593 # Indices to maintain
1594 index objectClass eq
1595 index cn,sn,mail pres,eq,approx,sub
1597 # We serve small clients that do not handle referrals,
1598 # so handle remote lookups on their behalf.
1601 uri ldap://ldap.some-server.com/
1606 "OpenLDAP Administrator's Guide" contains a longer annotated
1607 example of a configuration file.
1608 The original ETCDIR/slapd.conf is another example.
1612 default slapd configuration file
1616 .BR slapd-dnssrv (5),
1620 .BR slapd-monitor (5),
1622 .BR slapd-passwd (5),
1624 .BR slapd-shell (5),
1627 .BR slapd.access (5),
1628 .BR slapd.plugin (5),
1629 .BR slapd.replog (5),
1641 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1642 .SH ACKNOWLEDGEMENTS
1644 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1646 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob