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