]> git.sur5r.net Git - openldap/blob - doc/man/man5/slapd-ldap.5
e92774840d00df80000faee5aa5605e230044cb8
[openldap] / doc / man / man5 / slapd-ldap.5
1 .TH SLAPD-LDAP 5 "30 April 2002" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2002 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 .TP
26 .B uri <ldapurl>
27 LDAP server to use.
28 .TP
29 .B server <hostport>
30 Obsolete option; same as `uri ldap://<hostport>/'.
31 .TP
32 .B binddn "<administrative DN for access control purposes>"
33 DN which is used to query the target server for acl checking; it
34 should have read access on the target server to attributes used on the
35 proxy for acl checking.
36 There is no risk of giving away such values; they are only used to
37 check permissions.
38 .TP
39 .B bindpw <password>
40 Password used with the bind DN above.
41 .TP
42 .B rebind-as-user
43 If this option is given, the client's bind credentials are remembered
44 for rebinds when chasing referrals.
45 .TP
46 .B suffixmassage <suffix> <massaged (remote) suffix>
47 DNs ending with <suffix> in a request are changed to end with <remote
48 suffix> before sending the request to the remote server, and <remote
49 suffix> in the results are changed back to <suffix> before returning
50 them to the client.
51 The <suffix> field must be defined as a valid suffix (or suffixAlias?)
52 for the current database; the <massaged suffix> shouldn't have already
53 been defined as a valid suffix or suffixAlias for the current server.
54 .TP
55 .B map "{attribute | objectclass} {<local name> | *} [<foreign name> | *]"
56 Map attribute names and object classes from the foreign server to
57 different values on the local slapd.
58 The reason is that some attributes might not be part of the local
59 slapd's schema, some attribute names might be different but serve the
60 same purpose, etc.
61 If local or foreign name is `*', the name is preserved.
62 If foreign name is missing, the name is dropped.
63 Local name `*' and no foreign name means unmapped attributes are
64 removed, while local name = foreign name = `*' means unmapped
65 attributes are preserved.
66 .TP
67 .B rewrite*
68 The rewrite options are described in the "REWRITING" section of the
69 .BR slapd-meta (5)
70 manual page.
71 .SH EXAMPLES
72 This maps the OpenLDAP objectclass `groupOfNames' to the Active
73 Directory objectclass `group':
74 .LP
75 .nf
76   map objectclass groupOfNames group
77 .fi
78 .LP
79 This presents a limited a limited attribute set from the foreign
80 server:
81 .LP
82 .nf
83   map attribute cn *
84   map attribute sn *
85   map attribute manager *
86   map attribute description *
87   map attribute *
88 .fi
89 .LP
90 These lines map cn, sn, manager, and description to themselves, and 
91 any other attribute gets "removed" from the object before it is sent 
92 to the client (or sent up to the LDAP server).  This is obviously a 
93 simplistic example, but you get the point.
94 .SH FILES
95 ETCDIR/slapd.conf
96 .SH SEE ALSO
97 .BR slapd.conf (5),
98 .BR slapd-meta (5),
99 .BR slapd (8),
100 .BR ldap (3).
101