]> git.sur5r.net Git - openldap/blob - doc/man/man5/slapd-ldap.5
document proxyauthz{dn|pw} and idassert-*
[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 {none|anonymous|self|proxyid|<dn>}
102 defines what type of identity assertion is used.
103 The default is 
104 .BR none ,
105 which implies that the proxy will bind as itself and assert the user's
106 identity only when a user is bound.
107 Other values are
108 .BR anonymous
109 and
110 .BR self ,
111 which respectively mean that the empty or the client's identity
112 will be asserted,
113 .BR proxyid ,
114 which means that no proxyAuthz control will be used, so the proxyauthzdn
115 identity will be asserted.
116 Moreover, if a valid DN is used as 
117 .BR <mode> ,
118 that identity will be asserted.
119 .TP
120 .B idassert-authz <authz>
121 if defined, selects what
122 .I local
123 identities are authorized to exploit the identity assertion feature.
124 .TP
125 .B proxy-whoami
126 Turns on proxying of the WhoAmI extended operation. If this option is
127 given, back-ldap will replace slapd's original WhoAmI routine with its
128 own. On slapd sessions that were authenticated by back-ldap, the WhoAmI
129 request will be forwarded to the remote LDAP server. Other sessions will
130 be handled by the local slapd, as before. This option is mainly useful
131 in conjunction with Proxy Authorization.
132 .TP
133 .B rebind-as-user
134 If this option is given, the client's bind credentials are remembered
135 for rebinds when chasing referrals.
136 .TP
137 .B suffixmassage <suffix> <massaged (remote) suffix>
138 DNs ending with <suffix> in a request are changed to end with <remote
139 suffix> before sending the request to the remote server, and <remote
140 suffix> in the results are changed back to <suffix> before returning
141 them to the client.
142 The <suffix> field must be defined as a valid suffix
143 for the current database.
144 .TP
145 .B map "{attribute | objectclass} [<local name> | *] {<foreign name> | *}"
146 Map attribute names and object classes from the foreign server to
147 different values on the local slapd.
148 The reason is that some attributes might not be part of the local
149 slapd's schema, some attribute names might be different but serve the
150 same purpose, etc.
151 If local or foreign name is `*', the name is preserved.
152 If local name is omitted, the foreign name is removed.
153 Unmapped names are preseved if both local and foreign name are `*',
154 and removed if local name is omitted and foreign name is `*'.
155 .TP
156 .B rewrite*
157 The rewrite options are described in the "REWRITING" section of the
158 .BR slapd-meta (5)
159 manual page.
160 .SH EXAMPLES
161 This maps the OpenLDAP objectclass `groupOfNames' to the Active
162 Directory objectclass `group':
163 .LP
164 .RS
165 .nf
166 map objectclass groupOfNames group
167 .fi
168 .RE
169 .LP
170 This presents a limited attribute set from the foreign
171 server:
172 .LP
173 .RS
174 .nf
175 map attribute cn *
176 map attribute sn *
177 map attribute manager *
178 map attribute description *
179 map attribute *
180 .fi
181 .RE
182 .LP
183 These lines map cn, sn, manager, and description to themselves, and 
184 any other attribute gets "removed" from the object before it is sent 
185 to the client (or sent up to the LDAP server).  This is obviously a 
186 simplistic example, but you get the point.
187 .SH FILES
188 .TP
189 ETCDIR/slapd.conf
190 default slapd configuration file
191 .SH SEE ALSO
192 .BR slapd.conf (5),
193 .BR slapd-meta (5),
194 .BR slapd (8),
195 .BR ldap (3).
196 .SH AUTHOR
197 Howard Chu, with enhancements by Pierangelo Masarati