slapdconf2.sdf 42.3 KB
Newer Older
1
# $OpenLDAP$
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
2
# Copyright 2005-2020 The OpenLDAP Foundation, All Rights Reserved.
3
4
5
6
7
# COPYING RESTRICTIONS APPLY, see COPYRIGHT.

H1: Configuring slapd

Once the software has been built and installed, you are ready
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
8
9
to configure {{slapd}}(8) for use at your site.

10
11
12
13
14
15
16
OpenLDAP 2.3 and later have transitioned to using a dynamic runtime
configuration engine, {{slapd-config}}(5).  {{slapd-config}}(5)
* is fully LDAP-enabled
* is managed using the standard LDAP operations
* stores its configuration data in an {{TERM:LDIF}} database, generally
in the {{F:/usr/local/etc/openldap/slapd.d}} directory.
* allows all of slapd's configuration options to be changed on the fly,
17
generally without requiring a server restart for the changes
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
18
19
to take effect.

20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
This chapter describes the general format of the {{slapd-config}}(5)
configuration system, followed by a detailed description of commonly used
settings.

The older style {{slapd.conf}}(5) file is still supported, but its use
is deprecated and support for it will be withdrawn in a future OpenLDAP
release.  Configuring {{slapd}}(8) via {{slapd.conf}}(5) is described in
the next chapter.

Refer to {{slapd}}(8) for information on how to have slapd automatically
convert from {{slapd.conf}}(5) to {{slapd-config}}(5).


Note: Although the {{slapd-config}}(5) system stores its configuration
as (text-based) LDIF files, you should {{1:never}} edit any of
the LDIF files directly.  Configuration changes should be performed via LDAP
operations, e.g. {{ldapadd}}(1), {{ldapdelete}}(1), or {{ldapmodify}}(1).


Note: You will need to continue to use the older {{slapd.conf}}(5)
configuration system if your OpenLDAP installation requires the use of one
or more backends or overlays that have not been updated to use the
42
43
{{slapd-config}}(5) system.  As of OpenLDAP 2.4.33, all of the official
backends have been updated.  There may be additional contributed or experimental
44
overlays that also have not been updated.
45

46
47
48
49
50
51
52
53
54

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.

55
!import "config_dit.png"; align="center"; title="Sample configuration tree"
56
57
58
59
60
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.

61
The {{slapd-config}} configuration tree has a very specific structure. The
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
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
79
are ignored.  If a line begins with a single space, it is considered a
80
continuation of the previous line (even if the previous line is a
81
comment) and the single leading space is removed. Entries are separated by blank lines.
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

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
106
>	dn: olcBackend=<typeA>,cn=config
107
>	objectClass: olcBackendConfig
Howard Chu's avatar
Howard Chu committed
108
>	olcBackend: <typeA>
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
>	<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
129
130
131
132
133
134
135
136
137
138
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
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
139
separated by whitespace.  If an argument contains whitespace,
140
the argument should be enclosed in double quotes {{EX:"like this"}}.
Howard Chu's avatar
Howard Chu committed
141
142
In the descriptions that follow, arguments that should be replaced
by actual text are shown in brackets {{EX:<>}}.
143
144
145
146
147
148
149
150
151
152
153

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
154
a complete list, see the {{slapd-config}}(5) manual page.  This section
Howard Chu's avatar
Howard Chu committed
155
156
157
158
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.
159
160


Howard Chu's avatar
Howard Chu committed
161
H3: cn=config
162

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


Howard Chu's avatar
Howard Chu committed
168
H4: olcIdleTimeout: <integer>
169
170

Specify the number of seconds to wait before forcibly closing
Howard Chu's avatar
Howard Chu committed
171
an idle client connection.  A value of 0, the default,
172
173
174
disables this feature.


Howard Chu's avatar
Howard Chu committed
175
H4: olcLogLevel: <level>
176
177
178
179
180
181

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
182
183
184
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
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
185
correspond to what kind of debugging, invoke slapd with {{EX:-d?}}
Howard Chu's avatar
Howard Chu committed
186
or consult the table below. The possible values for <level> are:
187
188
189

