slapd-config.5 66.4 KB
Newer Older
1
.TH SLAPD-CONFIG 5 "RELEASEDATE" "OpenLDAP LDVERSION"
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
2
.\" Copyright 1998-2021 The OpenLDAP Foundation All Rights Reserved.
3
4
5
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
.\" $OpenLDAP$
.SH NAME
Howard Chu's avatar
Howard Chu committed
6
slapd\-config \- configuration backend to slapd
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
.SH SYNOPSIS
ETCDIR/slapd.d
.SH DESCRIPTION
The
.B config
backend manages all of the configuration information for the
.BR slapd (8)
daemon.  This configuration information is also used by the SLAPD tools
.BR slapacl (8),
.BR slapadd (8),
.BR slapauth (8),
.BR slapcat (8),
.BR slapdn (8),
.BR slapindex (8),
and
.BR slaptest (8).
.LP
The
.B config
backend is backward compatible with the older
.BR slapd.conf (5)
file but provides the ability to change the configuration dynamically
at runtime. If slapd is run with only a
.B slapd.conf
file dynamic changes will be allowed but they will not persist across
a server restart. Dynamic changes are only saved when slapd is running
from a
.B slapd.d
configuration directory.
.LP

Unlike other backends, there can only be one instance of the
.B config
backend, and most of its structure is predefined. The root of the
database is hardcoded to
.B "cn=config"
and this root entry contains
global settings for slapd. Multiple child entries underneath the
root entry are used to carry various other settings:
.RS
.TP
.B cn=Module
dynamically loaded modules
.TP
.B cn=Schema
schema definitions
.TP
.B olcBackend=xxx
backend-specific settings
.TP
.B olcDatabase=xxx
database-specific settings
.RE

The
.B cn=Module
entries will only appear in configurations where slapd
was built with support for dynamically loaded modules. There can be
multiple entries, one for each configured module path. Within each
entry there will be values recorded for each module loaded on a
given path. These entries have no children.

The
.B cn=Schema
entry contains all of the hardcoded schema elements.
The children of this entry contain all user-defined schema elements.
In schema that were loaded from include files, the child entry will
be named after the include file from which the schema was loaded.
Typically the first child in this subtree will be
.BR cn=core,cn=schema,cn=config .

.B olcBackend
entries are for storing settings specific to a single
backend type (and thus global to all database instances of that type).
At present there are no backends that implement settings of this
nature, so usually there will not be any olcBackend entries.

.B olcDatabase
entries store settings specific to a single database
instance. These entries may have
.B olcOverlay
child entries corresponding
to any overlays configured on the database. The olcDatabase and
olcOverlay entries may also have miscellaneous child entries for
other settings as needed. There are two special database entries
92
that are predefined \- one is an entry for the config database itself,
93
94
95
96
97
98
99
100
101
102
103
104
105
and the other is for the "frontend" database. Settings in the
frontend database are inherited by the other databases, unless
they are explicitly overridden in a specific database.
.LP
The specific configuration options available are discussed below in the
Global Configuration Options, General Backend Options, and General Database
Options. Options are set by defining LDAP attributes with specific values.
In general the names of the LDAP attributes are the same as the corresponding
.B slapd.conf
keyword, with an "olc" prefix added on.

The parser for many of these attributes is the same as used for parsing
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
108
109
110
111
multiple items to be specified in one attribute value. However, when
reading the attribute via LDAP, the items will be returned as individual
attribute values.

Backend-specific options are discussed in the
Howard Chu's avatar
Howard Chu committed
112
.B slapd\-<backend>(5)
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
manual pages.  Refer to the "OpenLDAP Administrator's Guide" for more
details on configuring slapd.
.SH GLOBAL CONFIGURATION OPTIONS
Options described in this section apply to the server as a whole.
Arguments that should be replaced by 
actual text are shown in brackets <>.

These options may only be specified in the
.B cn=config
entry. This entry must have an objectClass of
.BR olcGlobal .

.TP
.B olcAllows: <features>
Specify a set of features to allow (default none).
.B bind_v2
allows acceptance of LDAPv2 bind requests.  Note that
.BR slapd (8)
does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
.B bind_anon_cred
allows anonymous bind when credentials are not empty (e.g.
when DN is empty).
.B bind_anon_dn
allows unauthenticated (anonymous) bind when DN is not empty.
.B update_anon
allows unauthenticated (anonymous) update operations to be processed
(subject to access controls and other administrative limits).
.B proxy_authz_anon
allows unauthenticated (anonymous) proxy authorization control to be processed
(subject to access controls, authorization and other administrative limits).
.TP
.B olcArgsFile: <filename>
145
The (absolute) name of a file that will hold the 
146
.B slapd
147
server's command line (program name and options).
148
149
150
.TP
.B olcAttributeOptions: <option-name>...
Define tagging attribute options or option tag/range prefixes.
Howard Chu's avatar
Howard Chu committed
151
152
Options must not end with `\-', prefixes must end with `\-'.
The `lang\-' prefix is predefined.
153
154
If you use the
.B olcAttributeOptions
Howard Chu's avatar
Howard Chu committed
155
directive, `lang\-' will no longer be defined and you must specify it
156
157
158
159
160
explicitly if you want it defined.

