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