slapdconf2.sdf 33.8 KB
Newer Older
Howard Chu's avatar
Howard Chu committed
1
# $OpenLDAP$
Kurt Zeilenga's avatar
Kurt Zeilenga committed
2
# Copyright 2005-2008 The OpenLDAP Foundation, All Rights Reserved.
3
4
5
6
7
8
# COPYING RESTRICTIONS APPLY, see COPYRIGHT.

H1: Configuring slapd

Once the software has been built and installed, you are ready
to configure {{slapd}}(8) for use at your site. Unlike previous
Kurt Zeilenga's avatar
Kurt Zeilenga committed
9
10
OpenLDAP releases, the slapd(8) runtime configuration in 2.3 (and later)
is fully LDAP-enabled and can be managed using the standard LDAP
Howard Chu's avatar
Howard Chu committed
11
operations with data in {{TERM:LDIF}}. The LDAP configuration engine
12
13
14
allows all of slapd's configuration options to be changed on the fly,
generally without requiring a server restart for the changes
to take effect. The old style {{slapd.conf}}(5) file is still
15
supported, but must be converted to the new {{slapd-config}}(5) format
16
17
18
19
to allow runtime changes to be saved. While the old style
configuration uses a single file, normally installed as
{{F:/usr/local/etc/openldap/slapd.conf}}, the new style
uses a slapd backend database to store the configuration. The
Howard Chu's avatar
Howard Chu committed
20
configuration database normally resides in the
Howard Chu's avatar
Howard Chu committed
21
22
23
24
{{F:/usr/local/etc/openldap/slapd.d}} directory. When
converting from the slapd.conf format to slapd.d format, any
include files will also be integrated into the resulting configuration
database.
25

Kurt Zeilenga's avatar
Kurt Zeilenga committed
26
27
28
29
An alternate configuration directory (or file) can be specified via
a command-line option to {{slapd}}(8). This chapter describes the
general format of the configuration system, followed by a detailed
description of commonly used config settings.
30

31
32
33
34
Note: some of the backends and of the distributed overlays
do not support runtime configuration yet.  In those cases,
the old style {{slapd.conf}}(5) file must be used.

35
36
37
38
39
40
41
42
43

H2: Configuration Layout

The slapd configuration is stored as a special LDAP directory with
a predefined schema and DIT. There are specific objectClasses used to
carry global configuration options, schema definitions, backend and
database definitions, and assorted other items. A sample config tree
is shown in Figure 5.1.

44
!import "config_dit.png"; align="center"; title="Sample configuration tree"
45
46
47
48
49
FT[align="Center"] Figure 5.1: Sample configuration tree.

Other objects may be part of the configuration but were omitted from
the illustration for clarity.

50
The {{slapd-config}} configuration tree has a very specific structure. The
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
root of the tree is named {{EX:cn=config}} and contains global configuration
settings. Additional settings are contained in separate child entries:
* Dynamically loaded modules
.. These may only be used if the {{EX:--enable-modules}} option was
used to configure the software.
* Schema definitions
.. The {{EX:cn=schema,cn=config}} entry contains the system schema (all
the schema that is hard-coded in slapd).
.. Child entries of {{EX:cn=schema,cn=config}} contain user schema as
loaded from config files or added at runtime.
* Backend-specific configuration 
* Database-specific configuration
.. Overlays are defined in children of the Database entry.
.. Databases and Overlays may also have other miscellaneous children.

The usual rules for LDIF files apply to the configuration information:
Comment lines beginning with a '{{EX:#}}' character
68
are ignored.  If a line begins with a single space, it is considered a
69
continuation of the previous line (even if the previous line is a
70
comment) and the single leading space is removed. Entries are separated by blank lines.
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

The general layout of the config LDIF is as follows:

>	# global configuration settings
>	dn: cn=config
>	objectClass: olcGlobal
>	cn: config
>	<global config settings>
>
>	# schema definitions
>	dn: cn=schema,cn=config
>	objectClass: olcSchemaConfig
>	cn: schema
>	<system schema>
>
>	dn: cn={X}core,cn=schema,cn=config
>	objectClass: olcSchemaConfig
>	cn: {X}core
>	<core schema>
>
>	# additional user-specified schema
>	...
>
>	# backend definitions
Howard Chu's avatar
Howard Chu committed
95
>	dn: olcBackend=<typeA>,cn=config
96
>	objectClass: olcBackendConfig
Howard Chu's avatar
Howard Chu committed
97
>	olcBackend: <typeA>
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
>	<backend-specific settings>
>
>	# database definitions
>	dn: olcDatabase={X}<typeA>,cn=config
>	objectClass: olcDatabaseConfig
>	olcDatabase: {X}<typeA>
>	<database-specific settings>
>
>	# subsequent definitions and settings
>	...

Some of the entries listed above have a numeric index {{EX:"{X}"}} in
their names. While most configuration settings have an inherent ordering
dependency (i.e., one setting must take effect before a subsequent one
may be set), LDAP databases are inherently unordered. The numeric index
is used to enforce a consistent ordering in the configuration database,
so that all ordering dependencies are preserved. In most cases the index
does not have to be provided; it will be automatically generated based
on the order in which entries are created.