An attribute description with a tagging option is a subtype of that
attribute description without the option.
Except for that, options defined this way have no special semantics.
Howard Chu's avatar
Howard Chu committed
161
Prefixes defined this way work like the `lang\-' options:
162
They define a prefix for tagging options starting with the prefix.
Howard Chu's avatar
Howard Chu committed
163
164
That is, if you define the prefix `x\-foo\-', you can use the option
`x\-foo\-bar'.
165
Furthermore, in a search or compare, a prefix or range name (with
Howard Chu's avatar
Howard Chu committed
166
167
168
a trailing `\-') matches all options starting with that name, as well
as the option with the range name sans the trailing `\-'.
That is, `x\-foo\-bar\-' matches `x\-foo\-bar' and `x\-foo\-bar\-baz'.
169

Howard Chu's avatar
Howard Chu committed
170
RFC 4520 reserves options beginning with `x\-' for private experiments.
171
172
173
174
Other options should be registered with IANA, see RFC 4520 section 3.5.
OpenLDAP also has the `binary' option built in, but this is a transfer
option, not a tagging option.
.TP
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
.B olcAuthIDRewrite: <rewrite\-rule>
Used by the authentication framework to convert simple user names
to an LDAP DN used for authorization purposes.
Its purpose is analogous to that of
.BR olcAuthzRegexp
(see below).
The
.B rewrite\-rule
is a set of rules analogous to those described in
.BR slapo\-rwm (5)
for data rewriting (after stripping the \fIrwm\-\fP prefix).
.B olcAuthIDRewrite
and
.B olcAuthzRegexp
should not be intermixed.
.TP
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
.B olcAuthzPolicy: <policy>
Used to specify which rules to use for Proxy Authorization.  Proxy
authorization allows a client to authenticate to the server using one
user's credentials, but specify a different identity to use for authorization
and access control purposes. It essentially allows user A to login as user
B, using user A's password.
The
.B none
flag disables proxy authorization. This is the default setting.
The
.B from
flag will use rules in the
.I authzFrom
attribute of the authorization DN.
The
.B to
flag will use rules in the
.I authzTo
attribute of the authentication DN.
The
.B any
flag, an alias for the deprecated value of
.BR both ,
will allow any of the above, whatever succeeds first (checked in
.BR to ,
.B from
sequence.
The
.B all
flag requires both authorizations to succeed.
.LP
.RS
The rules are mechanisms to specify which identities are allowed 
to perform proxy authorization.
The
.I authzFrom
attribute in an entry specifies which other users
are allowed to proxy login to this entry. The
.I authzTo
attribute in
an entry specifies which other users this user can authorize as.  Use of
.I authzTo
rules can be easily
abused if users are allowed to write arbitrary values to this attribute.
In general the
.I authzTo
attribute must be protected with ACLs such that
only privileged users can modify it.
The value of
.I authzFrom
and
.I authzTo
describes an 
.B identity 
or a set of identities; it can take five forms:
.RS
.TP
.B ldap:///<base>??[<scope>]?<filter>
.RE
.RS
.B dn[.<dnstyle>]:<pattern>
.RE
.RS
.B u[<mech>[<realm>]]:<pattern>
.RE
.RS
.B group[/objectClass[/attributeType]]:<pattern>
.RE
.RS
.B <pattern>
.RE
.RS

.B <dnstyle>:={exact|onelevel|children|subtree|regex}

.RE
The first form is a valid LDAP
.B URI
where the 
.IR <host>:<port> ,
the
.I <attrs>
and the
.I <extensions>
portions must be absent, so that the search occurs locally on either
.I authzFrom
or 
.IR authzTo .
The second form is a 
.BR DN ,
with the optional style modifiers
.IR exact ,
.IR onelevel ,
.IR children ,
and
.I subtree
for exact, onelevel, children and subtree matches, which cause 
.I <pattern>
to be normalized according to the DN normalization rules, or the special
.I regex
style, which causes the
.I <pattern>
to be treated as a POSIX (''extended'') regular expression, as
discussed in
.BR regex (7)
and/or
.BR re_format (7).
A pattern of
.I *
means any non-anonymous DN.
The third form is a SASL
.BR id ,
with the optional fields
.I <mech>
and
.I <realm>
that allow to specify a SASL
.BR mechanism ,
and eventually a SASL
.BR realm ,
for those mechanisms that support one.
The need to allow the specification of a mechanism is still debated, 
and users are strongly discouraged to rely on this possibility.
The fourth form is a group specification, consisting of the keyword
.BR group ,
optionally followed by the specification of the group
.B objectClass
and member
.BR attributeType .
The group with DN
.B <pattern>
is searched with base scope, and in case of match, the values of the
member
.B attributeType
are searched for the asserted DN.
For backwards compatibility, if no identity type is provided, i.e. only
.B <pattern>
is present, an
.I exact DN
is assumed; as a consequence, 
.B <pattern>
is subjected to DN normalization.
Since the interpretation of
.I authzFrom
and
.I authzTo
can impact security, users are strongly encouraged 
to explicitly set the type of identity specification that is being used.
A subset of these rules can be used as third arg in the 
.B olcAuthzRegexp
statement (see below); significantly, the 
.I URI
and the
.I dn.exact:<dn> 
forms.
.RE
.TP
.B olcAuthzRegexp: <match> <replace>
Used by the authentication framework to convert simple user names,
such as provided by SASL subsystem, to an LDAP DN used for
authorization purposes.  Note that the resultant DN need not refer
to an existing entry to be considered valid.  When an authorization
request is received from the SASL subsystem, the SASL 
.BR USERNAME ,
.BR REALM , 
and
.B MECHANISM
are taken, when available, and combined into a name of the form
.RS
.RS
.TP
.B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth

.RE
This name is then compared against the
.B match
POSIX (''extended'') regular expression, and if the match is successful,
the name is replaced with the
.B replace
string.  If there are wildcard strings in the 
.B match
regular expression that are enclosed in parenthesis, e.g. 
.RS
.TP
.B UID=([^,]*),CN=.*

.RE
then the portion of the name that matched the wildcard will be stored
in the numbered placeholder variable $1. If there are other wildcard strings
in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The 
placeholders can then be used in the 
.B replace
string, e.g. 
.RS
.TP
.B UID=$1,OU=Accounts,DC=example,DC=com 

.RE
The replaced name can be either a DN, i.e. a string prefixed by "dn:",
or an LDAP URI.
If the latter, the server will use the URI to search its own database(s)
and, if the search returns exactly one entry, the name is
replaced by the DN of that entry.   The LDAP URI must have no
hostport, attrs, or extensions components, but the filter is mandatory,
e.g.
.RS
.TP
.B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)

.RE
The protocol portion of the URI must be strictly
.BR ldap .
Note that this search is subject to access controls.  Specifically,
the authentication identity must have "auth" access in the subject.

Multiple 
.B olcAuthzRegexp 
Howard Chu's avatar
Howard Chu committed
408
values can be specified to allow for multiple matching 
409
and replacement patterns. The matching patterns are checked in the order they 
Howard Chu's avatar
Howard Chu committed
410
appear in the attribute, stopping at the first successful match.
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447

.\".B Caution:
.\"Because the plus sign + is a character recognized by the regular expression engine,
.\"and it will appear in names that include a REALM, be careful to escape the
.\"plus sign with a backslash \\+ to remove the character's special meaning.
.RE
.TP
.B olcConcurrency: <integer>
Specify a desired level of concurrency.  Provided to the underlying
thread system as a hint.  The default is not to provide any hint. This setting
is only meaningful on some platforms where there is not a one to one
correspondence between user threads and kernel threads.
.TP
.B olcConnMaxPending: <integer>
Specify the maximum number of pending requests for an anonymous session.
If requests are submitted faster than the server can process them, they
will be queued up to this limit. If the limit is exceeded, the session
is closed. The default is 100.
.TP
.B olcConnMaxPendingAuth: <integer>
Specify the maximum number of pending requests for an authenticated session.
The default is 1000.
.TP
.B olcDisallows: <features>
Specify a set of features to disallow (default none).
.B bind_anon
disables acceptance of anonymous bind requests.  Note that this setting
does not prohibit anonymous directory access (See "require authc").
.B bind_simple
disables simple (bind) authentication.
.B tls_2_anon
disables forcing session to anonymous status (see also
.BR tls_authc )
upon StartTLS operation receipt.
.B tls_authc
disallows the StartTLS operation if authenticated (see also
.BR tls_2_anon ).
448
449
450
451
452
453
.B proxy_authz_non_critical
disables acceptance of the proxied authorization control (RFC4370)
with criticality set to FALSE.
.B dontusecopy_non_critical
disables acceptance of the dontUseCopy control (a work in progress)
with criticality set to FALSE.
454
455
456
457
458
459
460
.TP
.B olcGentleHUP: { TRUE | FALSE }
A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
.B Slapd
will stop listening for new connections, but will not close the
connections to the current clients.  Future write operations return
unwilling-to-perform, though.  Slapd terminates when all clients
461
have closed their connections (if they ever do), or \- as before \-
462
463
464
465
466
467
468
if it receives a SIGTERM signal.  This can be useful if you wish to
terminate the server and start a new
.B slapd
server
.B with another database,
without disrupting the currently active clients.
The default is FALSE.  You may wish to use
Howard Chu's avatar
Howard Chu committed
469
.B olcIdleTimeout
470
471
472
473
along with this option.
.TP
.B olcIdleTimeout: <integer>
Specify the number of seconds to wait before forcibly closing
474
an idle client connection.  A setting of 0 disables this
Howard Chu's avatar
Howard Chu committed
475
476
477
feature.  The default is 0. You may also want to set the
.B olcWriteTimeout
option.
478
.TP
479
480
481
482
483
484
485
486
487
488
.B olcIndexHash64: { on | off }
Use a 64 bit hash for indexing. The default is to use 32 bit hashes.
These hashes are used for equality and substring indexing. The 64 bit
version may be needed to avoid index collisions when the number of
indexed values exceeds ~64 million. (Note that substring indexing
generates multiple index values per actual attribute value.)
Indices generated with 32 bit hashes are incompatible with the 64 bit
version, and vice versa. Any existing databases must be fully reloaded
when changing this setting. This directive is only supported on 64 bit CPUs.
.TP
Howard Chu's avatar
Howard Chu committed
489
490
.B olcIndexIntLen: <integer>
Specify the key length for ordered integer indices. The most significant
Howard Chu's avatar
Howard Chu committed
491
bytes of the binary integer will be used for index keys. The default
492
493
value is 4, which provides exact indexing for 31 bit values.
A floating point representation is used to index too large values.
Howard Chu's avatar
Howard Chu committed
494
.TP
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
.B olcIndexSubstrIfMaxlen: <integer>
Specify the maximum length for subinitial and subfinal indices. Only
this many characters of an attribute value will be processed by the
indexing functions; any excess characters are ignored. The default is 4.
.TP
.B olcIndexSubstrIfMinlen: <integer>
Specify the minimum length for subinitial and subfinal indices. An
attribute value must have at least this many characters in order to be
processed by the indexing functions. The default is 2.
.TP
.B olcIndexSubstrAnyLen: <integer>
Specify the length used for subany indices. An attribute value must have
at least this many characters in order to be processed. Attribute values
longer than this length will be processed in segments of this length. The
default is 4. The subany index will also be used in subinitial and
subfinal index lookups when the filter string is longer than the
511
.I olcIndexSubstrIfMaxlen
512
513
514
515
516
517
518
519
520
value.
.TP
.B olcIndexSubstrAnyStep: <integer>
Specify the steps used in subany index lookups. This value sets the offset
for the segments of a filter string that are processed for a subany index
lookup. The default is 2. For example, with the default values, a search
using this filter "cn=*abcdefgh*" would generate index lookups for
"abcd", "cdef", and "efgh".

Howard Chu's avatar
Howard Chu committed
521
522
523
.LP
Note: Indexing support depends on the particular backend in use. Also,
changing these settings will generally require deleting any indices that
Howard Chu's avatar
Howard Chu committed
524
525
depend on these parameters and recreating them with
.BR slapindex (8).
Howard Chu's avatar
Howard Chu committed
526

527
528
529
530
531
.TP
.B olcListenerThreads: <integer>
Specify the number of threads to use for the connection manager.
The default is 1 and this is typically adequate for up to 16 CPU cores.
The value should be set to a power of 2.
532
533
534
535
536
537
538
539
540
.TP
.B olcLocalSSF: <SSF>
Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
such as those to the ldapi:// listener.  For a description of SSF values,
see 
.BR olcSaslSecProps 's
.B minssf
option description.  The default is 71.
.TP
Howard Chu's avatar
Howard Chu committed
541
.B olcLogFile: <filename>
Howard Chu's avatar
Howard Chu committed
542
543
544
545
Specify a file for recording debug log messages. By default these messages
only go to stderr and are not recorded anywhere else. Specifying a logfile
copies messages to both stderr and the logfile.
.TP
546
547
548
549
550
551
552
553
.B olcLogLevel: <integer> [...]
Specify the level at which debugging statements and operation 
statistics should be syslogged (currently logged to the
.BR syslogd (8) 
LOG_LOCAL4 facility).
They must be considered subsystems rather than increasingly verbose 
log levels.
Some messages with higher priority are logged regardless 
Howard Chu's avatar
Howard Chu committed
554
of the configured loglevel as soon as any logging is configured.
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
Log levels are additive, and available levels are:
.RS
.RS
.PD 0
.TP
.B 1
.B (0x1 trace)
trace function calls
.TP
.B 2
.B (0x2 packets)
debug packet handling
.TP
.B 4
.B (0x4 args)
heavy trace debugging (function args)
.TP
.B 8
.B (0x8 conns)
connection management
.TP
.B 16
.B (0x10 BER)
print out packets sent and received
.TP
.B 32
.B (0x20 filter)
search filter processing
.TP
.B 64
.B (0x40 config)
configuration file processing
.TP
.B 128
.B (0x80 ACL)
access control list processing
.TP
.B 256
.B (0x100 stats)
stats log connections/operations/results
.TP
.B 512
.B (0x200 stats2)
stats log entries sent
.TP
.B 1024
.B (0x400 shell)
print communication with shell backends
.TP
.B 2048
.B (0x800 parse)
entry parsing
\".TP
\".B 4096
\".B (0x1000 cache)
\"caching (unused)
\".TP
\".B 8192
\".B (0x2000 index)
\"data indexing (unused)
.TP
.B 16384
.B (0x4000 sync)
LDAPSync replication
.TP
.B 32768
.B (0x8000 none)
only messages that get logged whatever log level is set
.PD
.RE
The desired log level can be input as a single integer that combines 
the (ORed) desired levels, both in decimal or in hexadecimal notation,
as a list of integers (that are ORed internally),
628
or as a list of the names that are shown between parenthesis, such that
629
630
.LP
.nf
Howard Chu's avatar
Howard Chu committed
631
632
633
634
635
    olcLogLevel: 129
    olcLogLevel: 0x81
    olcLogLevel: 128 1
    olcLogLevel: 0x80 0x1
    olcLogLevel: acl trace
636
637
638
639
640
.fi
.LP
are equivalent.
The keyword 
.B any
Howard Chu's avatar
Howard Chu committed
641
can be used as a shortcut to enable logging at all levels (equivalent to \-1).
642
643
644
The keyword
.BR none ,
or the equivalent integer representation, causes those messages
Howard Chu's avatar
Howard Chu committed
645
646
that are logged regardless of the configured olcLogLevel to be logged.
In fact, if no olcLogLevel (or a 0 level) is defined, no logging occurs, 
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
so at least the 
.B none
level is required to have high priority messages logged.
.RE
.TP
.B olcPasswordCryptSaltFormat: <format>
Specify the format of the salt passed to
.BR crypt (3)
when generating {CRYPT} passwords (see
.BR olcPasswordHash )
during processing of LDAP Password Modify Extended Operations (RFC 3062).

This string needs to be in
.BR sprintf (3)
format and may include one (and only one) %s conversion.
This conversion will be substituted with a string of random
characters from [A\-Za\-z0\-9./].  For example, "%.2s"
provides a two character salt and "$1$%.8s" tells some
versions of crypt(3) to use an MD5 algorithm and provides
8 random characters of salt.  The default is "%s", which
provides 31 characters of salt.
.TP
.B olcPidFile: <filename>
670
The (absolute) name of a file that will hold the 
671
.B slapd
672
673
server's process ID (see
.BR getpid (2)).
674
675
676
677
678
.TP
.B olcPluginLogFile: <filename>
The ( absolute ) name of a file that will contain log
messages from
.B SLAPI
679
680
681
plugins. See
.BR slapd.plugin (5)
for details.
682
683
684
685
686
687
688
689
690
691
.TP
.B olcReferral: <url>
Specify the referral to pass back when
.BR slapd (8)
cannot find a local database to handle a request.
If multiple values are specified, each url is provided.
.TP
.B olcReverseLookup: TRUE | FALSE
Enable/disable client name unverified reverse lookup (default is 
.BR FALSE 
Howard Chu's avatar
Howard Chu committed
692
if compiled with \-\-enable\-rlookups).
693
694
695
696
697
.TP
.B olcRootDSE: <file>
Specify the name of an LDIF(5) file containing user defined attributes
for the root DSE.  These attributes are returned in addition to the
attributes normally produced by slapd.
Hallvard Furuseth's avatar
Hallvard Furuseth committed
698
699
700
701
702

The root DSE is an entry with information about the server and its
capabilities, in operational attributes.
It has the empty DN, and can be read with e.g.:
.ti +4
Howard Chu's avatar
Howard Chu committed
703
ldapsearch \-x \-b "" \-s base "+"
Hallvard Furuseth's avatar
Hallvard Furuseth committed
704
705
.br
See RFC 4512 section 5.1 for details.
706
.TP
Howard Chu's avatar
Howard Chu committed
707
.B olcSaslAuxprops: <plugin> [...]
Howard Chu's avatar
Howard Chu committed
708
709
710
711
Specify which auxprop plugins to use for authentication lookups. The
default is empty, which just uses slapd's internal support. Usually
no other auxprop plugins are needed.
.TP
712
713
714
715
716
717
718
719
.B olcSaslAuxpropsDontUseCopy: <attr> [...]
Specify which attribute(s) should be subject to the don't use copy control. This
is necessary for some SASL mechanisms such as OTP to work in a replicated
environment. The attribute "cmusaslsecretOTP" is the default value.
.TP
.B olcSaslAuxpropsDontUseCopyIgnore TRUE | FALSE
Used to disable replication of the attribute(s) defined by
olcSaslAuxpropsDontUseCopy and instead use a local value for the attribute. This
720
allows the SASL mechanism to continue to work if the provider is offline. This can
721
722
cause replication inconsistency. Defaults to FALSE.
.TP
723
724
725
726
727
728
.B olcSaslHost: <fqdn>
Used to specify the fully qualified domain name used for SASL processing.
.TP
.B olcSaslRealm: <realm>
Specify SASL realm.  Default is empty.
.TP
729
730
731
732
.B olcSaslCbinding: none | tls-unique | tls-endpoint
Specify the channel-binding type, see also LDAP_OPT_X_SASL_CBINDING.
Default is none.
.TP
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
.B olcSaslSecProps: <properties>
Used to specify Cyrus SASL security properties.
The
.B none
flag (without any other properties) causes the flag properties
default, "noanonymous,noplain", to be cleared.
The
.B noplain
flag disables mechanisms susceptible to simple passive attacks.
The
.B noactive
flag disables mechanisms susceptible to active attacks.
The
.B nodict
flag disables mechanisms susceptible to passive dictionary attacks.
The
.B noanonymous
flag disables mechanisms which support anonymous login.
The
.B forwardsec
flag require forward secrecy between sessions.
The
.B passcred
require mechanisms which pass client credentials (and allow
mechanisms which can pass credentials to do so).
The
.B minssf=<factor> 
property specifies the minimum acceptable
.I security strength factor
as an integer approximate to effective key length used for
encryption.  0 (zero) implies no protection, 1 implies integrity
protection only, 56 allows DES or other weak ciphers, 112
allows triple DES and other strong ciphers, 128 allows RC4,
Blowfish and other modern strong ciphers.  The default is 0.
The
.B maxssf=<factor> 
property specifies the maximum acceptable
.I security strength factor
as an integer (see minssf description).  The default is INT_MAX.
The
.B maxbufsize=<size> 
property specifies the maximum security layer receive buffer
size allowed.  0 disables security layers.  The default is 65536.
.TP
Howard Chu's avatar
Howard Chu committed
777
.B olcServerID: <integer> [<URL>]
778
779
780
Specify an integer ID from 0 to 4095 for this server (limited
to 3 hexadecimal digits).  The ID may also be specified as a
hexadecimal ID by prefixing the value with "0x".
781
Non-zero IDs are
782
783
required when using multi-provider replication and each provider must have a
unique non-zero ID. Note that this requirement also applies to separate providers
784
785
contributing to a glued set of databases.
If the URL is provided, this directive may be specified
Howard Chu's avatar
Howard Chu committed
786
787
788
multiple times, providing a complete list of participating servers
and their IDs. The fully qualified hostname of each server should be
used in the supplied URLs. The IDs are used in the "replica id" field
789
of all CSNs generated by the specified server. The default value is zero, which
790
is only valid for single provider replication.
Howard Chu's avatar
Howard Chu committed
791
792
793
794
795
796
797
Example:
.LP
.nf
	olcServerID: 1 ldap://ldap1.example.com
	olcServerID: 2 ldap://ldap2.example.com
.fi
.TP
798
799
800
801
802
803
804
805
.B olcSockbufMaxIncoming: <integer>
Specify the maximum incoming LDAP PDU size for anonymous sessions.
The default is 262143.
.TP
.B olcSockbufMaxIncomingAuth: <integer>
Specify the maximum incoming LDAP PDU size for authenticated sessions.
The default is 4194303.
.TP
806
807
808
809
810
811
812
813
814
815
.B olcTCPBuffer [listener=<URL>] [{read|write}=]<size>
Specify the size of the TCP buffer.
A global value for both read and write TCP buffers related to any listener
is defined, unless the listener is explicitly specified,
or either the read or write qualifiers are used.
See
.BR tcp (7)
for details.
Note that some OS-es implement automatic TCP buffer tuning.
.TP
816
817
818
819
.B olcThreads: <integer>
Specify the maximum size of the primary thread pool.
The default is 16; the minimum value is 2.
.TP
Howard Chu's avatar
Howard Chu committed
820
821
822
823
824
.B olcThreadQueues: <integer>
Specify the number of work queues to use for the primary thread pool.
The default is 1 and this is typically adequate for up to 8 CPU cores.
The value should not exceed the number of CPUs in the system.
.TP
825
826
827
828
.B olcToolThreads: <integer>
Specify the maximum number of threads to use in tool mode.
This should not be greater than the number of CPUs in the system.
The default is 1.
Howard Chu's avatar
Howard Chu committed
829
830
831
832
833
834
.TP
.B olcWriteTimeout: <integer>
Specify the number of seconds to wait before forcibly closing
a connection with an outstanding write.  This allows recovery from
various network hang conditions.  A setting of 0 disables this
feature.  The default is 0.
835
836
837
838
839
840
841
842
.SH TLS OPTIONS
If
.B slapd
is built with support for Transport Layer Security, there are more options
you can specify.
.TP
.B olcTLSCipherSuite: <cipher-suite-spec>
Permits configuring what ciphers will be accepted and the preference order.
Howard Chu's avatar
Howard Chu committed
843
<cipher-suite-spec> should be a cipher specification for
844
the TLS library in use (OpenSSL or GnuTLS).
845
846
847
848
849
Example:
.RS
.RS
.TP
.I OpenSSL:
850
olcTLSCipherSuite: HIGH:MEDIUM:+SSLv2
851
.TP
Howard Chu's avatar
Howard Chu committed
852
.I GnuTLS:
853
olcTLSCiphersuite: SECURE256:!AES-128-CBC
854
.RE
855

Howard Chu's avatar
Howard Chu committed
856
To check what ciphers a given spec selects in OpenSSL, use:
857

Howard Chu's avatar
Howard Chu committed
858
.nf
Howard Chu's avatar
Howard Chu committed
859
	openssl ciphers \-v <cipher-suite-spec>
Howard Chu's avatar
Howard Chu committed
860
861
.fi

Howard Chu's avatar
Howard Chu committed
862
With GnuTLS the available specs can be found in the manual page of
863
864
865
866
867
.BR gnutls\-cli (1)
(see the description of the
option
.BR \-\-priority ).

Howard Chu's avatar
Howard Chu committed
868
In older versions of GnuTLS, where gnutls\-cli does not support the option
869
\-\-priority, you can obtain the \(em more limited \(em list of ciphers by calling:
Howard Chu's avatar
Howard Chu committed
870
871

.nf
872
	gnutls\-cli \-l
Howard Chu's avatar
Howard Chu committed
873
.fi
874
.RE
875
876
877
878
879
880
881
882
883
884
.TP
.B olcTLSCACertificateFile: <filename>
Specifies the file that contains certificates for all of the Certificate
Authorities that
.B slapd
will recognize.
.TP
.B olcTLSCACertificatePath: <path>
Specifies the path of a directory that contains Certificate Authority
certificates in separate individual files. Usually only one of this
885
or the olcTLSCACertificateFile is defined. If both are specified, both
886
locations will be used.
887
888
889
890
891
892
893
894
895
896
897
.TP
.B olcTLSCertificateFile: <filename>
Specifies the file that contains the
.B slapd
server certificate.
.TP
.B olcTLSCertificateKeyFile: <filename>
Specifies the file that contains the
.B slapd
server private key that matches the certificate stored in the
.B olcTLSCertificateFile
Howard Chu's avatar
Howard Chu committed
898
899
900
901
902
file. If the private key is protected with a password, the password must
be manually typed in when slapd starts.  Usually the private key is not
protected with a password, to allow slapd to start without manual
intervention, so
it is of critical importance that the file is protected carefully. 
903
904
905
906
.TP
.B olcTLSDHParamFile: <filename>
This directive specifies the file that contains parameters for Diffie-Hellman
ephemeral key exchange.  This is required in order to use a DSA certificate on
Howard Chu's avatar
Howard Chu committed
907
908
the server, or an RSA certificate missing the "key encipherment" key usage.
Note that setting this option may also enable
909
Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
Howard Chu's avatar
Howard Chu committed
910
911
912
913
914
Anonymous key exchanges should generally be avoided since they provide no
actual client or server authentication and provide no protection against
man-in-the-middle attacks.
You should append "!ADH" to your cipher suites to ensure that these suites
are not used.
915
.TP
916
.B olcTLSECName: <name>
917
918
919
Specify the name of the curve(s) to use for Elliptic curve Diffie-Hellman
ephemeral key exchange.  This option is only used for OpenSSL.
This option is not used with GnuTLS; the curves may be
920
chosen in the GnuTLS ciphersuite specification.
921
.TP
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
.B olcTLSProtocolMin: <major>[.<minor>]
Specifies minimum SSL/TLS protocol version that will be negotiated.
If the server doesn't support at least that version,
the SSL handshake will fail.
To require TLS 1.x or higher, set this option to 3.(x+1),
e.g.,

.nf
	olcTLSProtocolMin: 3.2
.fi

would require TLS 1.1.
Specifying a minimum that is higher than that supported by the
OpenLDAP implementation will result in it requiring the
highest level that it does support.
This directive is ignored with GnuTLS.
.TP
939
940
941
942
.B olcTLSRandFile: <filename>
Specifies the file to obtain random bits from when /dev/[u]random
is not available.  Generally set to the name of the EGD/PRNGD socket.
The environment variable RANDFILE can also be used to specify the filename.
943
This directive is ignored with GnuTLS.
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
.TP
.B olcTLSVerifyClient: <level>
Specifies what checks to perform on client certificates in an
incoming TLS session, if any.
The
.B <level>
can be specified as one of the following keywords:
.RS
.TP
.B never
This is the default.
.B slapd
will not ask the client for a certificate.
.TP
.B allow
The client certificate is requested.  If no certificate is provided,
the session proceeds normally.  If a bad certificate is provided,
it will be ignored and the session proceeds normally.
.TP
.B try
The client certificate is requested.  If no certificate is provided,
the session proceeds normally.  If a bad certificate is provided,
the session is immediately terminated.
.TP
.B demand | hard | true
These keywords are all equivalent, for compatibility reasons.
The client certificate is requested.  If no certificate is provided,
or a bad certificate is provided, the session is immediately terminated.

Note that a valid client certificate is required in order to use the
SASL EXTERNAL authentication mechanism with a TLS session.  As such,
a non-default
.B olcTLSVerifyClient
setting must be chosen to enable SASL EXTERNAL authentication.
.RE
.TP
.B olcTLSCRLCheck: <level>
Specifies if the Certificate Revocation List (CRL) of the CA should be 
used to verify if the client certificates have not been revoked. This
requires
.B olcTLSCACertificatePath
985
parameter to be set. This parameter is ignored with GnuTLS.
986
987
988
989
990
991
992
993
994
995
996
997
998
.B <level>
can be specified as one of the following keywords:
.RS
.TP
.B none
No CRL checks are performed
.TP
.B peer
Check the CRL of the peer certificate
.TP
.B all
Check the CRL for a whole certificate chain
.RE
Howard Chu's avatar
Howard Chu committed
999
1000
1001
1002
.TP
.B olcTLSCRLFile: <filename>
Specifies a file containing a Certificate Revocation List to be used
for verifying that certificates have not been revoked. This parameter
1003
is only valid when using GnuTLS.
1004
1005
1006
.SH DYNAMIC MODULE OPTIONS
If
.B slapd
Howard Chu's avatar
Howard Chu committed
1007
is compiled with \-\-enable\-modules then the module-related entries will
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
be available. These entries are named
.B cn=module{x},cn=config
and
must have the olcModuleList objectClass. One entry should be created
per
.B olcModulePath.
Normally the config engine generates the "{x}" index in the RDN
automatically, so it can be omitted when initially loading these entries.
.TP
.B olcModuleLoad: <filename>
Specify the name of a dynamically loadable module to load. The filename
may be an absolute path name or a simple filename. Non-absolute names
are searched for in the directories specified by the
.B olcModulePath
option.
.TP
.B olcModulePath: <pathspec>
Specify a list of directories to search for loadable modules. Typically
the path is colon-separated but this depends on the operating system.
1027
1028
The default is MODULEDIR, which is where the standard OpenLDAP install
will place its modules. 
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
.SH SCHEMA OPTIONS
Schema definitions are created as entries in the
.B cn=schema,cn=config
subtree. These entries must have the olcSchemaConfig objectClass.
As noted above, the actual
.B cn=schema,cn=config
entry is predefined and any values specified for it are ignored.

.HP
.hy 0
.B olcAttributetypes: "(\ <oid>\
 [NAME\ <name>]\
 [DESC\ <description>]\
 [OBSOLETE]\
 [SUP\ <oid>]\
 [EQUALITY\ <oid>]\
 [ORDERING\ <oid>]\
 [SUBSTR\ <oid>]\
 [SYNTAX\ <oidlen>]\
 [SINGLE\-VALUE]\
 [COLLECTIVE]\
 [NO\-USER\-MODIFICATION]\
 [USAGE\ <attributeUsage>]\ )"
.RS
Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
The slapd parser extends the RFC 4512 definition by allowing string
forms as well as numeric OIDs to be used for the attribute OID and
attribute syntax OID.
(See the
.B olcObjectIdentifier
description.) 
.RE

.HP
.hy 0
.B olcDitContentRules: "(\ <oid>\
 [NAME\ <name>]\
 [DESC\ <description>]\
 [OBSOLETE]\
 [AUX\ <oids>]\
 [MUST\ <oids>]\
 [MAY\ <oids>]\
 [NOT\ <oids>]\ )"
.RS
Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
The slapd parser extends the RFC 4512 definition by allowing string
forms as well as numeric OIDs to be used for the attribute OID and
attribute syntax OID.
(See the
.B olcObjectIdentifier
description.) 
.RE

.HP
.hy 0
.B olcObjectClasses: "(\ <oid>\
 [NAME\ <name>]\
 [DESC\ <description>]\
 [OBSOLETE]\
 [SUP\ <oids>]\
 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
 [MUST\ <oids>] [MAY\ <oids>] )"
.RS
Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
The slapd parser extends the RFC 4512 definition by allowing string
forms as well as numeric OIDs to be used for the object class OID.
(See the
.B
olcObjectIdentifier
description.)  Object classes are "STRUCTURAL" by default.
.RE
.TP
.B olcObjectIdentifier: <name> "{ <oid> | <name>[:<suffix>] }"
Define a string name that equates to the given OID. The string can be used
in place of the numeric OID in objectclass and attribute definitions. The
name can also be used with a suffix of the form ":xx" in which case the
value "oid.xx" will be used.

.SH GENERAL BACKEND OPTIONS
Options in these entries only apply to the configuration of a single
1109
1110
type of backend. All backends may support this class of options, but
currently none do.
1111
1112
1113
1114
1115
1116
1117
1118
1119
The entry must be named
.B olcBackend=<databasetype>,cn=config
and must have the olcBackendConfig objectClass.
<databasetype>
should be one of
.BR config ,
.BR dnssrv ,
.BR ldap ,
.BR ldif ,
1120
.BR mdb ,
1121
1122
.BR meta ,
.BR monitor ,
1123
.BR ndb ,
1124
1125
1126
1127
1128
1129
1130
.BR null ,
.BR passwd ,
.BR perl ,
.BR relay ,
.BR shell ,
or
.BR sql .
1131
1132
At present, no backend implements any options of this type, so this
entry should not be used.
1133
1134
1135
1136
1137
1138
1139
1140

.SH DATABASE OPTIONS
Database options are set in entries named
.B olcDatabase={x}<databasetype>,cn=config
and must have the olcDatabaseConfig objectClass. Normally the config
engine generates the "{x}" index in the RDN automatically, so it
can be omitted when initially loading these entries.

Howard Chu's avatar
Howard Chu committed
1141
The special frontend database is always numbered "{\-1}" and the config
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
database is always numbered "{0}".

.SH GLOBAL DATABASE OPTIONS
Options in this section may be set in the special "frontend" database
and inherited in all the other databases. These options may be altered
by further settings in each specific database. The frontend entry must
be named
.B olcDatabase=frontend,cn=config
and must have the olcFrontendConfig objectClass.
.TP
.B olcAccess: to <what> "[ by <who> <access> <control> ]+"
Grant access (specified by <access>) to a set of entries and/or
attributes (specified by <what>) by one or more requestors (specified
by <who>).
If no access controls are present, the default policy
allows anyone and everyone to read anything but restricts
1158
updates to rootdn.  (e.g., "olcAccess: to * by * read").
1159
1160
1161
See
.BR slapd.access (5)
and the "OpenLDAP Administrator's Guide" for details.
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173

Access controls set in the frontend are appended to any access
controls set on the specific databases.
The rootdn of a database can always read and write EVERYTHING
in that database.

Extra special care must be taken with the access controls on the
config database. Unlike other databases, the default policy for the
config database is to only allow access to the rootdn. Regular users
should not have read access, and write access should be granted very
carefully to privileged administrators.

1174
1175
1176
1177
1178
1179
1180
.TP
.B olcDefaultSearchBase: <dn>
Specify a default search base to use when client submits a
non-base search request with an empty base DN.
Base scoped search requests with an empty base DN are not affected.
This setting is only allowed in the frontend entry.
.TP
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
.B olcExtraAttrs: <attr>
Lists what attributes need to be added to search requests.
Local storage backends return the entire entry to the frontend.
The frontend takes care of only returning the requested attributes
that are allowed by ACLs.
However, features like access checking and so may need specific
attributes that are not automatically returned by remote storage
backends, like proxy backends and so on.
.B <attr>
is an attribute that is needed for internal purposes
and thus always needs to be collected, even when not explicitly
requested by clients.
This attribute is multi-valued.
.TP
Howard Chu's avatar
Howard Chu committed
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
.B olcPasswordHash: <hash> [<hash>...]
This option configures one or more hashes to be used in generation of user
passwords stored in the userPassword attribute during processing of
LDAP Password Modify Extended Operations (RFC 3062).
The <hash> must be one of
.BR {SSHA} ,
.BR {SHA} ,
.BR {SMD5} ,
.BR {MD5} ,
.BR {CRYPT} ,
and
.BR {CLEARTEXT} .
The default is
.BR {SSHA} .

.B {SHA}
and
.B {SSHA}
use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.

.B {MD5}
and
.B {SMD5}
use the MD5 algorithm (RFC 1321), the latter with a seed.

.B {CRYPT}
uses the
.BR crypt (3).

.B {CLEARTEXT}
indicates that the new password should be
added to userPassword as clear text.

Note that this option does not alter the normal user applications
handling of userPassword during LDAP Add, Modify, or other LDAP operations.
This setting is only allowed in the frontend entry.
.TP
1232
1233
1234
1235
1236
.B olcReadOnly: TRUE | FALSE
This option puts the database into "read-only" mode.  Any attempts to 
modify the database will return an "unwilling to perform" error.  By
default, olcReadOnly is FALSE. Note that when this option is set
TRUE on the frontend, it cannot be reset without restarting the
Howard Chu's avatar
Howard Chu committed
1237
server, since further writes to the config database will be rejected.
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
.TP
.B olcRequires: <conditions>
Specify a set of conditions to require (default none).
The directive may be specified globally and/or per-database;
databases inherit global conditions, so per-database specifications
are additive.
.B bind
requires bind operation prior to directory operations.
.B LDAPv3
requires session to be using LDAP version 3.
.B authc
requires authentication prior to directory operations.
.B SASL
requires SASL authentication prior to directory operations.
.B strong
requires strong authentication prior to directory operations.
The strong keyword allows protected "simple" authentication
as well as SASL authentication.
.B none
may be used to require no conditions (useful to clear out globally
set conditions within a particular database); it must occur first
in the list of conditions.
.TP
.B olcRestrict: <oplist>
Specify a list of operations that are restricted.
Restrictions on a specific database override any frontend setting.
Operations can be any of 
.BR add ,
.BR bind ,
.BR compare ,
.BR delete ,
.BR extended[=<OID>] ,
.BR modify ,
.BR rename ,
.BR search ,
or the special pseudo-operations
.B read
and
.BR write ,
which respectively summarize read and write operations.
The use of 
.I restrict write
is equivalent to 
.I olcReadOnly: TRUE
(see above).
The 
.B extended
1285
keyword allows one to indicate the OID of the specific operation
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
to be restricted.
.TP
.B olcSchemaDN: <dn>
Specify the distinguished name for the subschema subentry that
controls the entries on this server.  The default is "cn=Subschema".
.TP
.B olcSecurity: <factors>
Specify a set of security strength factors (separated by white space)
to require (see
.BR olcSaslSecprops 's
.B minssf
option for a description of security strength factors).
The directive may be specified globally and/or per-database.
.B ssf=<n>
specifies the overall security strength factor.
.B transport=<n>
specifies the transport security strength factor.
.B tls=<n>
specifies the TLS security strength factor.
.B sasl=<n>
specifies the SASL security strength factor.
.B update_ssf=<n>
specifies the overall security strength factor to require for
directory updates.
.B update_transport=<n>
specifies the transport security strength factor to require for
directory updates.
.B update_tls=<n>
specifies the TLS security strength factor to require for
directory updates.
.B update_sasl=<n>
specifies the SASL security strength factor to require for
directory updates.
.B simple_bind=<n>
specifies the security strength factor required for
.I simple
username/password authentication.
Note that the
.B transport
factor is measure of security provided by the underlying transport,
e.g. ldapi:// (and eventually IPSEC).  It is not normally used.
.TP
.B olcSizeLimit: {<integer>|unlimited}
.TP
.B olcSizeLimit: size[.{soft|hard|unchecked}]=<integer> [...]
Specify the maximum number of entries to return from a search operation.
The default size limit is 500.
Use
.B unlimited
to specify no limits.
The second format allows a fine grain setting of the size limits.
1337
Extra args can be added in the same value. See
1338
1339
1340
.BR olcLimits
for an explanation of the different flags.
.TP
Howard Chu's avatar
Howard Chu committed
1341
.B olcSortVals: <attr> [...]
Howard Chu's avatar
Howard Chu committed
1342
1343
1344
1345
1346
1347
1348
1349
Specify a list of multi-valued attributes whose values will always
be maintained in sorted order. Using this option will allow Modify,
Compare, and filter evaluations on these attributes to be performed
more efficiently. The resulting sort order depends on the
attributes' syntax and matching rules and may not correspond to
lexical order or any other recognizable order.
This setting is only allowed in the frontend entry.
.TP
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
.B olcTimeLimit: {<integer>|unlimited}
.TP
.B olcTimeLimit: time[.{soft|hard}]=<integer> [...]
Specify the maximum number of seconds (in real time)
.B slapd
will spend answering a search request.  The default time limit is 3600.
Use
.B unlimited
to specify no limits.
The second format allows a fine grain setting of the time limits.
1360
Extra args can be added in the same value. See
1361
1362
1363
1364
1365
1366
1367
1368
1369
.BR olcLimits
for an explanation of the different flags.

.SH GENERAL DATABASE OPTIONS
Options in this section only apply to the specific database for
which they are defined.  They are supported by every
type of backend. All of the Global Database Options may also be
used here.
.TP
Howard Chu's avatar
Howard Chu committed
1370
.B olcAddContentAcl: TRUE | FALSE
Howard Chu's avatar
Howard Chu committed
1371
1372
Controls whether Add operations will perform ACL checks on
the content of the entry being added. This check is off
Howard Chu's avatar
Howard Chu committed
1373
1374
1375
1376
by default. See the
.BR slapd.access (5)
manual page for more details on ACL requirements for
Add operations.
Howard Chu's avatar
Howard Chu committed
1377
.TP
Howard Chu's avatar
Howard Chu committed
1378
1379
1380
1381
1382
.B olcHidden: TRUE | FALSE
Controls whether the database will be used to answer
queries. A database that is hidden will never be
selected to answer any queries, and any suffix configured
on the database will be ignored in checks for conflicts
Howard Chu's avatar
Howard Chu committed
1383
with other databases. By default, olcHidden is FALSE.
Howard Chu's avatar
Howard Chu committed
1384
.TP
1385
1386
1387
1388
1389
1390
1391
1392
1393
.B olcLastMod: TRUE | FALSE
Controls whether
.B slapd
will automatically maintain the 
modifiersName, modifyTimestamp, creatorsName, and 
createTimestamp attributes for entries. It also controls
the entryCSN and entryUUID attributes, which are needed
by the syncrepl provider. By default, olcLastMod is TRUE.
.TP
1394
1395
1396
1397
1398
1399
.B olcLastBind: TRUE | FALSE
Controls whether
.B slapd
will automatically maintain the pwdLastSuccess attribute for
entries. By default, olcLastBind is FALSE.
.TP
1400
1401
1402
.B olcLimits: <selector> <limit> [<limit> [...]]
Specify time and size limits based on the operation's initiator or
base DN.
1403
The argument
1404
.B <selector>
1405
1406
1407
1408
can be any of
.RS
.RS
.TP
1409
anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>
1410
1411
1412
1413
1414

.RE
with
.RS
.TP
1415
1416
1417
1418
<dnspec> ::= dn[.<type>][.<style>]
.TP
<type>  ::= self | this
.TP
1419
1420
1421
<style> ::= exact | base | onelevel | subtree | children | regex | anonymous

.RE
1422
1423
1424
1425
1426
DN type
.B self
is the default and means the bound user, while
.B this
means the base DN of the operation.
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
The term
.B anonymous
matches all unauthenticated clients.
The term
.B users
matches all authenticated clients;
otherwise an
.B exact
dn pattern is assumed unless otherwise specified by qualifying 
the (optional) key string
.B dn
with 
.B exact
or
.B base
(which are synonyms), to require an exact match; with
.BR onelevel , 
to require exactly one level of depth match; with
.BR subtree ,
to allow any level of depth match, including the exact match; with
.BR children ,
to allow any level of depth match, not including the exact match;
.BR regex
explicitly requires the (default) match based on POSIX (''extended'')
regular expression pattern.
Finally,
.B anonymous
matches unbound operations; the 
.B pattern
field is ignored.
The same behavior is obtained by using the 
.B anonymous
form of the
1460
.B <selector>
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
clause.
The term
.BR group ,
with the optional objectClass
.B oc
and attributeType
.B at
fields, followed by
.BR pattern ,
sets the limits for any DN listed in the values of the
.B at
attribute (default
.BR member )
of the 
.B oc
group objectClass (default
.BR groupOfNames )
whose DN exactly matches
.BR pattern .

The currently supported limits are 
.B size
and 
.BR time .

The syntax for time limits is 
.BR time[.{soft|hard}]=<integer> ,
where 
.I integer
is the number of seconds slapd will spend answering a search request.
If no time limit is explicitly requested by the client, the 
.BR soft
limit is used; if the requested time limit exceeds the
.BR hard
.\"limit, an
.\".I "Administrative limit exceeded"
.\"error is returned.
limit, the value of the limit is used instead.
If the
.BR hard
limit is set to the keyword 
.IR soft ,
the soft limit is used in either case; if it is set to the keyword 
.IR unlimited , 
no hard limit is enforced.
Explicit requests for time limits smaller or equal to the
.BR hard 
limit are honored.
If no limit specifier is set, the value is assigned to the 
.BR soft 
limit, and the
.BR hard
limit is set to
.IR soft ,
to preserve the original behavior.

The syntax for size limits is
.BR size[.{soft|hard|unchecked}]=<integer> ,
where
.I integer
is the maximum number of entries slapd will return answering a search 
request.
If no size limit is explicitly requested by the client, the
.BR soft
limit is used; if the requested size limit exceeds the
.BR hard
.\"limit, an 
.\".I "Administrative limit exceeded"
.\"error is returned.
limit, the value of the limit is used instead.
If the 
.BR hard
limit is set to the keyword 
.IR soft , 
the soft limit is used in either case; if it is set to the keyword
.IR unlimited , 
no hard limit is enforced.
Explicit requests for size limits smaller or equal to the
.BR hard
limit are honored.
The
.BR unchecked
specifier sets a limit on the number of candidates a search request is allowed
to examine.
The rationale behind it is that searches for non-properly indexed
attributes may result in large sets of candidates, which must be 
examined by
.BR slapd (8)
to determine whether they match the search filter or not.
The
.B unchecked
limit provides a means to drop such operations before they are even 
started.
If the selected candidates exceed the 
.BR unchecked
limit, the search will abort with 
.IR "Unwilling to perform" .
If it is set to the keyword 
.IR unlimited , 
no limit is applied (the default).
If it is set to
.IR disable ,
the search is not even performed; this can be used to disallow searches
for a specific set of users.
If no limit specifier is set, the value is assigned to the
.BR soft 
limit, and the
.BR hard
limit is set to
.IR soft ,
to preserve the original behavior.

In case of no match, the global limits are used.
1574
The default values are the same as for
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
.B olcSizeLimit
and
.BR olcTimeLimit ;
no limit is set on 
.BR unchecked .

If 
.B pagedResults
control is requested, the 
.B hard
size limit is used by default, because the request of a specific page size
is considered an explicit request for a limitation on the number
of entries to be returned.
However, the size limit applies to the total count of entries returned within
the search, and not to a single page.
Additional size limits may be enforced; the syntax is
.BR size.pr={<integer>|noEstimate|unlimited} ,
where
.I integer
is the max page size if no explicit limit is set; the keyword
.I noEstimate
inhibits the server from returning an estimate of the total number
of entries that might be returned
(note: the current implementation does not return any estimate).
The keyword
.I unlimited
indicates that no limit is applied to the pagedResults control page size.
The syntax
1603
.B size.prtotal={<integer>|hard|unlimited|disabled}
1604
1605
allows one to set a limit on the total number of entries that the pagedResults
control will return.
1606
1607
By default it is set to the 
.B hard
1608
limit which will use the size.hard value.
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
When set, 
.I integer
is the max number of entries that the whole search with pagedResults control
can return.
Use 
.I unlimited
to allow unlimited number of entries to be returned, e.g. to allow
the use of the pagedResults control as a means to circumvent size 
limitations on regular searches; the keyword
.I disabled
disables the control, i.e. no paged results can be returned.
Note that the total number of entries returned when the pagedResults control 
is requested cannot exceed the 
.B hard 
size limit of regular searches unless extended by the
.B prtotal
switch.
.RE
.TP
.B olcMaxDerefDepth: <depth>
Specifies the maximum number of aliases to dereference when trying to
1630
resolve an entry, used to avoid infinite alias loops. The default is 15.
1631
.TP
1632
1633
.B olcMultiProvider: TRUE | FALSE
This option puts a consumer database into Multi-Provider mode.  Update
1634
1635
operations will be accepted from any user, not just the updatedn.  The
database must already be configured as syncrepl consumer
1636
before this keyword may be set.  This mode also requires a
Howard Chu's avatar
Howard Chu committed
1637
.B olcServerID
1638
(see above) to be configured.
1639
By default, this setting is FALSE.
1640
1641
.TP
.B olcPlugin: <plugin_type> <lib_path> <init_function> [<arguments>]
Howard Chu's avatar
Howard Chu committed
1642
1643
1644
Configure a SLAPI plugin. See the
.BR slapd.plugin (5)
manpage for more details.
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
.TP
.B olcRootDN: <dn>
Specify the distinguished name that is not subject to access control 
or administrative limit restrictions for operations on this database.
This DN may or may not be associated with an entry.  An empty root
DN (the default) specifies no root access is to be granted.  It is
recommended that the rootdn only be specified when needed (such as
when initially populating a database).  If the rootdn is within
a namingContext (suffix) of the database, a simple bind password
may also be provided using the
.B olcRootPW
directive. Note that the rootdn is always needed when using syncrepl.
1657
1658
1659
1660
1661
1662
1663
The
.B olcRootDN
of the
.B cn=config
database defaults to
.B cn=config
itself.
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
.TP
.B olcRootPW: <password>
Specify a password (or hash of the password) for the rootdn.  The
password can only be set if the rootdn is within the namingContext
(suffix) of the database.
This option accepts all RFC 2307 userPassword formats known to
the server (see 
.B olcPasswordHash
description) as well as cleartext.
.BR slappasswd (8) 
may be used to generate a hash of a password.  Cleartext
and \fB{CRYPT}\fP passwords are not recommended.  If empty
(the default), authentication of the root DN is by other means
(e.g. SASL).  Use of SASL is encouraged.
.TP
.B olcSubordinate: [TRUE | FALSE | advertise]
Specify that the current backend database is a subordinate of another
backend database. A subordinate  database may have only one suffix. This
option may be used to glue multiple databases into a single namingContext.
If the suffix of the current database is within the namingContext of a
superior database, searches against the superior database will be
propagated to the subordinate as well. All of the databases
associated with a single namingContext should have identical rootdns.
Behavior of other LDAP operations is unaffected by this setting. In
particular, it is not possible to use moddn to move an entry from
one subordinate to another subordinate within the namingContext.

If the optional \fBadvertise\fP flag is supplied, the naming context of
this database is advertised in the root DSE. The default is to hide this
database context, so that only the superior context is visible.

If the slap tools
.BR slapcat (8),
.BR slapadd (8),
or
.BR slapindex (8)
are used on the superior database, any glued subordinates that support
these tools are opened as well.

Databases that are glued together should usually be configured with the
same indices (assuming they support indexing), even for attributes that
only exist in some of these databases. In general, all of the glued
databases should be configured as similarly as possible, since the intent
is to provide the appearance of a single directory.

Howard Chu's avatar
Howard Chu committed
1709
Note that the subordinate functionality is implemented internally
1710
1711
by the \fIglue\fP overlay and as such its behavior will interact with other
overlays in use. By default, the glue overlay is automatically configured as
Howard Chu's avatar
Howard Chu committed
1712
the last overlay on the superior database. Its position on the database
1713
1714
1715
1716
1717
1718
can be explicitly configured by setting an \fBoverlay glue\fP directive
at the desired position. This explicit configuration is necessary e.g.
when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
in order to work over all of the glued databases. E.g.
.RS
.nf
1719
	dn: olcDatabase={1}mdb,cn=config
1720
1721
1722
	olcSuffix: dc=example,dc=com
	...

1723
	dn: olcOverlay={0}glue,olcDatabase={1}mdb,cn=config
1724
1725
	...

1726
	dn: olcOverlay={1}syncprov,olcDatabase={1}mdb,cn=config
1727
1728
1729
1730
1731
1732
1733
1734
1735
	...
.fi
.RE
See the Overlays section below for more details.
.TP
.B olcSuffix: <dn suffix>
Specify the DN suffix of queries that will be passed to this 
backend database.  Multiple suffix lines can be given and at least one is 
required for each database definition.
1736

1737
1738
If the suffix of one database is "inside" that of another, the database
with the inner suffix must come first in the configuration file.
1739
1740
1741
You may also want to glue such databases together with the
.B olcSubordinate
attribute.
1742
1743
1744
1745
1746
.TP
.B olcSyncUseSubentry: TRUE | FALSE
Store the syncrepl contextCSN in a subentry instead of the context entry
of the database. The subentry's RDN will be "cn=ldapsync". The default is
FALSE, meaning the contextCSN is stored in the context entry.
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
.HP
.hy 0
.B olcSyncrepl: rid=<replica ID>
.B provider=ldap[s]://<hostname>[:port]
.B searchbase=<base DN>
.B [type=refreshOnly|refreshAndPersist]
.B [interval=dd:hh:mm:ss]
.B [retry=[<retry interval> <# of retries>]+]
.B [filter=<filter str>]
.B [scope=sub|one|base|subord]
.B [attrs=<attr list>]
.B [exattrs=<attr list>]
.B [attrsonly]
.B [sizelimit=<limit>]
.B [timelimit=<limit>]
.B [schemachecking=on|off]
Howard Chu's avatar
Howard Chu committed
1763
.B [network\-timeout=<seconds>]
1764
.B [timeout=<seconds>]
1765
1766
1767
1768
1769
1770
1771
1772
.B [bindmethod=simple|sasl]
.B [binddn=<dn>]
.B [saslmech=<mech>]
.B [authcid=<identity>]
.B [authzid=<identity>]
.B [credentials=<passwd>]
.B [realm=<realm>]
.B [secprops=<properties>]
1773
.B [keepalive=<idle>:<probes>:<interval>]
1774
1775
1776
1777
1778
1779
.B [starttls=yes|critical]
.B [tls_cert=<file>]
.B [tls_key=<file>]
.B [tls_cacert=<file>]
.B [tls_cacertdir=<path>]
.B [tls_reqcert=never|allow|try|demand]
1780
.B [tls_reqsan=never|allow|try|demand]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1781
.B [tls_cipher_suite=<ciphers>]
1782
.B [tls_ecname=<names>]
1783
.B [tls_crlcheck=none|peer|all]
Howard Chu's avatar
Howard Chu committed
1784
.B [tls_protocol_min=<major>[.<minor>]]
Howard Chu's avatar
Howard Chu committed
1785
.B [suffixmassage=<real DN>]
1786
1787
1788
.B [logbase=<base DN>]
.B [logfilter=<filter str>]
.B [syncdata=default|accesslog|changelog]
Howard Chu's avatar
Howard Chu committed
1789
.B [lazycommit]
1790
.RS
1791
1792
Specify the current database as a consumer which is kept up-to-date with the 
provider content by establishing the current
1793
1794
1795
1796
.BR slapd (8)
as a replication consumer site running a
.B syncrepl
replication engine.
1797
The consumer content is kept synchronized to the provider content using
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
the LDAP Content Synchronization protocol. Refer to the
"OpenLDAP Administrator's Guide" for detailed information on
setting up a replicated
.B slapd
directory service using the 
.B syncrepl
replication engine.

.B rid
identifies the current
.B syncrepl
directive within the replication consumer site.
Howard Chu's avatar
Howard Chu committed
1810
It is a non-negative integer having no more than three decimal digits.
1811
1812

.B provider
1813
specifies the replication provider site containing the provider content
1814
1815
1816
1817
1818
as an LDAP URI. If <port> is not given, the standard LDAP port number
(389 or 636) is used.

The content of the
.B syncrepl
1819
consumer is defined using a search
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
specification as its result set. The consumer
.B slapd
will send search requests to the provider
.B slapd
according to the search specification. The search specification includes
.B searchbase, scope, filter, attrs, attrsonly, sizelimit,
and
.B timelimit
parameters as in the normal search specification. The
.B exattrs
option may also be used to specify attributes that should be omitted
from incoming entries.
The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
\fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
\fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
attributes, and \fBattrsonly\fP and \fBexattrs\fP are unset by default.
The \fBsizelimit\fP and \fBtimelimit\fP only
accept "unlimited" and positive integers, and both default to "unlimited".
Note, however, that any provider-side limits for the replication identity
will be enforced by the provider regardless of the limits requested
by the LDAP Content Synchronization operation, much like for any other
search operation.

The LDAP Content Synchronization protocol has two operation types.
In the
.B refreshOnly
operation, the next synchronization search operation
is periodically rescheduled at an interval time (specified by 
.B interval
parameter; 1 day by default)
after each synchronization operation finishes.
In the
.B refreshAndPersist
operation, a synchronization search remains persistent in the provider slapd.
1854
Further updates to the provider will generate
1855
1856
.B searchResultEntry
to the consumer slapd as the search responses to the persistent
1857
1858
1859
1860
1861
synchronization search. If the initial search fails due to an error, the
next synchronization search operation is periodically rescheduled at an
interval time (specified by
.B interval
parameter; 1 day by default)
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876

If an error occurs during replication, the consumer will attempt to
reconnect according to the
.B retry
parameter which is a list of the <retry interval> and <# of retries> pairs.
For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
for the first 10 times and then retry every 300 seconds for the next 3
times before stop retrying. The `+' in <# of retries> means indefinite
number of retries until success.

