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

   1 .TH SLAPO-CHAIN 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 1998-2004 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 the referrals are chased with the
  19 .B acl-authcDN
  20 (if any; see
  21 .BR slapd-ldap (5)
  22 for details), with the original identity asserted by means of 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 conflicts with directives specific to the underlying database
  32 or to other stacked overlays.
  33
  34 .LP
  35 There are no chain overlay specific directives; however, directives
  36 related to the instance of the ldap backend that is implicitly
  37 instantiated by the overlay may assume a special meaning when used
  38 in conjuction with this overlay.
  39 .TP
  40 .B overlay chain
  41 This directive adds the chain overlay to the current backend.
  42 The chain overlay may be used with any backend but is intended
  43 for use with local storage backends that may return referrals.
  44 It is useless in conjunction with the ldap and meta backends
  45 because they exploit the libldap specific referral chase feature.
  46 .TP
  47 .B chain-uri <ldapuri>
  48 This directive instructs the underlying ldap database about which
  49 URI to contact to follow referrals.
  50 If not given, the referral itself is parsed, and the protocol/host/port
  51 portions are used to establish a connection.
  52
  53 .LP
  54 Directives for configuring the underlying ldap database must also be given,
  55 as shown here:
  56 .LP
  57 .RS
  58 .nf
  59 chain-acl-authcDN       cn=Auth,dc=example,dc=com
  60 chain-acl-passwd        secret
  61 .fi
  62 .RE
  63 .LP
  64 Any valid directives for the ldap database may be used; see
  65 .BR slapd-ldap (5)
  66 for details.
  67 .SH FILES
  68 .TP
  69 ETCDIR/slapd.conf
  70 default slapd configuration file
  71 .SH SEE ALSO
  72 .BR slapd.conf (5),
  73 .BR slapd\-ldap (5),
  74 .BR slapd (8).
  75 .SH AUTHOR
  76 Originally implemented by Howard Chu.