slapd-ldap.5 19.8 KB
Newer Older
1
.TH SLAPD-LDAP 5 "RELEASEDATE" "OpenLDAP LDVERSION"
Kurt Zeilenga's avatar
Kurt Zeilenga committed
2
.\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
3
4
5
6
7
8
9
10
11
12
13
14
15
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
.\" $OpenLDAP$
.SH NAME
slapd-ldap \- LDAP backend to slapd
.SH SYNOPSIS
ETCDIR/slapd.conf
.SH DESCRIPTION
The LDAP backend to
.BR slapd (8)
is not an actual database; instead it acts as a proxy to forward incoming
requests to another LDAP server. While processing requests it will also
chase referrals, so that referrals are fully processed instead of being
returned to the slapd client.
16
17
18
19
20
21
22
23
24

Sessions that explicitly Bind to the back-ldap database always create their
own private connection to the remote LDAP server. Anonymous sessions will
share a single anonymous connection to the remote server. For sessions bound
through other mechanisms, all sessions with the same DN will share the
same connection. This connection pooling strategy can enhance the proxy's
efficiency by reducing the overhead of repeatedly making/breaking multiple
connections.

Pierangelo Masarati's avatar
Pierangelo Masarati committed
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
The ldap database can also act as an information service, i.e. the identity
of locally authenticated clients is asserted to the remote server, possibly
in some modified form.
For this purpose, the proxy binds to the remote server with some 
administrative identity, and, if required, authorizes the asserted identity.
See the 
.IR idassert- *
rules below.
The administrative identity of the proxy, on the remote server, must be 
allowed to authorize by means of appropriate
.B authzTo
rules; see 
.BR slapd.conf (5)
for details.

40
.LP
41
42
43
44
Note: When looping back to the same instance of
.BR slapd (8), 
each connection requires a new thread; as a consequence,
.BR slapd (8)
45
46
must be compiled with thread support, and the \fBthreads\fP parameter 
may need some tuning; in those cases, one may consider using 
47
48
.BR slapd-relay (5)
instead, which performs the relayed operation 
Kurt Zeilenga's avatar
Kurt Zeilenga committed
49
internally and thus reuses the same connection.
50

51
52
53
54
55
56
57
58
59
.SH CONFIGURATION
These
.B slapd.conf
options apply to the LDAP backend database.
That is, they must follow a "database ldap" line and come before any
subsequent "backend" or "database" lines.
Other database options are described in the
.BR slapd.conf (5)
manual page.
60

61
.LP
62
Note: In early versions of back-ldap it was recommended to always set
63
.LP
64
.RS
65
.nf
66
lastmod  off
67
.fi
68
.RE
69
.LP
70
for 
71
72
73
.B ldap
and
.B meta
74
75
76
databases.
This was required because operational attributes related to entry creation 
and modification should not be proxied, as they could be mistakenly written
77
to the target server(s), generating an error.
78
79
The current implementation automatically sets lastmod to \fBoff\fP, 
so its use is redundant and should be omitted.
80

81
82
.TP
.B uri <ldapurl>
83
LDAP server to use.  Multiple URIs can be set in a single
84
85
86
87
.B ldapurl
argument, resulting in the underlying library automatically 
call the first server of the list that responds, e.g. 

88
\fBuri "ldap://host/ ldap://backup-host/"\fP
89
90

The URI list is space- or comma-separated.
91
92
93
94
Whenever the server that responds is not the first one in the list,
the list is rearranged and the responsive server is moved to the head,
so that it will be first contacted the next time a connection
needs be created.
95
96
.HP
.hy 0
97
.B acl-bind
98
99
100
.B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
.B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
.B [authcId=<authentication ID>] [authzId=<authorization ID>]
Howard Chu's avatar
Howard Chu committed
101
102
103
104
105
106
107
.B [tls_cert=<file>]
.B [tls_key=<file>]
.B [tls_cacert=<file>]
.B [tls_cacertdir=<path>]
.B [tls_reqcert=never|allow|try|demand]
.B [tls_ciphersuite=<ciphers>]
.B [tls_crlcheck=none|peer|all]
108
109
.RS
Allows to define the parameters of the authentication method that is 
110
111
112
internally used by the proxy to collect info related to access control,
and whenever an operation occurs with the identity of the rootdn
of the LDAP proxy database.
113
The identity defined by this directive, according to the properties
114
115
associated to the authentication method, is supposed to have read access 
on the target server to attributes used on the proxy for ACL checking.
116

