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 no chain overlay specific directives; however, directives
  36 related to the \fIslapd-ldap\fP database that is implicitly instantiated
  37 by the overlay may assume a special meaning when used in conjunction
  38 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 \fBslapd-ldap\fP(5) and
  49 \fBslapd-meta\fP(5) might no longer chase referrals on their own.]
  50 .TP
  51 .B chain-uri <ldapuri>
  52 This directive instructs the underlying ldap database about which
  53 URI to contact to chase referrals.
  54 If not present, the referral itself is parsed, and the protocol/host/port
  55 portions are used to establish a connection.
  56
  57 .LP
  58 Directives for configuring the underlying ldap database may also
  59 be required, as shown here:
  60 .LP
  61 .RS
  62 .nf
  63 chain-idassert-bind     bindmethod="simple"
  64                         binddn="cn=Auth,dc=example,dc=com"
  65                         credentials="secret"
  66                         mode="self"
  67 .fi
  68 .RE
  69 .LP
  70 Any valid directives for the ldap database may be used; see
  71 .BR slapd-ldap (5)
  72 for details.
  73 Multiple occurrences of the \fBchain-uri\fP directive may appear,
  74 to define multiple "trusted" URIs where operations with
  75 \fIidentity assertion\fP are chained.
  76 All URIs not listed in the configuration are chained anonymously.
  77 All \fBslapd-ldap\fP(5) directives appearing before the first
  78 occurrence of \fBchain-uri\fP are shared among all operations,
  79 unless specifically overridden inside each URI configuration.
  80 .SH FILES
  81 .TP
  82 ETCDIR/slapd.conf
  83 default slapd configuration file
  84 .SH SEE ALSO
  85 .BR slapd.conf (5),
  86 .BR slapd\-ldap (5),
  87 .BR slapd (8).
  88 .SH AUTHOR
  89 Originally implemented by Howard Chu.