slapd.conf.5 55.1 KB
Newer Older
1
.TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
Kurt Zeilenga's avatar
Kurt Zeilenga committed
2
.\" Copyright 1998-2008 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)
Howard Chu's avatar
Howard Chu committed
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
Howard Chu's avatar
Howard Chu committed
473
474
.B index_intlen <integer>
Specify the key length for ordered integer indices. The most significant
Howard Chu's avatar
Howard Chu committed
475
bytes of the binary integer will be used for index keys. The default
476
477
value is 4, which provides exact indexing for 31 bit values.
A floating point representation is used to index too large values.
Howard Chu's avatar
Howard Chu committed
478
.TP
Howard Chu's avatar
Howard Chu committed
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
.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".
Howard Chu's avatar
Howard Chu committed
504

Howard Chu's avatar
Howard Chu committed
505
506
507
.LP
Note: Indexing support depends on the particular backend in use. Also,
changing these settings will generally require deleting any indices that
Howard Chu's avatar
Howard Chu committed
508
509
depend on these parameters and recreating them with
.BR slapindex (8).
Howard Chu's avatar
Howard Chu committed
510

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

630
The loglevel defaults to \fBstats\fP.
631
This level should usually also be included when using other loglevels, to
Hallvard Furuseth's avatar
Hallvard Furuseth committed
632
help analyze the logs.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
633
.RE
634
635
636
637
638
639
640
641
642
643
644
645
646
.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.
647
.HP
648
649
650
.hy 0
.B objectclass "(\ <oid>\
 [NAME\ <name>]\
651
 [DESC\ <description>]\
652
653
654
655
 [OBSOLETE]\
 [SUP\ <oids>]\
 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
 [MUST\ <oids>] [MAY\ <oids>] )"
656
.RS
Kurt Zeilenga's avatar
Kurt Zeilenga committed
657
658
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
659
660
forms as well as numeric OIDs to be used for the object class OID.
(See the
661
662
.B
objectidentifier
Kurt Zeilenga's avatar
Kurt Zeilenga committed
663
description.)  Object classes are "STRUCTURAL" by default.
664
.RE
665
.TP
Pierangelo Masarati's avatar
Pierangelo Masarati committed
666
.B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
667
668
669
670
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
671
.TP
672
673
674
.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
675
LDAP Password Modify Extended Operations (RFC 3062).
676
The <hash> must be one of
677
678
679
680
.BR {SSHA} ,
.BR {SHA} ,
.BR {SMD5} ,
.BR {MD5} ,
681
.BR {CRYPT} ,
682
and
683
.BR {CLEARTEXT} .
684
685
The default is
.BR {SSHA} .
686

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

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

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

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

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

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

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

Howard Chu's avatar
Howard Chu committed
959
960
961
962
963
964
965
966
967
968
.nf
	openssl ciphers -v <cipher-suite-spec>
.fi

To obtain the list of ciphers in GNUtls use:

.nf
	gnutls-cli -l
.fi

969
.TP
970
971
972
973
974
975
.B TLSCACertificateFile <filename>
Specifies the file that contains certificates for all of the Certificate
Authorities that
.B slapd
will recognize.
.TP
976
977
978
.B TLSCACertificatePath <path>
Specifies the path of a directory that contains Certificate Authority
certificates in separate individual files. Usually only one of this
Howard Chu's avatar
Howard Chu committed
979
980
or the TLSCACertificateFile is used. This directive is not supported
when using GNUtls.
981
.TP
982
983
984
985
986
987
988
989
990
991
992
993
.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
994
.TP
Howard Chu's avatar
Howard Chu committed
995
996
997
998
.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
999
1000
them will be processed.  Note that setting this option may also enable
Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.