!block table; colaligns="RL"; align=Center; \
	title="Table 5.1: Debugging Levels"
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
190
191
192
Level	Keyword		Description
-1	any		enable all debugging
0			no debugging
Howard Chu's avatar
Howard Chu committed
193
1	(0x1 trace)	trace function calls
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
194
195
196
197
198
199
200
201
202
203
204
205
206
2	(0x2 packets)	debug packet handling
4	(0x4 args)	heavy trace debugging
8	(0x8 conns)	connection management
16	(0x10 BER)	print out packets sent and received
32	(0x20 filter)	search filter processing
64	(0x40 config)	configuration processing
128	(0x80 ACL)	access control list processing
256	(0x100 stats)	stats log connections/operations/results
512	(0x200 stats2)	stats log entries sent
1024	(0x400 shell)	print communication with shell backends
2048	(0x800 parse)	print entry parsing debugging
16384	(0x4000 sync)	syncrepl consumer processing
32768	(0x8000 none)	only messages that get logged whatever log level is set
207
208
!endblock

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
209
210
211
212
213
214
215
216
217
218
219
220
221
The desired log level can be input as a single integer that
combines the (ORed) desired levels, both in decimal or in hexadecimal 
notation, as a list of integers (that are ORed internally), or as a list of the names that are shown between brackets, such that

>		olcLogLevel 129
>		olcLogLevel 0x81
>		olcLogLevel 128 1
>		olcLogLevel 0x80 0x1
>		olcLogLevel acl trace

are equivalent.

\Examples:
222

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
223
E: olcLogLevel -1
224
225
226
227

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

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
228
E: olcLogLevel conns filter
229

Howard Chu's avatar
Howard Chu committed
230
Just log the connection and search filter processing.
231

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
232
233
234
235
236
237
E: olcLogLevel none

Log those messages that are logged regardless of the configured loglevel. This
differs from setting the log level to 0, when no logging occurs. At least the
{{EX:None}} level is required to have high priority messages logged.

Howard Chu's avatar
Howard Chu committed
238
\Default:
239

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
240
241
242
243
E: olcLogLevel stats

Basic stats logging is configured by default. However, if no olcLogLevel is
defined, no logging occurs (equivalent to a 0 level).
244
245


Howard Chu's avatar
Howard Chu committed
246
H4: olcReferral <URI>
247
248
249
250
251
252

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
253
>	olcReferral: ldap://root.openldap.org
254
255
256
257
258
259
260
261

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
262
H4: Sample Entry
263

Howard Chu's avatar
Howard Chu committed
264
265
266
267
268
269
>dn: cn=config
>objectClass: olcGlobal
>cn: config
>olcIdleTimeout: 30
>olcLogLevel: Stats
>olcReferral: ldap://root.openldap.org
270
271


272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
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
308
H3: cn=schema
309

Howard Chu's avatar
Howard Chu committed
310
311
312
313
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
314
315
in underneath. Schema entries must have the {{EX:olcSchemaConfig}}
objectClass.
316

Howard Chu's avatar
Howard Chu committed
317

Kurt Zeilenga's avatar
Kurt Zeilenga committed
318
H4: olcAttributeTypes: <{{REF:RFC4512}} Attribute Type Description>
Howard Chu's avatar
Howard Chu committed
319
320
321
322
323
324

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
325
H4: olcObjectClasses: <{{REF:RFC4512}} Object Class Description>
Howard Chu's avatar
Howard Chu committed
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341

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
342
343
344
>  NAME 'testAttr'
>  EQUALITY integerMatch
>  SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 )
Howard Chu's avatar
Howard Chu committed
345
>olcAttributeTypes: ( 1.1.2 NAME 'testTwo' EQUALITY caseIgnoreMatch
346
>  SUBSTR caseIgnoreSubstringsMatch SYNTAX 1.3.6.1.4.1.1466.115.121.1.44 )
Howard Chu's avatar
Howard Chu committed
347
>olcObjectClasses: ( 1.1.3 NAME 'testObject'
348
>  MAY ( testAttr $ testTwo ) AUXILIARY )
Howard Chu's avatar
Howard Chu committed
349
350
351
352
353


H3: Backend-specific Directives

Backend directives apply to all database instances of the
354
same type and, depending on the directive, may be overridden
355
356
by database directives. Backend entries must have the
{{EX:olcBackendConfig}} objectClass.
357

Howard Chu's avatar
Howard Chu committed
358
H4: olcBackend: <type>
359