117
118
There is no risk of giving away such values; they are only used to
check permissions.
119
The default is to use
120
121
.BR simple 
bind, with empty \fIbinddn\fP and \fIcredentials\fP,
122
which means that the related operations will be performed anonymously.
123
124
125
126
127
128
If not set, and if \fBidassert-bind\fP is defined, this latter identity
is used instead.  See \fBidassert-bind\fP for details.

The connection between the proxy database and the remote server
associated to this identity is cached regardless of the lifespan
of the client-proxy connection that first established it.
129

130
131
.B This identity is by no means implicitly used by the proxy 
.B when the client connects anonymously.
132
The
133
.B idassert-bind
134
135
feature, instead, in some cases can be crafted to implement that behavior,
which is \fIintrinsically unsafe and should be used with extreme care\fP.
136
This directive obsoletes
137
.BR acl-authcDN ,
138
139
and
.BR acl-passwd .
Howard Chu's avatar
Howard Chu committed
140
141
142
143
144

The TLS settings default to the same as the main slapd TLS settings,
except for
.B tls_reqcert
which defaults to "demand".
145
.RE
146

147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
.TP
.B cancel {ABANDON|ignore|exop[-discover]}
Defines how to handle operation cancellation.
By default,
.B abandon
is invoked, so the operation is abandoned immediately.
If set to
.BR ignore ,
no action is taken and any further response is ignored; this may result
in further response messages to be queued for that connection, so it is
recommended that long lasting connections are timed out either by
.I idle-timeout
or
.IR conn-ttl ,
so that resources eventually get released.
If set to
.BR exop ,
a
.I cancel
operation (RFC 3909) is issued, resulting in the cancellation 
of the current operation; the
.I cancel
operation waits for remote server response, so its use 
may not be recommended.
If set to
.BR exop-discover ,
support of the
.I cancel 
extended operation is detected by reading the remote server's root DSE.

177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
.TP
.B chase-referrals {YES|no}
enable/disable automatic referral chasing, which is delegated to the
underlying libldap, with rebinding eventually performed if the
\fBrebind-as-user\fP directive is used.  The default is to chase referrals.

.TP
.B conn-ttl <time>
This directive causes a cached connection to be dropped an recreated
after a given ttl, regardless of being idle or not.

.TP
.B idassert-authzFrom <authz-regexp>
if defined, selects what
.I local
identities are authorized to exploit the identity assertion feature.
The string
.B <authz-regexp>
follows the rules defined for the
.I authzFrom
attribute.
See 
.BR slapd.conf (5),
section related to
.BR authz-policy ,
for details on the syntax of this field.

204
205
206
207
208
209
210
.HP
.hy 0
.B idassert-bind
.B bindmethod=none|simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
.B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
.B [authcId=<authentication ID>] [authzId=<authorization ID>]
.B [authz={native|proxyauthz}] [mode=<mode>] [flags=<flags>]
Howard Chu's avatar
Howard Chu committed
211
212
213
214
215
216
217
.B [tls_cert=<file>]
.B [tls_key=<file>]
.B [tls_cacert=<file>]
.B [tls_cacertdir=<path>]
.B [tls_reqcert=never|allow|try|demand]
.B [tls_ciphersuite=<ciphers>]
.B [tls_crlcheck=none|peer|all]
218
219
220
221
222
223
224
225
226
.RS
Allows to define the parameters of the authentication method that is 
internally used by the proxy to authorize connections that are 
authenticated by other databases.
The identity defined by this directive, according to the properties
associated to the authentication method, is supposed to have auth access 
on the target server to attributes used on the proxy for authentication
and authorization, and to be allowed to authorize the users.
This requires to have
227
228
.B proxyAuthz
privileges on a wide set of DNs, e.g.
Pierangelo Masarati's avatar
Pierangelo Masarati committed
229
.BR authzTo=dn.subtree:"" ,
230
and the remote server to have
231
.B authz-policy
232
set to
233
.B to
234
or
235
.BR both .
236
See
237
238
239
.BR slapd.conf (5)
for details on these statements and for remarks and drawbacks about
their usage.
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
The supported bindmethods are

