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