Howard Chu's avatar
Howard Chu committed
360
This directive names a backend-specific configuration entry.
361
362
363
364
365
366
{{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
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
367
bdb	Berkeley DB transactional backend (deprecated)
Howard Chu's avatar
Howard Chu committed
368
config	Slapd configuration backend
369
dnssrv	DNS SRV backend
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
370
hdb	Hierarchical variant of bdb backend (deprecated)
371
ldap	Lightweight Directory Access Protocol (Proxy) backend
Howard Chu's avatar
Howard Chu committed
372
ldif	Lightweight Data Interchange Format backend
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
373
mdb	Memory-Mapped DB backend
374
375
376
377
378
379
380
381
382
383
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
384
>	olcBackend: bdb
385

Howard Chu's avatar
Howard Chu committed
386
387
388
389
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
390
391
392
393
394
395
396


H4: Sample Entry

> dn: olcBackend=bdb,cn=config
> objectClass: olcBackendConfig
> olcBackend: bdb
397
398


Howard Chu's avatar
Howard Chu committed
399
H3: Database-specific Directives
400

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

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

Howard Chu's avatar
Howard Chu committed
406
407
408
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.
409
{{EX:<type>}} should be one of the
Howard Chu's avatar
Howard Chu committed
410
411
412
413
414
415
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.
416

Howard Chu's avatar
Howard Chu committed
417
418
419
420
421
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.

422
423
\Example:

Howard Chu's avatar
Howard Chu committed
424
425
426
>	olcDatabase: bdb

This marks the beginning of a new {{TERM:BDB}} database instance.
427
428


429
H4: olcAccess: to <what> [ by <who> [<accesslevel>] [<control>] ]+
430

Howard Chu's avatar
Howard Chu committed
431
432
This directive grants access (specified by <accesslevel>) to a
set of entries and/or attributes (specified by <what>) by one or
433
more requestors (specified by <who>).
434
See the {{SECT:Access Control}} section of this guide for basic usage.
Howard Chu's avatar
Howard Chu committed
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449

!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 }
450
451
452

This directive puts the database into "read-only" mode. Any
attempts to modify the database will return an "unwilling to
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
453
454
perform" error.  If set on a consumer, modifications sent by
syncrepl will still occur.
455
456
457

\Default:

Howard Chu's avatar
Howard Chu committed
458
459
>	olcReadonly: FALSE

460

Howard Chu's avatar
Howard Chu committed
461
H4: olcRootDN: <DN>
462
463
464
465
466
467
468
469
470

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:

471
>	olcRootDN: cn=Manager,dc=example,dc=com
472
473
474

SASL-based Example:

475
>	olcRootDN: uid=root,cn=example.com,cn=digest-md5,cn=auth
476
477
478
479
480

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


Howard Chu's avatar
Howard Chu committed
481
H4: olcRootPW: <password>
482

Howard Chu's avatar
Howard Chu committed
483
This directive can be used to specify a password for the DN for
484
485
486
487
the rootdn (when the rootdn is set to a DN within the database).

\Example:

Howard Chu's avatar
Howard Chu committed
488
>	olcRootPW: secret
489

Kurt Zeilenga's avatar
Kurt Zeilenga committed
490
491
492
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.
493
494
495

\Example:

Howard Chu's avatar
Howard Chu committed
496
>	olcRootPW: {SSHA}ZKKuqbEKJfKSXhUbHG3fG8MDn9j1v4QN
497
498
499
500

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


Howard Chu's avatar
Howard Chu committed
501
502
503
504
505
506
507
508
509
H4: olcSizeLimit: <integer>

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

\Default:

>	olcSizeLimit: 500

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
510
511
See the {{SECT:Limits}} section of this guide and slapd-config(5)
for more details.
Howard Chu's avatar
Howard Chu committed
512
513
514


H4: olcSuffix: <dn suffix>
515
516
517

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
518
519
520
521
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.)
522
523
524

\Example:

525
>	olcSuffix: dc=example,dc=com
526
527
528
529
530

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
531
532
533
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.
534
535


Howard Chu's avatar
Howard Chu committed
536
H4: olcSyncrepl
537

