| blob | a6bb8e048fbcb27099b516f0cfd9dc3b9ebb14d9 |
1 .TH SLAPD.CONF 5 "2008/07/16" "OpenLDAP 2.4.11"
2 .\" Copyright 1998-2008 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
4 .\" $OpenLDAP: pkg/ldap/doc/man/man5/slapd.conf.5,v 1.239.2.18 2008/05/29 22:54:56 quanah Exp $
5 .SH NAME
6 slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
7 .SH SYNOPSIS
8 /etc/openldap/slapd.conf
9 .SH DESCRIPTION
10 The file
11 .B /etc/openldap/slapd.conf
12 contains configuration information for the
13 .BR slapd (8)
14 daemon. This configuration file is also used by the SLAPD tools
15 .BR slapacl (8),
16 .BR slapadd (8),
17 .BR slapauth (8),
18 .BR slapcat (8),
19 .BR slapdn (8),
20 .BR slapindex (8),
21 and
22 .BR slaptest (8).
23 .LP
24 The
25 .B slapd.conf
26 file consists of a series of global configuration options that apply to
27 .B slapd
28 as a whole (including all backends), followed by zero or more database
29 backend definitions that contain information specific to a backend
30 instance.
31 The configuration options are case-insensitive;
32 their value, on a case by case basis, may be case-sensitive.
33 .LP
34 The general format of
35 .B slapd.conf
36 is as follows:
37 .LP
38 .nf
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
45 ...
46 .fi
47 .LP
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
51 .B slapd.conf
52 file is used).
53 .LP
54 If a line begins with white space, it is considered a continuation
55 of the previous line. No physical line should be over 2000 bytes
56 long.
57 .LP
58 Blank lines and comment lines beginning with
59 a `#' character are ignored. Note: continuation lines are unwrapped
60 before comment processing is applied.
61 .LP
62 Arguments on configuration lines are separated by white space. If an
63 argument contains white space, the argument should be enclosed in
64 double quotes. If an argument contains a double quote (`"') or a
65 backslash character (`\\'), the character should be preceded by a
66 backslash character.
67 .LP
68 The specific configuration options available are discussed below in the
69 Global Configuration Options, General Backend Options, and General Database
70 Options. Backend-specific options are discussed in the
71 .B slapd-<backend>(5)
72 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
73 details on the slapd configuration file.
74 .SH GLOBAL CONFIGURATION OPTIONS
75 Options described in this section apply to all backends, unless specifically
76 overridden in a backend definition. Arguments that should be replaced by
77 actual text are shown in brackets <>.
78 .TP
79 .B access to <what> "[ by <who> <access> <control> ]+"
80 Grant access (specified by <access>) to a set of entries and/or
81 attributes (specified by <what>) by one or more requestors (specified
82 by <who>).
83 If no access controls are present, the default policy
84 allows anyone and everyone to read anything but restricts
85 updates to rootdn. (e.g., "access to * by * read").
86 The rootdn can always read and write EVERYTHING!
87 See
88 .BR slapd.access (5)
89 and the "OpenLDAP's Administrator's Guide" for details.
90 .TP
91 .B allow <features>
92 Specify a set of features (separated by white space) to
93 allow (default none).
94 .B bind_v2
95 allows acceptance of LDAPv2 bind requests. Note that
96 .BR slapd (8)
97 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
98 .B bind_anon_cred
99 allows anonymous bind when credentials are not empty (e.g.
100 when DN is empty).
101 .B bind_anon_dn
102 allows unauthenticated (anonymous) bind when DN is not empty.
103 .B update_anon
104 allows unauthenticated (anonymous) update operations to be processed
105 (subject to access controls and other administrative limits).
106 .B proxy_authz_anon
107 allows unauthenticated (anonymous) proxy authorization control to be processed
108 (subject to access controls, authorization and other administrative limits).
109 .TP
110 .B argsfile <filename>
111 The ( absolute ) name of a file that will hold the
112 .B slapd
113 server's command line options
114 if started without the debugging command line option.
115 .TP
116 .B attributeoptions [option-name]...
117 Define tagging attribute options or option tag/range prefixes.
118 Options must not end with `-', prefixes must end with `-'.
119 The `lang-' prefix is predefined.
120 If you use the
121 .B attributeoptions
122 directive, `lang-' will no longer be defined and you must specify it
123 explicitly if you want it defined.
125 An attribute description with a tagging option is a subtype of that
126 attribute description without the option.
127 Except for that, options defined this way have no special semantics.
128 Prefixes defined this way work like the `lang-' options:
129 They define a prefix for tagging options starting with the prefix.
130 That is, if you define the prefix `x-foo-', you can use the option
131 `x-foo-bar'.
132 Furthermore, in a search or compare, a prefix or range name (with
133 a trailing `-') matches all options starting with that name, as well
134 as the option with the range name sans the trailing `-'.
135 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
137 RFC 4520 reserves options beginning with `x-' for private experiments.
138 Other options should be registered with IANA, see RFC 4520 section 3.5.
139 OpenLDAP also has the `binary' option built in, but this is a transfer
140 option, not a tagging option.
141 .HP
142 .hy 0
143 .B attributetype "(\ <oid>\
144 [NAME\ <name>]\
145 [DESC\ <description>]\
146 [OBSOLETE]\
147 [SUP\ <oid>]\
148 [EQUALITY\ <oid>]\
149 [ORDERING\ <oid>]\
150 [SUBSTR\ <oid>]\
151 [SYNTAX\ <oidlen>]\
152 [SINGLE\-VALUE]\
153 [COLLECTIVE]\
154 [NO\-USER\-MODIFICATION]\
155 [USAGE\ <attributeUsage>]\ )"
156 .RS
157 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
158 The slapd parser extends the RFC 4512 definition by allowing string
159 forms as well as numeric OIDs to be used for the attribute OID and
160 attribute syntax OID.
161 (See the
162 .B objectidentifier
163 description.)
164 .RE
165 .TP
166 .B authz-policy <policy>
167 Used to specify which rules to use for Proxy Authorization. Proxy
168 authorization allows a client to authenticate to the server using one
169 user's credentials, but specify a different identity to use for authorization
170 and access control purposes. It essentially allows user A to login as user
171 B, using user A's password.
172 The
173 .B none
174 flag disables proxy authorization. This is the default setting.
175 The
176 .B from
177 flag will use rules in the
178 .I authzFrom
179 attribute of the authorization DN.
180 The
181 .B to
182 flag will use rules in the
183 .I authzTo
184 attribute of the authentication DN.
185 The
186 .B any
187 flag, an alias for the deprecated value of
188 .BR both ,
189 will allow any of the above, whatever succeeds first (checked in
190 .BR to ,
191 .B from
192 sequence.
193 The
194 .B all
195 flag requires both authorizations to succeed.
196 .LP
197 .RS
198 The rules are mechanisms to specify which identities are allowed
199 to perform proxy authorization.
200 The
201 .I authzFrom
202 attribute in an entry specifies which other users
203 are allowed to proxy login to this entry. The
204 .I authzTo
205 attribute in
206 an entry specifies which other users this user can authorize as. Use of
207 .I authzTo
208 rules can be easily
209 abused if users are allowed to write arbitrary values to this attribute.
210 In general the
211 .I authzTo
212 attribute must be protected with ACLs such that
213 only privileged users can modify it.
214 The value of
215 .I authzFrom
216 and
217 .I authzTo
218 describes an
219 .B identity
220 or a set of identities; it can take five forms:
221 .RS
222 .TP
223 .B ldap:///<base>??[<scope>]?<filter>
224 .RE
225 .RS
226 .B dn[.<dnstyle>]:<pattern>
227 .RE
228 .RS
229 .B u[<mech>[<realm>]]:<pattern>
230 .RE
231 .RS
232 .B group[/objectClass[/attributeType]]:<pattern>
233 .RE
234 .RS
235 .B <pattern>
236 .RE
237 .RS
239 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
241 .RE
242 The first form is a valid LDAP
243 .B URI
244 where the
245 .IR <host>:<port> ,
246 the
247 .I <attrs>
248 and the
249 .I <extensions>
250 portions must be absent, so that the search occurs locally on either
251 .I authzFrom
252 or
253 .IR authzTo .
254 The second form is a
255 .BR DN ,
256 with the optional style modifiers
257 .IR exact ,
258 .IR onelevel ,
259 .IR children ,
260 and
261 .I subtree
262 for exact, onelevel, children and subtree matches, which cause
263 .I <pattern>
264 to be normalized according to the DN normalization rules, or the special
265 .I regex
266 style, which causes the
267 .I <pattern>
268 to be treated as a POSIX (''extended'') regular expression, as
269 discussed in
270 .BR regex (7)
271 and/or
272 .BR re_format (7).
273 A pattern of
274 .I *
275 means any non-anonymous DN.
276 The third form is a SASL
277 .BR id ,
278 with the optional fields
279 .I <mech>
280 and
281 .I <realm>
282 that allow to specify a SASL
283 .BR mechanism ,
284 and eventually a SASL
285 .BR realm ,
286 for those mechanisms that support one.
287 The need to allow the specification of a mechanism is still debated,
288 and users are strongly discouraged to rely on this possibility.
289 The fourth form is a group specification, consisting of the keyword
290 .BR group ,
291 optionally followed by the specification of the group
292 .B objectClass
293 and member
294 .BR attributeType .
295 The group with DN
296 .B <pattern>
297 is searched with base scope, and in case of match, the values of the
298 member
299 .B attributeType
300 are searched for the asserted DN.
301 For backwards compatibility, if no identity type is provided, i.e. only
302 .B <pattern>
303 is present, an
304 .I exact DN
305 is assumed; as a consequence,
306 .B <pattern>
307 is subjected to DN normalization.
308 Since the interpretation of
309 .I authzFrom
310 and
311 .I authzTo
312 can impact security, users are strongly encouraged
313 to explicitly set the type of identity specification that is being used.
314 A subset of these rules can be used as third arg in the
315 .B authz-regexp
316 statement (see below); significantly, the
317 .I URI
318 and the
319 .I dn.exact:<dn>
320 forms.
321 .RE
322 .TP
323 .B authz-regexp <match> <replace>
324 Used by the authentication framework to convert simple user names,
325 such as provided by SASL subsystem, to an LDAP DN used for
326 authorization purposes. Note that the resultant DN need not refer
327 to an existing entry to be considered valid. When an authorization
328 request is received from the SASL subsystem, the SASL
329 .BR USERNAME ,
330 .BR REALM ,
331 and
332 .B MECHANISM
333 are taken, when available, and combined into a name of the form
334 .RS
335 .RS
336 .TP
337 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
339 .RE
340 This name is then compared against the
341 .B match
342 POSIX (''extended'') regular expression, and if the match is successful,
343 the name is replaced with the
344 .B replace
345 string. If there are wildcard strings in the
346 .B match
347 regular expression that are enclosed in parenthesis, e.g.
348 .RS
349 .TP
350 .B UID=([^,]*),CN=.*
352 .RE
353 then the portion of the name that matched the wildcard will be stored
354 in the numbered placeholder variable $1. If there are other wildcard strings
355 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
356 placeholders can then be used in the
357 .B replace
358 string, e.g.
359 .RS
360 .TP
361 .B UID=$1,OU=Accounts,DC=example,DC=com
363 .RE
364 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
365 or an LDAP URI.
366 If the latter, the server will use the URI to search its own database(s)
367 and, if the search returns exactly one entry, the name is
368 replaced by the DN of that entry. The LDAP URI must have no
369 hostport, attrs, or extensions components, but the filter is mandatory,
370 e.g.
371 .RS
372 .TP
373 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
375 .RE
376 The protocol portion of the URI must be strictly
377 .BR ldap .
378 Note that this search is subject to access controls. Specifically,
379 the authentication identity must have "auth" access in the subject.
381 Multiple
382 .B authz-regexp
383 options can be given in the configuration file to allow for multiple matching
384 and replacement patterns. The matching patterns are checked in the order they
385 appear in the file, stopping at the first successful match.
387 .\".B Caution:
388 .\"Because the plus sign + is a character recognized by the regular expression engine,
389 .\"and it will appear in names that include a REALM, be careful to escape the
390 .\"plus sign with a backslash \\+ to remove the character's special meaning.
391 .RE
392 .TP
393 .B concurrency <integer>
394 Specify a desired level of concurrency. Provided to the underlying
395 thread system as a hint. The default is not to provide any hint.
396 .TP
397 .B conn_max_pending <integer>
398 Specify the maximum number of pending requests for an anonymous session.
399 If requests are submitted faster than the server can process them, they
400 will be queued up to this limit. If the limit is exceeded, the session
401 is closed. The default is 100.
402 .TP
403 .B conn_max_pending_auth <integer>
404 Specify the maximum number of pending requests for an authenticated session.
405 The default is 1000.
406 .TP
407 .B defaultsearchbase <dn>
408 Specify a default search base to use when client submits a
409 non-base search request with an empty base DN.
410 Base scoped search requests with an empty base DN are not affected.
411 .TP
412 .B disallow <features>
413 Specify a set of features (separated by white space) to
414 disallow (default none).
415 .B bind_anon
416 disables acceptance of anonymous bind requests. Note that this setting
417 does not prohibit anonymous directory access (See "require authc").
418 .B bind_simple
419 disables simple (bind) authentication.
420 .B tls_2_anon
421 disables forcing session to anonymous status (see also
422 .BR tls_authc )
423 upon StartTLS operation receipt.
424 .B tls_authc
425 disallows the StartTLS operation if authenticated (see also
426 .BR tls_2_anon ).
427 .HP
428 .hy 0
429 .B ditcontentrule "(\ <oid>\
430 [NAME\ <name>]\
431 [DESC\ <description>]\
432 [OBSOLETE]\
433 [AUX\ <oids>]\
434 [MUST\ <oids>]\
435 [MAY\ <oids>]\
436 [NOT\ <oids>]\ )"
437 .RS
438 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
439 The slapd parser extends the RFC 4512 definition by allowing string
440 forms as well as numeric OIDs to be used for the attribute OID and
441 attribute syntax OID.
442 (See the
443 .B objectidentifier
444 description.)
445 .RE
446 .TP
447 .B gentlehup { on | off }
448 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
449 .B Slapd
450 will stop listening for new connections, but will not close the
451 connections to the current clients. Future write operations return
452 unwilling-to-perform, though. Slapd terminates when all clients
453 have closed their connections (if they ever do), or \- as before \-
454 if it receives a SIGTERM signal. This can be useful if you wish to
455 terminate the server and start a new
456 .B slapd
457 server
458 .B with another database,
459 without disrupting the currently active clients.
460 The default is off. You may wish to use
461 .B idletimeout
462 along with this option.
463 .TP
464 .B idletimeout <integer>
465 Specify the number of seconds to wait before forcibly closing
466 an idle client connection. A idletimeout of 0 disables this
467 feature. The default is 0.
468 .TP
469 .B include <filename>
470 Read additional configuration information from the given file before
471 continuing with the next line of the current file.
472 .TP
473 .B index_intlen <integer>
474 Specify the key length for ordered integer indices. The most significant
475 bytes of the binary integer will be used for index keys. The default
476 value is 4, which provides exact indexing for 31 bit values.
477 A floating point representation is used to index too large values.
478 .TP
479 .B index_substr_if_minlen <integer>
480 Specify the minimum length for subinitial and subfinal indices. An
481 attribute value must have at least this many characters in order to be
482 processed by the indexing functions. The default is 2.
483 .TP
484 .B index_substr_if_maxlen <integer>
485 Specify the maximum length for subinitial and subfinal indices. Only
486 this many characters of an attribute value will be processed by the
487 indexing functions; any excess characters are ignored. The default is 4.
488 .TP
489 .B index_substr_any_len <integer>
490 Specify the length used for subany indices. An attribute value must have
491 at least this many characters in order to be processed. Attribute values
492 longer than this length will be processed in segments of this length. The
493 default is 4. The subany index will also be used in subinitial and
494 subfinal index lookups when the filter string is longer than the
495 .I index_substr_if_maxlen
496 value.
497 .TP
498 .B index_substr_any_step <integer>
499 Specify the steps used in subany index lookups. This value sets the offset
500 for the segments of a filter string that are processed for a subany index
501 lookup. The default is 2. For example, with the default values, a search
502 using this filter "cn=*abcdefgh*" would generate index lookups for
503 "abcd", "cdef", and "efgh".
505 .LP
506 Note: Indexing support depends on the particular backend in use. Also,
507 changing these settings will generally require deleting any indices that
508 depend on these parameters and recreating them with
509 .BR slapindex (8).
511 .TP
512 .B localSSF <SSF>
513 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
514 such as those to the ldapi:// listener. For a description of SSF values,
515 see
516 .BR sasl-secprops 's
517 .B minssf
518 option description. The default is 71.
519 .TP
520 .B logfile <filename>
521 Specify a file for recording debug log messages. By default these messages
522 only go to stderr and are not recorded anywhere else. Specifying a logfile
523 copies messages to both stderr and the logfile.
524 .TP
525 .B loglevel <integer> [...]
526 Specify the level at which debugging statements and operation
527 statistics should be syslogged (currently logged to the
528 .BR syslogd (8)
529 LOG_LOCAL4 facility).
530 They must be considered subsystems rather than increasingly verbose
531 log levels.
532 Some messages with higher priority are logged regardless
533 of the configured loglevel as soon as any logging is configured.
534 Log levels are additive, and available levels are:
535 .RS
536 .RS
537 .PD 0
538 .TP
539 .B 1
540 .B (0x1 trace)
541 trace function calls
542 .TP
543 .B 2
544 .B (0x2 packets)
545 debug packet handling
546 .TP
547 .B 4
548 .B (0x4 args)
549 heavy trace debugging (function args)
550 .TP
551 .B 8
552 .B (0x8 conns)
553 connection management
554 .TP
555 .B 16
556 .B (0x10 BER)
557 print out packets sent and received
558 .TP
559 .B 32
560 .B (0x20 filter)
561 search filter processing
562 .TP
563 .B 64
564 .B (0x40 config)
565 configuration file processing
566 .TP
567 .B 128
568 .B (0x80 ACL)
569 access control list processing
570 .TP
571 .B 256
572 .B (0x100 stats)
573 connections, LDAP operations, results (recommended)
574 .TP
575 .B 512
576 .B (0x200 stats2)
577 stats log entries sent
578 .TP
579 .B 1024
580 .B (0x400 shell)
581 print communication with shell backends
582 .TP
583 .B 2048
584 .B (0x800 parse)
585 entry parsing
586 \".TP
587 \".B 4096
588 \".B (0x1000 cache)
589 \"caching (unused)
590 \".TP
591 \".B 8192
592 \".B (0x2000 index)
593 \"data indexing (unused)
594 .TP
595 .B 16384
596 .B (0x4000 sync)
597 LDAPSync replication
598 .TP
599 .B 32768
600 .B (0x8000 none)
601 only messages that get logged whatever log level is set
602 .PD
603 .RE
604 The desired log level can be input as a single integer that combines
605 the (ORed) desired levels, both in decimal or in hexadecimal notation,
606 as a list of integers (that are ORed internally),
607 or as a list of the names that are shown between brackets, such that
608 .LP
609 .nf
610 loglevel 129
611 loglevel 0x81
612 loglevel 128 1
613 loglevel 0x80 0x1
614 loglevel acl trace
615 .fi
616 .LP
617 are equivalent.
618 The keyword
619 .B any
620 can be used as a shortcut to enable logging at all levels (equivalent to -1).
621 The keyword
622 .BR none ,
623 or the equivalent integer representation, causes those messages
624 that are logged regardless of the configured loglevel to be logged.
625 In fact, if loglevel is set to 0, no logging occurs,
626 so at least the
627 .B none
628 level is required to have high priority messages logged.
630 The loglevel defaults to \fBstats\fP.
631 This level should usually also be included when using other loglevels, to
632 help analyze the logs.
633 .RE
634 .TP
635 .B moduleload <filename>
636 Specify the name of a dynamically loadable module to load. The filename
637 may be an absolute path name or a simple filename. Non-absolute names
638 are searched for in the directories specified by the
639 .B modulepath
640 option. This option and the
641 .B modulepath
642 option are only usable if slapd was compiled with --enable-modules.
643 .TP
644 .B modulepath <pathspec>
645 Specify a list of directories to search for loadable modules. Typically
646 the path is colon-separated but this depends on the operating system.
647 .HP
648 .hy 0
649 .B objectclass "(\ <oid>\
650 [NAME\ <name>]\
651 [DESC\ <description>]\
652 [OBSOLETE]\
653 [SUP\ <oids>]\
654 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
655 [MUST\ <oids>] [MAY\ <oids>] )"
656 .RS
657 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
658 The slapd parser extends the RFC 4512 definition by allowing string
659 forms as well as numeric OIDs to be used for the object class OID.
660 (See the
661 .B
662 objectidentifier
663 description.) Object classes are "STRUCTURAL" by default.
664 .RE
665 .TP
666 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
667 Define a string name that equates to the given OID. The string can be used
668 in place of the numeric OID in objectclass and attribute definitions. The
669 name can also be used with a suffix of the form ":xx" in which case the
670 value "oid.xx" will be used.
671 .TP
672 .B password-hash <hash> [<hash>...]
673 This option configures one or more hashes to be used in generation of user
674 passwords stored in the userPassword attribute during processing of
675 LDAP Password Modify Extended Operations (RFC 3062).
676 The <hash> must be one of
677 .BR {SSHA} ,
678 .BR {SHA} ,
679 .BR {SMD5} ,
680 .BR {MD5} ,
681 .BR {CRYPT} ,
682 and
683 .BR {CLEARTEXT} .
684 The default is
685 .BR {SSHA} .
687 .B {SHA}
688 and
689 .B {SSHA}
690 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
692 .B {MD5}
693 and
694 .B {SMD5}
695 use the MD5 algorithm (RFC 1321), the latter with a seed.
697 .B {CRYPT}
698 uses the
699 .BR crypt (3).
701 .B {CLEARTEXT}
702 indicates that the new password should be
703 added to userPassword as clear text.
705 Note that this option does not alter the normal user applications
706 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
707 .TP
708 .B password\-crypt\-salt\-format <format>
709 Specify the format of the salt passed to
710 .BR crypt (3)
711 when generating {CRYPT} passwords (see
712 .BR password\-hash )
713 during processing of LDAP Password Modify Extended Operations (RFC 3062).
715 This string needs to be in
716 .BR sprintf (3)
717 format and may include one (and only one) %s conversion.
718 This conversion will be substituted with a string of random
719 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
720 provides a two character salt and "$1$%.8s" tells some
721 versions of crypt(3) to use an MD5 algorithm and provides
722 8 random characters of salt. The default is "%s", which
723 provides 31 characters of salt.
724 .TP
725 .B pidfile <filename>
726 The ( absolute ) name of a file that will hold the
727 .B slapd
728 server's process ID ( see
729 .BR getpid (2)
730 ) if started without the debugging command line option.
731 .TP
732 .B referral <url>
733 Specify the referral to pass back when
734 .BR slapd (8)
735 cannot find a local database to handle a request.
736 If specified multiple times, each url is provided.
737 .TP
738 .B require <conditions>
739 Specify a set of conditions (separated by white space) to
740 require (default none).
741 The directive may be specified globally and/or per-database;
742 databases inherit global conditions, so per-database specifications
743 are additive.
744 .B bind
745 requires bind operation prior to directory operations.
746 .B LDAPv3
747 requires session to be using LDAP version 3.
748 .B authc
749 requires authentication prior to directory operations.
750 .B SASL
751 requires SASL authentication prior to directory operations.
752 .B strong
753 requires strong authentication prior to directory operations.
754 The strong keyword allows protected "simple" authentication
755 as well as SASL authentication.
756 .B none
757 may be used to require no conditions (useful to clear out globally
758 set conditions within a particular database); it must occur first
759 in the list of conditions.
760 .TP
761 .B reverse-lookup on | off
762 Enable/disable client name unverified reverse lookup (default is
763 .BR off
764 if compiled with --enable-rlookups).
765 .TP
766 .B rootDSE <file>
767 Specify the name of an LDIF(5) file containing user defined attributes
768 for the root DSE. These attributes are returned in addition to the
769 attributes normally produced by slapd.
771 The root DSE is an entry with information about the server and its
772 capabilities, in operational attributes.
773 It has the empty DN, and can be read with e.g.:
774 .ti +4
775 ldapsearch -x -b "" -s base "+"
776 .br
777 See RFC 4512 section 5.1 for details.
778 .TP
779 .B sasl-host <fqdn>
780 Used to specify the fully qualified domain name used for SASL processing.
781 .TP
782 .B sasl-realm <realm>
783 Specify SASL realm. Default is empty.
784 .TP
785 .B sasl-secprops <properties>
786 Used to specify Cyrus SASL security properties.
787 The
788 .B none
789 flag (without any other properties) causes the flag properties
790 default, "noanonymous,noplain", to be cleared.
791 The
792 .B noplain
793 flag disables mechanisms susceptible to simple passive attacks.
794 The
795 .B noactive
796 flag disables mechanisms susceptible to active attacks.
797 The
798 .B nodict
799 flag disables mechanisms susceptible to passive dictionary attacks.
800 The
801 .B noanonymous
802 flag disables mechanisms which support anonymous login.
803 The
804 .B forwardsec
805 flag require forward secrecy between sessions.
806 The
807 .B passcred
808 require mechanisms which pass client credentials (and allow
809 mechanisms which can pass credentials to do so).
810 The
811 .B minssf=<factor>
812 property specifies the minimum acceptable
813 .I security strength factor
814 as an integer approximate to effective key length used for
815 encryption. 0 (zero) implies no protection, 1 implies integrity
816 protection only, 56 allows DES or other weak ciphers, 112
817 allows triple DES and other strong ciphers, 128 allows RC4,
818 Blowfish and other modern strong ciphers. The default is 0.
819 The
820 .B maxssf=<factor>
821 property specifies the maximum acceptable
822 .I security strength factor
823 as an integer (see minssf description). The default is INT_MAX.
824 The
825 .B maxbufsize=<size>
826 property specifies the maximum security layer receive buffer
827 size allowed. 0 disables security layers. The default is 65536.
828 .TP
829 .B schemadn <dn>
830 Specify the distinguished name for the subschema subentry that
831 controls the entries on this server. The default is "cn=Subschema".
832 .TP
833 .B security <factors>
834 Specify a set of security strength factors (separated by white space)
835 to require (see
836 .BR sasl-secprops 's
837 .B minssf
838 option for a description of security strength factors).
839 The directive may be specified globally and/or per-database.
840 .B ssf=<n>
841 specifies the overall security strength factor.
842 .B transport=<n>
843 specifies the transport security strength factor.
844 .B tls=<n>
845 specifies the TLS security strength factor.
846 .B sasl=<n>
847 specifies the SASL security strength factor.
848 .B update_ssf=<n>
849 specifies the overall security strength factor to require for
850 directory updates.
851 .B update_transport=<n>
852 specifies the transport security strength factor to require for
853 directory updates.
854 .B update_tls=<n>
855 specifies the TLS security strength factor to require for
856 directory updates.
857 .B update_sasl=<n>
858 specifies the SASL security strength factor to require for
859 directory updates.
860 .B simple_bind=<n>
861 specifies the security strength factor required for
862 .I simple
863 username/password authentication.
864 Note that the
865 .B transport
866 factor is measure of security provided by the underlying transport,
867 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
868 .TP
869 .B serverID <integer> [<URL>]
870 Specify an integer ID from 0 to 4095 for this server (limited
871 to 3 hexadecimal digits).
872 These IDs are
873 required when using multimaster replication and each master must have a
874 unique ID. Note that this requirement also applies to separate masters
875 contributing to a glued set of databases.
876 If the URL is provided, this directive may be specified
877 multiple times, providing a complete list of participating servers
878 and their IDs. The fully qualified hostname of each server should be
879 used in the supplied URLs. The IDs are used in the "replica id" field
880 of all CSNs generated by the specified server. The default value is zero.
881 Example:
882 .LP
883 .nf
884 serverID 1
885 .fi
886 .TP
887 .B sizelimit {<integer>|unlimited}
888 .TP
889 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
890 Specify the maximum number of entries to return from a search operation.
891 The default size limit is 500.
892 Use
893 .B unlimited
894 to specify no limits.
895 The second format allows a fine grain setting of the size limits.
896 Extra args can be added on the same line.
897 See
898 .BR limits
899 for an explanation of the different flags.
900 .TP
901 .B sockbuf_max_incoming <integer>
902 Specify the maximum incoming LDAP PDU size for anonymous sessions.
903 The default is 262143.
904 .TP
905 .B sockbuf_max_incoming_auth <integer>
906 Specify the maximum incoming LDAP PDU size for authenticated sessions.
907 The default is 4194303.
908 .TP
909 .B sortvals <attr> [...]
910 Specify a list of multi-valued attributes whose values will always
911 be maintained in sorted order. Using this option will allow Modify,
912 Compare, and filter evaluations on these attributes to be performed
913 more efficiently. The resulting sort order depends on the
914 attributes' syntax and matching rules and may not correspond to
915 lexical order or any other recognizable order.
916 .TP
917 .B threads <integer>
918 Specify the maximum size of the primary thread pool.
919 The default is 16; the minimum value is 2.
920 .TP
921 .B timelimit {<integer>|unlimited}
922 .TP
923 .B timelimit time[.{soft|hard}]=<integer> [...]
924 Specify the maximum number of seconds (in real time)
925 .B slapd
926 will spend answering a search request. The default time limit is 3600.
927 Use
928 .B unlimited
929 to specify no limits.
930 The second format allows a fine grain setting of the time limits.
931 Extra args can be added on the same line.
932 See
933 .BR limits
934 for an explanation of the different flags.
935 .TP
936 .B tool-threads <integer>
937 Specify the maximum number of threads to use in tool mode.
938 This should not be greater than the number of CPUs in the system.
939 The default is 1.
940 .\"ucdata-path is obsolete / ignored...
941 .\".TP
942 .\".B ucdata-path <path>
943 .\"Specify the path to the directory containing the Unicode character
944 .\"tables. The default path is /usr/share/openldap/ucdata.
945 .SH TLS OPTIONS
946 If
947 .B slapd
948 is built with support for Transport Layer Security, there are more options
949 you can specify.
950 .TP
951 .B TLSCipherSuite <cipher-suite-spec>
952 Permits configuring what ciphers will be accepted and the preference order.
953 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
955 TLSCipherSuite HIGH:MEDIUM:+SSLv2
957 To check what ciphers a given spec selects, use:
959 .nf
960 openssl ciphers -v <cipher-suite-spec>
961 .fi
963 To obtain the list of ciphers in GNUtls use:
965 .nf
966 gnutls-cli -l
967 .fi
969 .TP
970 .B TLSCACertificateFile <filename>
971 Specifies the file that contains certificates for all of the Certificate
972 Authorities that
973 .B slapd
974 will recognize.
975 .TP
976 .B TLSCACertificatePath <path>
977 Specifies the path of a directory that contains Certificate Authority
978 certificates in separate individual files. Usually only one of this
979 or the TLSCACertificateFile is used. This directive is not supported
980 when using GNUtls.
981 .TP
982 .B TLSCertificateFile <filename>
983 Specifies the file that contains the
984 .B slapd
985 server certificate.
986 .TP
987 .B TLSCertificateKeyFile <filename>
988 Specifies the file that contains the
989 .B slapd
990 server private key that matches the certificate stored in the
991 .B TLSCertificateFile
992 file. Currently, the private key must not be protected with a password, so
993 it is of critical importance that it is protected carefully.
994 .TP
995 .B TLSDHParamFile <filename>
996 This directive specifies the file that contains parameters for Diffie-Hellman
997 ephemeral key exchange. This is required in order to use a DSA certificate on
998 the server. If multiple sets of parameters are present in the file, all of
999 them will be processed. Note that setting this option may also enable
1000 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
1001 You should append "!ADH" to your cipher suites if you have changed them
1002 from the default, otherwise no certificate exchanges or verification will
1003 be done. When using GNUtls these parameters are always generated randomly so
1004 this directive is ignored.
1005 .TP
1006 .B TLSRandFile <filename>
1007 Specifies the file to obtain random bits from when /dev/[u]random
1008 is not available. Generally set to the name of the EGD/PRNGD socket.
1009 The environment variable RANDFILE can also be used to specify the filename.
1010 This directive is ignored with GNUtls.
1011 .TP
1012 .B TLSVerifyClient <level>
1013 Specifies what checks to perform on client certificates in an
1014 incoming TLS session, if any.
1015 The
1016 .B <level>
1017 can be specified as one of the following keywords:
1018 .RS
1019 .TP
1020 .B never
1021 This is the default.
1022 .B slapd
1023 will not ask the client for a certificate.
1024 .TP
1025 .B allow
1026 The client certificate is requested. If no certificate is provided,
1027 the session proceeds normally. If a bad certificate is provided,
1028 it will be ignored and the session proceeds normally.
1029 .TP
1030 .B try
1031 The client certificate is requested. If no certificate is provided,
1032 the session proceeds normally. If a bad certificate is provided,
1033 the session is immediately terminated.
1034 .TP
1035 .B demand | hard | true
1036 These keywords are all equivalent, for compatibility reasons.
1037 The client certificate is requested. If no certificate is provided,
1038 or a bad certificate is provided, the session is immediately terminated.
1040 Note that a valid client certificate is required in order to use the
1041 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1042 a non-default
1043 .B TLSVerifyClient
1044 setting must be chosen to enable SASL EXTERNAL authentication.
1045 .RE
1046 .TP
1047 .B TLSCRLCheck <level>
1048 Specifies if the Certificate Revocation List (CRL) of the CA should be
1049 used to verify if the client certificates have not been revoked. This
1050 requires
1051 .B TLSCACertificatePath
1052 parameter to be set. This directive is ignored with GNUtls.
1053 .B <level>
1054 can be specified as one of the following keywords:
1055 .RS
1056 .TP
1057 .B none
1058 No CRL checks are performed
1059 .TP
1060 .B peer
1061 Check the CRL of the peer certificate
1062 .TP
1063 .B all
1064 Check the CRL for a whole certificate chain
1065 .RE
1066 .TP
1067 .B TLSCRLFile <filename>
1068 Specifies a file containing a Certificate Revocation List to be used
1069 for verifying that certificates have not been revoked. This directive is
1070 only valid when using GNUtls.
1071 .SH GENERAL BACKEND OPTIONS
1072 Options in this section only apply to the configuration file section
1073 for the specified backend. They are supported by every
1074 type of backend.
1075 .TP
1076 .B backend <databasetype>
1077 Mark the beginning of a backend definition. <databasetype>
1078 should be one of
1079 .BR bdb ,
1080 .BR config ,
1081 .BR dnssrv ,
1082 .BR hdb ,
1083 .BR ldap ,
1084 .BR ldif ,
1085 .BR meta ,
1086 .BR monitor ,
1087 .BR null ,
1088 .BR passwd ,
1089 .BR perl ,
1090 .BR relay ,
1091 .BR shell ,
1092 or
1093 .BR sql ,
1094 depending on which backend will serve the database.
1096 .SH GENERAL DATABASE OPTIONS
1097 Options in this section only apply to the configuration file section
1098 for the database in which they are defined. They are supported by every
1099 type of backend. Note that the
1100 .B database
1101 and at least one
1102 .B suffix
1103 option are mandatory for each database.
1104 .TP
1105 .B database <databasetype>
1106 Mark the beginning of a new database instance definition. <databasetype>
1107 should be one of
1108 .BR bdb ,
1109 .BR config ,
1110 .BR dnssrv ,
1111 .BR hdb ,
1112 .BR ldap ,
1113 .BR ldif ,
1114 .BR meta ,
1115 .BR monitor ,
1116 .BR null ,
1117 .BR passwd ,
1118 .BR perl ,
1119 .BR relay ,
1120 .BR shell ,
1121 or
1122 .BR sql ,
1123 depending on which backend will serve the database.
1124 .TP
1125 .B hidden on | off
1126 Controls whether the database will be used to answer
1127 queries. A database that is hidden will never be
1128 selected to answer any queries, and any suffix configured
1129 on the database will be ignored in checks for conflicts
1130 with other databases. By default, hidden is off.
1131 .TP
1132 .B lastmod on | off
1133 Controls whether
1134 .B slapd
1135 will automatically maintain the
1136 modifiersName, modifyTimestamp, creatorsName, and
1137 createTimestamp attributes for entries. It also controls
1138 the entryCSN and entryUUID attributes, which are needed
1139 by the syncrepl provider. By default, lastmod is on.
1140 .TP
1141 .B limits <who> <limit> [<limit> [...]]
1142 Specify time and size limits based on who initiated an operation.
1143 The argument
1144 .B who
1145 can be any of
1146 .RS
1147 .RS
1148 .TP
1149 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1151 .RE
1152 with
1153 .RS
1154 .TP
1155 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1157 .RE
1158 The term
1159 .B anonymous
1160 matches all unauthenticated clients.
1161 The term
1162 .B users
1163 matches all authenticated clients;
1164 otherwise an
1165 .B exact
1166 dn pattern is assumed unless otherwise specified by qualifying
1167 the (optional) key string
1168 .B dn
1169 with
1170 .B exact
1171 or
1172 .B base
1173 (which are synonyms), to require an exact match; with
1174 .BR onelevel ,
1175 to require exactly one level of depth match; with
1176 .BR subtree ,
1177 to allow any level of depth match, including the exact match; with
1178 .BR children ,
1179 to allow any level of depth match, not including the exact match;
1180 .BR regex
1181 explicitly requires the (default) match based on POSIX (''extended'')
1182 regular expression pattern.
1183 Finally,
1184 .B anonymous
1185 matches unbound operations; the
1186 .B pattern
1187 field is ignored.
1188 The same behavior is obtained by using the
1189 .B anonymous
1190 form of the
1191 .B who
1192 clause.
1193 The term
1194 .BR group ,
1195 with the optional objectClass
1196 .B oc
1197 and attributeType
1198 .B at
1199 fields, followed by
1200 .BR pattern ,
1201 sets the limits for any DN listed in the values of the
1202 .B at
1203 attribute (default
1204 .BR member )
1205 of the
1206 .B oc
1207 group objectClass (default
1208 .BR groupOfNames )
1209 whose DN exactly matches
1210 .BR pattern .
1212 The currently supported limits are
1213 .B size
1214 and
1215 .BR time .
1217 The syntax for time limits is
1218 .BR time[.{soft|hard}]=<integer> ,
1219 where
1220 .I integer
1221 is the number of seconds slapd will spend answering a search request.
1222 If no time limit is explicitly requested by the client, the
1223 .BR soft
1224 limit is used; if the requested time limit exceeds the
1225 .BR hard
1226 .\"limit, an
1227 .\".I "Administrative limit exceeded"
1228 .\"error is returned.
1229 limit, the value of the limit is used instead.
1230 If the
1231 .BR hard
1232 limit is set to the keyword
1233 .IR soft ,
1234 the soft limit is used in either case; if it is set to the keyword
1235 .IR unlimited ,
1236 no hard limit is enforced.
1237 Explicit requests for time limits smaller or equal to the
1238 .BR hard
1239 limit are honored.
1240 If no limit specifier is set, the value is assigned to the
1241 .BR soft
1242 limit, and the
1243 .BR hard
1244 limit is set to
1245 .IR soft ,
1246 to preserve the original behavior.
1248 The syntax for size limits is
1249 .BR size[.{soft|hard|unchecked}]=<integer> ,
1250 where
1251 .I integer
1252 is the maximum number of entries slapd will return answering a search
1253 request.
1254 If no size limit is explicitly requested by the client, the
1255 .BR soft
1256 limit is used; if the requested size limit exceeds the
1257 .BR hard
1258 .\"limit, an
1259 .\".I "Administrative limit exceeded"
1260 .\"error is returned.
1261 limit, the value of the limit is used instead.
1262 If the
1263 .BR hard
1264 limit is set to the keyword
1265 .IR soft ,
1266 the soft limit is used in either case; if it is set to the keyword
1267 .IR unlimited ,
1268 no hard limit is enforced.
1269 Explicit requests for size limits smaller or equal to the
1270 .BR hard
1271 limit are honored.
1272 The
1273 .BR unchecked
1274 specifier sets a limit on the number of candidates a search request is allowed
1275 to examine.
1276 The rationale behind it is that searches for non-properly indexed
1277 attributes may result in large sets of candidates, which must be
1278 examined by
1279 .BR slapd (8)
1280 to determine whether they match the search filter or not.
1281 The
1282 .B unchecked
1283 limit provides a means to drop such operations before they are even
1284 started.
1285 If the selected candidates exceed the
1286 .BR unchecked
1287 limit, the search will abort with
1288 .IR "Unwilling to perform" .
1289 If it is set to the keyword
1290 .IR unlimited ,
1291 no limit is applied (the default).
1292 If it is set to
1293 .IR disable ,
1294 the search is not even performed; this can be used to disallow searches
1295 for a specific set of users.
1296 If no limit specifier is set, the value is assigned to the
1297 .BR soft
1298 limit, and the
1299 .BR hard
1300 limit is set to
1301 .IR soft ,
1302 to preserve the original behavior.
1304 In case of no match, the global limits are used.
1305 The default values are the same of
1306 .B sizelimit
1307 and
1308 .BR timelimit ;
1309 no limit is set on
1310 .BR unchecked .
1312 If
1313 .B pagedResults
1314 control is requested, the
1315 .B hard
1316 size limit is used by default, because the request of a specific page size
1317 is considered an explicit request for a limitation on the number
1318 of entries to be returned.
1319 However, the size limit applies to the total count of entries returned within
1320 the search, and not to a single page.
1321 Additional size limits may be enforced; the syntax is
1322 .BR size.pr={<integer>|noEstimate|unlimited} ,
1323 where
1324 .I integer
1325 is the max page size if no explicit limit is set; the keyword
1326 .I noEstimate
1327 inhibits the server from returning an estimate of the total number
1328 of entries that might be returned
1329 (note: the current implementation does not return any estimate).
1330 The keyword
1331 .I unlimited
1332 indicates that no limit is applied to the pagedResults control page size.
1333 The syntax
1334 .B size.prtotal={<integer>|unlimited|disabled}
1335 allows to set a limit on the total number of entries that a pagedResults
1336 control allows to return.
1337 By default it is set to the
1338 .B hard
1339 limit.
1340 When set,
1341 .I integer
1342 is the max number of entries that the whole search with pagedResults control
1343 can return.
1344 Use
1345 .I unlimited
1346 to allow unlimited number of entries to be returned, e.g. to allow
1347 the use of the pagedResults control as a means to circumvent size
1348 limitations on regular searches; the keyword
1349 .I disabled
1350 disables the control, i.e. no paged results can be returned.
1351 Note that the total number of entries returned when the pagedResults control
1352 is requested cannot exceed the
1353 .B hard
1354 size limit of regular searches unless extended by the
1355 .B prtotal
1356 switch.
1358 The \fBlimits\fP statement is typically used to let an unlimited
1359 number of entries be returned by searches performed
1360 with the identity used by the consumer for synchronization purposes
1361 by means of the RFC 4533 LDAP Content Synchronization protocol
1362 (see \fBsyncrepl\fP for details).
1363 .RE
1364 .TP
1365 .B maxderefdepth <depth>
1366 Specifies the maximum number of aliases to dereference when trying to
1367 resolve an entry, used to avoid infinite alias loops. The default is 15.
1368 .TP
1369 .B mirrormode on | off
1370 This option puts a replica database into "mirror" mode. Update
1371 operations will be accepted from any user, not just the updatedn. The
1372 database must already be configured as a syncrepl consumer
1373 before this keyword may be set. This mode also requires a
1374 .B serverID
1375 (see above) to be configured.
1376 By default, mirrormode is off.
1377 .TP
1378 .B monitoring on | off
1379 This option enables database-specific monitoring in the entry related
1380 to the current database in the "cn=Databases,cn=Monitor" subtree
1381 of the monitor database, if the monitor database is enabled.
1382 Currently, only the BDB and the HDB databases provide database-specific
1383 monitoring.
1384 The default depends on the backend type.
1385 .TP
1386 .B overlay <overlay-name>
1387 Add the specified overlay to this database. An overlay is a piece of
1388 code that intercepts database operations in order to extend or change
1389 them. Overlays are pushed onto
1390 a stack over the database, and so they will execute in the reverse
1391 of the order in which they were configured and the database itself
1392 will receive control last of all. See the
1393 .BR slapd.overlays (5)
1394 manual page for an overview of the available overlays.
1395 Note that all of the database's
1396 regular settings should be configured before any overlay settings.
1397 .TP
1398 .B readonly on | off
1399 This option puts the database into "read-only" mode. Any attempts to
1400 modify the database will return an "unwilling to perform" error. By
1401 default, readonly is off.
1402 .TP
1403 .B restrict <oplist>
1404 Specify a whitespace separated list of operations that are restricted.
1405 If defined inside a database specification, restrictions apply only
1406 to that database, otherwise they are global.
1407 Operations can be any of
1408 .BR add ,
1409 .BR bind ,
1410 .BR compare ,
1411 .BR delete ,
1412 .BR extended[=<OID>] ,
1413 .BR modify ,
1414 .BR rename ,
1415 .BR search ,
1416 or the special pseudo-operations
1417 .B read
1418 and
1419 .BR write ,
1420 which respectively summarize read and write operations.
1421 The use of
1422 .I restrict write
1423 is equivalent to
1424 .I readonly on
1425 (see above).
1426 The
1427 .B extended
1428 keyword allows to indicate the OID of the specific operation
1429 to be restricted.
1430 .TP
1431 .B rootdn <dn>
1432 Specify the distinguished name that is not subject to access control
1433 or administrative limit restrictions for operations on this database.
1434 This DN may or may not be associated with an entry. An empty root
1435 DN (the default) specifies no root access is to be granted. It is
1436 recommended that the rootdn only be specified when needed (such as
1437 when initially populating a database). If the rootdn is within
1438 a namingContext (suffix) of the database, a simple bind password
1439 may also be provided using the
1440 .B rootpw
1441 directive. Many optional features, including syncrepl, require the
1442 rootdn to be defined for the database.
1443 .TP
1444 .B rootpw <password>
1445 Specify a password (or hash of the password) for the rootdn. The
1446 password can only be set if the rootdn is within the namingContext
1447 (suffix) of the database.
1448 This option accepts all RFC 2307 userPassword formats known to
1449 the server (see
1450 .B password-hash
1451 description) as well as cleartext.
1452 .BR slappasswd (8)
1453 may be used to generate a hash of a password. Cleartext
1454 and \fB{CRYPT}\fP passwords are not recommended. If empty
1455 (the default), authentication of the root DN is by other means
1456 (e.g. SASL). Use of SASL is encouraged.
1457 .TP
1458 .B suffix <dn suffix>
1459 Specify the DN suffix of queries that will be passed to this
1460 backend database. Multiple suffix lines can be given and at least one is
1461 required for each database definition.
1462 If the suffix of one database is "inside" that of another, the database
1463 with the inner suffix must come first in the configuration file.
1464 .TP
1465 .B subordinate [advertise]
1466 Specify that the current backend database is a subordinate of another
1467 backend database. A subordinate database may have only one suffix. This
1468 option may be used to glue multiple databases into a single namingContext.
1469 If the suffix of the current database is within the namingContext of a
1470 superior database, searches against the superior database will be
1471 propagated to the subordinate as well. All of the databases
1472 associated with a single namingContext should have identical rootdns.
1473 Behavior of other LDAP operations is unaffected by this setting. In
1474 particular, it is not possible to use moddn to move an entry from
1475 one subordinate to another subordinate within the namingContext.
1477 If the optional \fBadvertise\fP flag is supplied, the naming context of
1478 this database is advertised in the root DSE. The default is to hide this
1479 database context, so that only the superior context is visible.
1481 If the slap tools
1482 .BR slapcat (8),
1483 .BR slapadd (8),
1484 or
1485 .BR slapindex (8)
1486 are used on the superior database, any glued subordinates that support
1487 these tools are opened as well.
1489 Databases that are glued together should usually be configured with the
1490 same indices (assuming they support indexing), even for attributes that
1491 only exist in some of these databases. In general, all of the glued
1492 databases should be configured as similarly as possible, since the intent
1493 is to provide the appearance of a single directory.
1495 Note that the \fIsubordinate\fP functionality is implemented internally
1496 by the \fIglue\fP overlay and as such its behavior will interact with other
1497 overlays in use. By default, the glue overlay is automatically configured as
1498 the last overlay on the superior backend. Its position on the backend
1499 can be explicitly configured by setting an \fBoverlay glue\fP directive
1500 at the desired position. This explicit configuration is necessary e.g.
1501 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1502 in order to work over all of the glued databases. E.g.
1503 .RS
1504 .nf
1505 database bdb
1506 suffix dc=example,dc=com
1507 ...
1508 overlay glue
1509 overlay syncprov
1510 .fi
1511 .RE
1512 .HP
1513 .hy 0
1514 .B syncrepl rid=<replica ID>
1515 .B provider=ldap[s]://<hostname>[:port]
1516 .B searchbase=<base DN>
1517 .B [type=refreshOnly|refreshAndPersist]
1518 .B [interval=dd:hh:mm:ss]
1519 .B [retry=[<retry interval> <# of retries>]+]
1520 .B [filter=<filter str>]
1521 .B [scope=sub|one|base|subord]
1522 .B [attrs=<attr list>]
1523 .B [attrsonly]
1524 .B [sizelimit=<limit>]
1525 .B [timelimit=<limit>]
1526 .B [schemachecking=on|off]
1527 .B [network-timeout=<seconds>]
1528 .B [timeout=<seconds>]
1529 .B [bindmethod=simple|sasl]
1530 .B [binddn=<dn>]
1531 .B [saslmech=<mech>]
1532 .B [authcid=<identity>]
1533 .B [authzid=<identity>]
1534 .B [credentials=<passwd>]
1535 .B [realm=<realm>]
1536 .B [secprops=<properties>]
1537 .B [starttls=yes|critical]
1538 .B [tls_cert=<file>]
1539 .B [tls_key=<file>]
1540 .B [tls_cacert=<file>]
1541 .B [tls_cacertdir=<path>]
1542 .B [tls_reqcert=never|allow|try|demand]
1543 .B [tls_ciphersuite=<ciphers>]
1544 .B [tls_crlcheck=none|peer|all]
1545 .B [logbase=<base DN>]
1546 .B [logfilter=<filter str>]
1547 .B [syncdata=default|accesslog|changelog]
1548 .RS
1549 Specify the current database as a replica which is kept up-to-date with the
1550 master content by establishing the current
1551 .BR slapd (8)
1552 as a replication consumer site running a
1553 .B syncrepl
1554 replication engine.
1555 The replica content is kept synchronized to the master content using
1556 the LDAP Content Synchronization protocol. Refer to the
1557 "OpenLDAP Administrator's Guide" for detailed information on
1558 setting up a replicated
1559 .B slapd
1560 directory service using the
1561 .B syncrepl
1562 replication engine.
1564 .B rid
1565 identifies the current
1566 .B syncrepl
1567 directive within the replication consumer site.
1568 It is a non-negative integer not greater than 4095 (limited
1569 to three hexadecimal digits).
1571 .B provider
1572 specifies the replication provider site containing the master content
1573 as an LDAP URI. If <port> is not given, the standard LDAP port number
1574 (389 or 636) is used.
1576 The content of the
1577 .B syncrepl
1578 replica is defined using a search
1579 specification as its result set. The consumer
1580 .B slapd
1581 will send search requests to the provider
1582 .B slapd
1583 according to the search specification. The search specification includes
1584 .BR searchbase ", " scope ", " filter ", " attrs ", " attrsonly ", " sizelimit ", "
1585 and
1586 .B timelimit
1587 parameters as in the normal search specification.
1588 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1589 \fB(objectclass=*)\fP, while there is no default \fBsearchbase\fP. The
1590 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1591 attributes, and \fBattrsonly\fP is unset by default.
1592 The \fBsizelimit\fP and \fBtimelimit\fP only
1593 accept "unlimited" and positive integers, and both default to "unlimited".
1594 The \fBsizelimit\fP and \fBtimelimit\fP parameters define
1595 a consumer requested limitation on the number of entries that can be returned
1596 by the LDAP Content Synchronization operation; as such, it is intended
1597 to implement partial replication based on the size of the replicated database
1598 and on the time required by the synchronization.
1599 Note, however, that any provider-side limits for the replication identity
1600 will be enforced by the provider regardless of the limits requested
1601 by the LDAP Content Synchronization operation, much like for any other
1602 search operation.
1604 The LDAP Content Synchronization protocol has two operation types.
1605 In the
1606 .B refreshOnly
1607 operation, the next synchronization search operation
1608 is periodically rescheduled at an interval time (specified by
1609 .B interval
1610 parameter; 1 day by default)
1611 after each synchronization operation finishes.
1612 In the
1613 .B refreshAndPersist
1614 operation, a synchronization search remains persistent in the provider slapd.
1615 Further updates to the master replica will generate
1616 .B searchResultEntry
1617 to the consumer slapd as the search responses to the persistent
1618 synchronization search.
1620 If an error occurs during replication, the consumer will attempt to
1621 reconnect according to the
1622 .B retry
1623 parameter which is a list of the <retry interval> and <# of retries> pairs.
1624 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1625 for the first 10 times and then retry every 300 seconds for the next 3
1626 times before stop retrying. The `+' in <# of retries> means indefinite
1627 number of retries until success.
1629 The schema checking can be enforced at the LDAP Sync
1630 consumer site by turning on the
1631 .B schemachecking
1632 parameter. The default is \fBoff\fP.
1633 Schema checking \fBon\fP means that replicated entries must have
1634 a structural objectClass, must obey to objectClass requirements
1635 in terms of required/allowed attributes, and that naming attributes
1636 and distinguished values must be present.
1637 As a consequence, schema checking should be \fBoff\fP when partial
1638 replication is used.
1640 The
1641 .B network-timeout
1642 parameter sets how long the consumer will wait to establish a
1643 network connection to the provider. Once a connection is
1644 established, the
1645 .B timeout
1646 parameter determines how long the consumer will wait for the initial
1647 Bind request to complete. The defaults for these parameters come
1648 from
1649 .BR ldap.conf (5).
1651 A
1652 .B bindmethod
1653 of
1654 .B simple
1655 requires the options
1656 .B binddn
1657 and
1658 .B credentials
1659 and should only be used when adequate security services
1660 (e.g. TLS or IPSEC) are in place.
1661 .B REMEMBER: simple bind credentials must be in cleartext!
1662 A
1663 .B bindmethod
1664 of
1665 .B sasl
1666 requires the option
1667 .B saslmech.
1668 Depending on the mechanism, an authentication identity and/or
1669 credentials can be specified using
1670 .B authcid
1671 and
1672 .B credentials.
1673 The
1674 .B authzid
1675 parameter may be used to specify an authorization identity.
1676 Specific security properties (as with the
1677 .B sasl-secprops
1678 keyword above) for a SASL bind can be set with the
1679 .B secprops
1680 option. A non default SASL realm can be set with the
1681 .B realm
1682 option.
1683 The identity used for synchronization by the consumer should be allowed
1684 to receive an unlimited number of entries in response to a search request.
1685 The provider, other than allow authentication of the syncrepl identity,
1686 should grant that identity appropriate access privileges to the data
1687 that is being replicated (\fBaccess\fP directive), and appropriate time
1688 and size limits.
1689 This can be accomplished by either allowing unlimited \fBsizelimit\fP
1690 and \fBtimelimit\fP, or by setting an appropriate \fBlimits\fP statement
1691 in the consumer's configuration (see \fBsizelimit\fP and \fBlimits\fP
1692 for details).
1694 The
1695 .B starttls
1696 parameter specifies use of the StartTLS extended operation
1697 to establish a TLS session before Binding to the provider. If the
1698 .B critical
1699 argument is supplied, the session will be aborted if the StartTLS request
1700 fails. Otherwise the syncrepl session continues without TLS. The
1701 tls_reqcert setting defaults to "demand" and the other TLS settings
1702 default to the same as the main slapd TLS settings.
1704 Rather than replicating whole entries, the consumer can query logs of
1705 data modifications. This mode of operation is referred to as \fIdelta
1706 syncrepl\fP. In addition to the above parameters, the
1707 .B logbase
1708 and
1709 .B logfilter
1710 parameters must be set appropriately for the log that will be used. The
1711 .B syncdata
1712 parameter must be set to either "accesslog" if the log conforms to the
1713 .BR slapo-accesslog (5)
1714 log format, or "changelog" if the log conforms
1715 to the obsolete \fIchangelog\fP format. If the
1716 .B syncdata
1717 parameter is omitted or set to "default" then the log parameters are
1718 ignored.
1719 .RE
1720 .TP
1721 .B updatedn <dn>
1722 This option is only applicable in a slave
1723 database.
1724 It specifies the DN permitted to update (subject to access controls)
1725 the replica. It is only needed in certain push-mode
1726 replication scenarios. Generally, this DN
1727 .I should not
1728 be the same as the
1729 .B rootdn
1730 used at the master.
1731 .TP
1732 .B updateref <url>
1733 Specify the referral to pass back when
1734 .BR slapd (8)
1735 is asked to modify a replicated local database.
1736 If specified multiple times, each url is provided.
1738 .SH DATABASE-SPECIFIC OPTIONS
1739 Each database may allow specific configuration options; they are
1740 documented separately in the backends' manual pages. See the
1741 .BR slapd.backends (5)
1742 manual page for an overview of available backends.
1743 .SH EXAMPLES
1744 .LP
1745 Here is a short example of a configuration file:
1746 .LP
1747 .RS
1748 .nf
1749 include /etc/openldap/schema/core.schema
1750 pidfile /var/openldap/run/slapd.pid
1752 # Subtypes of "name" (e.g. "cn" and "ou") with the
1753 # option ";x-hidden" can be searched for/compared,
1754 # but are not shown. See \fBslapd.access\fP(5).
1755 attributeoptions x-hidden lang-
1756 access to attrs=name;x-hidden by * =cs
1758 # Protect passwords. See \fBslapd.access\fP(5).
1759 access to attrs=userPassword by * auth
1760 # Read access to other attributes and entries.
1761 access to * by * read
1763 database bdb
1764 suffix "dc=our-domain,dc=com"
1765 # The database directory MUST exist prior to
1766 # running slapd AND should only be accessible
1767 # by the slapd/tools. Mode 0700 recommended.
1768 directory /var/openldap/openldap-data
1769 # Indices to maintain
1770 index objectClass eq
1771 index cn,sn,mail pres,eq,approx,sub
1773 # We serve small clients that do not handle referrals,
1774 # so handle remote lookups on their behalf.
1775 database ldap
1776 suffix ""
1777 uri ldap://ldap.some-server.com/
1778 lastmod off
1779 .fi
1780 .RE
1781 .LP
1782 "OpenLDAP Administrator's Guide" contains a longer annotated
1783 example of a configuration file.
1784 The original /etc/openldap/slapd.conf is another example.
1785 .SH FILES
1786 .TP
1787 /etc/openldap/slapd.conf
1788 default slapd configuration file
1789 .SH SEE ALSO
1790 .BR ldap (3),
1791 .BR slapd\-config (5),
1792 .BR slapd.access (5),
1793 .BR slapd.backends (5),
1794 .BR slapd.overlays (5),
1795 .BR slapd.plugin (5),
1796 .BR slapd.replog (5),
1797 .BR slapd (8),
1798 .BR slapacl (8),
1799 .BR slapadd (8),
1800 .BR slapauth (8),
1801 .BR slapcat (8),
1802 .BR slapdn (8),
1803 .BR slapindex (8),
1804 .BR slappasswd (8),
1805 .BR slaptest (8).
1806 .LP
1807 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1808 .SH ACKNOWLEDGEMENTS
1809 .\" Shared Project Acknowledgement Text
1810 .B "OpenLDAP Software"
1811 is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.
1812 .B "OpenLDAP Software"
1813 is derived from University of Michigan LDAP 3.3 Release.