Howard Chu's avatar
Howard Chu committed
118
119
120
121
122
123
124
125
126
127
Configuration directives are specified as values of individual
attributes.
Most of the attributes and objectClasses used in the slapd
configuration have a prefix of {{EX:"olc"}} (OpenLDAP Configuration)
in their names. Generally there is a one-to-one correspondence
between the attributes and the old-style {{EX:slapd.conf}} configuration
keywords, using the keyword as the attribute name, with the "olc"
prefix attached.

A configuration directive may take arguments.  If so, the arguments are
128
separated by white space.  If an argument contains white space,
129
the argument should be enclosed in double quotes {{EX:"like this"}}.
Howard Chu's avatar
Howard Chu committed
130
131
In the descriptions that follow, arguments that should be replaced
by actual text are shown in brackets {{EX:<>}}.
132
133
134
135
136
137
138
139
140
141
142

The distribution contains an example configuration file that will
be installed in the {{F: /usr/local/etc/openldap}} directory.
A number of files containing schema definitions (attribute types
and object classes) are also provided in the
{{F: /usr/local/etc/openldap/schema}} directory.


H2: Configuration Directives

This section details commonly used configuration directives.  For
143
a complete list, see the {{slapd-config}}(5) manual page.  This section
Howard Chu's avatar
Howard Chu committed
144
145
146
147
will treat the configuration directives in a top-down order, starting
with the global directives in the {{EX:cn=config}} entry. Each
directive will be described along with its default value (if any) and
an example of its use.
148
149


Howard Chu's avatar
Howard Chu committed
150
H3: cn=config
151

Howard Chu's avatar
Howard Chu committed
152
Directives contained in this entry generally apply to the server as a whole.
153
154
Most of them are system or connection oriented, not database related. This
entry must have the {{EX:olcGlobal}} objectClass.
155
156


Howard Chu's avatar
Howard Chu committed
157
H4: olcIdleTimeout: <integer>
158
159

Specify the number of seconds to wait before forcibly closing
Howard Chu's avatar
Howard Chu committed
160
an idle client connection.  A value of 0, the default,
161
162
163
disables this feature.


Howard Chu's avatar
Howard Chu committed
164
H4: olcLogLevel: <level>
165
166
167
168
169
170

This directive specifies the level at which debugging statements
and operation statistics should be syslogged (currently logged to
the {{syslogd}}(8) {{EX:LOG_LOCAL4}} facility). You must have
configured OpenLDAP {{EX:--enable-debug}} (the default) for this
to work (except for the two statistics levels, which are always
Howard Chu's avatar
Howard Chu committed
171
172
173
enabled). Log levels may be specified as integers or by keyword.
Multiple log levels may be used and the levels are additive.
To display what levels
174
correspond to what kind of debugging, invoke slapd with {{EX:-d?}}
Howard Chu's avatar
Howard Chu committed
175
or consult the table below. The possible values for <level> are:
176
177
178

!block table; colaligns="RL"; align=Center; \
	title="Table 5.1: Debugging Levels"
Howard Chu's avatar
Howard Chu committed
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
Level	Keyword	Description
-1	Any	enable all debugging
0		no debugging
1	Trace	trace function calls
2	Packets	debug packet handling
4	Args	heavy trace debugging
8	Conns	connection management
16	BER	print out packets sent and received
32	Filter	search filter processing
64	Config	configuration processing
128	ACL	access control list processing
256	Stats	stats log connections/operations/results
512	Stats2	stats log entries sent
1024	Shell	print communication with shell backends
2048	Parse	print entry parsing debugging
4096	Cache	database cache processing
8192	Index	database indexing
16384	Sync	syncrepl consumer processing
197
198
199
200
!endblock

\Example:

Howard Chu's avatar
Howard Chu committed
201
E: olcLogLevel: -1
202
203
204
205

This will cause lots and lots of debugging information to be
logged.

Howard Chu's avatar
Howard Chu committed
206
E: olcLogLevel: Conns Filter
207

Howard Chu's avatar
Howard Chu committed
208
Just log the connection and search filter processing.
209

Howard Chu's avatar
Howard Chu committed
210
\Default:
211

Howard Chu's avatar
Howard Chu committed
212
E: olcLogLevel: Stats
213
214


Howard Chu's avatar
Howard Chu committed
215
H4: olcReferral <URI>
216
217
218
219
220
221

This directive specifies the referral to pass back when slapd
cannot find a local database to handle a request.

\Example:

Howard Chu's avatar
Howard Chu committed
222
>	olcReferral: ldap://root.openldap.org
223
224
225
226
227
228
229
230

This will refer non-local queries to the global root LDAP server
at the OpenLDAP Project. Smart LDAP clients can re-ask their
query at that server, but note that most of these clients are
only going to know how to handle simple LDAP URLs that
contain a host part and optionally a distinguished name part.


Howard Chu's avatar
Howard Chu committed
231
H4: Sample Entry
232

Howard Chu's avatar
Howard Chu committed
233
234
235
236
237
238
>dn: cn=config
>objectClass: olcGlobal
>cn: config
>olcIdleTimeout: 30
>olcLogLevel: Stats
>olcReferral: ldap://root.openldap.org
239
240


241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
H3: cn=module

If support for dynamically loaded modules was enabled when configuring
slapd, {{EX:cn=module}} entries may be used to specify sets of modules to load.
Module entries must have the {{EX:olcModuleList}} objectClass.