The schema checking can be enforced at the LDAP Sync
consumer site by turning on the
.B schemachecking
parameter. The default is off.

1877
The
Howard Chu's avatar
Howard Chu committed
1878
.B network\-timeout
1879
1880
1881
1882
1883
1884
1885
1886
1887
parameter sets how long the consumer will wait to establish a
network connection to the provider. Once a connection is
established, the
.B timeout
parameter determines how long the consumer will wait for the initial
Bind request to complete. The defaults for these parameters come
from 
.BR ldap.conf (5).

1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
A
.B bindmethod
of 
.B simple
requires the options 
.B binddn
and 
.B credentials
and should only be used when adequate security services
(e.g. TLS or IPSEC) are in place.
A
.B bindmethod
of
.B sasl
requires the option
.B saslmech.
Depending on the mechanism, an authentication identity and/or
credentials can be specified using
.B authcid
and
.B credentials.
The
.B authzid
parameter may be used to specify an authorization identity.
Specific security properties (as with the
Howard Chu's avatar
Howard Chu committed
1913
.B sasl\-secprops
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
keyword above) for a SASL bind can be set with the
.B secprops
option. A non default SASL realm can be set with the
.B realm 
option.
The provider, other than allow authentication of the syncrepl identity,
should grant that identity appropriate access privileges to the data 
that is being replicated (\fBaccess\fP directive), and appropriate time 
and size limits (\fBlimits\fP directive).

