]> git.sur5r.net Git - openldap/blob - doc/man/man5/slapd-config.5
ITS#6147 fix typos
[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 olcSaslAuxprops: <plugin> [...]
671 Specify which auxprop plugins to use for authentication lookups. The
672 default is empty, which just uses slapd's internal support. Usually
673 no other auxprop plugins are needed.
674 .TP
675 .B olcSaslHost: <fqdn>
676 Used to specify the fully qualified domain name used for SASL processing.
677 .TP
678 .B olcSaslRealm: <realm>
679 Specify SASL realm.  Default is empty.
680 .TP
681 .B olcSaslSecProps: <properties>
682 Used to specify Cyrus SASL security properties.
683 The
684 .B none
685 flag (without any other properties) causes the flag properties
686 default, "noanonymous,noplain", to be cleared.
687 The
688 .B noplain
689 flag disables mechanisms susceptible to simple passive attacks.
690 The
691 .B noactive
692 flag disables mechanisms susceptible to active attacks.
693 The
694 .B nodict
695 flag disables mechanisms susceptible to passive dictionary attacks.
696 The
697 .B noanonymous
698 flag disables mechanisms which support anonymous login.
699 The
700 .B forwardsec
701 flag require forward secrecy between sessions.
702 The
703 .B passcred
704 require mechanisms which pass client credentials (and allow
705 mechanisms which can pass credentials to do so).
706 The
707 .B minssf=<factor> 
708 property specifies the minimum acceptable
709 .I security strength factor
710 as an integer approximate to effective key length used for
711 encryption.  0 (zero) implies no protection, 1 implies integrity
712 protection only, 56 allows DES or other weak ciphers, 112
713 allows triple DES and other strong ciphers, 128 allows RC4,
714 Blowfish and other modern strong ciphers.  The default is 0.
715 The
716 .B maxssf=<factor> 
717 property specifies the maximum acceptable
718 .I security strength factor
719 as an integer (see minssf description).  The default is INT_MAX.
720 The
721 .B maxbufsize=<size> 
722 property specifies the maximum security layer receive buffer
723 size allowed.  0 disables security layers.  The default is 65536.
724 .TP
725 .B olcServerID: <integer> [<URL>]
726 Specify an integer ID from 0 to 4095 for this server. These IDs are
727 required when using multimaster replication and each master must have a
728 unique ID. Note that this requirement also applies to separate masters
729 contributing to a glued set of databases.
730 If the URL is provided, this directive may be specified
731 multiple times, providing a complete list of participating servers
732 and their IDs. The fully qualified hostname of each server should be
733 used in the supplied URLs. The IDs are used in the "replica id" field
734 of all CSNs generated by the specified server. The default value is zero.
735 Example:
736 .LP
737 .nf
738         olcServerID: 1 ldap://ldap1.example.com
739         olcServerID: 2 ldap://ldap2.example.com
740 .fi
741 .TP
742 .B olcSockbufMaxIncoming: <integer>
743 Specify the maximum incoming LDAP PDU size for anonymous sessions.
744 The default is 262143.
745 .TP
746 .B olcSockbufMaxIncomingAuth: <integer>
747 Specify the maximum incoming LDAP PDU size for authenticated sessions.
748 The default is 4194303.
749 .TP
750 .B olcThreads: <integer>
751 Specify the maximum size of the primary thread pool.
752 The default is 16; the minimum value is 2.
753 .TP
754 .B olcToolThreads: <integer>
755 Specify the maximum number of threads to use in tool mode.
756 This should not be greater than the number of CPUs in the system.
757 The default is 1.
758 .TP
759 .B olcWriteTimeout: <integer>
760 Specify the number of seconds to wait before forcibly closing
761 a connection with an outstanding write.  This allows recovery from
762 various network hang conditions.  A setting of 0 disables this
763 feature.  The default is 0.
764 .SH TLS OPTIONS
765 If
766 .B slapd
767 is built with support for Transport Layer Security, there are more options
768 you can specify.
769 .TP
770 .B olcTLSCipherSuite: <cipher-suite-spec>
771 Permits configuring what ciphers will be accepted and the preference order.
772 <cipher-suite-spec> should be a cipher specification for OpenSSL.  Example:
773
774 olcTLSCipherSuite: HIGH:MEDIUM:+SSLv2
775
776 To check what ciphers a given spec selects in OpenSSL, use:
777
778 .nf
779         openssl ciphers -v <cipher-suite-spec>
780 .fi
781
782 To obtain the list of ciphers in GNUtls use:
783
784 .nf
785         gnutls-cli -l
786 .fi
787 .TP
788 .B olcTLSCACertificateFile: <filename>
789 Specifies the file that contains certificates for all of the Certificate
790 Authorities that
791 .B slapd
792 will recognize.
793 .TP
794 .B olcTLSCACertificatePath: <path>
795 Specifies the path of a directory that contains Certificate Authority
796 certificates in separate individual files. Usually only one of this
797 or the olcTLSCACertificateFile is defined. If both are specified, both
798 locations will be used. This directive is not supported
799 when using GNUtls.
800 .TP
801 .B olcTLSCertificateFile: <filename>
802 Specifies the file that contains the
803 .B slapd
804 server certificate.
805 .TP
806 .B olcTLSCertificateKeyFile: <filename>
807 Specifies the file that contains the
808 .B slapd
809 server private key that matches the certificate stored in the
810 .B olcTLSCertificateFile
811 file. If the private key is protected with a password, the password must
812 be manually typed in when slapd starts.  Usually the private key is not
813 protected with a password, to allow slapd to start without manual
814 intervention, so
815 it is of critical importance that the file is protected carefully. 
816 .TP
817 .B olcTLSDHParamFile: <filename>
818 This directive specifies the file that contains parameters for Diffie-Hellman
819 ephemeral key exchange.  This is required in order to use a DSA certificate on
820 the server. If multiple sets of parameters are present in the file, all of
821 them will be processed.  Note that setting this option may also enable
822 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
823 You should append "!ADH" to your cipher suites if you have changed them
824 from the default, otherwise no certificate exchanges or verification will
825 be done. When using GNUtls these parameters are always generated randomly
826 so this directive is ignored.
827 .TP
828 .B olcTLSRandFile: <filename>
829 Specifies the file to obtain random bits from when /dev/[u]random
830 is not available.  Generally set to the name of the EGD/PRNGD socket.
831 The environment variable RANDFILE can also be used to specify the filename.
832 This directive is ignored with GNUtls.
833 .TP
834 .B olcTLSVerifyClient: <level>
835 Specifies what checks to perform on client certificates in an
836 incoming TLS session, if any.
837 The
838 .B <level>
839 can be specified as one of the following keywords:
840 .RS
841 .TP
842 .B never
843 This is the default.
844 .B slapd
845 will not ask the client for a certificate.
846 .TP
847 .B allow
848 The client certificate is requested.  If no certificate is provided,
849 the session proceeds normally.  If a bad certificate is provided,
850 it will be ignored and the session proceeds normally.
851 .TP
852 .B try
853 The client certificate is requested.  If no certificate is provided,
854 the session proceeds normally.  If a bad certificate is provided,
855 the session is immediately terminated.
856 .TP
857 .B demand | hard | true
858 These keywords are all equivalent, for compatibility reasons.
859 The client certificate is requested.  If no certificate is provided,
860 or a bad certificate is provided, the session is immediately terminated.
861
862 Note that a valid client certificate is required in order to use the
863 SASL EXTERNAL authentication mechanism with a TLS session.  As such,
864 a non-default
865 .B olcTLSVerifyClient
866 setting must be chosen to enable SASL EXTERNAL authentication.
867 .RE
868 .TP
869 .B olcTLSCRLCheck: <level>
870 Specifies if the Certificate Revocation List (CRL) of the CA should be 
871 used to verify if the client certificates have not been revoked. This
872 requires
873 .B olcTLSCACertificatePath
874 parameter to be set. This parameter is ignored with GNUtls.
875 .B <level>
876 can be specified as one of the following keywords:
877 .RS
878 .TP
879 .B none
880 No CRL checks are performed
881 .TP
882 .B peer
883 Check the CRL of the peer certificate
884 .TP
885 .B all
886 Check the CRL for a whole certificate chain
887 .RE
888 .TP
889 .B olcTLSCRLFile: <filename>
890 Specifies a file containing a Certificate Revocation List to be used
891 for verifying that certificates have not been revoked. This parameter
892 is only valid when using GNUtls.
893 .SH DYNAMIC MODULE OPTIONS
894 If
895 .B slapd
896 is compiled with --enable-modules then the module-related entries will
897 be available. These entries are named
898 .B cn=module{x},cn=config
899 and
900 must have the olcModuleList objectClass. One entry should be created
901 per
902 .B olcModulePath.
903 Normally the config engine generates the "{x}" index in the RDN
904 automatically, so it can be omitted when initially loading these entries.
905 .TP
906 .B olcModuleLoad: <filename>
907 Specify the name of a dynamically loadable module to load. The filename
908 may be an absolute path name or a simple filename. Non-absolute names
909 are searched for in the directories specified by the
910 .B olcModulePath
911 option.
912 .TP
913 .B olcModulePath: <pathspec>
914 Specify a list of directories to search for loadable modules. Typically
915 the path is colon-separated but this depends on the operating system.
916 .SH SCHEMA OPTIONS
917 Schema definitions are created as entries in the
918 .B cn=schema,cn=config
919 subtree. These entries must have the olcSchemaConfig objectClass.
920 As noted above, the actual
921 .B cn=schema,cn=config
922 entry is predefined and any values specified for it are ignored.
923
924 .HP
925 .hy 0
926 .B olcAttributetypes: "(\ <oid>\
927  [NAME\ <name>]\
928  [DESC\ <description>]\
929  [OBSOLETE]\
930  [SUP\ <oid>]\
931  [EQUALITY\ <oid>]\
932  [ORDERING\ <oid>]\
933  [SUBSTR\ <oid>]\
934  [SYNTAX\ <oidlen>]\
935  [SINGLE\-VALUE]\
936  [COLLECTIVE]\
937  [NO\-USER\-MODIFICATION]\
938  [USAGE\ <attributeUsage>]\ )"
939 .RS
940 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
941 The slapd parser extends the RFC 4512 definition by allowing string
942 forms as well as numeric OIDs to be used for the attribute OID and
943 attribute syntax OID.
944 (See the
945 .B olcObjectIdentifier
946 description.) 
947 .RE
948
949 .HP
950 .hy 0
951 .B olcDitContentRules: "(\ <oid>\
952  [NAME\ <name>]\
953  [DESC\ <description>]\
954  [OBSOLETE]\
955  [AUX\ <oids>]\
956  [MUST\ <oids>]\
957  [MAY\ <oids>]\
958  [NOT\ <oids>]\ )"
959 .RS
960 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
961 The slapd parser extends the RFC 4512 definition by allowing string
962 forms as well as numeric OIDs to be used for the attribute OID and
963 attribute syntax OID.
964 (See the
965 .B olcObjectIdentifier
966 description.) 
967 .RE
968
969 .HP
970 .hy 0
971 .B olcObjectClasses: "(\ <oid>\
972  [NAME\ <name>]\
973  [DESC\ <description>]\
974  [OBSOLETE]\
975  [SUP\ <oids>]\
976  [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
977  [MUST\ <oids>] [MAY\ <oids>] )"
978 .RS
979 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
980 The slapd parser extends the RFC 4512 definition by allowing string
981 forms as well as numeric OIDs to be used for the object class OID.
982 (See the
983 .B
984 olcObjectIdentifier
985 description.)  Object classes are "STRUCTURAL" by default.
986 .RE
987 .TP
988 .B olcObjectIdentifier: <name> "{ <oid> | <name>[:<suffix>] }"
989 Define a string name that equates to the given OID. The string can be used
990 in place of the numeric OID in objectclass and attribute definitions. The
991 name can also be used with a suffix of the form ":xx" in which case the
992 value "oid.xx" will be used.
993
994 .SH GENERAL BACKEND OPTIONS
995 Options in these entries only apply to the configuration of a single
996 type of backend. All backends may support this class of options.
997 The entry must be named
998 .B olcBackend=<databasetype>,cn=config
999 and must have the olcBackendConfig objectClass.
1000 <databasetype>
1001 should be one of
1002 .BR bdb ,
1003 .BR config ,
1004 .BR dnssrv ,
1005 .BR hdb ,
1006 .BR ldap ,
1007 .BR ldif ,
1008 .BR meta ,
1009 .BR monitor ,
1010 .BR null ,
1011 .BR passwd ,
1012 .BR perl ,
1013 .BR relay ,
1014 .BR shell ,
1015 or
1016 .BR sql .
1017 At present, no backend implements any options of this type.
1018
1019 .SH DATABASE OPTIONS
1020 Database options are set in entries named
1021 .B olcDatabase={x}<databasetype>,cn=config
1022 and must have the olcDatabaseConfig objectClass. Normally the config
1023 engine generates the "{x}" index in the RDN automatically, so it
1024 can be omitted when initially loading these entries.
1025
1026 The special frontend database is always numbered "{-1}" and the config
1027 database is always numbered "{0}".
1028
1029 .SH GLOBAL DATABASE OPTIONS
1030 Options in this section may be set in the special "frontend" database
1031 and inherited in all the other databases. These options may be altered
1032 by further settings in each specific database. The frontend entry must
1033 be named
1034 .B olcDatabase=frontend,cn=config
1035 and must have the olcFrontendConfig objectClass.
1036 .TP
1037 .B olcAccess: to <what> "[ by <who> <access> <control> ]+"
1038 Grant access (specified by <access>) to a set of entries and/or
1039 attributes (specified by <what>) by one or more requestors (specified
1040 by <who>).
1041 If no access controls are present, the default policy
1042 allows anyone and everyone to read anything but restricts
1043 updates to rootdn.  (e.g., "olcAccess: to * by * read").
1044 See
1045 .BR slapd.access (5)
1046 and the "OpenLDAP Administrator's Guide" for details.
1047
1048 Access controls set in the frontend are appended to any access
1049 controls set on the specific databases.
1050 The rootdn of a database can always read and write EVERYTHING
1051 in that database.
1052
1053 Extra special care must be taken with the access controls on the
1054 config database. Unlike other databases, the default policy for the
1055 config database is to only allow access to the rootdn. Regular users
1056 should not have read access, and write access should be granted very
1057 carefully to privileged administrators.
1058
1059 .TP
1060 .B olcDefaultSearchBase: <dn>
1061 Specify a default search base to use when client submits a
1062 non-base search request with an empty base DN.
1063 Base scoped search requests with an empty base DN are not affected.
1064 This setting is only allowed in the frontend entry.
1065 .TP
1066 .B olcPasswordHash: <hash> [<hash>...]
1067 This option configures one or more hashes to be used in generation of user
1068 passwords stored in the userPassword attribute during processing of
1069 LDAP Password Modify Extended Operations (RFC 3062).
1070 The <hash> must be one of
1071 .BR {SSHA} ,
1072 .BR {SHA} ,
1073 .BR {SMD5} ,
1074 .BR {MD5} ,
1075 .BR {CRYPT} ,
1076 and
1077 .BR {CLEARTEXT} .
1078 The default is
1079 .BR {SSHA} .
1080
1081 .B {SHA}
1082 and
1083 .B {SSHA}
1084 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
1085
1086 .B {MD5}
1087 and
1088 .B {SMD5}
1089 use the MD5 algorithm (RFC 1321), the latter with a seed.
1090
1091 .B {CRYPT}
1092 uses the
1093 .BR crypt (3).
1094
1095 .B {CLEARTEXT}
1096 indicates that the new password should be
1097 added to userPassword as clear text.
1098
1099 Note that this option does not alter the normal user applications
1100 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
1101 This setting is only allowed in the frontend entry.
1102 .TP
1103 .B olcReadOnly: TRUE | FALSE
1104 This option puts the database into "read-only" mode.  Any attempts to 
1105 modify the database will return an "unwilling to perform" error.  By
1106 default, olcReadOnly is FALSE. Note that when this option is set
1107 TRUE on the frontend, it cannot be reset without restarting the
1108 server, since further writes to the config database will be rejected.
1109 .TP
1110 .B olcRequires: <conditions>
1111 Specify a set of conditions to require (default none).
1112 The directive may be specified globally and/or per-database;
1113 databases inherit global conditions, so per-database specifications
1114 are additive.
1115 .B bind
1116 requires bind operation prior to directory operations.
1117 .B LDAPv3
1118 requires session to be using LDAP version 3.
1119 .B authc
1120 requires authentication prior to directory operations.
1121 .B SASL
1122 requires SASL authentication prior to directory operations.
1123 .B strong
1124 requires strong authentication prior to directory operations.
1125 The strong keyword allows protected "simple" authentication
1126 as well as SASL authentication.
1127 .B none
1128 may be used to require no conditions (useful to clear out globally
1129 set conditions within a particular database); it must occur first
1130 in the list of conditions.
1131 .TP
1132 .B olcRestrict: <oplist>
1133 Specify a list of operations that are restricted.
1134 Restrictions on a specific database override any frontend setting.
1135 Operations can be any of 
1136 .BR add ,
1137 .BR bind ,
1138 .BR compare ,
1139 .BR delete ,
1140 .BR extended[=<OID>] ,
1141 .BR modify ,
1142 .BR rename ,
1143 .BR search ,
1144 or the special pseudo-operations
1145 .B read
1146 and
1147 .BR write ,
1148 which respectively summarize read and write operations.
1149 The use of 
1150 .I restrict write
1151 is equivalent to 
1152 .I olcReadOnly: TRUE
1153 (see above).
1154 The 
1155 .B extended
1156 keyword allows to indicate the OID of the specific operation
1157 to be restricted.
1158 .TP
1159 .B olcSchemaDN: <dn>
1160 Specify the distinguished name for the subschema subentry that
1161 controls the entries on this server.  The default is "cn=Subschema".
1162 .TP
1163 .B olcSecurity: <factors>
1164 Specify a set of security strength factors (separated by white space)
1165 to require (see
1166 .BR olcSaslSecprops 's
1167 .B minssf
1168 option for a description of security strength factors).
1169 The directive may be specified globally and/or per-database.
1170 .B ssf=<n>
1171 specifies the overall security strength factor.
1172 .B transport=<n>
1173 specifies the transport security strength factor.
1174 .B tls=<n>
1175 specifies the TLS security strength factor.
1176 .B sasl=<n>
1177 specifies the SASL security strength factor.
1178 .B update_ssf=<n>
1179 specifies the overall security strength factor to require for
1180 directory updates.
1181 .B update_transport=<n>
1182 specifies the transport security strength factor to require for
1183 directory updates.
1184 .B update_tls=<n>
1185 specifies the TLS security strength factor to require for
1186 directory updates.
1187 .B update_sasl=<n>
1188 specifies the SASL security strength factor to require for
1189 directory updates.
1190 .B simple_bind=<n>
1191 specifies the security strength factor required for
1192 .I simple
1193 username/password authentication.
1194 Note that the
1195 .B transport
1196 factor is measure of security provided by the underlying transport,
1197 e.g. ldapi:// (and eventually IPSEC).  It is not normally used.
1198 .TP
1199 .B olcSizeLimit: {<integer>|unlimited}
1200 .TP
1201 .B olcSizeLimit: size[.{soft|hard|unchecked}]=<integer> [...]
1202 Specify the maximum number of entries to return from a search operation.
1203 The default size limit is 500.
1204 Use
1205 .B unlimited
1206 to specify no limits.
1207 The second format allows a fine grain setting of the size limits.
1208 Extra args can be added in the same value or as additional values.
1209 See
1210 .BR olcLimits
1211 for an explanation of the different flags.
1212 .TP
1213 .B olcSortVals: <attr> [...]
1214 Specify a list of multi-valued attributes whose values will always
1215 be maintained in sorted order. Using this option will allow Modify,
1216 Compare, and filter evaluations on these attributes to be performed
1217 more efficiently. The resulting sort order depends on the
1218 attributes' syntax and matching rules and may not correspond to
1219 lexical order or any other recognizable order.
1220 This setting is only allowed in the frontend entry.
1221 .TP
1222 .B olcTimeLimit: {<integer>|unlimited}
1223 .TP
1224 .B olcTimeLimit: time[.{soft|hard}]=<integer> [...]
1225 Specify the maximum number of seconds (in real time)
1226 .B slapd
1227 will spend answering a search request.  The default time limit is 3600.
1228 Use
1229 .B unlimited
1230 to specify no limits.
1231 The second format allows a fine grain setting of the time limits.
1232 Extra args can be added in the same value or as additional values.
1233 See
1234 .BR olcLimits
1235 for an explanation of the different flags.
1236
1237 .SH GENERAL DATABASE OPTIONS
1238 Options in this section only apply to the specific database for
1239 which they are defined.  They are supported by every
1240 type of backend. All of the Global Database Options may also be
1241 used here.
1242 .TP
1243 .B olcAddContentAcl: TRUE | FALSE
1244 Controls whether Add operations will perform ACL checks on
1245 the content of the entry being added. This check is off
1246 by default. See the
1247 .BR slapd.access (5)
1248 manual page for more details on ACL requirements for
1249 Add operations.
1250 .TP
1251 .B olcHidden: TRUE | FALSE
1252 Controls whether the database will be used to answer
1253 queries. A database that is hidden will never be
1254 selected to answer any queries, and any suffix configured
1255 on the database will be ignored in checks for conflicts
1256 with other databases. By default, olcHidden is FALSE.
1257 .TP
1258 .B olcLastMod: TRUE | FALSE
1259 Controls whether
1260 .B slapd
1261 will automatically maintain the 
1262 modifiersName, modifyTimestamp, creatorsName, and 
1263 createTimestamp attributes for entries. It also controls
1264 the entryCSN and entryUUID attributes, which are needed
1265 by the syncrepl provider. By default, olcLastMod is TRUE.
1266 .TP
1267 .B olcLimits: <selector> <limit> [<limit> [...]]
1268 Specify time and size limits based on the operation's initiator or
1269 base DN.
1270 The argument
1271 .B <selector>
1272 can be any of
1273 .RS
1274 .RS
1275 .TP
1276 anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>
1277
1278 .RE
1279 with
1280 .RS
1281 .TP
1282 <dnspec> ::= dn[.<type>][.<style>]
1283 .TP
1284 <type>  ::= self | this
1285 .TP
1286 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1287
1288 .RE
1289 DN type
1290 .B self
1291 is the default and means the bound user, while
1292 .B this
1293 means the base DN of the operation.
1294 The term
1295 .B anonymous
1296 matches all unauthenticated clients.
1297 The term
1298 .B users
1299 matches all authenticated clients;
1300 otherwise an
1301 .B exact
1302 dn pattern is assumed unless otherwise specified by qualifying 
1303 the (optional) key string
1304 .B dn
1305 with 
1306 .B exact
1307 or
1308 .B base
1309 (which are synonyms), to require an exact match; with
1310 .BR onelevel , 
1311 to require exactly one level of depth match; with
1312 .BR subtree ,
1313 to allow any level of depth match, including the exact match; with
1314 .BR children ,
1315 to allow any level of depth match, not including the exact match;
1316 .BR regex
1317 explicitly requires the (default) match based on POSIX (''extended'')
1318 regular expression pattern.
1319 Finally,
1320 .B anonymous
1321 matches unbound operations; the 
1322 .B pattern
1323 field is ignored.
1324 The same behavior is obtained by using the 
1325 .B anonymous
1326 form of the
1327 .B <selector>
1328 clause.
1329 The term
1330 .BR group ,
1331 with the optional objectClass
1332 .B oc
1333 and attributeType
1334 .B at
1335 fields, followed by
1336 .BR pattern ,
1337 sets the limits for any DN listed in the values of the
1338 .B at
1339 attribute (default
1340 .BR member )
1341 of the 
1342 .B oc
1343 group objectClass (default
1344 .BR groupOfNames )
1345 whose DN exactly matches
1346 .BR pattern .
1347
1348 The currently supported limits are 
1349 .B size
1350 and 
1351 .BR time .
1352
1353 The syntax for time limits is 
1354 .BR time[.{soft|hard}]=<integer> ,
1355 where 
1356 .I integer
1357 is the number of seconds slapd will spend answering a search request.
1358 If no time limit is explicitly requested by the client, the 
1359 .BR soft
1360 limit is used; if the requested time limit exceeds the
1361 .BR hard
1362 .\"limit, an
1363 .\".I "Administrative limit exceeded"
1364 .\"error is returned.
1365 limit, the value of the limit is used instead.
1366 If the
1367 .BR hard
1368 limit is set to the keyword 
1369 .IR soft ,
1370 the soft limit is used in either case; if it is set to the keyword 
1371 .IR unlimited , 
1372 no hard limit is enforced.
1373 Explicit requests for time limits smaller or equal to the
1374 .BR hard 
1375 limit are honored.
1376 If no limit specifier is set, the value is assigned to the 
1377 .BR soft 
1378 limit, and the
1379 .BR hard
1380 limit is set to
1381 .IR soft ,
1382 to preserve the original behavior.
1383
1384 The syntax for size limits is
1385 .BR size[.{soft|hard|unchecked}]=<integer> ,
1386 where
1387 .I integer
1388 is the maximum number of entries slapd will return answering a search 
1389 request.
1390 If no size limit is explicitly requested by the client, the
1391 .BR soft
1392 limit is used; if the requested size limit exceeds the
1393 .BR hard
1394 .\"limit, an 
1395 .\".I "Administrative limit exceeded"
1396 .\"error is returned.
1397 limit, the value of the limit is used instead.
1398 If the 
1399 .BR hard
1400 limit is set to the keyword 
1401 .IR soft , 
1402 the soft limit is used in either case; if it is set to the keyword
1403 .IR unlimited , 
1404 no hard limit is enforced.
1405 Explicit requests for size limits smaller or equal to the
1406 .BR hard
1407 limit are honored.
1408 The
1409 .BR unchecked
1410 specifier sets a limit on the number of candidates a search request is allowed
1411 to examine.
1412 The rationale behind it is that searches for non-properly indexed
1413 attributes may result in large sets of candidates, which must be 
1414 examined by
1415 .BR slapd (8)
1416 to determine whether they match the search filter or not.
1417 The
1418 .B unchecked
1419 limit provides a means to drop such operations before they are even 
1420 started.
1421 If the selected candidates exceed the 
1422 .BR unchecked
1423 limit, the search will abort with 
1424 .IR "Unwilling to perform" .
1425 If it is set to the keyword 
1426 .IR unlimited , 
1427 no limit is applied (the default).
1428 If it is set to
1429 .IR disable ,
1430 the search is not even performed; this can be used to disallow searches
1431 for a specific set of users.
1432 If no limit specifier is set, the value is assigned to the
1433 .BR soft 
1434 limit, and the
1435 .BR hard
1436 limit is set to
1437 .IR soft ,
1438 to preserve the original behavior.
1439
1440 In case of no match, the global limits are used.
1441 The default values are the same as for
1442 .B olcSizeLimit
1443 and
1444 .BR olcTimeLimit ;
1445 no limit is set on 
1446 .BR unchecked .
1447
1448 If 
1449 .B pagedResults
1450 control is requested, the 
1451 .B hard
1452 size limit is used by default, because the request of a specific page size
1453 is considered an explicit request for a limitation on the number
1454 of entries to be returned.
1455 However, the size limit applies to the total count of entries returned within
1456 the search, and not to a single page.
1457 Additional size limits may be enforced; the syntax is
1458 .BR size.pr={<integer>|noEstimate|unlimited} ,
1459 where
1460 .I integer
1461 is the max page size if no explicit limit is set; the keyword
1462 .I noEstimate
1463 inhibits the server from returning an estimate of the total number
1464 of entries that might be returned
1465 (note: the current implementation does not return any estimate).
1466 The keyword
1467 .I unlimited
1468 indicates that no limit is applied to the pagedResults control page size.
1469 The syntax
1470 .B size.prtotal={<integer>|unlimited|disabled}
1471 allows to set a limit on the total number of entries that a pagedResults
1472 control allows to return.
1473 By default it is set to the 
1474 .B hard
1475 limit.
1476 When set, 
1477 .I integer
1478 is the max number of entries that the whole search with pagedResults control
1479 can return.
1480 Use 
1481 .I unlimited
1482 to allow unlimited number of entries to be returned, e.g. to allow
1483 the use of the pagedResults control as a means to circumvent size 
1484 limitations on regular searches; the keyword
1485 .I disabled
1486 disables the control, i.e. no paged results can be returned.
1487 Note that the total number of entries returned when the pagedResults control 
1488 is requested cannot exceed the 
1489 .B hard 
1490 size limit of regular searches unless extended by the
1491 .B prtotal
1492 switch.
1493 .RE
1494 .TP
1495 .B olcMaxDerefDepth: <depth>
1496 Specifies the maximum number of aliases to dereference when trying to
1497 resolve an entry, used to avoid infinite alias loops. The default is 15.
1498 .TP
1499 .B olcMirrorMode: TRUE | FALSE
1500 This option puts a replica database into "mirror" mode.  Update
1501 operations will be accepted from any user, not just the updatedn.  The
1502 database must already be configured as syncrepl consumer
1503 before this keyword may be set.  This mode also requires a
1504 .B olcServerID
1505 (see above) to be configured.
1506 By default, this setting is FALSE.
1507 .TP
1508 .B olcPlugin: <plugin_type> <lib_path> <init_function> [<arguments>]
1509 Configure a SLAPI plugin. See the
1510 .BR slapd.plugin (5)
1511 manpage for more details.
1512 .TP
1513 .B olcRootDN: <dn>
1514 Specify the distinguished name that is not subject to access control 
1515 or administrative limit restrictions for operations on this database.
1516 This DN may or may not be associated with an entry.  An empty root
1517 DN (the default) specifies no root access is to be granted.  It is
1518 recommended that the rootdn only be specified when needed (such as
1519 when initially populating a database).  If the rootdn is within
1520 a namingContext (suffix) of the database, a simple bind password
1521 may also be provided using the
1522 .B olcRootPW
1523 directive. Note that the rootdn is always needed when using syncrepl.
1524 .TP
1525 .B olcRootPW: <password>
1526 Specify a password (or hash of the password) for the rootdn.  The
1527 password can only be set if the rootdn is within the namingContext
1528 (suffix) of the database.
1529 This option accepts all RFC 2307 userPassword formats known to
1530 the server (see 
1531 .B olcPasswordHash
1532 description) as well as cleartext.
1533 .BR slappasswd (8) 
1534 may be used to generate a hash of a password.  Cleartext
1535 and \fB{CRYPT}\fP passwords are not recommended.  If empty
1536 (the default), authentication of the root DN is by other means
1537 (e.g. SASL).  Use of SASL is encouraged.
1538 .TP
1539 .B olcSubordinate: [TRUE | FALSE | advertise]
1540 Specify that the current backend database is a subordinate of another
1541 backend database. A subordinate  database may have only one suffix. This
1542 option may be used to glue multiple databases into a single namingContext.
1543 If the suffix of the current database is within the namingContext of a
1544 superior database, searches against the superior database will be
1545 propagated to the subordinate as well. All of the databases
1546 associated with a single namingContext should have identical rootdns.
1547 Behavior of other LDAP operations is unaffected by this setting. In
1548 particular, it is not possible to use moddn to move an entry from
1549 one subordinate to another subordinate within the namingContext.
1550
1551 If the optional \fBadvertise\fP flag is supplied, the naming context of
1552 this database is advertised in the root DSE. The default is to hide this
1553 database context, so that only the superior context is visible.
1554
1555 If the slap tools
1556 .BR slapcat (8),
1557 .BR slapadd (8),
1558 or
1559 .BR slapindex (8)
1560 are used on the superior database, any glued subordinates that support
1561 these tools are opened as well.
1562
1563 Databases that are glued together should usually be configured with the
1564 same indices (assuming they support indexing), even for attributes that
1565 only exist in some of these databases. In general, all of the glued
1566 databases should be configured as similarly as possible, since the intent
1567 is to provide the appearance of a single directory.
1568
1569 Note that the subordinate functionality is implemented internally
1570 by the \fIglue\fP overlay and as such its behavior will interact with other
1571 overlays in use. By default, the glue overlay is automatically configured as
1572 the last overlay on the superior database. Its position on the database
1573 can be explicitly configured by setting an \fBoverlay glue\fP directive
1574 at the desired position. This explicit configuration is necessary e.g.
1575 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1576 in order to work over all of the glued databases. E.g.
1577 .RS
1578 .nf
1579         dn: olcDatabase={1}bdb,cn=config
1580         olcSuffix: dc=example,dc=com
1581         ...
1582
1583         dn: olcOverlay={0}glue,olcDatabase={1}bdb,cn=config
1584         ...
1585
1586         dn: olcOverlay={1}syncprov,olcDatabase={1}bdb,cn=config
1587         ...
1588 .fi
1589 .RE
1590 See the Overlays section below for more details.
1591 .TP
1592 .B olcSuffix: <dn suffix>
1593 Specify the DN suffix of queries that will be passed to this 
1594 backend database.  Multiple suffix lines can be given and at least one is 
1595 required for each database definition.
1596
1597 If the suffix of one database is "inside" that of another, the database
1598 with the inner suffix must come first in the configuration file.
1599 You may also want to glue such databases together with the
1600 .B olcSubordinate
1601 attribute.
1602 .HP
1603 .hy 0
1604 .B olcSyncrepl: rid=<replica ID>
1605 .B provider=ldap[s]://<hostname>[:port]
1606 .B searchbase=<base DN>
1607 .B [type=refreshOnly|refreshAndPersist]
1608 .B [interval=dd:hh:mm:ss]
1609 .B [retry=[<retry interval> <# of retries>]+]
1610 .B [filter=<filter str>]
1611 .B [scope=sub|one|base|subord]
1612 .B [attrs=<attr list>]
1613 .B [exattrs=<attr list>]
1614 .B [attrsonly]
1615 .B [sizelimit=<limit>]
1616 .B [timelimit=<limit>]
1617 .B [schemachecking=on|off]
1618 .B [network-timeout=<seconds>]
1619 .B [timeout=<seconds>]
1620 .B [bindmethod=simple|sasl]
1621 .B [binddn=<dn>]
1622 .B [saslmech=<mech>]
1623 .B [authcid=<identity>]
1624 .B [authzid=<identity>]
1625 .B [credentials=<passwd>]
1626 .B [realm=<realm>]
1627 .B [secprops=<properties>]
1628 .B [starttls=yes|critical]
1629 .B [tls_cert=<file>]
1630 .B [tls_key=<file>]
1631 .B [tls_cacert=<file>]
1632 .B [tls_cacertdir=<path>]
1633 .B [tls_reqcert=never|allow|try|demand]
1634 .B [tls_ciphersuite=<ciphers>]
1635 .B [tls_crlcheck=none|peer|all]
1636 .B [logbase=<base DN>]
1637 .B [logfilter=<filter str>]
1638 .B [syncdata=default|accesslog|changelog]
1639 .RS
1640 Specify the current database as a replica which is kept up-to-date with the 
1641 master content by establishing the current
1642 .BR slapd (8)
1643 as a replication consumer site running a
1644 .B syncrepl
1645 replication engine.
1646 The replica content is kept synchronized to the master content using
1647 the LDAP Content Synchronization protocol. Refer to the
1648 "OpenLDAP Administrator's Guide" for detailed information on
1649 setting up a replicated
1650 .B slapd
1651 directory service using the 
1652 .B syncrepl
1653 replication engine.
1654
1655 .B rid
1656 identifies the current
1657 .B syncrepl
1658 directive within the replication consumer site.
1659 It is a non-negative integer having no more than three digits.
1660
1661 .B provider
1662 specifies the replication provider site containing the master content
1663 as an LDAP URI. If <port> is not given, the standard LDAP port number
1664 (389 or 636) is used.
1665
1666 The content of the
1667 .B syncrepl
1668 replica is defined using a search
1669 specification as its result set. The consumer
1670 .B slapd
1671 will send search requests to the provider
1672 .B slapd
1673 according to the search specification. The search specification includes
1674 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1675 and
1676 .B timelimit
1677 parameters as in the normal search specification. The
1678 .B exattrs
1679 option may also be used to specify attributes that should be omitted
1680 from incoming entries.
1681 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1682 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1683 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1684 attributes, and \fBattrsonly\fP and \fBexattrs\fP are unset by default.
1685 The \fBsizelimit\fP and \fBtimelimit\fP only
1686 accept "unlimited" and positive integers, and both default to "unlimited".
1687 Note, however, that any provider-side limits for the replication identity
1688 will be enforced by the provider regardless of the limits requested
1689 by the LDAP Content Synchronization operation, much like for any other
1690 search operation.
1691
1692 The LDAP Content Synchronization protocol has two operation types.
1693 In the
1694 .B refreshOnly
1695 operation, the next synchronization search operation
1696 is periodically rescheduled at an interval time (specified by 
1697 .B interval
1698 parameter; 1 day by default)
1699 after each synchronization operation finishes.
1700 In the
1701 .B refreshAndPersist
1702 operation, a synchronization search remains persistent in the provider slapd.
1703 Further updates to the master replica will generate
1704 .B searchResultEntry
1705 to the consumer slapd as the search responses to the persistent
1706 synchronization search.
1707
1708 If an error occurs during replication, the consumer will attempt to
1709 reconnect according to the
1710 .B retry
1711 parameter which is a list of the <retry interval> and <# of retries> pairs.
1712 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1713 for the first 10 times and then retry every 300 seconds for the next 3
1714 times before stop retrying. The `+' in <# of retries> means indefinite
1715 number of retries until success.
1716
1717 The schema checking can be enforced at the LDAP Sync
1718 consumer site by turning on the
1719 .B schemachecking
1720 parameter. The default is off.
1721
1722 The
1723 .B network-timeout
1724 parameter sets how long the consumer will wait to establish a
1725 network connection to the provider. Once a connection is
1726 established, the
1727 .B timeout
1728 parameter determines how long the consumer will wait for the initial
1729 Bind request to complete. The defaults for these parameters come
1730 from 
1731 .BR ldap.conf (5).
1732
1733 A
1734 .B bindmethod
1735 of 
1736 .B simple
1737 requires the options 
1738 .B binddn
1739 and 
1740 .B credentials
1741 and should only be used when adequate security services
1742 (e.g. TLS or IPSEC) are in place.
1743 A
1744 .B bindmethod
1745 of
1746 .B sasl
1747 requires the option
1748 .B saslmech.
1749 Depending on the mechanism, an authentication identity and/or
1750 credentials can be specified using
1751 .B authcid
1752 and
1753 .B credentials.
1754 The
1755 .B authzid
1756 parameter may be used to specify an authorization identity.
1757 Specific security properties (as with the
1758 .B sasl-secprops
1759 keyword above) for a SASL bind can be set with the
1760 .B secprops
1761 option. A non default SASL realm can be set with the
1762 .B realm 
1763 option.
1764 The provider, other than allow authentication of the syncrepl identity,
1765 should grant that identity appropriate access privileges to the data 
1766 that is being replicated (\fBaccess\fP directive), and appropriate time 
1767 and size limits (\fBlimits\fP directive).
1768
1769
1770 The
1771 .B starttls
1772 parameter specifies use of the StartTLS extended operation
1773 to establish a TLS session before Binding to the provider. If the
1774 .B critical
1775 argument is supplied, the session will be aborted if the StartTLS request
1776 fails. Otherwise the syncrepl session continues without TLS. The
1777 tls_reqcert setting defaults to "demand" and the other TLS settings
1778 default to the same as the main slapd TLS settings.
1779
1780 Rather than replicating whole entries, the consumer can query logs of
1781 data modifications. This mode of operation is referred to as \fIdelta
1782 syncrepl\fP. In addition to the above parameters, the
1783 .B logbase
1784 and
1785 .B logfilter
1786 parameters must be set appropriately for the log that will be used. The
1787 .B syncdata
1788 parameter must be set to either "accesslog" if the log conforms to the
1789 .BR slapo-accesslog (5)
1790 log format, or "changelog" if the log conforms
1791 to the obsolete \fIchangelog\fP format. If the
1792 .B syncdata
1793 parameter is omitted or set to "default" then the log parameters are
1794 ignored.
1795 .RE
1796 .TP
1797 .B olcUpdateDN: <dn>
1798 This option is only applicable in a slave
1799 database.
1800 It specifies the DN permitted to update (subject to access controls)
1801 the replica.  It is only needed in certain push-mode
1802 replication scenarios.  Generally, this DN
1803 .I should not
1804 be the same as the
1805 .B rootdn 
1806 used at the master.
1807 .TP
1808 .B olcUpdateRef: <url>
1809 Specify the referral to pass back when
1810 .BR slapd (8)
1811 is asked to modify a replicated local database.
1812 If multiple values are specified, each url is provided.
1813
1814 .SH DATABASE-SPECIFIC OPTIONS
1815 Each database may allow specific configuration options; they are
1816 documented separately in the backends' manual pages. See the
1817 .BR slapd.backends (5)
1818 manual page for an overview of available backends.
1819 .SH OVERLAYS
1820 An overlay is a piece of
1821 code that intercepts database operations in order to extend or change
1822 them. Overlays are pushed onto
1823 a stack over the database, and so they will execute in the reverse
1824 of the order in which they were configured and the database itself
1825 will receive control last of all.
1826
1827 Overlays must be configured as child entries of a specific database. The
1828 entry's RDN must be of the form
1829 .B olcOverlay={x}<overlaytype>
1830 and the entry must have the olcOverlayConfig objectClass. Normally the
1831 config engine generates the "{x}" index in the RDN automatically, so
1832 it can be omitted when initially loading these entries.
1833
1834 See the
1835 .BR slapd.overlays (5)
1836 manual page for an overview of available overlays.
1837 .SH EXAMPLES
1838 .LP
1839 Here is a short example of a configuration in LDIF suitable for use with
1840 .BR slapadd (8)
1841 :
1842 .LP
1843 .RS
1844 .nf
1845 dn: cn=config
1846 objectClass: olcGlobal
1847 cn: config
1848 olcPidFile: LOCALSTATEDIR/run/slapd.pid
1849 olcAttributeOptions: x-hidden lang-
1850
1851 dn: cn=schema,cn=config
1852 objectClass: olcSchemaConfig
1853 cn: schema
1854
1855 include: SYSCONFDIR/schema/core.ldif
1856
1857 dn: olcDatabase=frontend,cn=config
1858 objectClass: olcDatabaseConfig
1859 objectClass: olcFrontendConfig
1860 olcDatabase: frontend
1861 # Subtypes of "name" (e.g. "cn" and "ou") with the
1862 # option ";x-hidden" can be searched for/compared,
1863 # but are not shown.  See \fBslapd.access\fP(5).
1864 olcAccess: to attrs=name;x-hidden by * =cs
1865 # Protect passwords.  See \fBslapd.access\fP(5).
1866 olcAccess: to attrs=userPassword  by * auth
1867 # Read access to other attributes and entries.
1868 olcAccess: to * by * read
1869
1870 # set a rootpw for the config database so we can bind.
1871 # deny access to everyone else.
1872 dn: olcDatabase=config,cn=config
1873 objectClass: olcDatabaseConfig
1874 olcDatabase: config
1875 olcRootPW: {SSHA}XKYnrjvGT3wZFQrDD5040US592LxsdLy
1876 olcAccess: to * by * none
1877
1878 dn: olcDatabase=bdb,cn=config
1879 objectClass: olcDatabaseConfig
1880 objectClass: olcBdbConfig
1881 olcDatabase: bdb
1882 olcSuffix: "dc=our-domain,dc=com"
1883 # The database directory MUST exist prior to
1884 # running slapd AND should only be accessible
1885 # by the slapd/tools. Mode 0700 recommended.
1886 olcDbDirectory: LOCALSTATEDIR/openldap-data
1887 # Indices to maintain
1888 olcDbIndex:     objectClass  eq
1889 olcDbIndex:     cn,sn,mail   pres,eq,approx,sub
1890
1891 # We serve small clients that do not handle referrals,
1892 # so handle remote lookups on their behalf.
1893 dn: olcDatabase=ldap,cn=config
1894 objectClass: olcDatabaseConfig
1895 objectClass: olcLdapConfig
1896 olcDatabase: ldap
1897 olcSuffix: ""
1898 olcDbUri: ldap://ldap.some-server.com/
1899 .fi
1900 .RE
1901 .LP
1902 Assuming the above data was saved in a file named "config.ldif" and the
1903 ETCDIR/slapd.d directory has been created, this command will initialize
1904 the configuration:
1905 .RS
1906 .nf
1907 slapadd -F ETCDIR/slapd.d -n 0 -l config.ldif
1908 .fi
1909 .RE
1910
1911 .LP
1912 "OpenLDAP Administrator's Guide" contains a longer annotated
1913 example of a slapd configuration.
1914
1915 Alternatively, an existing slapd.conf file can be converted to the new
1916 format using slapd or any of the slap tools:
1917 .RS
1918 .nf
1919 slaptest -f ETCDIR/slapd.conf -F ETCDIR/slapd.d
1920 .fi
1921 .RE
1922
1923 .SH FILES
1924 .TP
1925 ETCDIR/slapd.conf
1926 default slapd configuration file
1927 .TP
1928 ETCDIR/slapd.d
1929 default slapd configuration directory
1930 .SH SEE ALSO
1931 .BR ldap (3),
1932 .BR ldif (5),
1933 .BR slapd.access (5),
1934 .BR slapd.backends (5),
1935 .BR slapd.conf (5),
1936 .BR slapd.overlays (5),
1937 .BR slapd.plugin (5),
1938 .BR slapd.replog (5),
1939 .BR slapd (8),
1940 .BR slapacl (8),
1941 .BR slapadd (8),
1942 .BR slapauth (8),
1943 .BR slapcat (8),
1944 .BR slapdn (8),
1945 .BR slapindex (8),
1946 .BR slappasswd (8),
1947 .BR slaptest (8).
1948 .LP
1949 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1950 .SH ACKNOWLEDGEMENTS
1951 .so ../Project