H4: olcModuleLoad: <filename>

Specify the name of a dynamically loadable module to load. The filename
may be an absolute path name or a simple filename. Non-absolute names
are searched for in the directories specified by the {{EX:olcModulePath}}
directive.


H4: olcModulePath: <pathspec>

Specify a list of directories to search for loadable modules. Typically the
path is colon-separated but this depends on the operating system.


H4: Sample Entries

>dn: cn=module{0},cn=config
>objectClass: olcModuleList
>cn: module{0}
>olcModuleLoad: /usr/local/lib/smbk5pwd.la
>
>dn: cn=module{1},cn=config
>objectClass: olcModuleList
>cn: module{1}
>olcModulePath: /usr/local/lib:/usr/local/lib/slapd
>olcModuleLoad: accesslog.la
>olcModuleLoad: pcache.la


Howard Chu's avatar
Howard Chu committed
277
H3: cn=schema
278

Howard Chu's avatar
Howard Chu committed
279
280
281
282
The cn=schema entry holds all of the schema definitions that are hard-coded
in slapd. As such, the values in this entry are generated by slapd so no
schema values need to be provided in the config file. The entry must still
be defined though, to serve as a base for the user-defined schema to add
283
284
in underneath. Schema entries must have the {{EX:olcSchemaConfig}}
objectClass.
285

Howard Chu's avatar
Howard Chu committed
286

Kurt Zeilenga's avatar
Kurt Zeilenga committed
287
H4: olcAttributeTypes: <{{REF:RFC4512}} Attribute Type Description>
Howard Chu's avatar
Howard Chu committed
288
289
290
291
292
293

This directive defines an attribute type.
Please see the {{SECT:Schema Specification}} chapter
for information regarding how to use this directive.


Kurt Zeilenga's avatar
Kurt Zeilenga committed
294
H4: olcObjectClasses: <{{REF:RFC4512}} Object Class Description>
Howard Chu's avatar
Howard Chu committed
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310

This directive defines an object class.
Please see the {{SECT:Schema Specification}} chapter for
information regarding how to use this directive.


H4: Sample Entries

>dn: cn=schema,cn=config
>objectClass: olcSchemaConfig
>cn: schema
>
>dn: cn=test,cn=schema,cn=config
>objectClass: olcSchemaConfig
>cn: test
>olcAttributeTypes: ( 1.1.1
311
312
313
>  NAME 'testAttr'
>  EQUALITY integerMatch
>  SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 )
Howard Chu's avatar
Howard Chu committed
314
>olcAttributeTypes: ( 1.1.2 NAME 'testTwo' EQUALITY caseIgnoreMatch
315
>  SUBSTR caseIgnoreSubstringsMatch SYNTAX 1.3.6.1.4.1.1466.115.121.1.44 )
Howard Chu's avatar
Howard Chu committed
316
>olcObjectClasses: ( 1.1.3 NAME 'testObject'
317
>  MAY ( testAttr $ testTwo ) AUXILIARY )
Howard Chu's avatar
Howard Chu committed
318
319
320
321
322


H3: Backend-specific Directives

Backend directives apply to all database instances of the
323
same type and, depending on the directive, may be overridden
324
325
by database directives. Backend entries must have the
{{EX:olcBackendConfig}} objectClass.
326

Howard Chu's avatar
Howard Chu committed
327
H4: olcBackend: <type>
328

Howard Chu's avatar
Howard Chu committed
329
This directive names a backend-specific configuration entry.
330
331
332
333
334
335
336
{{EX:<type>}} should be one of the
supported backend types listed in Table 5.2.

!block table; align=Center; coltags="EX,N"; \
	title="Table 5.2: Database Backends"
Types	Description
bdb	Berkeley DB transactional backend
Howard Chu's avatar
Howard Chu committed
337
config	Slapd configuration backend
338
dnssrv	DNS SRV backend
Howard Chu's avatar
Howard Chu committed
339
hdb	Hierarchical variant of bdb backend
340
ldap	Lightweight Directory Access Protocol (Proxy) backend
Howard Chu's avatar
Howard Chu committed
341
ldif	Lightweight Data Interchange Format backend
342
343
344
345
346
347
348
349
350
351
meta	Meta Directory backend
monitor	Monitor backend
passwd	Provides read-only access to {{passwd}}(5)
perl	Perl Programmable backend
shell	Shell (extern program) backend
sql	SQL Programmable backend
!endblock

\Example:

Howard Chu's avatar
Howard Chu committed
352
>	olcBackend: bdb
353

Howard Chu's avatar
Howard Chu committed
354
355
356
357
There are no other directives defined for this entry.  Specific backend
types may define additional attributes for their particular use but so
far none have ever been defined.  As such, these directives usually do
not appear in any actual configurations.
Howard Chu's avatar
Howard Chu committed
358
359
360
361
362
363
364


H4: Sample Entry

> dn: olcBackend=bdb,cn=config
> objectClass: olcBackendConfig
> olcBackend: bdb
365
366


Howard Chu's avatar
Howard Chu committed
367
H3: Database-specific Directives
368

Howard Chu's avatar
Howard Chu committed
369
Directives in this section are supported by every type of database.
370
Database entries must have the {{EX:olcDatabaseConfig}} objectClass.
371

