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