\fBnone|simple|sasl\fP

where
.B none
is the default, i.e. no \fIidentity assertion\fP is performed.

The authz parameter is used to instruct the SASL bind to exploit 
.B native 
SASL authorization, if available; since connections are cached,
this should only be used when authorizing with a fixed identity
(e.g. by means of the 
.B authzDN
or
.B authzID
parameters).
Otherwise, the default
.B proxyauthz
259
260
is used, i.e. the proxyAuthz control (Proxied Authorization, RFC 4370)
is added to all operations.
261

262
The supported modes are:
Pierangelo Masarati's avatar
cleanup    
Pierangelo Masarati committed
263

264
\fB<mode> := {legacy|anonymous|none|self}\fP
Pierangelo Masarati's avatar
cleanup    
Pierangelo Masarati committed
265

266
267
268
269
270
271
272
If 
.B <mode>
is not present, and 
.B authzId
is given, the proxy always authorizes that identity.
.B <authorization ID>
can be 
Pierangelo Masarati's avatar
cleanup    
Pierangelo Masarati committed
273

274
\fBu:<user>\fP
275

276
277
278
279
280
281
282
283
284
285
286
\fB[dn:]<DN>\fP

The former is supposed to be expanded by the remote server according 
to the authz rules; see
.BR slapd.conf (5)
for details.
In the latter case, whether or not the 
.B dn:
prefix is present, the string must pass DN validation and normalization.

The default mode is 
287
.BR legacy ,
288
289
290
291
which implies that the proxy will either perform a simple bind as the
.I authcDN
or a SASL bind as the
.I authcID
292
293
and assert the client's identity when it is not anonymous.
Direct binds are always proxied.
294
295
296
297
298
The other modes imply that the proxy will always either perform a simple bind 
as the
.IR authcDN
or a SASL bind as the
.IR authcID ,
299
unless restricted by
Pierangelo Masarati's avatar
Pierangelo Masarati committed
300
.BR idassert-authzFrom
301
302
303
304
rules (see below), in which case the operation will fail;
eventually, it will assert some other identity according to
.BR <mode> .
Other identity assertion modes are
305
306
307
.BR anonymous
and
.BR self ,
308
309
310
311
312
313
314
315
which respectively mean that the 
.I empty 
or the 
.IR client 's 
identity
will be asserted;
.BR none ,
which means that no proxyAuthz control will be used, so the
316
317
318
.I authcDN
or the
.I authcID
319
identity will be asserted.
320
321
322
323
324
325
326
327
For all modes that require the use of the
.I proxyAuthz 
control, on the remote server the proxy identity must have appropriate 
.I authzTo
permissions, or the asserted identities must have appropriate
.I authzFrom 
permissions.  Note, however, that the ID assertion feature is mostly 
useful when the asserted identities do not exist on the remote server.
328

329
330
Flags can be

331
\fBoverride,[non-]prescriptive\fP
332

Pierangelo Masarati's avatar
cleanup    
Pierangelo Masarati committed
333
334
335
336
337
338
339
When the 
.B override
flag is used, identity assertion takes place even when the database
is authorizing for the identity of the client, i.e. after binding
with the provided identity, and thus authenticating it, the proxy
performs the identity assertion using the configured identity and
authentication method.
340