Howard Chu's avatar
Howard Chu committed
372
H4: olcDatabase: [{<index>}]<type>
373

Howard Chu's avatar
Howard Chu committed
374
375
376
This directive names a specific database instance. The numeric {<index>} may
be provided to distinguish multiple databases of the same type. Usually the
index can be omitted, and slapd will generate it automatically.
377
{{EX:<type>}} should be one of the
Howard Chu's avatar
Howard Chu committed
378
379
380
381
382
383
supported backend types listed in Table 5.2 or the {{EX:frontend}} type.

The {{EX:frontend}} is a special database that is used to hold
database-level options that should be applied to all the other
databases. Subsequent database definitions may also override some
frontend settings.
384

Howard Chu's avatar
Howard Chu committed
385
386
387
388
389
The {{EX:config}} database is also special; both the {{EX:config}} and
the {{EX:frontend}} databases are always created implicitly even if they
are not explicitly configured, and they are created before any other
databases.

390
391
\Example:

Howard Chu's avatar
Howard Chu committed
392
393
394
>	olcDatabase: bdb

This marks the beginning of a new {{TERM:BDB}} database instance.
395
396


397
H4: olcAccess: to <what> [ by <who> [<accesslevel>] [<control>] ]+
398

Howard Chu's avatar
Howard Chu committed
399
400
This directive grants access (specified by <accesslevel>) to a
set of entries and/or attributes (specified by <what>) by one or
Gavin Henry's avatar
Gavin Henry committed
401
more requestors (specified by <who>).
402
See the {{SECT:Access Control}} section of this guide for basic usage.
Howard Chu's avatar
Howard Chu committed
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417

!if 0
More detailed discussion of this directive can be found in the
{{SECT:Advanced Access Control}} chapter.
!endif

Note: If no {{EX:olcAccess}} directives are specified, the default
access control policy, {{EX:to * by * read}}, allows all
users (both authenticated and anonymous) read access.

Note: Access controls defined in the frontend are appended to all
other databases' controls.


H4: olcReadonly { TRUE | FALSE }
418
419
420
421
422
423
424

This directive puts the database into "read-only" mode. Any
attempts to modify the database will return an "unwilling to
perform" error.

\Default:

Howard Chu's avatar
Howard Chu committed
425
426
>	olcReadonly: FALSE

427

Howard Chu's avatar
Howard Chu committed
428
H4: olcRootDN: <DN>
429
430
431
432
433
434
435
436
437

This directive specifies the DN that is not subject to
access control or administrative limit restrictions for
operations on this database.  The DN need not refer to
an entry in this database or even in the directory. The
DN may refer to a SASL identity.

Entry-based Example:

Howard Chu's avatar
Howard Chu committed
438
>	olcRootDN: "cn=Manager,dc=example,dc=com"
439
440
441

SASL-based Example:

Howard Chu's avatar
Howard Chu committed
442
>	olcRootDN: "uid=root,cn=example.com,cn=digest-md5,cn=auth"
443
444
445
446
447

See the {{SECT:SASL Authentication}} section for information on
SASL authentication identities.


Howard Chu's avatar
Howard Chu committed
448
H4: olcRootPW: <password>
449

Howard Chu's avatar
Howard Chu committed
450
This directive can be used to specify a password for the DN for
451
452
453
454
the rootdn (when the rootdn is set to a DN within the database).

\Example:

Howard Chu's avatar
Howard Chu committed
455
>	olcRootPW: secret
456

Kurt Zeilenga's avatar
Kurt Zeilenga committed
457
458
459
It is also permissible to provide a hash of the password in
{{REF:RFC2307}} form.  {{slappasswd}}(8) may be used to generate
the password hash.
460
461
462

\Example:

Howard Chu's avatar
Howard Chu committed
463
>	olcRootPW: {SSHA}ZKKuqbEKJfKSXhUbHG3fG8MDn9j1v4QN
464
465
466
467

The hash was generated using the command {{EX:slappasswd -s secret}}.


Howard Chu's avatar
Howard Chu committed
468
469
470
471
472
473
474
475
476
477
478
479
H4: olcSizeLimit: <integer>

This directive specifies the maximum number of entries to return
from a search operation.

\Default:

>	olcSizeLimit: 500



H4: olcSuffix: <dn suffix>
480
481
482

This directive specifies the DN suffix of queries that will be
passed to this backend database. Multiple suffix lines can be
Howard Chu's avatar
Howard Chu committed
483
484
485
486
given, and usually at least one is required for each database
definition. (Some backend types, such as {{EX:frontend}} and
{{EX:monitor}} use a hard-coded suffix which may not be overridden
in the configuration.)
487
488
489

\Example:

Howard Chu's avatar
Howard Chu committed
490
>	olcSuffix: "dc=example,dc=com"
491
492
493
494
495

Queries with a DN ending in "dc=example,dc=com"
will be passed to this backend.

Note: When the backend to pass a query to is selected, slapd
Howard Chu's avatar
Howard Chu committed
496
497
498
looks at the suffix value(s) in each database definition in the
order in which they were configured. Thus, if one database suffix is a
prefix of another, it must appear after it in the configuration.
499
500


Howard Chu's avatar
Howard Chu committed
501
H4: olcSyncrepl
502

