1 .TH SLAPD-LDAP 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2012 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd\-ldap \- LDAP backend to slapd
12 is not an actual database; instead it acts as a proxy to forward incoming
13 requests to another LDAP server. While processing requests it will also
14 chase referrals, so that referrals are fully processed instead of being
15 returned to the slapd client.
17 Sessions that explicitly Bind to the back-ldap database always create their
18 own private connection to the remote LDAP server. Anonymous sessions will
19 share a single anonymous connection to the remote server. For sessions bound
20 through other mechanisms, all sessions with the same DN will share the
21 same connection. This connection pooling strategy can enhance the proxy's
22 efficiency by reducing the overhead of repeatedly making/breaking multiple
25 The ldap database can also act as an information service, i.e. the identity
26 of locally authenticated clients is asserted to the remote server, possibly
27 in some modified form.
28 For this purpose, the proxy binds to the remote server with some
29 administrative identity, and, if required, authorizes the asserted identity.
33 The administrative identity of the proxy, on the remote server, must be
34 allowed to authorize by means of appropriate
42 must contain schema information for the attributes and objectClasses
43 used in filters, request DN and request-related data in general.
44 It should also contain schema information for the data returned
45 by the proxied server.
46 It is the responsibility of the proxy administrator to keep the schema
47 of the proxy lined up with that of the proxied server.
50 Note: When looping back to the same instance of
52 each connection requires a new thread; as a consequence,
54 must be compiled with thread support, and the \fBthreads\fP parameter
55 may need some tuning; in those cases, one may consider using
57 instead, which performs the relayed operation
58 internally and thus reuses the same connection.
63 options apply to the LDAP backend database.
64 That is, they must follow a "database ldap" line and come before any
65 subsequent "backend" or "database" lines.
66 Other database options are described in the
71 Note: In early versions of back-ldap it was recommended to always set
84 This was required because operational attributes related to entry creation
85 and modification should not be proxied, as they could be mistakenly written
86 to the target server(s), generating an error.
87 The current implementation automatically sets lastmod to \fBoff\fP,
88 so its use is redundant and should be omitted.
92 LDAP server to use. Multiple URIs can be set in a single
94 argument, resulting in the underlying library automatically
95 call the first server of the list that responds, e.g.
97 \fBuri "ldap://host/ ldap://backup\-host/"\fP
99 The URI list is space- or comma-separated.
100 Whenever the server that responds is not the first one in the list,
101 the list is rearranged and the responsive server is moved to the head,
102 so that it will be first contacted the next time a connection
107 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
108 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
109 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
110 .B [starttls=no|yes|critical]
113 .B [tls_cacert=<file>]
114 .B [tls_cacertdir=<path>]
115 .B [tls_reqcert=never|allow|try|demand]
116 .B [tls_ciphersuite=<ciphers>]
117 .B [tls_protocol_min=<version>]
118 .B [tls_crlcheck=none|peer|all]
120 Allows to define the parameters of the authentication method that is
121 internally used by the proxy to collect info related to access control,
122 and whenever an operation occurs with the identity of the rootdn
123 of the LDAP proxy database.
124 The identity defined by this directive, according to the properties
125 associated to the authentication method, is supposed to have read access
126 on the target server to attributes used on the proxy for ACL checking.
128 There is no risk of giving away such values; they are only used to
130 The default is to use
132 bind, with empty \fIbinddn\fP and \fIcredentials\fP,
133 which means that the related operations will be performed anonymously.
134 If not set, and if \fBidassert\-bind\fP is defined, this latter identity
135 is used instead. See \fBidassert\-bind\fP for details.
137 The connection between the proxy database and the remote server
138 associated to this identity is cached regardless of the lifespan
139 of the client-proxy connection that first established it.
141 .B This identity is by no means implicitly used by the proxy
142 .B when the client connects anonymously.
145 feature, instead, in some cases can be crafted to implement that behavior,
146 which is \fIintrinsically unsafe and should be used with extreme care\fP.
147 This directive obsoletes
152 The TLS settings default to the same as the main slapd TLS settings,
155 which defaults to "demand".
159 .B cancel {ABANDON|ignore|exop[\-discover]}
160 Defines how to handle operation cancellation.
163 is invoked, so the operation is abandoned immediately.
166 no action is taken and any further response is ignored; this may result
167 in further response messages to be queued for that connection, so it is
168 recommended that long lasting connections are timed out either by
172 so that resources eventually get released.
177 operation (RFC 3909) is issued, resulting in the cancellation
178 of the current operation; the
180 operation waits for remote server response, so its use
181 may not be recommended.
186 extended operation is detected by reading the remote server's root DSE.
189 .B chase\-referrals {YES|no}
190 enable/disable automatic referral chasing, which is delegated to the
191 underlying libldap, with rebinding eventually performed if the
192 \fBrebind\-as\-user\fP directive is used. The default is to chase referrals.
196 This directive causes a cached connection to be dropped an recreated
197 after a given ttl, regardless of being idle or not.
200 .B idassert\-authzFrom <authz-regexp>
201 if defined, selects what
203 identities are authorized to exploit the identity assertion feature.
206 follows the rules defined for the
213 for details on the syntax of this field.
218 .B bindmethod=none|simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
219 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
220 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
221 .B [authz={native|proxyauthz}] [mode=<mode>] [flags=<flags>]
222 .B [starttls=no|yes|critical]
225 .B [tls_cacert=<file>]
226 .B [tls_cacertdir=<path>]
227 .B [tls_reqcert=never|allow|try|demand]
228 .B [tls_ciphersuite=<ciphers>]
229 .B [tls_protocol_min=<version>]
230 .B [tls_crlcheck=none|peer|all]
232 Allows to define the parameters of the authentication method that is
233 internally used by the proxy to authorize connections that are
234 authenticated by other databases.
235 The identity defined by this directive, according to the properties
236 associated to the authentication method, is supposed to have auth access
237 on the target server to attributes used on the proxy for authentication
238 and authorization, and to be allowed to authorize the users.
239 This requires to have
241 privileges on a wide set of DNs, e.g.
242 .BR authzTo=dn.subtree:"" ,
243 and the remote server to have
251 for details on these statements and for remarks and drawbacks about
253 The supported bindmethods are
255 \fBnone|simple|sasl\fP
259 is the default, i.e. no \fIidentity assertion\fP is performed.
261 The authz parameter is used to instruct the SASL bind to exploit
263 SASL authorization, if available; since connections are cached,
264 this should only be used when authorizing with a fixed identity
265 (e.g. by means of the
270 Otherwise, the default
272 is used, i.e. the proxyAuthz control (Proxied Authorization, RFC 4370)
273 is added to all operations.
275 The supported modes are:
277 \fB<mode> := {legacy|anonymous|none|self}\fP
283 is given, the proxy always authorizes that identity.
284 .B <authorization ID>
291 The former is supposed to be expanded by the remote server according
292 to the authz rules; see
295 In the latter case, whether or not the
297 prefix is present, the string must pass DN validation and normalization.
301 which implies that the proxy will either perform a simple bind as the
303 or a SASL bind as the
305 and assert the client's identity when it is not anonymous.
306 Direct binds are always proxied.
307 The other modes imply that the proxy will always either perform a simple bind
310 or a SASL bind as the
313 .BR idassert\-authzFrom
314 rules (see below), in which case the operation will fail;
315 eventually, it will assert some other identity according to
317 Other identity assertion modes are
321 which respectively mean that the
328 which means that no proxyAuthz control will be used, so the
332 identity will be asserted.
333 For all modes that require the use of the
335 control, on the remote server the proxy identity must have appropriate
337 permissions, or the asserted identities must have appropriate
339 permissions. Note, however, that the ID assertion feature is mostly
340 useful when the asserted identities do not exist on the remote server.
344 \fBoverride,[non\-]prescriptive,proxy\-authz\-[non\-]critical,dn\-{authzid|whoami}\fP
348 flag is used, identity assertion takes place even when the database
349 is authorizing for the identity of the client, i.e. after binding
350 with the provided identity, and thus authenticating it, the proxy
351 performs the identity assertion using the configured identity and
352 authentication method.
356 flag is used (the default), operations fail with
357 \fIinappropriateAuthentication\fP
358 for those identities whose assertion is not allowed by the
359 .B idassert\-authzFrom
363 flag is used, operations are performed anonymously for those identities
364 whose assertion is not allowed by the
365 .B idassert\-authzFrom
369 .B proxy\-authz\-non\-critical
370 flag is used (the default), the proxyAuthz control is not marked as critical,
371 in violation of RFC 4370. Use of
372 .B proxy\-authz\-critical
377 flag is used, RFC 3829 LDAP Authorization Identity Controls
378 is used to retrieve the identity associated to the SASL identity;
381 flag is used, RFC 4532 LDAP Who am I? Operation is performed
382 after the bind for the same purpose.
384 The TLS settings default to the same as the main slapd TLS settings,
387 which defaults to "demand".
389 The identity associated to this directive is also used for privileged
390 operations whenever \fBidassert\-bind\fP is defined and \fBacl\-bind\fP
391 is not. See \fBacl\-bind\fP for details.
393 This directive obsoletes
394 .BR idassert\-authcDN ,
395 .BR idassert\-passwd ,
398 .BR idassert\-method .
402 .B idassert-passthru <authz-regexp>
403 if defined, selects what
405 identities bypass the identity assertion feature.
406 Those identities need to be known by the remote host.
409 follows the rules defined for the
416 for details on the syntax of this field.
420 .B idle\-timeout <time>
421 This directive causes a cached connection to be dropped an recreated
422 after it has been idle for the specified time.
425 .B network\-timeout <time>
426 Sets the network timeout value after which
427 .BR poll (2)/ select (2)
430 returns in case of no activity.
431 The value is in seconds, and it can be specified as for
438 do not return search reference responses.
439 By default, they are returned unless request is LDAPv2.
442 .B noundeffilter <NO|yes>
445 return success instead of searching if a filter is undefined or contains
447 By default, the search is propagated after replacing undefined portions
449 .BR (!(objectClass=*)) ,
450 which corresponds to the empty result set.
453 .B protocol\-version {0,2,3}
454 This directive indicates what protocol version must be used to contact
456 If set to 0 (the default), the proxy uses the same protocol version
457 used by the client, otherwise the requested protocol is used.
458 The proxy returns \fIunwillingToPerform\fP if an operation that is
459 incompatible with the requested protocol is attempted.
462 .B proxy\-whoami {NO|yes}
463 Turns on proxying of the WhoAmI extended operation. If this option is
464 given, back-ldap will replace slapd's original WhoAmI routine with its
465 own. On slapd sessions that were authenticated by back-ldap, the WhoAmI
466 request will be forwarded to the remote LDAP server. Other sessions will
467 be handled by the local slapd, as before. This option is mainly useful
468 in conjunction with Proxy Authorization.
471 .B quarantine <interval>,<num>[;<interval>,<num>[...]]
472 Turns on quarantine of URIs that returned
473 .IR LDAP_UNAVAILABLE ,
474 so that an attempt to reconnect only occurs at given intervals instead
475 of any time a client requests an operation.
476 The pattern is: retry only after at least
478 seconds elapsed since last attempt, for exactly
480 times; then use the next pattern.
483 for the last pattern is "\fB+\fP", it retries forever; otherwise,
484 no more retries occur.
485 The process can be restarted by resetting the \fIolcDbQuarantine\fP
486 attribute of the database entry in the configuration backend.
489 .B rebind\-as\-user {NO|yes}
490 If this option is given, the client's bind credentials are remembered
491 for rebinds, when trying to re-establish a broken connection,
492 or when chasing a referral, if
498 .B session\-tracking\-request {NO|yes}
499 Adds session tracking control for all requests.
500 The client's IP and hostname, and the identity associated to each request,
501 if known, are sent to the remote server for informational purposes.
502 This directive is incompatible with setting \fIprotocol\-version\fP to 2.
505 .B single\-conn {NO|yes}
506 Discards current cached connection when the client rebinds.
509 .B t\-f\-support {NO|yes|discover}
510 enable if the remote server supports absolute filters
511 (see \fIdraft-zeilenga-ldap-t-f\fP for details).
514 support is detected by reading the remote server's root DSE.
517 .B timeout [<op>=]<val> [...]
518 This directive allows to set per-operation timeouts.
521 \fB<op> ::= bind, add, delete, modrdn, modify, compare, search\fP
523 The overall duration of the \fBsearch\fP operation is controlled either
524 by the \fBtimelimit\fP parameter or by server-side enforced
525 time limits (see \fBtimelimit\fP and \fBlimits\fP in
528 This \fBtimeout\fP parameter controls how long the target can be
529 irresponsive before the operation is aborted.
530 Timeout is meaningless for the remaining operations,
531 \fBunbind\fP and \fBabandon\fP, which do not imply any response,
532 while it is not yet implemented in currently supported \fBextended\fP
534 If no operation is specified, the timeout \fBval\fP affects all
535 supported operations.
537 Note: if the timelimit is exceeded, the operation is cancelled
538 (according to the \fBcancel\fP directive);
539 the protocol does not provide any means to rollback operations,
540 so the client will not be notified about the result of the operation,
541 which may eventually succeeded or not.
542 In case the timeout is exceeded during a bind operation, the connection
543 is destroyed, according to RFC4511.
545 Note: in some cases, this backend may issue binds prior
546 to other operations (e.g. to bind anonymously or with some prescribed
547 identity according to the \fBidassert\-bind\fP directive).
548 In this case, the timeout of the operation that resulted in the bind
553 .B tls {[try\-]start|[try\-]propagate|ldaps}
556 .B [tls_cacert=<file>]
557 .B [tls_cacertdir=<path>]
558 .B [tls_reqcert=never|allow|try|demand]
559 .B [tls_ciphersuite=<ciphers>]
560 .B [tls_crlcheck=none|peer|all]
562 Specify the use of TLS when a regular connection is initialized. The
563 StartTLS extended operation will be used unless the URI directive protocol
564 scheme is \fBldaps://\fP. In that case this keyword may only be
565 set to "ldaps" and the StartTLS operation will not be used.
566 \fBpropagate\fP issues the StartTLS operation only if the original
568 The \fBtry\-\fP prefix instructs the proxy to continue operations
569 if the StartTLS operation failed; its use is \fBnot\fP recommended.
571 The TLS settings default to the same as the main slapd TLS settings,
574 which defaults to "demand".
578 .B use\-temporary\-conn {NO|yes}
581 create a temporary connection whenever competing with other threads
582 for a shared one; otherwise, wait until the shared connection is available.
584 .SH BACKWARD COMPATIBILITY
585 The LDAP backend has been heavily reworked between releases 2.2 and 2.3,
586 and subsequently between 2.3 and 2.4.
587 As a side-effect, some of the traditional directives have been
588 deprecated and should be no longer used, as they might disappear
592 .B acl\-authcDN "<administrative DN for access control purposes>"
593 Formerly known as the
595 it is the DN that is used to query the target server for acl checking;
596 it is supposed to have read access on the target server to attributes used
597 on the proxy for acl checking.
598 There is no risk of giving away such values; they are only used to
601 .B The acl\-authcDN identity is by no means implicitly used by the proxy
602 .B when the client connects anonymously.
605 feature can be used (at own risk) for that purpose instead.
607 This directive is obsoleted by the
611 when \fIbindmethod\fP=\fBsimple\fP, and will be dismissed in the future.
614 .B acl\-passwd <password>
615 Formerly known as the
617 it is the password used with the above
620 This directive is obsoleted by the
624 when \fIbindmethod\fP=\fBsimple\fP, and will be dismissed in the future.
627 .B idassert\-authcDN "<administrative DN for proxyAuthz purposes>"
628 DN which is used to propagate the client's identity to the target
629 by means of the proxyAuthz control when the client does not
630 belong to the DIT fragment that is being proxied by back-ldap.
631 This directive is obsoleted by the
635 when \fIbindmethod\fP=\fBsimple\fP, and will be dismissed in the future.
638 .B idassert\-passwd <password>
639 Password used with the
642 This directive is obsoleted by the
646 when \fIbindmethod\fP=\fBsimple\fP, and will be dismissed in the future.
649 .B idassert\-mode <mode> [<flags>]
651 .I identity assertion
653 This directive is obsoleted by the
657 and will be dismissed in the future.
660 .B idassert\-method <method> [<saslargs>]
661 This directive is obsoleted by the
665 and will be dismissed in the future.
669 this directive is no longer supported. Use the
671 directive as described above.
674 .B server <hostname[:port]>
675 this directive is no longer supported. Use the
677 directive as described above.
680 .B suffixmassage, map, rewrite*
681 These directives are no longer supported by back-ldap; their
682 functionality is now delegated to the
684 overlay. Essentially, add a statement
688 first, and prefix all rewrite/map statements with
690 to obtain the original behavior.
694 .\" However, to ease update from existing configurations, back-ldap still
695 .\" recognizes them and automatically instantiates the
697 .\" overlay if available and not instantiated yet.
698 .\" This behavior may change in the future.
703 backend does not honor all ACL semantics as described in
704 .BR slapd.access (5).
705 In general, access checking is delegated to the remote server(s).
710 pseudo-attribute and to the other attribute values of the entries
713 operation is honored, which is performed by the frontend.
716 The LDAP backend provides basic proxying functionalities to many overlays.
719 overlay, described in
720 .BR slapo\-chain (5),
723 overlay, described in
724 .BR slapo\-translucent (5),
725 deserve a special mention.
727 Conversely, there are many overlays that are best used in conjunction
728 with the LDAP backend.
731 overlay allows caching of LDAP search requests (queries)
734 .BR slapo\-pcache (5)
738 overlay provides DN rewrite and attribute/objectClass mapping
739 capabilities to the underlying database.
747 default slapd configuration file
750 .BR slapd\-config (5),
752 .BR slapo\-chain (5),
753 .BR slapo\-pcache (5),
755 .BR slapo\-translucent (5),
759 Howard Chu, with enhancements by Pierangelo Masarati
projects / openldap / blob