git.sur5r.net Git - openldap/blob - doc/man/man5/slapo-chain.5

   1 .TH SLAPO-CHAIN 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 1998-2005 The OpenLDAP Foundation, All Rights Reserved.
   3 .\" Copying restrictions apply.  See the COPYRIGHT file.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapo-chain \- chain overlay
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The
  11 .B chain
  12 overlay to
  13 .BR slapd (8)
  14 allows automatic referral chasing.
  15 Any time a referral is returned (except for bind operations),
  16 it is chased by using an instance of the ldap backend.
  17 If operations are performed with an identity (i.e. after a bind),
  18 that identity can be asserted while chasing the referrals
  19 by means of the \fIidentity assertion\fP feature of back-ldap
  20 (see
  21 .BR slapd-ldap (5)
  22 for details), which is essentially based on the
  23 .B proxyAuthz
  24 control (see \fIdraft-weltman-ldapv3-proxy\fP for details).
  25
  26 .LP
  27 The config directives that are specific to the
  28 .B chain
  29 overlay can be prefixed by
  30 .BR chain\- ,
  31 to avoid potential conflicts with directives specific to the underlying
  32 database or to other stacked overlays.
  33
  34 .LP
  35 There are very few chain overlay specific directives; however, directives
  36 related to the instances of the \fIldap\fP backend that may be implicitly
  37 instantiated by the overlay may assume a special meaning when used
  38 in conjunction with this overlay.  They are described in
  39 .BR slapd-ldap (5).
  40 .TP
  41 .B overlay chain
  42 This directive adds the chain overlay to the current backend.
  43 The chain overlay may be used with any backend, but it is mainly
  44 intended for use with local storage backends that may return referrals.
  45 It is useless in conjunction with the \fIslapd-ldap\fP and \fIslapd-meta\fP
  46 backends because they already exploit the libldap specific referral chase
  47 feature.
  48 [Note: this may change in the future, as the \fBldap\fP(5) and
  49 \fBmeta\fP(5) backends might no longer chase referrals on their own.]
  50 .\".TP
  51 .\".B chain-chaining [resolve=<r>] [continuation=<c>] [critical]
  52 .\"This directive enables the \fIchaining\fP control
  53 .\"(see \fIdraft-sermersheim-ldap-chaining\fP for details)
  54 .\"with the desired resolve and continuation behaviors and criticality.
  55 .\"The values \fBr\fP and \fBc\fP can be any of
  56 .\".BR chainingPreferred ,
  57 .\".BR chainingRequired ,
  58 .\".BR referralsPreferred ,
  59 .\".BR referralsRequired .
  60 .\"[This control is experimental and its support may change in the future.]
  61 .TP
  62 .B chain-cache-uris {FALSE|true}
  63 This directive instructs the \fIchain\fP overlay to cache
  64 connections to URIs parsed out of referrals that are not predefined,
  65 to be reused for later chaining.
  66 .TP
  67 .B chain-uri <ldapuri>
  68 This directive instantiates a new underlying \fIldap\fP database
  69 and instructs it about which URI to contact to chase referrals.
  70 As opposed to what stated in \fBslapd-ldap\fP(5), only one URI
  71 can appear after this directive.
  72
  73 .LP
  74 Directives for configuring the underlying ldap database may also
  75 be required, as shown here:
  76 .LP
  77 .RS
  78 .nf
  79 chain-idassert-bind     bindmethod="simple"
  80                         binddn="cn=Auth,dc=example,dc=com"
  81                         credentials="secret"
  82                         mode="self"
  83 .fi
  84 .RE
  85 .LP
  86 Any valid directives for the ldap database may be used; see
  87 .BR slapd-ldap (5)
  88 for details.
  89 Multiple occurrences of the \fBchain-uri\fP directive may appear,
  90 to define multiple "trusted" URIs where operations with
  91 \fIidentity assertion\fP are chained.
  92 All URIs not listed in the configuration are chained anonymously.
  93 All \fBslapd-ldap\fP(5) directives appearing before the first
  94 occurrence of \fBchain-uri\fP are shared among all operations,
  95 unless specifically overridden inside each URI configuration.
  96 .SH FILES
  97 .TP
  98 ETCDIR/slapd.conf
  99 default slapd configuration file
 100 .SH SEE ALSO
 101 .BR slapd.conf (5),
 102 .BR slapd\-ldap (5),
 103 .BR slapd (8).
 104 .SH AUTHOR
 105 Originally implemented by Howard Chu; extended by Pierangelo Masarati.