slapd.conf.5 56.2 KB
Newer Older
1
.TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
Kurt Zeilenga's avatar
Kurt Zeilenga committed
2
.\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
3
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
4
.\" $OpenLDAP$
Kurt Zeilenga's avatar
Kurt Zeilenga committed
5
6
7
8
9
10
11
12
13
.SH NAME
slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
.SH SYNOPSIS
ETCDIR/slapd.conf
.SH DESCRIPTION
The file
.B ETCDIR/slapd.conf
contains configuration information for the
.BR slapd (8)
14
daemon.  This configuration file is also used by the SLAPD tools
Pierangelo Masarati's avatar
Pierangelo Masarati committed
15
.BR slapacl (8),
16
.BR slapadd (8),
Pierangelo Masarati's avatar
Pierangelo Masarati committed
17
.BR slapauth (8),
18
.BR slapcat (8),
Pierangelo Masarati's avatar
Pierangelo Masarati committed
19
20
.BR slapdn (8),
.BR slapindex (8),
Kurt Zeilenga's avatar
Kurt Zeilenga committed
21
and
Pierangelo Masarati's avatar
Pierangelo Masarati committed
22
.BR slaptest (8).
Kurt Zeilenga's avatar
Kurt Zeilenga committed
23
24
25
26
27
28
29
30
.LP
The
.B slapd.conf
file consists of a series of global configuration options that apply to
.B slapd
as a whole (including all backends), followed by zero or more database
backend definitions that contain information specific to a backend
instance.
31
32
The configuration options are case-insensitive;
their value, on a case by case basis, may be case-sensitive.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
33
34
35
36
37
38
39
40
41
.LP
The general format of
.B slapd.conf
is as follows:
.LP
.nf
    # comment - these options apply to every database
    <global configuration options>
    # first database definition & configuration options
42
    database <backend 1 type>
Kurt Zeilenga's avatar
Kurt Zeilenga committed
43
44
45
46
47
48
49
50
51
    <configuration options specific to backend 1>
    # subsequent database definitions & configuration options
    ...