1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
The
.B keepalive
parameter sets the values of \fIidle\fP, \fIprobes\fP, and \fIinterval\fP
used to check whether a socket is alive;
.I idle
is the number of seconds a connection needs to remain idle before TCP 
starts sending keepalive probes;
.I probes
is the maximum number of keepalive probes TCP should send before dropping
the connection;
.I interval
is interval in seconds between individual keepalive probes.
Only some systems support the customization of these values;
the
.B keepalive
parameter is ignored otherwise, and system-wide settings are used.
1940
1941
1942
1943
1944
1945
1946

The
.B starttls
parameter specifies use of the StartTLS extended operation
to establish a TLS session before Binding to the provider. If the
.B critical
argument is supplied, the session will be aborted if the StartTLS request
1947
fails. Otherwise the syncrepl session continues without TLS. The
1948
.B tls_reqcert
1949
1950
1951
setting defaults to "demand", the
.B tls_reqsan
setting defaults to "allow", and the other TLS settings default to the same
1952
as the main slapd TLS settings.
1953

Howard Chu's avatar
Howard Chu committed
1954
1955
1956
1957
1958
1959
1960
The
.B suffixmassage
parameter allows the consumer to pull entries from a remote directory
whose DN suffix differs from the local directory. The portion of the
remote entries' DNs that matches the \fIsearchbase\fP will be replaced
with the suffixmassage DN.

