slapd-config.5 59.8 KB
Newer Older
1
.TH SLAPD-CONFIG 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2
.\" Copyright 1998-2009 The OpenLDAP Foundation All Rights Reserved.
3
4
5
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
.\" $OpenLDAP$
.SH NAME
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
.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
that are predefined - one is an entry for the config database itself,
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
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>
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
145
The (absolute) name of a file that will hold the 
146
.B slapd
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
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.
151
152
Options must not end with `\-', prefixes must end with `\-'.
The `lang\-' prefix is predefined.
153
154
If you use the
.B olcAttributeOptions
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.
161
Prefixes defined this way work like the `lang\-' options:
162
They define a prefix for tagging options starting with the prefix.
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
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

170
RFC 4520 reserves options beginning with `x\-' for private experiments.
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
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
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
.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
392
values can be specified to allow for multiple matching 
393
and replacement patterns. The matching patterns are checked in the order they 
Howard Chu's avatar
Howard Chu committed
394
appear in the attribute, stopping at the first successful match.
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
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

.\".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 ).
.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
439
have closed their connections (if they ever do), or - as before -
440
441
442
443
444
445
446
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
447
.B olcIdleTimeout
448
449
450
451
along with this option.
.TP
.B olcIdleTimeout: <integer>
Specify the number of seconds to wait before forcibly closing
452
an idle client connection.  A setting of 0 disables this
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
453
454
455
feature.  The default is 0. You may also want to set the
.B olcWriteTimeout
option.
456
.TP
457
458
459
.B olcIndexIntLen: <integer>
Specify the key length for ordered integer indices. The most significant
bytes of the binary integer will be used for index keys. The default
460
461
value is 4, which provides exact indexing for 31 bit values.
A floating point representation is used to index too large values.
462
.TP
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
.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
479
.I olcIndexSubstrIfMaxlen
480
481
482
483
484
485
486
487
488
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".

489
490
491
492
493
.LP
Note: Indexing support depends on the particular backend in use. Also,
changing these settings will generally require deleting any indices that
depend on these parameters and recreating them with
.BR slapindex (8).
494

495
496
497
498
499
500
501
502
503
.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
504
505
506
507
508
.B olcLogFile: <filename>
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
509
510
511
512
513
514
515
516
.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 
517
of the configured loglevel as soon as any logging is configured.
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
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
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),
or as a list of the names that are shown between brackets, such that
.LP
.nf
Howard Chu's avatar
Howard Chu committed
594
595
596
597
598
    olcLogLevel: 129
    olcLogLevel: 0x81
    olcLogLevel: 128 1
    olcLogLevel: 0x80 0x1
    olcLogLevel: acl trace
599
600
601
602
603
.fi
.LP
are equivalent.
The keyword 
.B any
604
can be used as a shortcut to enable logging at all levels (equivalent to \-1).
605
606
607
The keyword
.BR none ,
or the equivalent integer representation, causes those messages
Howard Chu's avatar
Howard Chu committed
608
609
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, 
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
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>
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
633
The (absolute) name of a file that will hold the 
634
.B slapd
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
635
636
server's process ID (see
.BR getpid (2)).
637
638
639
640
641
.TP
.B olcPluginLogFile: <filename>
The ( absolute ) name of a file that will contain log
messages from
.B SLAPI
642
643
644
plugins. See
.BR slapd.plugin (5)
for details.
645
646
647
648
649
650
651
652
653
654
.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 
655
if compiled with \-\-enable\-rlookups).
656
657
658
659
660
.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.
661
662
663
664
665

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
666
ldapsearch \-x \-b "" \-s base "+"
667
668
.br
See RFC 4512 section 5.1 for details.
669
.TP
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
670
671
672
673
674
.B olcSaslAuxprops: <plugin> [...]
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
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
.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
.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
725
726
727
.B olcServerID: <integer> [<URL>]
Specify an integer ID from 0 to 4095 for this server. These IDs are
required when using multimaster replication and each master must have a
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
728
729
730
unique ID. Note that this requirement also applies to separate masters
contributing to a glued set of databases.
If the URL is provided, this directive may be specified
Howard Chu's avatar
Howard Chu committed
731
732
733
734
735
736
737
738
739
740
741
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
of all CSNs generated by the specified server. The default value is zero.
Example:
.LP
.nf
	olcServerID: 1 ldap://ldap1.example.com
	olcServerID: 2 ldap://ldap2.example.com
.fi
.TP
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
.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
.B olcThreads: <integer>
Specify the maximum size of the primary thread pool.
The default is 16; the minimum value is 2.
.TP
.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.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
758
759
760
761
762
763
.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.
764
765
766
767
768
769
770
771
772
773
774
775
.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.
<cipher-suite-spec> should be a cipher specification for OpenSSL.  Example:

olcTLSCipherSuite: HIGH:MEDIUM:+SSLv2

776
777
778
To check what ciphers a given spec selects in OpenSSL, use:

.nf
779
	openssl ciphers \-v <cipher-suite-spec>
780
.fi
781

782
783
784
To obtain the list of ciphers in GNUtls use:

.nf
785
	gnutls-cli \-l
786
.fi
787
788
789
790
791
792
793
794
795
796
.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
797
or the olcTLSCACertificateFile is defined. If both are specified, both
798
799
locations will be used. This directive is not supported
when using GNUtls.
800
801
802
803
804
805
806
807
808
809
810
.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
811
812
813
814
815
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. 
816
817
818
819
820
821
822
823
824
.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
the server. If multiple sets of parameters are present in the file, all of
them will be processed.  Note that setting this option may also enable
Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
You should append "!ADH" to your cipher suites if you have changed them
from the default, otherwise no certificate exchanges or verification will
825
826
be done. When using GNUtls these parameters are always generated randomly
so this directive is ignored.
827
828
829
830
831
.TP
.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.
832
This directive is ignored with GNUtls.
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
.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
874
parameter to be set. This parameter is ignored with GNUtls.
875
876
877
878
879
880
881
882
883
884
885
886
887
.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
888
889
890
891
892
.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
is only valid when using GNUtls.
893
894
895
.SH DYNAMIC MODULE OPTIONS
If
.B slapd
896
is compiled with \-\-enable\-modules then the module-related entries will
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
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.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
916
917
The default is MODULEDIR, which is where the standard OpenLDAP install
will place its modules. 
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
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
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
.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
type of backend. All backends may support this class of options.
The entry must be named
.B olcBackend=<databasetype>,cn=config