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