1961
1962
1963
1964
1965
1966
1967
1968
1969
Rather than replicating whole entries, the consumer can query logs of
data modifications. This mode of operation is referred to as \fIdelta
syncrepl\fP. In addition to the above parameters, the
.B logbase
and
.B logfilter
parameters must be set appropriately for the log that will be used. The
.B syncdata
parameter must be set to either "accesslog" if the log conforms to the
Howard Chu's avatar
Howard Chu committed
1970
.BR slapo\-accesslog (5)
1971
1972
1973
1974
1975
log format, or "changelog" if the log conforms
to the obsolete \fIchangelog\fP format. If the
.B syncdata
parameter is omitted or set to "default" then the log parameters are
ignored.
Howard Chu's avatar
Howard Chu committed
1976

1977
1978
The
.B lazycommit
Howard Chu's avatar
Howard Chu committed
1979
1980
1981
parameter tells the underlying database that it can store changes without
performing a full flush after each change. This may improve performance
for the consumer, while sacrificing safety or durability.
1982
.RE
1983
1984
.TP
.B olcUpdateDN: <dn>
1985
This option is only applicable in a replica
1986
1987
database.
It specifies the DN permitted to update (subject to access controls)
Howard Chu's avatar
Howard Chu committed
1988
1989
the replica.  It is only needed in certain push-mode
replication scenarios.  Generally, this DN
1990
1991
1992
.I should not
be the same as the
.B rootdn 
1993
used at the provider.
1994
1995
1996
1997
1998
1999
2000
2001
2002
.TP
.B olcUpdateRef: <url>
Specify the referral to pass back when
.BR slapd (8)
is asked to modify a replicated local database.
If multiple values are specified, each url is provided.

