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