slapd.conf.5 57.9 KB
Newer Older
1
.TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2
.\" Copyright 1998-2009 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
Global Configuration Options, General Backend Options, and General Database
Options.  Backend-specific options are discussed in the
71
.B slapd\-<backend>(5)
72
73
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
.B argsfile <filename>
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
111
The (absolute) name of a file that will hold the 
112
.B slapd
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
113
server's command line (program name and options).
114
115
116
.TP
.B attributeoptions [option-name]...
Define tagging attribute options or option tag/range prefixes.
117
118
Options must not end with `\-', prefixes must end with `\-'.
The `lang\-' prefix is predefined.
119
120
If you use the
.B attributeoptions
121
directive, `lang\-' will no longer be defined and you must specify it
122
123
124
125
126
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.
127
Prefixes defined this way work like the `lang\-' options:
128
They define a prefix for tagging options starting with the prefix.
129
130
That is, if you define the prefix `x\-foo\-', you can use the option
`x\-foo\-bar'.
131
Furthermore, in a search or compare, a prefix or range name (with
132
133
134
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'.
135

136
RFC 4520 reserves options beginning with `x\-' for private experiments.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
137
Other options should be registered with IANA, see RFC 4520 section 3.5.
138
139
OpenLDAP also has the `binary' option built in, but this is a transfer
option, not a tagging option.
140
141
.HP
.hy 0
142
143
.B attributetype "(\ <oid>\
 [NAME\ <name>]\
144
 [DESC\ <description>]\
145
146
147
148
149
150
151
152
153
154
 [OBSOLETE]\
 [SUP\ <oid>]\
 [EQUALITY\ <oid>]\
 [ORDERING\ <oid>]\
 [SUBSTR\ <oid>]\
 [SYNTAX\ <oidlen>]\
 [SINGLE\-VALUE]\
 [COLLECTIVE]\
 [NO\-USER\-MODIFICATION]\
 [USAGE\ <attributeUsage>]\ )"
155
.RS
Kurt Zeilenga's avatar
Kurt Zeilenga committed
156
157
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
158
159
forms as well as numeric OIDs to be used for the attribute OID and
attribute syntax OID.
160
(See the
161
.B objectidentifier
162
description.) 
163
.RE
164
.TP
165
.B authz\-policy <policy>
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
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
195
196
197
.LP
.RS
The rules are mechanisms to specify which identities are allowed 
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
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
219
or a set of identities; it can take five forms:
220
221
222
223
224
225
226
227
.RS
.TP
.B ldap:///<base>??[<scope>]?<filter>
.RE
.RS
.B dn[.<dnstyle>]:<pattern>
.RE
.RS
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
228
.B u[.<mech>[/<realm>]]:<pattern>
229
230
.RE
.RS
Pierangelo Masarati's avatar
Pierangelo Masarati committed
231
232
233
.B group[/objectClass[/attributeType]]:<pattern>
.RE
.RS
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
.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
265
style, which causes the
266
.I <pattern>
267
268
269
270
271
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
272
273
274
A pattern of
.I *
means any non-anonymous DN.
275
276
277
278
279
280
281
282
283
284
285
286
287
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
288
289
290
291
292
293
294
295
296
297
298
299
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.
300
301
302
303
304
305
306
307
308
309
310
311
312
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
313
A subset of these rules can be used as third arg in the 
314
.B authz\-regexp
Pierangelo Masarati's avatar
Pierangelo Masarati committed
315
statement (see below); significantly, the 
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
316
317
.IR URI ,
provided it results in exactly one entry,
Pierangelo Masarati's avatar
Pierangelo Masarati committed
318
319
320
and the
.I dn.exact:<dn> 
forms.
321
322
.RE
.TP
323
.B authz\-regexp <match> <replace>
324
Used by the authentication framework to convert simple user names,
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
325
326
327
328
such as provided by SASL subsystem, or extracted from certificates
in case of cert-based SASL EXTERNAL, or provided within the RFC 4370
"proxied authorization" control, to an LDAP DN used for
authorization purposes.  Note that the resulting DN need not refer
329
330
331
332
333
334
335
336
337
338
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
339
.B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
340
341
342
343

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

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

383
Multiple 
384
.B authz\-regexp 
385
386
387
388
389
390
391
392
393
394
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
395
396
.B concurrency <integer>
Specify a desired level of concurrency.  Provided to the underlying
397
thread system as a hint.  The default is not to provide any hint.
398
399
400
401
402
403
404
405
406
407
.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
408
.TP
409
410
411
.B defaultsearchbase <dn>
Specify a default search base to use when client submits a
non-base search request with an empty base DN.
412
Base scoped search requests with an empty base DN are not affected.
413
.TP
414
.B disallow <features>
415
416
Specify a set of features (separated by white space) to
disallow (default none).
417
.B bind_anon
418
419
disables acceptance of anonymous bind requests.  Note that this setting
does not prohibit anonymous directory access (See "require authc").
420
421
.B bind_simple
disables simple (bind) authentication.
422
.B tls_2_anon
Kurt Zeilenga's avatar
Kurt Zeilenga committed
423
disables forcing session to anonymous status (see also
Pierangelo Masarati's avatar
Pierangelo Masarati committed
424
425
.BR tls_authc )
upon StartTLS operation receipt.
426
.B tls_authc
Pierangelo Masarati's avatar
Pierangelo Masarati committed
427
disallows the StartTLS operation if authenticated (see also
428
.BR tls_2_anon ).
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
429
430
431
432
433
434
.B proxy_authz_non_critical
disables acceptance of the proxied authorization control (RFC4370)
when criticality is FALSE.
.B dontusecopy_non_critical
disables acceptance of the dontUseCopy control (a work in progress)
when criticality is FALSE.
435
436
437
438
439
440
441
442
443
444
445
.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
446
447
Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
The slapd parser extends the RFC 4512 definition by allowing string
448
449
450
451
452
453
forms as well as numeric OIDs to be used for the attribute OID and
attribute syntax OID.
(See the
.B objectidentifier
description.) 
.RE
454
.TP
455
456
457
458
.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
459
460
connections to the current clients.  Future write operations return
unwilling-to-perform, though.  Slapd terminates when all clients
461
have closed their connections (if they ever do), or - as before -
462
463
464
465
466
467
468
469
470
471
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
472
473
.B idletimeout <integer>
Specify the number of seconds to wait before forcibly closing
474
an idle client connection.  A idletimeout of 0 disables this
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
475
476
477
feature.  The default is 0. You may also want to set the
.B writetimeout
option.
478
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
479
480
481
.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
482
.TP
483
484
485
.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
486
487
value is 4, which provides exact indexing for 31 bit values.
A floating point representation is used to index too large values.
488
.TP
Howard Chu's avatar
Howard Chu committed
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
.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".
514

515
516
517
518
519
.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).
520

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
521
522
523
524
.HP
.hy 0
.B ldapsyntax "(\ <oid>\
 [DESC\ <description>]\
525
 [X\-SUBST <substitute-syntax>]\ )"
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
526
527
528
529
530
531
532
533
.RS
Specify an LDAP syntax using the LDAPv3 syntax defined in RFC 4512.
The slapd parser extends the RFC 4512 definition by allowing string
forms as well as numeric OIDs to be used for the syntax OID.
(See the
.B objectidentifier
description.) 
The slapd parser also honors the
534
.B X\-SUBST
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
535
536
537
538
extension (an OpenLDAP-specific extension), which allows to use the
.B ldapsyntax
statement to define a non-implemented syntax along with another syntax,
the extension value
539
.IR substitute-syntax ,
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
540
541
as its temporary replacement.
The
542
.I substitute-syntax
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
543
544
545
546
must be defined.
This allows to define attribute types that make use of non-implemented syntaxes
using the correct syntax OID.
Unless 
547
.B X\-SUBST
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
548
549
550
551
is used, this configuration statement would result in an error,
since no handlers would be associated to the resulting syntax structure.
.RE

552
.TP
553
554
555
556
557
558
.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
559
option description.  The default is 71.
560
.TP
561
562
563
564
565
.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
566
.B loglevel <integer> [...]
Kurt Zeilenga's avatar
Kurt Zeilenga committed
567
568
569
Specify the level at which debugging statements and operation 
statistics should be syslogged (currently logged to the
.BR syslogd (8) 
570
571
572
573
LOG_LOCAL4 facility).
They must be considered subsystems rather than increasingly verbose 
log levels.
Some messages with higher priority are logged regardless 
574
of the configured loglevel as soon as any logging is configured.
575
Log levels are additive, and available levels are:
Kurt Zeilenga's avatar
Kurt Zeilenga committed
576
577
578
579
580
.RS
.RS
.PD 0
.TP
.B 1
581
.B (0x1 trace)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
582
583
584
trace function calls
.TP
.B 2
585
.B (0x2 packets)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
586
587
588
debug packet handling
.TP
.B 4
589
590
.B (0x4 args)
heavy trace debugging (function args)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
591
592
.TP
.B 8
593
.B (0x8 conns)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
594
595
596
connection management
.TP
.B 16
597
.B (0x10 BER)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
598
599
600
print out packets sent and received
.TP
.B 32
601
.B (0x20 filter)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
602
603
604
search filter processing
.TP
.B 64
605
.B (0x40 config)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
606
607
608
configuration file processing
.TP
.B 128
609
.B (0x80 ACL)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
610
611
612
access control list processing
.TP
.B 256
613
.B (0x100 stats)
614
connections, LDAP operations, results (recommended)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
615
616
.TP
.B 512
617
.B (0x200 stats2)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
618
619
620
stats log entries sent
.TP
.B 1024
621
.B (0x400 shell)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
622
623
624
print communication with shell backends
.TP
.B 2048
625
.B (0x800 parse)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
626
entry parsing
627
628
629
630
631
632
633
634
\".TP
\".B 4096
\".B (0x1000 cache)
\"caching (unused)
\".TP
\".B 8192
\".B (0x2000 index)
\"data indexing (unused)
635
636
637
638
639
640
.TP
.B 16384
.B (0x4000 sync)
LDAPSync replication
.TP
.B 32768
641
.B (0x8000 none)
642
only messages that get logged whatever log level is set
Kurt Zeilenga's avatar
Kurt Zeilenga committed
643
644
.PD
.RE
645
The desired log level can be input as a single integer that combines 
646
647
the (ORed) desired levels, both in decimal or in hexadecimal notation,
as a list of integers (that are ORed internally),
648
649
650
651
or as a list of the names that are shown between brackets, such that
.LP
.nf
    loglevel 129
652
    loglevel 0x81
653
    loglevel 128 1
654
    loglevel 0x80 0x1
655
656
657
658
659
660
    loglevel acl trace
.fi
.LP
are equivalent.
The keyword 
.B any
661
can be used as a shortcut to enable logging at all levels (equivalent to \-1).
662
663
664
665
The keyword
.BR none ,
or the equivalent integer representation, causes those messages
that are logged regardless of the configured loglevel to be logged.
666
In fact, if loglevel is set to 0, no logging occurs, 
667
668
669
so at least the 
.B none
level is required to have high priority messages logged.
670
671
672
673

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
674
.RE
675
676
677
678
679
680
681
682
.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
683
option are only usable if slapd was compiled with \-\-enable\-modules.
684
685
686
687
.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.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
688
689
The default is MODULEDIR, which is where the standard OpenLDAP install
will place its modules.
690
.HP
691
692
693
.hy 0
.B objectclass "(\ <oid>\
 [NAME\ <name>]\
694
 [DESC\ <description>]\
695
696
697
698
 [OBSOLETE]\
 [SUP\ <oids>]\
 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
 [MUST\ <oids>] [MAY\ <oids>] )"
699
.RS
Kurt Zeilenga's avatar
Kurt Zeilenga committed
700
701
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
702
703
forms as well as numeric OIDs to be used for the object class OID.
(See the
704
705
.B
objectidentifier
Kurt Zeilenga's avatar
Kurt Zeilenga committed
706
description.)  Object classes are "STRUCTURAL" by default.
707
.RE
708
.TP
Pierangelo Masarati's avatar
Pierangelo Masarati committed
709
.B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
710
711
712
713
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
714
.TP
715
.B password\-hash <hash> [<hash>...]
716
717
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
718
LDAP Password Modify Extended Operations (RFC 3062).
719
The <hash> must be one of
720
721
722
723
.BR {SSHA} ,
.BR {SHA} ,
.BR {SMD5} ,
.BR {MD5} ,
724
.BR {CRYPT} ,
725
and
726
.BR {CLEARTEXT} .
727
728
The default is
.BR {SSHA} .
729

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

735
736
737
738
.B {MD5}
and
.B {SMD5}
use the MD5 algorithm (RFC 1321), the latter with a seed.
739

740
741
742
.B {CRYPT}
uses the
.BR crypt (3).
743

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

748
Note that this option does not alter the normal user applications
749
handling of userPassword during LDAP Add, Modify, or other LDAP operations.
750
.TP
751
.B password\-crypt\-salt\-format <format>
752
753
Specify the format of the salt passed to
.BR crypt (3)
754
755
756
757
when generating {CRYPT} passwords (see
.BR password\-hash )
during processing of LDAP Password Modify Extended Operations (RFC 3062).

758
759
760
This string needs to be in
.BR sprintf (3)
format and may include one (and only one) %s conversion.
761
This conversion will be substituted with a string of random
762
763
764
765
766
767
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
768
.B pidfile <filename>
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
769
The (absolute) name of a file that will hold the 
Kurt Zeilenga's avatar
Kurt Zeilenga committed
770
.B slapd
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
771
772
server's process ID (see
.BR getpid (2)).
Kurt Zeilenga's avatar
Kurt Zeilenga committed
773
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
774
775
776
777
.B referral <url>
Specify the referral to pass back when
.BR slapd (8)
cannot find a local database to handle a request.
778
If specified multiple times, each url is provided.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
779
.TP
780
.B require <conditions>
781
782
Specify a set of conditions (separated by white space) to
require (default none).
783
784
785
The directive may be specified globally and/or per-database;
databases inherit global conditions, so per-database specifications
are additive.
786
787
788
789
790
791
792
793
794
795
.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.
796
797
The strong keyword allows protected "simple" authentication
as well as SASL authentication.
798
.B none
799
800
801
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.
802
.TP
803
.B reverse\-lookup on | off
804
805
Enable/disable client name unverified reverse lookup (default is 
.BR off 
806
if compiled with \-\-enable\-rlookups).
807
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
808
.B rootDSE <file>
809
810
811
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.
812
813
814
815
816

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
817
ldapsearch \-x \-b "" \-s base "+"
818
819
.br
See RFC 4512 section 5.1 for details.
820
.TP
821
.B sasl\-auxprops <plugin> [...]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
822
823
824
825
Specify which auxprop plugins to use for authentication lookups. The
default is empty, which just uses slapd's internal support. Usually
no other auxprop plugins are needed.
.TP
826
.B sasl\-host <fqdn>
Kurt Zeilenga's avatar
Kurt Zeilenga committed
827
828
Used to specify the fully qualified domain name used for SASL processing.
.TP
829
.B sasl\-realm <realm>
Kurt Zeilenga's avatar
Kurt Zeilenga committed
830
Specify SASL realm.  Default is empty.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
831
.TP
832
.B sasl\-secprops <properties>
Kurt Zeilenga's avatar
Kurt Zeilenga committed
833
834
835
Used to specify Cyrus SASL security properties.
The
.B none
836
flag (without any other properties) causes the flag properties
Kurt Zeilenga's avatar
Kurt Zeilenga committed
837
838
839
840
841
842
843
844
845
846
847
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
848
.B noanonymous
Kurt Zeilenga's avatar
Kurt Zeilenga committed
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
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
872
.B maxbufsize=<size> 
Kurt Zeilenga's avatar
Kurt Zeilenga committed
873
874
875
property specifies the maximum security layer receive buffer
size allowed.  0 disables security layers.  The default is 65536.
.TP
876
877
878
879
.B schemadn <dn>
Specify the distinguished name for the subschema subentry that
controls the entries on this server.  The default is "cn=Subschema".
.TP
880
.B security <factors>
Kurt Zeilenga's avatar
Kurt Zeilenga committed
881
882
Specify a set of security strength factors (separated by white space)
to require (see
883
.BR sasl\-secprops 's
Kurt Zeilenga's avatar
Kurt Zeilenga committed
884
885
.B minssf
option for a description of security strength factors).
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
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.
907
908
909
910
.B simple_bind=<n>
specifies the security strength factor required for
.I simple
username/password authentication.
911
912
913
914
915
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
916
.B serverID <integer> [<URL>]
917
918
919
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
920
required when using multimaster replication and each master must have a
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
921
922
923
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
924
925
926
927
928
929
930
931
932
933
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
934
.B sizelimit {<integer>|unlimited}
935
.TP
936
.B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
Kurt Zeilenga's avatar
Kurt Zeilenga committed
937
938
Specify the maximum number of entries to return from a search operation.
The default size limit is 500.
939
940
941
Use
.B unlimited
to specify no limits.
942
The second format allows a fine grain setting of the size limits.
943
Extra args can be added on the same line.
944
945
946
See
.BR limits
for an explanation of the different flags.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
947
.TP
Kurt Zeilenga's avatar
Kurt Zeilenga committed
948
.B sockbuf_max_incoming <integer>
949
950
951
952
953
954
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
955
.TP
956
957
958
959
960
961
962
963
.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
964
965
.B threads <integer>
Specify the maximum size of the primary thread pool.
966
The default is 16; the minimum value is 2.
967
.TP
968
.B timelimit {<integer>|unlimited}
969
.TP
970
.B timelimit time[.{soft|hard}]=<integer> [...]
Kurt Zeilenga's avatar
Kurt Zeilenga committed
971
972
973
Specify the maximum number of seconds (in real time)
.B slapd
will spend answering a search request.  The default time limit is 3600.
974
975
976
Use
.B unlimited
to specify no limits.
977
The second format allows a fine grain setting of the time limits.
978
Extra args can be added on the same line.
979
980
981
See
.BR limits
for an explanation of the different flags.
982
.TP
983
.B tool\-threads <integer>
984
985
986
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.
987
988
989
990
991
.\"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.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
992
993
994
995
996
997
.TP
.B writetimeout <integer>
Specify the number of seconds to wait before forcibly closing
a connection with an outstanding write. This allows recovery from
various network hang conditions.  A writetimeout of 0 disables this
feature.  The default is 0.
998
999
1000
.SH TLS OPTIONS
If
.B slapd