.SH DATABASE-SPECIFIC OPTIONS
Each database may allow specific configuration options; they are
2003
2004
2005
documented separately in the backends' manual pages. See the
.BR slapd.backends (5)
manual page for an overview of available backends.
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
.SH OVERLAYS
An overlay is a piece of
code that intercepts database operations in order to extend or change
them. Overlays are pushed onto
a stack over the database, and so they will execute in the reverse
of the order in which they were configured and the database itself
will receive control last of all.

Overlays must be configured as child entries of a specific database. The
entry's RDN must be of the form
.B olcOverlay={x}<overlaytype>
and the entry must have the olcOverlayConfig objectClass. Normally the
config engine generates the "{x}" index in the RDN automatically, so
it can be omitted when initially loading these entries.

2021
2022
2023
See the
.BR slapd.overlays (5)
manual page for an overview of available overlays.
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
.SH EXAMPLES
.LP
Here is a short example of a configuration in LDIF suitable for use with
.BR slapadd (8)
:
.LP
.RS
.nf
dn: cn=config
objectClass: olcGlobal
cn: config
2035
olcPidFile: LOCALSTATEDIR/run/slapd.pid
Howard Chu's avatar
Howard Chu committed
2036
olcAttributeOptions: x\-hidden lang\-
2037
2038
2039
2040
2041

