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 \fIldap\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 \fIldap\fP and \fImeta\fP backends
  46 because they already exploit the libldap specific referral chase feature.
  47 .TP
  48 .B chain-uri <ldapuri>
  49 This directive instructs the underlying ldap database about which
  50 URI to contact to chase referrals.
  51 If not present, the referral itself is parsed, and the protocol/host/port
  52 portions are used to establish a connection.
  53
  54 .LP
  55 Directives for configuring the underlying ldap database may also
  56 be required, as shown here:
  57 .LP
  58 .RS
  59 .nf
  60 chain-idassert-method   "simple"
  61 chain-idassert-authcDN  "cn=Auth,dc=example,dc=com"
  62 chain-idassert-passwd   "secret"
  63 chain-idassert-mode     "self"
  64 .fi
  65 .RE
  66 .LP
  67 Any valid directives for the ldap database may be used; see
  68 .BR slapd-ldap (5)
  69 for details.
  70 .SH FILES
  71 .TP
  72 ETCDIR/slapd.conf
  73 default slapd configuration file
  74 .SH SEE ALSO
  75 .BR slapd.conf (5),
  76 .BR slapd\-ldap (5),
  77 .BR slapd (8).
  78 .SH AUTHOR
  79 Originally implemented by Howard Chu.