Howard Chu's avatar
Howard Chu committed
538
>	olcSyncrepl: rid=<replica ID>
539
540
541
542
>		provider=ldap[s]://<hostname>[:port]
>		[type=refreshOnly|refreshAndPersist]
>		[interval=dd:hh:mm:ss]
>		[retry=[<retry interval> <# of retries>]+]
543
>		searchbase=<base DN>
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
>		[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
559
560
561
562
563
564
>		[starttls=yes|critical]
>		[tls_cert=<file>]
>		[tls_key=<file>]
>		[tls_cacert=<file>]
>		[tls_cacertdir=<path>]
>		[tls_reqcert=never|allow|try|demand]
565
>		[tls_cipher_suite=<ciphers>]
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
566
567
568
569
>		[tls_crlcheck=none|peer|all]
>		[logbase=<base DN>]
>		[logfilter=<filter str>]
>		[syncdata=default|accesslog|changelog]
570
571


572
573
This directive specifies the current database as a consumer of the
provider content by establishing the current {{slapd}}(8) as a
574
replication consumer site running a syncrepl replication engine.
575
576
577
The provider database is located at the provider site
specified by the {{EX:provider}} parameter. The consumer database is
kept up-to-date with the provider content using the LDAP Content
Howard Chu's avatar
Howard Chu committed
578
579
Synchronization protocol. See {{REF:RFC4533}}
for more information on the protocol.
580
581
582
583
584
585
586
587

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
588
containing the provider content as an LDAP URI. The {{EX:provider}}
589
590
591
592
593
594
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
595
specification is located on the consumer.
596

597
The content of the syncrepl consumer is defined using a search
598
599
600
601
602
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
603
604
605
606
607
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}}
608
609
and {{EX:timelimit}} default to "unlimited", and only positive integers
or "unlimited" may be specified.
610

Kurt Zeilenga's avatar
Kurt Zeilenga committed
611
The {{TERM[expand]LDAP Sync}} protocol has two operation
612
613
614
615
616
617
618
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
619
remains persistent in the provider {{slapd}} instance. Further updates to the
620
provider will generate {{EX:searchResultEntry}} to the consumer slapd
621
622
623
624
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>
625
and <# of retries> pairs. For example, retry="60 10 300 3" lets the consumer
626
627
628
629
630
631
632
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
633
634
schema as the entry is stored on the consumer.
Every entry in the consumer should contain those attributes
635
636
637
638
639
640
641
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
642
provider database. 
643
644
645
646

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
647
to the provider {{slapd}} instance.
648
649
650

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
651
or IPsec). Simple authentication requires specification of {{EX:binddn}}
652
653
654
655
656
657
658
659
660
661
662
663
664
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
665
The {{EX:starttls}} parameter specifies use of the StartTLS extended
Kurt Zeilenga's avatar
Kurt Zeilenga committed
666
operation to establish a TLS session before authenticating to the provider.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
667
If the {{EX:critical}} argument is supplied, the session will be aborted
Kurt Zeilenga's avatar
Kurt Zeilenga committed
668
if the StartTLS request fails.  Otherwise the syncrepl session continues
669
670
without TLS.  The tls_reqcert setting defaults to {{EX:"demand"}} and the
other TLS settings default to the same as the main slapd TLS settings.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
671

Kurt Zeilenga's avatar
Kurt Zeilenga committed
672
673
674
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
675
{{EX:logbase}} and {{EX:logfilter}} parameters must be set appropriately
Kurt Zeilenga's avatar
Kurt Zeilenga committed
676
677
678
679
680
681
682
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.

683
684
The {{syncrepl}} replication mechanism is supported by the {{bdb}},
{{hdb}}, and {{mdb}} backends.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
685
686
687

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


Howard Chu's avatar
Howard Chu committed
690
691
692
693
694
695
696
697
698
699
700
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

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
701
702
703
See the {{SECT:Limits}} section of this guide and slapd-config(5)
for more details.

Howard Chu's avatar
Howard Chu committed
704
705

H4: olcUpdateref: <URL>
706

707
708
This directive is only applicable in a {{replica}} (or {{shadow}})
{{slapd}}(8) instance. It
709
710
711
712
713
714
specifies the URL to return to clients which submit update
requests upon the replica.
If specified multiple times, each {{TERM:URL}} is provided.

\Example:

715
>	olcUpdateref:	ldap://provider.example.net
716
717


Howard Chu's avatar
Howard Chu committed
718
H4: Sample Entries
Howard Chu's avatar
Howard Chu committed
719
720
721