dn: cn=schema,cn=config
objectClass: olcSchemaConfig
cn: schema

Howard Chu's avatar
Howard Chu committed
2042
include: file://SYSCONFDIR/schema/core.ldif
2043
2044
2045
2046
2047
2048

dn: olcDatabase=frontend,cn=config
objectClass: olcDatabaseConfig
objectClass: olcFrontendConfig
olcDatabase: frontend
# Subtypes of "name" (e.g. "cn" and "ou") with the
Howard Chu's avatar
Howard Chu committed
2049
# option ";x\-hidden" can be searched for/compared,
2050
# but are not shown.  See \fBslapd.access\fP(5).
Howard Chu's avatar
Howard Chu committed
2051
olcAccess: to attrs=name;x\-hidden by * =cs
2052
2053
2054
2055
2056
# Protect passwords.  See \fBslapd.access\fP(5).
olcAccess: to attrs=userPassword  by * auth
# Read access to other attributes and entries.
olcAccess: to * by * read

2057
2058
2059
2060
2061
2062
2063
2064
# set a rootpw for the config database so we can bind.
# deny access to everyone else.
dn: olcDatabase=config,cn=config
objectClass: olcDatabaseConfig
olcDatabase: config
olcRootPW: {SSHA}XKYnrjvGT3wZFQrDD5040US592LxsdLy
olcAccess: to * by * none