341
342
343
344
345
346
347
348
349
350
351
352
353
354
When the
.B prescriptive
flag is used (the default), operations fail with
\fIinappropriateAuthentication\fP
for those identities whose assertion is not allowed by the
.B idassert-authzFrom
patterns.
If the 
.B non-prescriptive
flag is used, operations are performed anonymously for those identities 
whose assertion is not allowed by the
.B idassert-authzFrom
patterns.

Howard Chu's avatar
Howard Chu committed
355
356
357
358
359
The TLS settings default to the same as the main slapd TLS settings,
except for
.B tls_reqcert
which defaults to "demand".

360
361
362
363
The identity associated to this directive is also used for privileged
operations whenever \fBidassert-bind\fP is defined and \fBacl-bind\fP
is not.  See \fBacl-bind\fP for details.

364
365
366
367
368
369
This directive obsoletes
.BR idassert-authcDN ,
.BR idassert-passwd ,
.BR idassert-mode ,
and
.BR idassert-method .
Pierangelo Masarati's avatar
Pierangelo Masarati committed
370
.RE
371

372
.TP
373
374
375
376
.B idle-timeout <time>
This directive causes a cached connection to be dropped an recreated
after it has been idle for the specified time.

377
378
379
380
381
382
383
384
385
386
.TP
.B network-timeout <time>
Sets the network timeout value after which
.BR poll (2)/ select (2) 
following a 
.BR connect (2) 
returns in case of no activity.
The value is in seconds, and it can be specified as for
.BR idle-timeout .

387
388
389
390
391
392
393
394
.TP
.B protocol\-version {0,2,3}
This directive indicates what protocol version must be used to contact
the remote server.
If set to 0 (the default), the proxy uses the same protocol version 
used by the client, otherwise the requested protocol is used.
The proxy returns \fIunwillingToPerform\fP if an operation that is 
incompatible with the requested protocol is attempted.
Pierangelo Masarati's avatar
cleanup    
Pierangelo Masarati committed
395

Pierangelo Masarati's avatar
Pierangelo Masarati committed
396
.TP
397
.B proxy\-whoami {NO|yes}
398
399
400
401
402
403
Turns on proxying of the WhoAmI extended operation. If this option is
given, back-ldap will replace slapd's original WhoAmI routine with its
own. On slapd sessions that were authenticated by back-ldap, the WhoAmI
request will be forwarded to the remote LDAP server. Other sessions will
be handled by the local slapd, as before. This option is mainly useful
in conjunction with Proxy Authorization.
404

405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
.TP
.B quarantine <interval>,<num>[;<interval>,<num>[...]]
Turns on quarantine of URIs that returned
.IR LDAP_UNAVAILABLE ,
so that an attempt to reconnect only occurs at given intervals instead
of any time a client requests an operation.
The pattern is: retry only after at least
.I interval
seconds elapsed since last attempt, for exactly
.I num
times; then use the next pattern.
If
.I num
for the last pattern is "\fB+\fP", it retries forever; otherwise, 
no more retries occur.
The process can be restarted by resetting the \fIolcDbQuarantine\fP
attribute of the database entry in the configuration backend.

423
.TP
424
.B rebind-as-user {NO|yes}
425
If this option is given, the client's bind credentials are remembered
426
427
428
429
430
for rebinds, when trying to re-establish a broken connection,
or when chasing a referral, if 
.B chase-referrals
is set to
.IR yes .
431

432
433
434
435
.TP
.B single\-conn {NO|yes}
Discards current cached connection when the client rebinds.

436
437
438
439
440
441
.TP
.B t-f-support {NO|yes|discover}
enable if the remote server supports absolute filters
(see \fIdraft-zeilenga-ldap-t-f\fP for details).
If set to
.BR discover ,
Hallvard Furuseth's avatar
Hallvard Furuseth committed
442
support is detected by reading the remote server's root DSE.
443

444
.TP
445
.B timeout [<op>=]<val> [...]
446
This directive allows to set per-operation timeouts.
447
448
449
450
451
452
453
Operations can be

\fB<op> ::= bind, add, delete, modrdn, modify, compare\fP