>dn: olcDatabase=frontend,cn=config
>objectClass: olcDatabaseConfig
Howard Chu's avatar
Howard Chu committed
722
>objectClass: olcFrontendConfig
Howard Chu's avatar
Howard Chu committed
723
724
>olcDatabase: frontend
>olcReadOnly: FALSE
Howard Chu's avatar
Howard Chu committed
725
726
727
728
729
730
>
>dn: olcDatabase=config,cn=config
>objectClass: olcDatabaseConfig
>olcDatabase: config
>olcRootDN: cn=Manager,dc=example,dc=com

Howard Chu's avatar
Howard Chu committed
731

Howard Chu's avatar
Howard Chu committed
732
H3: BDB and HDB Database Directives
733

Howard Chu's avatar
Howard Chu committed
734
735
Directives in this category apply to both the {{TERM:BDB}}
and the {{TERM:HDB}} database.
Howard Chu's avatar
Howard Chu committed
736
They are used in an olcDatabase entry in addition to the generic
737
database directives defined above.  For a complete reference
738
739
740
741
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.
742
743


Howard Chu's avatar
Howard Chu committed
744
H4: olcDbDirectory: <directory>
745
746
747
748
749
750

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

\Default:

Howard Chu's avatar
Howard Chu committed
751
752
753
>	olcDbDirectory: /usr/local/var/openldap-data


754
H4: olcDbCachesize: <integer>
755

756
757
This directive specifies the size in entries of the in-memory
cache maintained by the BDB backend database instance.
758

759
\Default:
760

761
>	olcDbCachesize: 1000
762
763


764
H4: olcDbCheckpoint: <kbyte> <min>
765

766
767
768
769
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
770
<min> minutes have passed since the last checkpoint. Both arguments default
771
772
773
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.
774

775
\Example:
776

777
>	olcDbCheckpoint: 1024 10
778
779


780
H4: olcDbConfig: <DB_CONFIG setting>
781

782
783
784
785
786
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
787
is multi-valued, to accommodate multiple configuration directives. No default
788
789
is provided, but it is essential to use proper settings here to get the
best server performance.
790

791
792
793
794
795
796
797
798
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.

799
\Example:
800

801
802
803
804
>	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
805

806
807
808
809
810
811
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
812
cleanup procedure removes them. See the Berkeley DB documentation for the
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
813
814
{{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}}
815

816
817
Ideally the BDB cache must be
at least as large as the working set of the database, the log buffer size
818
should be large enough to accommodate most transactions without overflowing,
819
820
821
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
822
the root, boot, or swap filesystems. See the FAQ-o-Matic and the Berkeley DB
823
documentation for more details.
824
825


826
H4: olcDbNosync: { TRUE | FALSE }
827
828

This option causes on-disk database contents to not be immediately
829
synchronized with in memory changes upon change.  Setting this option
830
to {{EX:TRUE}} may improve performance at the expense of data integrity. This
831
832
directive has the same effect as using
>	olcDbConfig: set_flags DB_TXN_NOSYNC
833
834


835
H4: olcDbIDLcacheSize: <integer>
836

837
838
839
840
841
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.
842

843
\Example:
844

845
>	olcDbIDLcacheSize: 3000
846
847


848
H4: olcDbIndex: {<attrlist> | default} [pres,eq,approx,sub,none]
849
850
851

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
852
853
indices are maintained. The index keywords correspond to the
common types of matches that may be used in an LDAP search filter.
854
855
856

\Example:

857
858
859
860
>	olcDbIndex: default pres,eq
>	olcDbIndex: uid
>	olcDbIndex: cn,sn pres,eq,sub
>	olcDbIndex: objectClass eq
861
862
863
864
865
866
867
868
869

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
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
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.

888
889
890
By default, no indices are maintained.  It is generally advised
that minimally an equality index upon objectClass be maintained.

891
892
>	olcDbindex: objectClass eq

Howard Chu's avatar
Howard Chu committed
893
894
895
896
897
898
899
900
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.

901
902
903
904
905
906
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.

907

908
H4: olcDbLinearIndex: { TRUE | FALSE }
909

910
911
912
913
914
915
916
917
918
919
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.
920

921

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
922
H4: olcDbMode: { <octal> | <symbolic> }
923
924

This directive specifies the file protection mode that newly
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
925
926
created database index files should have. This can be in the form
{{EX:0600}} or {{EX:-rw-------}}
927
928
929

\Default:

930
931
>	olcDbMode: 0600

932

933
934
935
H4: olcDbSearchStack: <integer>