2065
dn: olcDatabase=mdb,cn=config
2066
objectClass: olcDatabaseConfig
2067
2068
objectClass: olcMdbConfig
olcDatabase: mdb
Howard Chu's avatar
Howard Chu committed
2069
olcSuffix: "dc=our\-domain,dc=com"
2070
2071
2072
# The database directory MUST exist prior to
# running slapd AND should only be accessible
# by the slapd/tools. Mode 0700 recommended.
Howard Chu's avatar
Howard Chu committed
2073
olcDbDirectory: LOCALSTATEDIR/openldap\-data
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
# Indices to maintain
olcDbIndex:     objectClass  eq
olcDbIndex:     cn,sn,mail   pres,eq,approx,sub

# We serve small clients that do not handle referrals,
# so handle remote lookups on their behalf.
dn: olcDatabase=ldap,cn=config
objectClass: olcDatabaseConfig
objectClass: olcLdapConfig
olcDatabase: ldap
olcSuffix: ""
Howard Chu's avatar
Howard Chu committed
2085
olcDbUri: ldap://ldap.some\-server.com/
2086
2087
2088
2089
2090
2091
2092
2093
.fi
.RE
.LP
Assuming the above data was saved in a file named "config.ldif" and the
ETCDIR/slapd.d directory has been created, this command will initialize
the configuration:
.RS
.nf
Howard Chu's avatar
Howard Chu committed
2094
slapadd \-F ETCDIR/slapd.d \-n 0 \-l config.ldif
2095
2096
2097
2098
2099
2100
.fi
.RE

.LP
"OpenLDAP Administrator's Guide" contains a longer annotated
example of a slapd configuration.
2101
2102
2103
2104
2105

Alternatively, an existing slapd.conf file can be converted to the new
format using slapd or any of the slap tools:
.RS
.nf
Howard Chu's avatar
Howard Chu committed
2106
slaptest \-f ETCDIR/slapd.conf \-F ETCDIR/slapd.d
2107
2108
2109
.fi
.RE

2110
2111
.SH FILES
.TP
2112
2113
2114
ETCDIR/slapd.conf
default slapd configuration file
.TP
2115
2116
2117
2118
2119
ETCDIR/slapd.d
default slapd configuration directory
.SH SEE ALSO
.BR ldap (3),
.BR ldif (5),
2120
.BR gnutls\-cli (1),
2121
.BR slapd.access (5),
2122
2123
2124
.BR slapd.backends (5),
.BR slapd.conf (5),
.BR slapd.overlays (5),
2125
2126
2127
2128
2129
2130
2131
2132
2133
.BR slapd.plugin (5),
.BR slapd (8),
.BR slapacl (8),
.BR slapadd (8),
.BR slapauth (8),
.BR slapcat (8),
.BR slapdn (8),
.BR slapindex (8),
.BR slappasswd (8),