The \fBsearch\fP operation is already controlled either
by the \fBtimelimit\fP parameter or by server-side enforced
time limits (see \fBtimelimit\fP and \fBlimits\fP in
454
.BR slapd.conf (5)
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
for details).
Timeout is meaningless for the remaining operations,
\fBunbind\fP and \fBabandon\fP, which do not imply any response,
while it is not yet implemented in currently supported \fBextended\fP 
operations.
If no operation is specified, the timeout \fBval\fP affects all
supported operations.

Note: if the timelimit is exceeded, the operation is cancelled
(according to the \fBcancel\fP directive);
the protocol does not provide any means to rollback operations,
so the client will not be notified about the result of the operation,
which may eventually succeeded or not.
In case the timeout is exceeded during a bind operation, the connection
is destroyed, according to RFC4511.

Note: in some cases, this backend may issue binds prior
to other operations (e.g. to bind anonymously or with some prescribed
identity according to the \fBidassert-bind\fP directive).
In this case, the timeout of the operation that resulted in the bind
is used.
476

Howard Chu's avatar
Howard Chu committed
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
.HP
.hy 0
.B tls {[try-]start|[try-]propagate|ldaps}
.B [tls_cert=<file>]
.B [tls_key=<file>]
.B [tls_cacert=<file>]
.B [tls_cacertdir=<path>]
.B [tls_reqcert=never|allow|try|demand]
.B [tls_ciphersuite=<ciphers>]
.B [tls_crlcheck=none|peer|all]
.RS
Specify the use of TLS when a regular connection is initialized. The
StartTLS extended operation will be used unless the URI directive protocol
scheme is \fBldaps://\fP. In that case this keyword may only be
set to "ldaps" and the StartTLS operation will not be used.
492
493
494
\fBpropagate\fP issues the StartTLS operation only if the original
connection did.
The \fBtry-\fP prefix instructs the proxy to continue operations
495
if the StartTLS operation failed; its use is \fBnot\fP recommended.
496

Howard Chu's avatar
Howard Chu committed
497
498
499
500
501
The TLS settings default to the same as the main slapd TLS settings,
except for
.B tls_reqcert
which defaults to "demand".

502
503
504
505
506
507
508
.TP
.B use-temporary-conn {NO|yes}
when set to 
.BR yes ,
create a temporary connection whenever competing with other threads
for a shared one; otherwise, wait until the shared connection is available.

509
.SH BACKWARD COMPATIBILITY
510
511
512
The LDAP backend has been heavily reworked between releases 2.2 and 2.3,
and subsequently between 2.3 and 2.4.
As a side-effect, some of the traditional directives have been
513
514
deprecated and should be no longer used, as they might disappear
in future releases.
515
516
517

.TP
.B acl-authcDN "<administrative DN for access control purposes>"
518
519
520
521
Formerly known as the
.BR binddn ,
it is the DN that is used to query the target server for acl checking;
it is supposed to have read access on the target server to attributes used
522
523
524
on the proxy for acl checking.
There is no risk of giving away such values; they are only used to
check permissions.
525

526
527
.B The acl-authcDN identity is by no means implicitly used by the proxy 
.B when the client connects anonymously.
528
The
529
.B idassert-*
530
531
feature can be used (at own risk) for that purpose instead.

532
533
534
535
536
This directive is obsoleted by the
.B binddn
arg of
.B acl-bind
when \fIbindmethod\fP=\fBsimple\fP, and will be dismissed in the future.
537
538
539

.TP
.B acl-passwd <password>
540
541
542
Formerly known as the
.BR bindpw ,
it is the password used with the above
543
544
545
.B acl-authcDN
directive.
This directive is obsoleted by the
546
.B credentials
547
548
549
arg of
.B acl-bind
when \fIbindmethod\fP=\fBsimple\fP, and will be dismissed in the future.
550
551
552
553
554

