]> git.sur5r.net Git - openldap/blob - doc/man/man5/slapd-ldap.5
reflect Kurt's comments on ID assertion
[openldap] / doc / man / man5 / slapd-ldap.5
1 .TH SLAPD-LDAP 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2004 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 .LP
37 .RS
38 .nf
39 lastmod  off
40 .fi
41 .RE
42 .LP
43 for every
44 .B ldap
45 and
46 .B meta
47 database.
48 This is because operational attributes related to entry creation and
49 modification should not be used, as they could be passed to the target
50 servers, generating an error.
51 .TP
52 .B uri <ldapurl>
53 LDAP server to use.  Multiple URIs can be set in in a single
54 .B ldapurl
55 argument, resulting in the underlying library automatically 
56 call the first server of the list that responds, e.g. 
57
58 \fBuri "ldap://host/ ldap://backup-host"\fP
59
60 The URI list is space- or comma-separated.
61 .TP
62 .B server <hostport>
63 Obsolete option; same as `uri ldap://<hostport>/'.
64 .TP
65 .B binddn "<administrative DN for access control purposes>"
66 DN which is used to query the target server for acl checking; it
67 should have read access on the target server to attributes used on the
68 proxy for acl checking.
69 There is no risk of giving away such values; they are only used to
70 check permissions.
71 .TP
72 .B bindpw <password>
73 Password used with the bind DN above.
74 .TP
75 .B proxyauthzdn "<administrative DN for proxyAuthz purposes>"
76 DN which is used to propagate the client's identity to the target
77 by means of the proxyAuthz control when the client does not
78 belong to the DIT fragment that is being proxyied by back-ldap.
79 This is useful when operations performed by users bound to another 
80 backend are propagated through back-ldap.
81 This requires the entry with 
82 .B proxyauthzdn 
83 identity on the remote server to have
84 .B proxyAuthz
85 privileges on a wide set of DNs, e.g.
86 .BR authzTo=dn.regex:.* ,
87 and the remote server to have
88 .B authz-policy
89 set to 
90 .B to
91 or 
92 .BR both .
93 See 
94 .BR slapd.conf (5)
95 for details on these statements and for remarks and drawbacks about
96 their usage.
97 .TP
98 .B proxyauthzpw <password>
99 Password used with the proxy authzDN above.
100 .TP
101 .B idassert-mode <mode>
102 defines what type of
103 .I identity assertion
104 is used.
105 The supported modes are:
106 .RS
107 .RS
108 .TP
109 .B <mode>={legacy|anonymous|self|none|<id>}
110 .RE
111 .RS
112 .B <id>={u:<ID>|[dn:]<DN>}
113 .RE
114
115 The default is 
116 .BR legacy ,
117 which implies that the proxy will bind as
118 .I proxyauthzdn
119 and assert the client's identity when it is not anonymous.
120 Direct binds are always proxied.
121 The other modes imply that the proxy will always bind as 
122 .IR proxyauthzdn ,
123 unless restricted by
124 .BR idassert-authz
125 rules (see below), in which case the operation will fail;
126 eventually, it will assert some other identity according to
127 .BR <mode> .
128 Other identity assertion modes are
129 .BR anonymous
130 and
131 .BR self ,
132 which respectively mean that the 
133 .I empty 
134 or the 
135 .IR client 's 
136 identity
137 will be asserted;
138 .BR none ,
139 which means that no proxyAuthz control will be used, so the
140 .I proxyauthzdn
141 identity will be asserted.
142 Moreover, if a string prefixed with
143 .B u:
144 or 
145 .B dn:
146 is used as 
147 .BR <mode> ,
148 that identity will be asserted.
149 Ths string is also treated as a DN if it is not prefixed
150 by any recognized type indicator.  Whether or not the 
151 .B dn: 
152 prefix is present, the string must pass DN validation and normalization.
153 For all modes that require the use of the
154 .I proxyAuthz 
155 control, on the remote server the proxy identity must have appropriate 
156 .I authzTo
157 permissions, or the asserted identities must have appropriate
158 .I authzFrom 
159 permissions.  Note, however, that the ID assertion feature is mostly 
160 useful when the asserted identities do not exist on the remote server.
161 .TP
162 .B idassert-authz <authz>
163 if defined, selects what
164 .I local
165 identities are authorized to exploit the identity assertion feature.
166 The string
167 .B authz 
168 follows the rules defined for the
169 .I authzFrom
170 attribute.
171 See 
172 .BR slapd.conf (5),
173 section related to
174 .BR authz-policy ,
175 for details on the supported syntaxes.
176 .TP
177 .B proxy-whoami
178 Turns on proxying of the WhoAmI extended operation. If this option is
179 given, back-ldap will replace slapd's original WhoAmI routine with its
180 own. On slapd sessions that were authenticated by back-ldap, the WhoAmI
181 request will be forwarded to the remote LDAP server. Other sessions will
182 be handled by the local slapd, as before. This option is mainly useful
183 in conjunction with Proxy Authorization.
184 .TP
185 .B rebind-as-user
186 If this option is given, the client's bind credentials are remembered
187 for rebinds when chasing referrals.
188 .TP
189 .B suffixmassage <suffix> <massaged (remote) suffix>
190 DNs ending with <suffix> in a request are changed to end with <remote
191 suffix> before sending the request to the remote server, and <remote
192 suffix> in the results are changed back to <suffix> before returning
193 them to the client.
194 The <suffix> field must be defined as a valid suffix
195 for the current database.
196 .TP
197 .B map "{attribute | objectclass} [<local name> | *] {<foreign name> | *}"
198 Map attribute names and object classes from the foreign server to
199 different values on the local slapd.
200 The reason is that some attributes might not be part of the local
201 slapd's schema, some attribute names might be different but serve the
202 same purpose, etc.
203 If local or foreign name is `*', the name is preserved.
204 If local name is omitted, the foreign name is removed.
205 Unmapped names are preseved if both local and foreign name are `*',
206 and removed if local name is omitted and foreign name is `*'.
207 .TP
208 .B rewrite*
209 The rewrite options are described in the "REWRITING" section of the
210 .BR slapd-meta (5)
211 manual page.
212 .SH EXAMPLES
213 This maps the OpenLDAP objectclass `groupOfNames' to the Active
214 Directory objectclass `group':
215 .LP
216 .RS
217 .nf
218 map objectclass groupOfNames group
219 .fi
220 .RE
221 .LP
222 This presents a limited attribute set from the foreign
223 server:
224 .LP
225 .RS
226 .nf
227 map attribute cn *
228 map attribute sn *
229 map attribute manager *
230 map attribute description *
231 map attribute *
232 .fi
233 .RE
234 .LP
235 These lines map cn, sn, manager, and description to themselves, and 
236 any other attribute gets "removed" from the object before it is sent 
237 to the client (or sent up to the LDAP server).  This is obviously a 
238 simplistic example, but you get the point.
239 .SH FILES
240 .TP
241 ETCDIR/slapd.conf
242 default slapd configuration file
243 .SH SEE ALSO
244 .BR slapd.conf (5),
245 .BR slapd-meta (5),
246 .BR slapd (8),
247 .BR ldap (3).
248 .SH AUTHOR
249 Howard Chu, with enhancements by Pierangelo Masarati