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