.fi
.LP
As many backend-specific sections as desired may be included.  Global
options can be overridden in a backend (for options that appear more
than once, the last appearance in the
.B slapd.conf
52
53
54
file is used).
.LP
If a line begins with white space, it is considered a continuation
Kurt Zeilenga's avatar
Kurt Zeilenga committed
55
56
57
58
of the previous line.  No physical line should be over 2000 bytes
long.
.LP
Blank lines and comment lines beginning with
59
60
a `#' character are ignored.  Note: continuation lines are unwrapped
before comment processing is applied.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
61
62
63
64
65
66
67
68
.LP
Arguments on configuration lines are separated by white space. If an
argument contains white space, the argument should be enclosed in
double quotes.  If an argument contains a double quote (`"') or a
backslash character (`\\'), the character should be preceded by a
backslash character.
.LP
The specific configuration options available are discussed below in the
69
70
71
72
73
Global Configuration Options, General Backend Options, and General Database
Options.  Backend-specific options are discussed in the
.B slapd-<backend>(5)
manual pages.  Refer to the "OpenLDAP Administrator's Guide" for more
details on the slapd configuration file.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
74
75
76
77
78
.SH GLOBAL CONFIGURATION OPTIONS
Options described in this section apply to all backends, unless specifically 
overridden in a backend definition. Arguments that should be replaced by 
actual text are shown in brackets <>.
.TP
Pierangelo Masarati's avatar
Pierangelo Masarati committed
79
.B access to <what> "[ by <who> <access> <control> ]+"
80
Grant access (specified by <access>) to a set of entries and/or
Kurt Zeilenga's avatar
Kurt Zeilenga committed
81
attributes (specified by <what>) by one or more requestors (specified
82
by <who>).
83
84
85
86
If no access controls are present, the default policy
allows anyone and everyone to read anything but restricts
updates to rootdn.  (e.g., "access to * by * read").
The rootdn can always read and write EVERYTHING!
Pierangelo Masarati's avatar
Pierangelo Masarati committed
87
88
89
See
.BR slapd.access (5)
and the "OpenLDAP's Administrator's Guide" for details.
90
.TP
91
.B allow <features>
92
93
Specify a set of features (separated by white space) to
allow (default none).
94
.B bind_v2
Kurt Zeilenga's avatar
Kurt Zeilenga committed
95
96
allows acceptance of LDAPv2 bind requests.  Note that
.BR slapd (8)
97
does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
98
.B bind_anon_cred
Howard Chu's avatar
Howard Chu committed
99
allows anonymous bind when credentials are not empty (e.g.
100
101
102
when DN is empty).
.B bind_anon_dn
allows unauthenticated (anonymous) bind when DN is not empty.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
103
.B update_anon
Pierangelo Masarati's avatar
Pierangelo Masarati committed
104
allows unauthenticated (anonymous) update operations to be processed
Kurt Zeilenga's avatar
Kurt Zeilenga committed
105
(subject to access controls and other administrative limits).
Pierangelo Masarati's avatar
Pierangelo Masarati committed
106
107
108
.B proxy_authz_anon
allows unauthenticated (anonymous) proxy authorization control to be processed
(subject to access controls, authorization and other administrative limits).
109
.TP
110
111
112
113
114
.B argsfile <filename>
The ( absolute ) name of a file that will hold the 
.B slapd
server's command line options
if started without the debugging command line option.
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
.TP
.B attributeoptions [option-name]...
Define tagging attribute options or option tag/range prefixes.
Options must not end with `-', prefixes must end with `-'.
The `lang-' prefix is predefined.
If you use the
.B attributeoptions
directive, `lang-' will no longer be defined and you must specify it
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.
Prefixes defined this way work like the `lang-' options:
They define a prefix for tagging options starting with the prefix.
That is, if you define the prefix `x-foo-', you can use the option
`x-foo-bar'.
Furthermore, in a search or compare, a prefix or range name (with
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'.

Kurt Zeilenga's avatar
Kurt Zeilenga committed
137
138
RFC 4520 reserves options beginning with `x-' for private experiments.
Other options should be registered with IANA, see RFC 4520 section 3.5.
139
140
OpenLDAP also has the `binary' option built in, but this is a transfer
option, not a tagging option.
141
142
.HP
.hy 0
143
144
.B attributetype "(\ <oid>\
 [NAME\ <name>]\
145
 [DESC\ <description>]\
146
147
148
149
150
151
152
153
154
155
 [OBSOLETE]\
 [SUP\ <oid>]\
 [EQUALITY\ <oid>]\
 [ORDERING\ <oid>]\
 [SUBSTR\ <oid>]\
 [SYNTAX\ <oidlen>]\
 [SINGLE\-VALUE]\
 [COLLECTIVE]\
 [NO\-USER\-MODIFICATION]\
 [USAGE\ <attributeUsage>]\ )"
156
.RS
Kurt Zeilenga's avatar
Kurt Zeilenga committed
157
158
Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
The slapd parser extends the RFC 4512 definition by allowing string
Kurt Zeilenga's avatar
Kurt Zeilenga committed
159
160
forms as well as numeric OIDs to be used for the attribute OID and
attribute syntax OID.
161
(See the
162
.B objectidentifier
163
description.) 
164
.RE
165
.TP
166
167
168
169
170
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
.B authz-policy <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.
Pierangelo Masarati's avatar
Pierangelo Masarati committed
196
197
198
.LP
.RS
The rules are mechanisms to specify which identities are allowed 
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
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 
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
220
or a set of identities; it can take five forms:
221
222
223
224
225
226
227
228
229
230
231
.RS
.TP
.B ldap:///<base>??[<scope>]?<filter>
.RE
.RS
.B dn[.<dnstyle>]:<pattern>
.RE
.RS
.B u[<mech>[<realm>]]:<pattern>
.RE
.RS
Pierangelo Masarati's avatar
Pierangelo Masarati committed
232
233
234
.B group[/objectClass[/attributeType]]:<pattern>
.RE
.RS
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
.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
266
style, which causes the
267
.I <pattern>
268
269
270
271
272
to be treated as a POSIX (''extended'') regular expression, as
discussed in
.BR regex (7)
and/or
.BR re_format (7).
Pierangelo Masarati's avatar
Pierangelo Masarati committed
273
274
275
A pattern of
.I *
means any non-anonymous DN.
276
277
278
279
280
281
282
283
284
285
286
287
288
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.
Pierangelo Masarati's avatar
Pierangelo Masarati committed
289
290
291
292
293
294
295
296
297
298
299
300
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.
301
302
303
304
305
306
307
308
309
310
311
312
313
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.
Pierangelo Masarati's avatar
Pierangelo Masarati committed
314
315
316
317
318
319
320
A subset of these rules can be used as third arg in the 
.B authz-regexp
statement (see below); significantly, the 
.I URI
and the
.I dn.exact:<dn> 
forms.
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
.RE
.TP
.B authz-regexp <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
Pierangelo Masarati's avatar
typo    
Pierangelo Masarati committed
337
.B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
338
339
340
341

.RE
This name is then compared against the
.B match
342
343
POSIX (''extended'') regular expression, and if the match is successful,
the name is replaced with the
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
.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
364
365
366
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)
367
368
and, if the search returns exactly one entry, the name is
replaced by the DN of that entry.   The LDAP URI must have no
369
370
hostport, attrs, or extensions components, but the filter is mandatory,
e.g.
371
372
373
374
375
.RS
.TP
.B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)

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

381
382
383
384
385
386
387
388
389
390
391
392
Multiple 
.B authz-regexp 
options can be given in the configuration file to allow for multiple matching 
and replacement patterns. The matching patterns are checked in the order they 
appear in the file, stopping at the first successful match.

.\".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
393
394
.B concurrency <integer>
Specify a desired level of concurrency.  Provided to the underlying
395
thread system as a hint.  The default is not to provide any hint.
396
397
398
399
400
401
402
403
404
405
.TP
.B conn_max_pending <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 conn_max_pending_auth <integer>
Specify the maximum number of pending requests for an authenticated session.
The default is 1000.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
406
.TP
407
408
409
.B defaultsearchbase <dn>
Specify a default search base to use when client submits a
non-base search request with an empty base DN.
410
Base scoped search requests with an empty base DN are not affected.
411
.TP
412
.B disallow <features>
413
414
Specify a set of features (separated by white space) to
disallow (default none).
415
.B bind_anon
416
417
disables acceptance of anonymous bind requests.  Note that this setting
does not prohibit anonymous directory access (See "require authc").
418
419
.B bind_simple
disables simple (bind) authentication.
420
.B tls_2_anon
Kurt Zeilenga's avatar
Kurt Zeilenga committed
421
disables forcing session to anonymous status (see also
Pierangelo Masarati's avatar
Pierangelo Masarati committed
422
423
.BR tls_authc )
upon StartTLS operation receipt.
424
.B tls_authc
Pierangelo Masarati's avatar
Pierangelo Masarati committed
425
disallows the StartTLS operation if authenticated (see also
426
.BR tls_2_anon ).
427
428
429
430
431
432
433
434
435
436
437
.HP
.hy 0
.B ditcontentrule "(\ <oid>\
 [NAME\ <name>]\
 [DESC\ <description>]\
 [OBSOLETE]\
 [AUX\ <oids>]\
 [MUST\ <oids>]\
 [MAY\ <oids>]\
 [NOT\ <oids>]\ )"
.RS
Kurt Zeilenga's avatar
Kurt Zeilenga committed
438
439
Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
The slapd parser extends the RFC 4512 definition by allowing string
440
441
442
443
444
445
forms as well as numeric OIDs to be used for the attribute OID and
attribute syntax OID.
(See the
.B objectidentifier
description.) 
.RE
446
.TP
447
448
449
450
.B gentlehup { on | off }
A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
.B Slapd
will stop listening for new connections, but will not close the
451
452
connections to the current clients.  Future write operations return
unwilling-to-perform, though.  Slapd terminates when all clients
453
454
455
456
457
458
459
460
461
462
463
have closed their connections (if they ever do), or \- as before \-
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 off.  You may wish to use
.B idletimeout
along with this option.
.TP
464
465
.B idletimeout <integer>
Specify the number of seconds to wait before forcibly closing
466
an idle client connection.  A idletimeout of 0 disables this
467
468
feature.  The default is 0.
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
469
470
471
.B include <filename>
Read additional configuration information from the given file before
continuing with the next line of the current file.
Howard Chu's avatar
Howard Chu committed
472
.TP
473
474
475
476
477
.B index_intlen <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
value is 4, which provides exact indexing for 32 bit values.
.TP
Howard Chu's avatar
Howard Chu committed
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
.B index_substr_if_minlen <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 index_substr_if_maxlen <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 index_substr_any_len <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
.I index_substr_if_maxlen
value.
.TP
.B index_substr_any_step <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".
503

504
505
506
507
508
.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).
509

510
.TP
511
512
513
514
515
516
.B localSSF <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 sasl-secprops 's
.B minssf
Kurt Zeilenga's avatar
Kurt Zeilenga committed
517
option description.  The default is 71.
518
.TP
519
520
521
522
523
.B logfile <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
524
.B loglevel <integer> [...]
Kurt Zeilenga's avatar
Kurt Zeilenga committed
525
526
527
Specify the level at which debugging statements and operation 
statistics should be syslogged (currently logged to the
.BR syslogd (8) 
528
529
530
531
LOG_LOCAL4 facility).
They must be considered subsystems rather than increasingly verbose 
log levels.
Some messages with higher priority are logged regardless 
532
of the configured loglevel as soon as any logging is configured.
533
Log levels are additive, and available levels are:
Kurt Zeilenga's avatar
Kurt Zeilenga committed
534
535
536
537
538
.RS
.RS
.PD 0
.TP
.B 1
539
.B (0x1 trace)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
540
541
542
trace function calls
.TP
.B 2
543
.B (0x2 packets)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
544
545
546
debug packet handling
.TP
.B 4
547
548
.B (0x4 args)
heavy trace debugging (function args)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
549
550
.TP
.B 8
551
.B (0x8 conns)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
552
553
554
connection management
.TP
.B 16
555
.B (0x10 BER)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
556
557
558
print out packets sent and received
.TP
.B 32
559
.B (0x20 filter)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
560
561
562
search filter processing
.TP
.B 64
563
.B (0x40 config)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
564
565
566
configuration file processing
.TP
.B 128
567
.B (0x80 ACL)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
568
569
570
access control list processing
.TP
.B 256
571
.B (0x100 stats)
572
connections, LDAP operations, results (recommended)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
573
574
.TP
.B 512
575
.B (0x200 stats2)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
576
577
578
stats log entries sent
.TP
.B 1024
579
.B (0x400 shell)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
580
581
582
print communication with shell backends
.TP
.B 2048
583
.B (0x800 parse)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
584
entry parsing
585
586
587
588
589
590
591
592
\".TP
\".B 4096
\".B (0x1000 cache)
\"caching (unused)
\".TP
\".B 8192
\".B (0x2000 index)
\"data indexing (unused)
593
594
595
596
597
598
.TP
.B 16384
.B (0x4000 sync)
LDAPSync replication
.TP
.B 32768
599
.B (0x8000 none)
600
only messages that get logged whatever log level is set
Kurt Zeilenga's avatar
Kurt Zeilenga committed
601
602
.PD
.RE
603
The desired log level can be input as a single integer that combines 
604
605
the (ORed) desired levels, both in decimal or in hexadecimal notation,
as a list of integers (that are ORed internally),
606
607
608
609
or as a list of the names that are shown between brackets, such that
.LP
.nf
    loglevel 129
610
    loglevel 0x81
611
    loglevel 128 1
612
    loglevel 0x80 0x1
613
614
615
616
617
618
619
    loglevel acl trace
.fi
.LP
are equivalent.
The keyword 
.B any
can be used as a shortcut to enable logging at all levels (equivalent to -1).
620
621
622
623
The keyword
.BR none ,
or the equivalent integer representation, causes those messages
that are logged regardless of the configured loglevel to be logged.
624
In fact, if loglevel is set to 0, no logging occurs, 
625
626
627
so at least the 
.B none
level is required to have high priority messages logged.
628
629
630
631

The loglevel defaults to \fBstats\fP.
This level should usually also be included when using other loglevels, to
help analyze the logs.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
632
.RE
633
634
635
636
637
638
639
640
641
642
643
644
645
.TP
.B moduleload <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 modulepath
option. This option and the
.B modulepath
option are only usable if slapd was compiled with --enable-modules.
.TP
.B modulepath <pathspec>
Specify a list of directories to search for loadable modules. Typically
the path is colon-separated but this depends on the operating system.
646
.HP
647
648
649
.hy 0
.B objectclass "(\ <oid>\
 [NAME\ <name>]\
650
 [DESC\ <description>]\
651
652
653
654
 [OBSOLETE]\
 [SUP\ <oids>]\
 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
 [MUST\ <oids>] [MAY\ <oids>] )"
655
.RS
Kurt Zeilenga's avatar
Kurt Zeilenga committed
656
657
Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
The slapd parser extends the RFC 4512 definition by allowing string
Kurt Zeilenga's avatar
Kurt Zeilenga committed
658
659
forms as well as numeric OIDs to be used for the object class OID.
(See the
660
661
.B
objectidentifier
Kurt Zeilenga's avatar
Kurt Zeilenga committed
662
description.)  Object classes are "STRUCTURAL" by default.
663
.RE
664
.TP
Pierangelo Masarati's avatar
Pierangelo Masarati committed
665
.B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
666
667
668
669
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.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
670
.TP
671
672
673
.B password-hash <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
Kurt Zeilenga's avatar
Kurt Zeilenga committed
674
LDAP Password Modify Extended Operations (RFC 3062).
675
The <hash> must be one of
676
677
678
679
.BR {SSHA} ,
.BR {SHA} ,
.BR {SMD5} ,
.BR {MD5} ,
680
.BR {CRYPT} ,
681
and
682
.BR {CLEARTEXT} .
683
684
The default is
.BR {SSHA} .
685

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

691
692
693
694
.B {MD5}
and
.B {SMD5}
use the MD5 algorithm (RFC 1321), the latter with a seed.
695

696
697
698
.B {CRYPT}
uses the
.BR crypt (3).
699

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

704
Note that this option does not alter the normal user applications
705
handling of userPassword during LDAP Add, Modify, or other LDAP operations.
706
.TP
707
.B password\-crypt\-salt\-format <format>
708
709
Specify the format of the salt passed to
.BR crypt (3)
710
711
712
713
when generating {CRYPT} passwords (see
.BR password\-hash )
during processing of LDAP Password Modify Extended Operations (RFC 3062).

714
715
716
This string needs to be in
.BR sprintf (3)
format and may include one (and only one) %s conversion.
717
This conversion will be substituted with a string of random
718
719
720
721
722
723
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
Kurt Zeilenga's avatar
Kurt Zeilenga committed
724
725
726
727
728
729
730
.B pidfile <filename>
The ( absolute ) name of a file that will hold the 
.B slapd
server's process ID ( see
.BR getpid (2)
) if started without the debugging command line option.
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
731
732
733
734
.B referral <url>
Specify the referral to pass back when
.BR slapd (8)
cannot find a local database to handle a request.
735
If specified multiple times, each url is provided.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
736
.TP
737
.B require <conditions>
738
739
Specify a set of conditions (separated by white space) to
require (default none).
740
741
742
The directive may be specified globally and/or per-database;
databases inherit global conditions, so per-database specifications
are additive.
743
744
745
746
747
748
749
750
751
752
.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.
753
754
The strong keyword allows protected "simple" authentication
as well as SASL authentication.
755
.B none
756
757
758
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.
759
.TP
760
.B reverse-lookup on | off
761
762
Enable/disable client name unverified reverse lookup (default is 
.BR off 
763
764
if compiled with --enable-rlookups).
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
765
.B rootDSE <file>
766
767
768
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.
769
770
771
772
773
774
775
776

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
ldapsearch -x -b "" -s base "+"
.br
See RFC 4512 section 5.1 for details.
777
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
778
779
780
.B sasl-host <fqdn>
Used to specify the fully qualified domain name used for SASL processing.
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
781
782
.B sasl-realm <realm>
Specify SASL realm.  Default is empty.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
783
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
784
785
786
787
.B sasl-secprops <properties>
Used to specify Cyrus SASL security properties.
The
.B none
788
flag (without any other properties) causes the flag properties
Kurt Zeilenga's avatar
Kurt Zeilenga committed
789
790
791
792
793
794
795
796
797
798
799
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
Kurt Zeilenga's avatar
Kurt Zeilenga committed
800
.B noanonymous
Kurt Zeilenga's avatar
Kurt Zeilenga committed
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
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
Kurt Zeilenga's avatar
Kurt Zeilenga committed
824
.B maxbufsize=<size> 
Kurt Zeilenga's avatar
Kurt Zeilenga committed
825
826
827
property specifies the maximum security layer receive buffer
size allowed.  0 disables security layers.  The default is 65536.
.TP
828
829
830
831
.B schemadn <dn>
Specify the distinguished name for the subschema subentry that
controls the entries on this server.  The default is "cn=Subschema".
.TP
832
.B security <factors>
Kurt Zeilenga's avatar
Kurt Zeilenga committed
833
834
835
836
837
Specify a set of security strength factors (separated by white space)
to require (see
.BR sasl-secprops 's
.B minssf
option for a description of security strength factors).
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
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.
859
860
861
862
.B simple_bind=<n>
specifies the security strength factor required for
.I simple
username/password authentication.
863
864
865
866
867
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
Howard Chu's avatar
Howard Chu committed
868
.B serverID <integer> [<URL>]
869
870
871
Specify an integer ID from 0 to 4095 for this server (limited
to 3 hexadecimal digits).
These IDs are
Howard Chu's avatar
Howard Chu committed
872
873
874
875
876
877
878
879
880
881
882
883
required when using multimaster replication and each master must have a
unique ID. If the URL is provided, this directive may be specified
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
	serverID 1
.fi
.TP
884
.B sizelimit {<integer>|unlimited}
885
.TP
886
.B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
Kurt Zeilenga's avatar
Kurt Zeilenga committed
887
888
Specify the maximum number of entries to return from a search operation.
The default size limit is 500.
889
890
891
Use
.B unlimited
to specify no limits.
892
The second format allows a fine grain setting of the size limits.
893
Extra args can be added on the same line.
894
895
896
See
.BR limits
for an explanation of the different flags.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
897
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
898
.B sockbuf_max_incoming <integer>
899
900
901
902
903
904
Specify the maximum incoming LDAP PDU size for anonymous sessions.
The default is 262143.
.TP
.B sockbuf_max_incoming_auth <integer>
Specify the maximum incoming LDAP PDU size for authenticated sessions.
The default is 4194303.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
905
.TP
906
907
908
909
910
911
912
913
.B sortvals <attr> [...]
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.
.TP
914
915
.B threads <integer>
Specify the maximum size of the primary thread pool.
916
The default is 16; the minimum value is 2.
917
.TP
918
.B timelimit {<integer>|unlimited}
919
.TP
920
.B timelimit time[.{soft|hard}]=<integer> [...]
Kurt Zeilenga's avatar
Kurt Zeilenga committed
921
922
923
Specify the maximum number of seconds (in real time)
.B slapd
will spend answering a search request.  The default time limit is 3600.
924
925
926
Use
.B unlimited
to specify no limits.
927
The second format allows a fine grain setting of the time limits.
928
Extra args can be added on the same line.
929
930
931
See
.BR limits
for an explanation of the different flags.
932
.TP
933
934
935
936
.B tool-threads <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.
937
938
939
940
941
.\"ucdata-path is obsolete / ignored...
.\".TP
.\".B ucdata-path <path>
.\"Specify the path to the directory containing the Unicode character
.\"tables. The default path is DATADIR/ucdata.
942
943
944
.SH TLS OPTIONS
If
.B slapd
945
is built with support for Transport Layer Security, there are more options
946
947
948
949
950
951
952
953
954
955
you can specify.
.TP
.B TLSCipherSuite <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:

TLSCipherSuite HIGH:MEDIUM:+SSLv2

To check what ciphers a given spec selects, use:

956
957
958
959
960
961
962
963
964
965
.nf
	openssl ciphers -v <cipher-suite-spec>
.fi

To obtain the list of ciphers in GNUtls use:

.nf
	gnutls-cli -l
.fi

966
.TP
967
968
969
970
971
972
.B TLSCACertificateFile <filename>
Specifies the file that contains certificates for all of the Certificate
Authorities that
.B slapd
will recognize.
.TP
973
974
975
.B TLSCACertificatePath <path>
Specifies the path of a directory that contains Certificate Authority
certificates in separate individual files. Usually only one of this
976
977
or the TLSCACertificateFile is used. This directive is not supported
when using GNUtls.
978
.TP
979
980
981
982
983
984
985
986
987
988
989
990
.B TLSCertificateFile <filename>
Specifies the file that contains the
.B slapd
server certificate.
.TP
.B TLSCertificateKeyFile <filename>
Specifies the file that contains the
.B slapd
server private key that matches the certificate stored in the
.B TLSCertificateFile
file.  Currently, the private key must not be protected with a password, so
it is of critical importance that it is protected carefully. 
Kurt Zeilenga's avatar
Kurt Zeilenga committed
991
.TP
Howard Chu's avatar
Howard Chu committed
992
993
994
995
.B TLSDHParamFile <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
996
997
998
999
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
1000
1001
be done. When using GNUtls these parameters are always generated randomly so
this directive is ignored.
Howard Chu's avatar
Howard Chu committed
1002
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1003
1004
1005
1006
.B TLSRandFile <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.
1007
This directive is ignored with GNUtls.
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
.TP
.B TLSVerifyClient <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.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1036

1037
1038
1039
1040
1041
1042
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 TLSVerifyClient
setting must be chosen to enable SASL EXTERNAL authentication.
.RE
1043
1044
1045
.TP
.B TLSCRLCheck <level>
Specifies if the Certificate Revocation List (CRL) of the CA should be 
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1046
used to verify if the client certificates have not been revoked. This
1047
1048
requires
.B TLSCACertificatePath
1049
parameter to be set. This directive is ignored with GNUtls.
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
.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
1063
1064
1065
1066
1067
.TP
.B TLSCRLFile <filename>
Specifies a file containing a Certificate Revocation List to be used
for verifying that certificates have not been revoked. This directive is
only valid when using GNUtls.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1068
1069
.SH GENERAL BACKEND OPTIONS
Options in this section only apply to the configuration file section
1070
1071
1072
1073
1074
1075
for the specified backend.  They are supported by every
type of backend.
.TP
.B backend <databasetype>
Mark the beginning of a backend definition. <databasetype>
should be one of
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1076
.BR bdb ,
1077
.BR config ,
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1078
.BR dnssrv ,
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1079
.BR hdb ,
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1080
.BR ldap ,
1081
.BR ldif ,
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1082
1083
1084
1085
1086
1087
1088
.BR meta ,
.BR monitor ,
.BR null ,
.BR passwd ,
.BR perl ,
.BR relay ,
.BR shell ,
1089
or
1090
.BR sql ,
1091
1092
1093
1094
1095
depending on which backend will serve the database.

.SH GENERAL DATABASE OPTIONS
Options in this section only apply to the configuration file section
for the database in which they are defined.  They are supported by every
1096
1097
1098
1099
1100
type of backend.  Note that the
.B database
and at least one
.B suffix
option are mandatory for each database.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1101
1102
1103
1104
.TP
.B database <databasetype>
Mark the beginning of a new database instance definition. <databasetype>
should be one of
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1105
.BR bdb ,
1106
.BR config ,
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1107
.BR dnssrv ,
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1108
.BR hdb ,
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1109
.BR ldap ,
1110
.BR ldif ,
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1111
1112
1113
1114
1115
1116
1117
.BR meta ,
.BR monitor ,
.BR null ,
.BR passwd ,
.BR perl ,
.BR relay ,
.BR shell ,
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1118
or
1119
.BR sql ,
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1120
1121
depending on which backend will serve the database.
.TP
1122
1123
1124
1125
1126
1127
1128
.B hidden on | off
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
with other databases. By default, hidden is off.
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1129
1130
1131
1132
1133
.B lastmod on | off
Controls whether
.B slapd
will automatically maintain the 
modifiersName, modifyTimestamp, creatorsName, and 
1134
1135
1136
createTimestamp attributes for entries. It also controls
the entryCSN and entryUUID attributes, which are needed
by the syncrepl provider. By default, lastmod is on.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1137
.TP
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
.B limits <who> <limit> [<limit> [...]]
Specify time and size limits based on who initiated an operation.
The argument
.B who
can be any of
.RS
.RS
.TP
anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>

.RE
with
.RS
.TP
<style> ::= exact | base | onelevel | subtree | children | regex | anonymous

.RE
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
1178
1179
explicitly requires the (default) match based on POSIX (''extended'')
regular expression pattern.
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
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
.B who
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 
1217
.I integer
1218
1219
1220
1221
1222
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
1223
1224
1225
1226
.\"limit, an
.\".I "Administrative limit exceeded"
.\"error is returned.
limit, the value of the limit is used instead.
1227
1228
If the
.BR hard
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1229
limit is set to the keyword 
1230
.IR soft ,
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1231
the soft limit is used in either case; if it is set to the keyword 
1232
.IR unlimited , 
1233
1234
1235
1236
no hard limit is enforced.
Explicit requests for time limits smaller or equal to the
.BR hard 
limit are honored.
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1237
If no limit specifier is set, the value is assigned to the 
1238
1239
1240
.BR soft 
limit, and the
.BR hard
1241
1242
1243
limit is set to
.IR soft ,
to preserve the original behavior.
1244
1245
1246
1247

The syntax for size limits is
.BR size[.{soft|hard|unchecked}]=<integer> ,
where
1248
.I integer
1249
1250
1251
1252
1253
1254
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
1255
1256
1257
1258
.\"limit, an 
.\".I "Administrative limit exceeded"
.\"error is returned.
limit, the value of the limit is used instead.
1259
1260
If the 
.BR hard
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1261
limit is set to the keyword 
1262
.IR soft , 
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1263
the soft limit is used in either case; if it is set to the keyword
1264
.IR unlimited , 
1265
1266
1267
1268
1269
1270
no hard limit is enforced.
Explicit requests for size limits smaller or equal to the
.BR hard
limit are honored.
The
.BR unchecked
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1271
specifier sets a limit on the number of candidates a search request is allowed
1272
to examine.
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1273
The rationale behind it is that searches for non-properly indexed
1274
1275
1276
1277
1278
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
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1279
.B unchecked
1280
1281
limit provides a means to drop such operations before they are even 
started.
1282
1283
1284
If the selected candidates exceed the 
.BR unchecked
limit, the search will abort with 
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1285
1286
.IR "Unwilling to perform" .
If it is set to the keyword 
1287
.IR unlimited , 
1288
1289
1290
1291
1292
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.
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1293
If no limit specifier is set, the value is assigned to the
1294
1295
1296
.BR soft 
limit, and the
.BR hard
1297
1298
1299
limit is set to
.IR soft ,
to preserve the original behavior.
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313

In case of no match, the global limits are used.
The default values are the same of
.B sizelimit
and
.BR timelimit ;
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
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1314
is considered an explicit request for a limitation on the number
1315
1316
1317
1318
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
1319
.BR size.pr={<integer>|noEstimate|unlimited} ,
1320
where
1321
.I integer
1322
1323
is the max page size if no explicit limit is set; the keyword
.I noEstimate
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1324
inhibits the server from returning an estimate of the total number
1325
1326
1327
1328
of entries that might be returned
(note: the current implementation does not return any estimate).
The keyword
.I unlimited
1329
1330
indicates that no limit is applied to the pagedResults control page size.
The syntax
1331
.B size.prtotal={<integer>|unlimited|disabled}
1332
1333
1334
1335
1336
1337
allows to set a limit on the total number of entries that a pagedResults
control allows to return.
By default it is set to the 
.B hard
limit.
When set, 
1338
.I integer
1339
1340
1341
is the max number of entries that the whole search with pagedResults control
can return.
Use 
1342
1343
1344
1345
.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
1346
1347
.I disabled
disables the control, i.e. no paged results can be returned.
1348
1349
1350
1351
1352
1353
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.
1354
1355
1356
1357
1358
1359

The \fBlimits\fP statement is typically used to let an unlimited
number of entries be returned by searches performed
with the identity used by the consumer for synchronization purposes
by means of the RFC 4533 LDAP Content Synchronization protocol
(see \fBsyncrepl\fP for details).
1360
1361
.RE
.TP
1362
1363
.B maxderefdepth <depth>
Specifies the maximum number of aliases to dereference when trying to
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1364
resolve an entry, used to avoid infinite alias loops. The default is 15.
1365
.TP
Howard Chu's avatar
Howard Chu committed
1366
1367
.B mirrormode on | off
This option puts a replica database into "mirror" mode.  Update
Howard Chu's avatar
Howard Chu committed
1368
operations will be accepted from any user, not just the updatedn.  The
1369
1370
1371
1372
database must already be configured as a syncrepl consumer
before this keyword may be set. This mode also requires a
.B serverID
(see above) to be configured.
Howard Chu's avatar
Howard Chu committed
1373
By default, mirrormode is off.
Howard Chu's avatar
Howard Chu committed
1374
.TP
1375
1376
1377
1378
1379
1380
1381
1382
.B monitoring on | off
This option enables database-specific monitoring in the entry related
to the current database in the "cn=Databases,cn=Monitor" subtree 
of the monitor database, if the monitor database is enabled.
Currently, only the BDB and the HDB databases provide database-specific
monitoring.
The default depends on the backend type.
.TP
Howard Chu's avatar
Howard Chu committed
1383
1384
1385
1386
1387
1388
.B overlay <overlay-name>
Add the specified overlay to this database. 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
1389
1390
1391
will receive control last of all. See the
.BR slapd.overlays (5)
manual page for an overview of the available overlays.
1392
1393
Note that all of the database's
regular settings should be configured before any overlay settings.
Howard Chu's avatar
Howard Chu committed
1394
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1395
1396
1397
1398
.B readonly on | off
This option puts the database into "read-only" mode.  Any attempts to 
modify the database will return an "unwilling to perform" error.  By
default, readonly is off.
1399
.HP
1400
.hy 0
1401
1402
.B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port] 
.B [starttls=yes|critical]
1403
.B [suffix=<suffix> [...]]
1404
.B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
Howard Chu's avatar
Howard Chu committed
1405
1406
.B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
.B [authcId=<authentication ID>] [authzId=<authorization ID>]
1407
.B [attrs[!]=<attr list>]
1408
.RS
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1409
Specify a replication site for this database.  Refer to the "OpenLDAP 
1410
Administrator's Guide" for detailed information on setting up a replicated
Kurt Zeilenga's avatar
Kurt Zeilenga committed
1411
.B slapd
1412
1413
1414
directory service. Zero or more
.B suffix
instances can be used to select the subtrees that will be replicated
1415
1416
1417
1418
1419
1420
1421
1422
(defaults to all the database). 
.B host
is deprecated in favor of the
.B uri
option.
.B uri
allows the replica LDAP server to be specified as an LDAP URI. 
A
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
.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. 
Howard Chu's avatar
Howard Chu committed
1437
1438
1439
1440
1441
1442
1443
Specific security properties (as with the
.B sasl-secprops
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.
1444
1445
1446
1447
If the 
.B mechanism
will use Kerberos, a kerberos instance should be given in 
.B authcId.
1448
1449
1450
An
.B attr list
can be given after the 
1451
.B attrs