Howard Chu's avatar
Howard Chu committed
503
>	olcSyncrepl: rid=<replica ID>
504
505
506
507
>		provider=ldap[s]://<hostname>[:port]
>		[type=refreshOnly|refreshAndPersist]
>		[interval=dd:hh:mm:ss]
>		[retry=[<retry interval> <# of retries>]+]
508
>		searchbase=<base DN>
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
>		[filter=<filter str>]
>		[scope=sub|one|base]
>		[attrs=<attr list>]
>		[attrsonly]
>		[sizelimit=<limit>]
>		[timelimit=<limit>]
>		[schemachecking=on|off]
>		[bindmethod=simple|sasl]
>		[binddn=<DN>]
>		[saslmech=<mech>]
>		[authcid=<identity>]
>		[authzid=<identity>]
>		[credentials=<passwd>]
>		[realm=<realm>]
>		[secprops=<properties>]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
524
525
526
527
528
529
530
531
532
533
534
>		[starttls=yes|critical]
>		[tls_cert=<file>]
>		[tls_key=<file>]
>		[tls_cacert=<file>]
>		[tls_cacertdir=<path>]
>		[tls_reqcert=never|allow|try|demand]
>		[tls_ciphersuite=<ciphers>]
>		[tls_crlcheck=none|peer|all]
>		[logbase=<base DN>]
>		[logfilter=<filter str>]
>		[syncdata=default|accesslog|changelog]
535
536
537
538
539
540
541
542


This directive specifies the current database as a replica of the
master content by establishing the current {{slapd}}(8) as a
replication consumer site running a syncrepl replication engine.
The master database is located at the replication provider site
specified by the {{EX:provider}} parameter. The replica database is
kept up-to-date with the master content using the LDAP Content
Howard Chu's avatar
Howard Chu committed
543
544
Synchronization protocol. See {{REF:RFC4533}}
for more information on the protocol.
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570

The {{EX:rid}} parameter is used for identification of the current
{{EX:syncrepl}} directive within the replication consumer server,
where {{EX:<replica ID>}} uniquely identifies the syncrepl specification
described by the current {{EX:syncrepl}} directive. {{EX:<replica ID>}}
is non-negative and is no more than three decimal digits in length.

The {{EX:provider}} parameter specifies the replication provider site
containing the master content as an LDAP URI. The {{EX:provider}}
parameter specifies a scheme, a host and optionally a port where the
provider slapd instance can be found. Either a domain name or IP
address may be used for <hostname>. Examples are
{{EX:ldap://provider.example.com:389}} or {{EX:ldaps://192.168.1.1:636}}.
If <port> is not given, the standard LDAP port number (389 or 636) is used.
Note that the syncrepl uses a consumer-initiated protocol, and hence its
specification is located at the consumer site, whereas the {{EX:replica}}
specification is located at the provider site. {{EX:syncrepl}} and
{{EX:replica}} directives define two independent replication
mechanisms. They do not represent the replication peers of each other.

The content of the syncrepl replica is defined using a search
specification as its result set. The consumer slapd will
send search requests to the provider slapd according to the search
specification. The search specification includes {{EX:searchbase}},
{{EX:scope}}, {{EX:filter}}, {{EX:attrs}}, {{EX:attrsonly}},
{{EX:sizelimit}}, and {{EX:timelimit}} parameters as in the normal
571
572
573
574
575
search specification. The {{EX:searchbase}} parameter has no
default value and must always be specified. The {{EX:scope}} defaults
to {{EX:sub}}, the {{EX:filter}} defaults to {{EX:(objectclass=*)}},
{{EX:attrs}} defaults to {{EX:"*,+"}} to replicate all user and operational
attributes, and {{EX:attrsonly}} is unset by default. Both {{EX:sizelimit}}
576
577
and {{EX:timelimit}} default to "unlimited", and only positive integers
or "unlimited" may be specified.
578

Kurt Zeilenga's avatar
Kurt Zeilenga committed
579
The {{TERM[expand]LDAP Sync}} protocol has two operation
580
581
582
583
584
585
586
types: {{EX:refreshOnly}} and {{EX:refreshAndPersist}}.
The operation type is specified by the {{EX:type}} parameter.
In the {{EX:refreshOnly}} operation, the next synchronization search operation
is periodically rescheduled at an interval time after each
synchronization operation finishes. The interval is specified
by the {{EX:interval}} parameter. It is set to one day by default.
In the {{EX:refreshAndPersist}} operation, a synchronization search
Kurt Zeilenga's avatar
Kurt Zeilenga committed
587
remains persistent in the provider {{slapd}} instance. Further updates to the
588
589
590
591
592
master replica will generate {{EX:searchResultEntry}} to the consumer slapd
as the search responses to the persistent synchronization search.

If an error occurs during replication, the consumer will attempt to reconnect
according to the retry parameter which is a list of the <retry interval>
593
and <# of retries> pairs. For example, retry="60 10 300 3" lets the consumer
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
retry every 60 seconds for the first 10 times and then retry every 300 seconds
for the next three times before stop retrying. + in <#  of retries> means
indefinite number of retries until success.

The schema checking can be enforced at the LDAP Sync consumer site
by turning on the {{EX:schemachecking}} parameter.
If it is turned on, every replicated entry will be checked for its
schema as the entry is stored into the replica content.
Every entry in the replica should contain those attributes
required by the schema definition.
If it is turned off, entries will be stored without checking
schema conformance. The default is off.

The {{EX:binddn}} parameter gives the DN to bind as for the
syncrepl searches to the provider slapd. It should be a DN
which has read access to the replication content in the
master database. 

The {{EX:bindmethod}} is {{EX:simple}} or {{EX:sasl}},
depending on whether simple password-based authentication or
{{TERM:SASL}} authentication is to be used when connecting
Kurt Zeilenga's avatar
Kurt Zeilenga committed
615
to the provider {{slapd}} instance.
616
617
618

Simple authentication should not be used unless adequate data
integrity and confidentiality protections are in place (e.g. TLS
Kurt Zeilenga's avatar
Kurt Zeilenga committed
619
or IPsec). Simple authentication requires specification of {{EX:binddn}}
620
621
622
623
624
625
626
627
628
629
630
631
632
and {{EX:credentials}} parameters.

SASL authentication is generally recommended.  SASL authentication
requires specification of a mechanism using the {{EX:saslmech}} parameter.
Depending on the mechanism, an authentication identity and/or
credentials can be specified using {{EX:authcid}} and {{EX:credentials}},
respectively.  The {{EX:authzid}} parameter may be used to specify
an authorization identity.

The {{EX:realm}} parameter specifies a realm which a certain
mechanisms authenticate the identity within. The {{EX:secprops}}
parameter specifies Cyrus SASL security properties.

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
633
The {{EX:starttls}} parameter specifies use of the StartTLS extended
Kurt Zeilenga's avatar
Kurt Zeilenga committed
634
operation to establish a TLS session before authenticating to the provider.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
635
If the {{EX:critical}} argument is supplied, the session will be aborted
Kurt Zeilenga's avatar
Kurt Zeilenga committed
636
if the StartTLS request fails.  Otherwise the syncrepl session continues
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
637
without TLS.  Note that the main slapd TLS settings are not used by the
Kurt Zeilenga's avatar
Kurt Zeilenga committed
638
639
640
syncrepl engine; by default the TLS parameters from a {{ldap.conf}}(5)
configuration file will be used.  TLS settings may be specified here,
in which case any {{ldap.conf}}(5) settings will be completely ignored.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
641

Kurt Zeilenga's avatar
Kurt Zeilenga committed
642
643
644
Rather than replicating whole entries, the consumer can query logs
of data modifications.  This mode of operation is referred to as
{{delta syncrepl}}.  In addition to the above parameters, the
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
645
{{EX:logbase}} and {{EX:logfilter}} parameters must be set appropriately
Kurt Zeilenga's avatar
Kurt Zeilenga committed
646
647
648
649
650
651
652
653
654
655
656
657
for the log that will be used. The {{EX:syncdata}} parameter must
be set to either {{EX:"accesslog"}} if the log conforms to the
{{slapo-accesslog}}(5) log format, or {{EX:"changelog"}} if the log
conforms to the obsolete {{changelog}} format. If the {{EX:syncdata}}
parameter is omitted or set to {{EX:"default"}} then the log
parameters are ignored.

The {{syncrepl}} replication mechanism is supported by the {{bdb}} and
{{hdb}} backends.

See the {{SECT:LDAP Sync Replication}} chapter of this guide for
more information on how to use this directive.
658
659


Howard Chu's avatar
Howard Chu committed
660
661
662
663
664
665
666
667
668
669
670
671
672
H4: olcTimeLimit: <integer>

This directive specifies the maximum number of seconds (in real
time) slapd will spend answering a search request. If a
request is not finished in this time, a result indicating an
exceeded timelimit will be returned.

\Default:

>	olcTimeLimit: 3600


H4: olcUpdateref: <URL>
673
674
675
676
677
678
679
680

This directive is only applicable in a slave slapd. It
specifies the URL to return to clients which submit update
requests upon the replica.
If specified multiple times, each {{TERM:URL}} is provided.

\Example:

Howard Chu's avatar
Howard Chu committed
681
>	olcUpdateref:	ldap://master.example.net
682
683


Howard Chu's avatar
Howard Chu committed
684
H4: Sample Entries
Howard Chu's avatar
Howard Chu committed
685
686
687

>dn: olcDatabase=frontend,cn=config
>objectClass: olcDatabaseConfig
Howard Chu's avatar
Howard Chu committed
688
>objectClass: olcFrontendConfig
Howard Chu's avatar
Howard Chu committed
689
690
>olcDatabase: frontend
>olcReadOnly: FALSE
Howard Chu's avatar
Howard Chu committed
691
692
693
694
695
696
>
>dn: olcDatabase=config,cn=config
>objectClass: olcDatabaseConfig
>olcDatabase: config
>olcRootDN: cn=Manager,dc=example,dc=com

Howard Chu's avatar
Howard Chu committed
697

Howard Chu's avatar
Howard Chu committed
698
H3: BDB and HDB Database Directives
699

Howard Chu's avatar
Howard Chu committed
700
701
Directives in this category apply to both the {{TERM:BDB}}
and the {{TERM:HDB}} database.
Howard Chu's avatar
Howard Chu committed
702
They are used in an olcDatabase entry in addition to the generic
703
database directives defined above.  For a complete reference
704
705
706
707
of BDB/HDB configuration directives, see {{slapd-bdb}}(5). In
addition to the {{EX:olcDatabaseConfig}} objectClass, BDB and HDB
database entries must have the {{EX:olcBdbConfig}} and
{{EX:olcHdbConfig}} objectClass, respectively.
708
709


Howard Chu's avatar
Howard Chu committed
710
H4: olcDbDirectory: <directory>
711
712
713
714
715
716

This directive specifies the directory where the BDB files
containing the database and associated indices live.

\Default:

Howard Chu's avatar
Howard Chu committed
717
718
719
>	olcDbDirectory: /usr/local/var/openldap-data


720
H4: olcDbCachesize: <integer>
721

722
723
This directive specifies the size in entries of the in-memory
cache maintained by the BDB backend database instance.
724

725
\Default:
726

727
>	olcDbCachesize: 1000
728
729


730
H4: olcDbCheckpoint: <kbyte> <min>
731

732
733
734
735
This directive specifies how often to checkpoint the BDB transaction log.
A checkpoint operation flushes the database buffers to disk and writes a
checkpoint record in the log.
The checkpoint will occur if either <kbyte> data has been written or
Gavin Henry's avatar
Gavin Henry committed
736
<min> minutes have passed since the last checkpoint. Both arguments default
737
738
739
to zero, in which case they are ignored. When the <min> argument is
non-zero, an internal task will run every <min> minutes to perform the
checkpoint. See the Berkeley DB reference guide for more details.
740

741
\Example:
742

743
>	olcDbCheckpoint: 1024 10
744
745


746
H4: olcDbConfig: <DB_CONFIG setting>
747

748
749
750
751
752
This attribute specifies a configuration directive to be placed in the
{{EX:DB_CONFIG}} file of the database directory. At server startup time, if
no such file exists yet, the {{EX:DB_CONFIG}} file will be created and the
settings in this attribute will be written to it. If the file exists,
its contents will be read and displayed in this attribute. The attribute
Gavin Henry's avatar
Gavin Henry committed
753
is multi-valued, to accommodate multiple configuration directives. No default
754
755
is provided, but it is essential to use proper settings here to get the
best server performance.
756

757
758
759
760
761
762
763
764
Any changes made to this attribute will be written to the {{EX:DB_CONFIG}}
file and will cause the database environment to be reset so the changes
can take immediate effect. If the environment cache is large and has not
been recently checkpointed, this reset operation may take a long time. It
may be advisable to manually perform a single checkpoint using the Berkeley DB
{{db_checkpoint}} utility before using LDAP Modify to change this
attribute.

765
\Example:
766

767
768
769
770
>	olcDbConfig: set_cachesize 0 10485760 0
>	olcDbConfig: set_lg_bsize 2097512
>	olcDbConfig: set_lg_dir /var/tmp/bdb-log
>	olcDbConfig: set_flags DB_LOG_AUTOREMOVE
771

772
773
774
775
776
777
In this example, the BDB cache is set to 10MB, the BDB transaction log
buffer size is set to 2MB, and the transaction log files are to be stored
in the /var/tmp/bdb-log directory. Also a flag is set to tell BDB to
delete transaction log files as soon as their contents have been
checkpointed and they are no longer needed. Without this setting the
transaction log files will continue to accumulate until some other
Howard Chu's avatar
Howard Chu committed
778
cleanup procedure removes them. See the Berkeley DB documentation for the
Gavin Henry's avatar
Gavin Henry committed
779
780
{{EX:db_archive}} command for details. For a complete list of Berkeley DB 
flags please see - {{URL:http://www.oracle.com/technology/documentation/berkeley-db/db/api_c/env_set_flags.html}}
781

782
783
Ideally the BDB cache must be
at least as large as the working set of the database, the log buffer size
Gavin Henry's avatar
Gavin Henry committed
784
should be large enough to accommodate most transactions without overflowing,
785
786
787
and the log directory must be on a separate physical disk from the main
database files. And both the database directory and the log directory
should be separate from disks used for regular system activities such as
Howard Chu's avatar
Howard Chu committed
788
the root, boot, or swap filesystems. See the FAQ-o-Matic and the Berkeley DB
789
documentation for more details.
790
791


792
H4: olcDbNosync: { TRUE | FALSE }
793
794

This option causes on-disk database contents to not be immediately
795
synchronized with in memory changes upon change.  Setting this option
796
to {{EX:TRUE}} may improve performance at the expense of data integrity. This
797
798
directive has the same effect as using
>	olcDbConfig: set_flags DB_TXN_NOSYNC
799
800


801
H4: olcDbIDLcacheSize: <integer>
802

803
804
805
806
807
Specify the size of the in-memory index cache, in index slots. The
default is zero. A larger value will speed up frequent searches of
indexed entries. The optimal size will depend on the data and search
characteristics of the database, but using a number three times
the entry cache size is a good starting point.
808

809
\Example:
810

811
>	olcDbIDLcacheSize: 3000
812
813


814
H4: olcDbIndex: {<attrlist> | default} [pres,eq,approx,sub,none]
815
816
817

This directive specifies the indices to maintain for the given
attribute. If only an {{EX:<attrlist>}} is given, the default
Howard Chu's avatar
Howard Chu committed
818
819
indices are maintained. The index keywords correspond to the
common types of matches that may be used in an LDAP search filter.
820
821
822

\Example:

823
824
825
826
>	olcDbIndex: default pres,eq
>	olcDbIndex: uid
>	olcDbIndex: cn,sn pres,eq,sub
>	olcDbIndex: objectClass eq
827
828
829
830
831
832
833
834
835

The first line sets the default set of indices to maintain to
present and equality.  The second line causes the default (pres,eq)
set of indices to be maintained for the {{EX:uid}} attribute type.
The third line causes present, equality, and substring indices to
be maintained for {{EX:cn}} and {{EX:sn}} attribute types.  The
fourth line causes an equality index for the {{EX:objectClass}}
attribute type.

Howard Chu's avatar
Howard Chu committed
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
There is no index keyword for inequality matches. Generally these
matches do not use an index. However, some attributes do support
indexing for inequality matches, based on the equality index.

A substring index can be more explicitly specified as {{EX:subinitial}},
{{EX:subany}}, or {{EX:subfinal}}, corresponding to the three 
possible components
of a substring match filter. A subinitial index only indexes
substrings that appear at the beginning of an attribute value.
A subfinal index only indexes substrings that appear at the end
of an attribute value, while subany indexes substrings that occur
anywhere in a value.

Note that by default, setting an index for an attribute also
affects every subtype of that attribute. E.g., setting an equality
index on the {{EX:name}} attribute causes {{EX:cn}}, {{EX:sn}}, and every other
attribute that inherits from {{EX:name}} to be indexed.

854
855
856
By default, no indices are maintained.  It is generally advised
that minimally an equality index upon objectClass be maintained.

857
858
>	olcDbindex: objectClass eq

Howard Chu's avatar
Howard Chu committed
859
860
861
862
863
864
865
866
Additional indices should be configured corresponding to the
most common searches that are used on the database.
Presence indexing should not be configured for an attribute
unless the attribute occurs very rarely in the database, and
presence searches on the attribute occur very frequently during
normal use of the directory. Most applications don't use presence
searches, so usually presence indexing is not very useful.

867
868
869
870
871
872
If this setting is changed while slapd is running, an internal task
will be run to generate the changed index data. All server operations
can continue as normal while the indexer does its work.  If slapd is
stopped before the index task completes, indexing will have to be
manually completed using the slapindex tool.

873

874
H4: olcDbLinearIndex: { TRUE | FALSE }
875

876
877
878
879
880
881
882
883
884
885
If this setting is {{EX:TRUE}} slapindex will index one attribute
at a time. The default settings is {{EX:FALSE}} in which case all
indexed attributes of an entry are processed at the same time. When
enabled, each indexed attribute is processed individually, using
multiple passes through the entire database. This option improves
slapindex performance when the database size exceeds the BDB cache
size. When the BDB cache is large enough, this option is not needed
and will decrease performance. Also by default, slapadd performs
full indexing and so a separate slapindex run is not needed. With
this option, slapadd does no indexing and slapindex must be used.
886

887
888

H4: olcDbMode: <integer>
889
890
891
892
893
894

This directive specifies the file protection mode that newly
created database index files should have.

\Default:

895
896
>	olcDbMode: 0600

897

898
899
900
H4: olcDbSearchStack: <integer>

Specify the depth of the stack used for search filter evaluation.
Gavin Henry's avatar
Gavin Henry committed
901
Search filters are evaluated on a stack to accommodate nested {{EX:AND}} /
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
{{EX:OR}} clauses. An individual stack is allocated for each server thread.
The depth of the stack determines how complex a filter can be evaluated
without requiring any additional memory allocation. Filters that are
nested deeper than the search stack depth will cause a separate stack to
be allocated for that particular search operation. These separate allocations
can have a major negative impact on server performance, but specifying
too much stack will also consume a great deal of memory. Each search
uses 512K bytes per level on a 32-bit machine, or 1024K bytes per level
on a 64-bit machine. The default stack depth is 16, thus 8MB or 16MB
per thread is used on 32 and 64 bit machines, respectively. Also the
512KB size of a single stack slot is set by a compile-time constant which
may be changed if needed; the code must be recompiled for the change
to take effect.

\Default:

>	olcDbSearchStack: 16


H4: olcDbShmKey: <integer>

Specify a key for a shared memory BDB environment. By default the BDB
environment uses memory mapped files. If a non-zero value is specified,
it will be used as the key to identify a shared memory region that will
house the environment.

\Example:

>	olcDbShmKey: 42


H4: Sample Entry

Howard Chu's avatar
Howard Chu committed
935
>dn: olcDatabase=hdb,cn=config
936
>objectClass: olcDatabaseConfig
937
>objectClass: olcHdbConfig
Howard Chu's avatar
Howard Chu committed
938
>olcDatabase: hdb
939
940
941
942
943
944
945
946
947
948
>olcSuffix: "dc=example,dc=com"
>olcDbDirectory: /usr/local/var/openldap-data
>olcDbCacheSize: 1000
>olcDbCheckpoint: 1024 10
>olcDbConfig: set_cachesize 0 10485760 0
>olcDbConfig: set_lg_bsize 2097152
>olcDbConfig: set_lg_dir /var/tmp/bdb-log
>olcDbConfig: set_flags DB_LOG_AUTOREMOVE
>olcDbIDLcacheSize: 3000
>olcDbIndex: objectClass eq