.TP
.B idassert-authcDN "<administrative DN for proxyAuthz purposes>"
DN which is used to propagate the client's identity to the target
by means of the proxyAuthz control when the client does not
Hallvard Furuseth's avatar
Hallvard Furuseth committed
555
belong to the DIT fragment that is being proxied by back-ldap.
556
557
558
559
560
This directive is obsoleted by the
.B binddn
arg of
.BR idassert-bind
when \fIbindmethod\fP=\fBsimple\fP, and will be dismissed in the future.
561
562
563
564
565
566

.TP
.B idassert-passwd <password>
Password used with the
.B idassert-authcDN
above.
567
568
This directive is obsoleted by the
.B crendentials
569
arg of
570
571
.B idassert-bind
when \fIbindmethod\fP=\fBsimple\fP, and will be dismissed in the future.
572
573
574
575
576
577

.TP
.B idassert-mode <mode> [<flags>]
defines what type of
.I identity assertion
is used.
578
579
580
This directive is obsoleted by the
.B mode
arg of 
581
.BR idassert-bind ,
582
and will be dismissed in the future.
583
584
585

.TP
.B idassert-method <method> [<saslargs>]
586
587
588
This directive is obsoleted by the
.B bindmethod
arg of
589
.BR idassert-bind ,
590
and will be dismissed in the future.
591

592
593
594
595
596
597
.TP
.B port <port>
this directive is no longer supported.  Use the 
.B uri
directive as described above.

598
599
600
601
602
603
.TP
.B server <hostname[:port]>
this directive is no longer supported.  Use the 
.B uri
directive as described above.

604
.TP
Pierangelo Masarati's avatar
cleanup    
Pierangelo Masarati committed
605
606
607
608
.B suffixmassage, map, rewrite*
These directives are no longer supported by back-ldap; their 
functionality is now delegated to the
.B rwm
609
610
611
612
613
614
615
616
overlay.  Essentially, add a statement

.B overlay rwm

first, and prefix all rewrite/map statements with
.B rwm-
to obtain the original behavior.
See
Pierangelo Masarati's avatar
cleanup    
Pierangelo Masarati committed
617
618
.BR slapo-rwm (5)
for details.
619
620
621
622
623
.\" However, to ease update from existing configurations, back-ldap still 
.\" recognizes them and automatically instantiates the
.\" .B rwm
.\" overlay if available and not instantiated yet.
.\" This behavior may change in the future.
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639

.SH ACCESS CONTROL
The
.B ldap
backend does not honor all ACL semantics as described in
.BR slapd.access (5).
In general, access checking is delegated to the remote server(s).
Only
.B read (=r)
access to the
.B entry
pseudo-attribute and to the other attribute values of the entries
returned by the
.B search
operation is honored, which is performed by the frontend.

640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
.SH OVERLAYS
The LDAP backend provides basic proxying functionalities to many overlays.
The 
.B chain
overlay, described in
.BR slapo\-chain (5),
and the
.B translucent
overlay, described in
.BR slapo\-translucent (5),
deserve a special mention.

Conversely, there are many overlays that are best used in conjunction
with the LDAP backend.
The
.B proxycache 
overlay allows caching of LDAP search requests (queries) 
in a local database.
See 
.BR slapo\-pcache (5)
for details.
The
.B rwm
overlay provides DN rewrite and attribute/objectClass mapping
capabilities to the underlying database.
665
See 
666
.BR slapo\-rwm (5)
667
for details.
668

669
.SH FILES
670
.TP
671
ETCDIR/slapd.conf
672
default slapd configuration file
673
674
.SH SEE ALSO
.BR slapd.conf (5),
675
.BR slapd\-meta (5),
676
.BR slapo\-chain (5),
677
.BR slapo\-pcache (5),
Pierangelo Masarati's avatar
cleanup    
Pierangelo Masarati committed
678
.BR slapo\-rwm (5),
679
.BR slapo\-translucent (5),
680
681
.BR slapd (8),
.BR ldap (3).
Howard Chu's avatar
Howard Chu committed
682
683
.SH AUTHOR
Howard Chu, with enhancements by Pierangelo Masarati