git.sur5r.net Git - openldap/blob - doc/man/man5/slapd-ldap.5

   1 .TH SLAPD-LDAP 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 1998-2003 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapd-ldap \- LDAP backend to slapd
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The LDAP backend to
  11 .BR slapd (8)
  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.
  16
  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
  23 connections.
  24
  25 .SH CONFIGURATION
  26 These
  27 .B slapd.conf
  28 options apply to the LDAP backend database.
  29 That is, they must follow a "database ldap" line and come before any
  30 subsequent "backend" or "database" lines.
  31 Other database options are described in the
  32 .BR slapd.conf (5)
  33 manual page.
  34 .LP
  35 Note: It is strongly recommended to set
  36 .RS
  37 lastmod  off
  38 .RE
  39 for every
  40 .B ldap
  41 and
  42 .B meta
  43 database.
  44 This is because operational attributes related to entry creation and
  45 modification should not be used, as they could be passed to the target
  46 servers, generating an error.
  47 .TP
  48 .B uri <ldapurl>
  49 LDAP server to use.  Multiple URIs can be set in in a single
  50 .B ldapurl
  51 argument, resulting in the underlying library automatically
  52 call the first server of the list that responds, e.g.
  53
  54 \fBuri "ldap://host/ ldap://backup-host"\fP
  55
  56 The URI list is space- or comma-separated.
  57 .TP
  58 .B server <hostport>
  59 Obsolete option; same as `uri ldap://<hostport>/'.
  60 .TP
  61 .B binddn "<administrative DN for access control purposes>"
  62 DN which is used to query the target server for acl checking; it
  63 should have read access on the target server to attributes used on the
  64 proxy for acl checking.
  65 There is no risk of giving away such values; they are only used to
  66 check permissions.
  67 .TP
  68 .B bindpw <password>
  69 Password used with the bind DN above.
  70 .TP
  71 .B proxy-whoami
  72 Turns on proxying of the WhoAmI extended operation. If this option is
  73 given, back-ldap will replace slapd's original WhoAmI routine with its
  74 own. On slapd sessions that were authenticated by back-ldap, the WhoAmI
  75 request will be forwarded to the remote LDAP server. Other sessions will
  76 be handled by the local slapd, as before. This option is mainly useful
  77 in conjunction with Proxy Authorization.
  78 .TP
  79 .B rebind-as-user
  80 If this option is given, the client's bind credentials are remembered
  81 for rebinds when chasing referrals.
  82 .TP
  83 .B suffixmassage <suffix> <massaged (remote) suffix>
  84 DNs ending with <suffix> in a request are changed to end with <remote
  85 suffix> before sending the request to the remote server, and <remote
  86 suffix> in the results are changed back to <suffix> before returning
  87 them to the client.
  88 The <suffix> field must be defined as a valid suffix
  89 for the current database.
  90 .TP
  91 .B map "{attribute | objectclass} [<local name> | *] {<foreign name> | *}"
  92 Map attribute names and object classes from the foreign server to
  93 different values on the local slapd.
  94 The reason is that some attributes might not be part of the local
  95 slapd's schema, some attribute names might be different but serve the
  96 same purpose, etc.
  97 If local or foreign name is `*', the name is preserved.
  98 If local name is omitted, the foreign name is removed.
  99 Unmapped names are preseved if both local and foreign name are `*',
 100 and removed if local name is omitted and foreign name is `*'.
 101 .TP
 102 .B rewrite*
 103 The rewrite options are described in the "REWRITING" section of the
 104 .BR slapd-meta (5)
 105 manual page.
 106 .SH EXAMPLES
 107 This maps the OpenLDAP objectclass `groupOfNames' to the Active
 108 Directory objectclass `group':
 109 .LP
 110 .RS
 111 .nf
 112 map objectclass groupOfNames group
 113 .fi
 114 .RE
 115 .LP
 116 This presents a limited attribute set from the foreign
 117 server:
 118 .LP
 119 .RS
 120 .nf
 121 map attribute cn *
 122 map attribute sn *
 123 map attribute manager *
 124 map attribute description *
 125 map attribute *
 126 .fi
 127 .RE
 128 .LP
 129 These lines map cn, sn, manager, and description to themselves, and
 130 any other attribute gets "removed" from the object before it is sent
 131 to the client (or sent up to the LDAP server).  This is obviously a
 132 simplistic example, but you get the point.
 133 .SH FILES
 134 .TP
 135 ETCDIR/slapd.conf
 136 default slapd configuration file
 137 .SH SEE ALSO
 138 .BR slapd.conf (5),
 139 .BR slapd-meta (5),
 140 .BR slapd (8),
 141 .BR ldap (3).
 142 .SH AUTHOR
 143 Howard Chu, with enhancements by Pierangelo Masarati