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