Specify the depth of the stack used for search filter evaluation.
936
Search filters are evaluated on a stack to accommodate nested {{EX:AND}} /
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
{{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
970
>dn: olcDatabase=hdb,cn=config
971
>objectClass: olcDatabaseConfig
972
>objectClass: olcHdbConfig
Howard Chu's avatar
Howard Chu committed
973
>olcDatabase: hdb
974
>olcSuffix: dc=example,dc=com
975
976
977
978
979
980
981
982
983
>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
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042


H2: Configuration Example

The following is an example configuration, interspersed
with explanatory text. It defines two databases to handle
different parts of the {{TERM:X.500}} tree; both are {{TERM:BDB}}
database instances. The line numbers shown are provided for
reference only and are not included in the actual file. First, the
global configuration section:

E:  1.    # example config file - global configuration entry
E:  2.    dn: cn=config
E:  3.    objectClass: olcGlobal
E:  4.    cn: config
E:  5.    olcReferral: ldap://root.openldap.org
E:  6.    

Line 1 is a comment. Lines 2-4 identify this as the global
configuration entry.
The {{EX:olcReferral:}} directive on line 5
means that queries not local to one of the databases defined
below will be referred to the LDAP server running on the
standard port (389) at the host {{EX:root.openldap.org}}.
Line 6 is a blank line, indicating the end of this entry.

E:  7.    # internal schema
E:  8.    dn: cn=schema,cn=config
E:  9.    objectClass: olcSchemaConfig
E: 10.    cn: schema
E: 11.    

Line 7 is a comment. Lines 8-10 identify this as the root of
the schema subtree. The actual schema definitions in this entry
are hardcoded into slapd so no additional attributes are specified here.
Line 11 is a blank line, indicating the end of this entry.

E: 12.    # include the core schema
E: 13.    include: file:///usr/local/etc/openldap/schema/core.ldif
E: 14.    

Line 12 is a comment. Line 13 is an LDIF include directive which
accesses the {{core}} schema definitions in LDIF format. Line 14
is a blank line.

Next comes the database definitions. The first database is the
special {{EX:frontend}} database whose settings are applied globally
to all the other databases.

E: 15.    # global database parameters
E: 16.    dn: olcDatabase=frontend,cn=config
E: 17.    objectClass: olcDatabaseConfig
E: 18.    olcDatabase: frontend
E: 19.    olcAccess: to * by * read
E: 20.    

Line 15 is a comment. Lines 16-18 identify this entry as the global
database entry. Line 19 is a global access control. It applies to all
entries (after any applicable database-specific access controls).
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
Line 20 is a blank line.

The next entry defines the config backend.

E: 21.    # set a rootpw for the config database so we can bind.
E: 22.    # deny access to everyone else.
E: 23.    dn: olcDatabase=config,cn=config
E: 24.    objectClass: olcDatabaseConfig
E: 25.    olcDatabase: config
E: 26.    olcRootPW: {SSHA}XKYnrjvGT3wZFQrDD5040US592LxsdLy
E: 27.    olcAccess: to * by * none
E: 28.

Lines 21-22 are comments. Lines 23-25 identify this entry as the config
database entry. Line 26 defines the {{super-user}} password for this
database. (The DN defaults to {{"cn=config"}}.) Line 27 denies all access
to this database, so only the super-user will be able to access it. (This
is already the default access on the config database. It is just listed
here for illustration, and to reiterate that unless a means to authenticate
as the super-user is explicitly configured, the config database will be
inaccessible.)

Line 28 is a blank line.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1066
1067
1068
1069
1070
1071

The next entry defines a BDB backend that will handle queries for things
in the "dc=example,dc=com" portion of the tree. Indices are to be maintained
for several attributes, and the {{EX:userPassword}} attribute is to be
protected from unauthorized access.

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1072
1073
1074
1075
1076
E: 29.    # BDB definition for example.com
E: 30.    dn: olcDatabase=bdb,cn=config
E: 31.    objectClass: olcDatabaseConfig
E: 32.    objectClass: olcBdbConfig
E: 33.    olcDatabase: bdb
Howard Chu's avatar
Howard Chu committed
1077
E: 34.    olcSuffix: dc=example,dc=com
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1078
E: 35.    olcDbDirectory: /usr/local/var/openldap-data
Howard Chu's avatar
Howard Chu committed
1079
E: 36.    olcRootDN: cn=Manager,dc=example,dc=com
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1080
1081
E: 37.    olcRootPW: secret
E: 38.    olcDbIndex: uid pres,eq
Howard Chu's avatar
Howard Chu committed
1082
E: 39.    olcDbIndex: cn,sn pres,eq,approx,sub
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
E: 40.    olcDbIndex: objectClass eq
E: 41.    olcAccess: to attrs=userPassword
E: 42.      by self write
E: 43.      by anonymous auth
E: 44.      by dn.base="cn=Admin,dc=example,dc=com" write
E: 45.      by * none
E: 46.    olcAccess: to *
E: 47.      by self write
E: 48.      by dn.base="cn=Admin,dc=example,dc=com" write
E: 49.      by * read
E: 50.    

Line 29 is a comment. Lines 30-33 identify this entry as a BDB database
configuration entry.  Line 34 specifies the DN suffix
for queries to pass to this database. Line 35 specifies the directory
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1098
1099
in which the database files will live.

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1100
Lines 36 and 37 identify the database {{super-user}} entry and associated
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1101
1102
1103
password. This entry is not subject to access control or size or
time limit restrictions.

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1104
Lines 38 through 40 indicate the indices to maintain for various
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1105
1106
attributes.

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1107
Lines 41 through 49 specify access control for entries in this
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1108
1109
1110
1111
1112
1113
database. For all applicable entries, the {{EX:userPassword}} attribute is writable
by the entry itself and by the "admin" entry.  It may be used for
authentication/authorization purposes, but is otherwise not readable.
All other attributes are writable by the entry and the "admin"
entry, but may be read by all users (authenticated or not).

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1114
Line 50 is a blank line, indicating the end of this entry.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1115

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1116
The next entry defines another
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1117
1118
BDB database. This one handles queries involving the
{{EX:dc=example,dc=net}} subtree but is managed by the same entity
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1119
as the first database.  Note that without line 60, the read access
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1120
1121
would be allowed due to the global access rule at line 19.

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1122
1123
1124
1125
1126
E: 51.    # BDB definition for example.net
E: 52.    dn: olcDatabase=bdb,cn=config
E: 53.    objectClass: olcDatabaseConfig
E: 54.    objectClass: olcBdbConfig
E: 55.    olcDatabase: bdb
1127
E: 56.    olcSuffix: dc=example,dc=net
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1128
E: 57.    olcDbDirectory: /usr/local/var/openldap-data-net
1129
E: 58.    olcRootDN: cn=Manager,dc=example,dc=com
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1130
1131
E: 59.    olcDbIndex: objectClass eq
E: 60.    olcAccess: to * by users read
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1132
1133
1134
1135


H2: Converting old style {{slapd.conf}}(5) file to {{cn=config}} format

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
Before converting to the {{cn=config}} format you should make sure that the
config backend is properly configured in your existing config file. While
the config backend is always present inside slapd, by default it is only
accessible by its rootDN, and there are no default credentials assigned
so unless you explicitly configure a means to authenticate to it, it will be
unusable.

If you do not already have a {{EX:database config}} section, add something
like this to the end of {{EX:slapd.conf}}

> database config
> rootpw VerySecret

Note: Since the config backend can be used to load arbitrary code into the
slapd process, it is extremely important to carefully guard whatever
credentials are used to access it. Since simple passwords are vulnerable to
password guessing attacks, it is usually better to omit the rootpw and only
use SASL authentication for the config rootDN.

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1155
1156
1157
1158
1159
An existing {{slapd.conf}}(5) file can be converted to the new format using
{{slaptest}}(8) or any of the slap tools:

>	slaptest -f /usr/local/etc/openldap/slapd.conf -F /usr/local/etc/openldap/slapd.d

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1160
1161
1162
1163
1164
Test that you can access entries under {{EX:cn=config}} using the
default {{rootdn}} and the {{rootpw}} configured above:

>	ldapsearch -x -D cn=config -w VerySecret -b cn=config

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1165
You can then discard the old {{slapd.conf}}(5) file. Make sure to launch
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1166
1167
{{slapd}}(8) with the {{-F}} option to specify the configuration directory
if you are not using the default directory path.
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
1168
1169
1170
1171

Note: When converting from the slapd.conf format to slapd.d format, any
included files will also be integrated into the resulting configuration
database.