1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 * @brief Apache LDAP library
25 /* APR header files */
27 #include "apr_thread_mutex.h"
28 #include "apr_thread_rwlock.h"
29 #include "apr_tables.h"
31 #include "apr_version.h"
32 #if APR_MAJOR_VERSION < 2
33 /* The LDAP API is currently only present in APR 1.x */
35 #include "apr_ldap_rebind.h"
37 #define APR_HAS_LDAP 0
40 #if APR_HAS_SHARED_MEMORY
45 /* this whole thing disappears if LDAP is not enabled */
48 #if APR_HAS_MICROSOFT_LDAPSDK
49 #define AP_LDAP_IS_SERVER_DOWN(s) ((s) == LDAP_SERVER_DOWN \
50 ||(s) == LDAP_UNAVAILABLE)
52 #define AP_LDAP_IS_SERVER_DOWN(s) ((s) == LDAP_SERVER_DOWN)
55 /* Apache header files */
56 #include "ap_config.h"
58 #include "http_config.h"
59 #include "http_core.h"
61 #include "http_protocol.h"
62 #include "http_request.h"
63 #include "apr_optional.h"
65 /* Create a set of LDAP_DECLARE macros with appropriate export
66 * and import tags for the platform
69 #define LDAP_DECLARE(type) type
70 #define LDAP_DECLARE_NONSTD(type) type
71 #define LDAP_DECLARE_DATA
72 #elif defined(LDAP_DECLARE_STATIC)
73 #define LDAP_DECLARE(type) type __stdcall
74 #define LDAP_DECLARE_NONSTD(type) type
75 #define LDAP_DECLARE_DATA
76 #elif defined(LDAP_DECLARE_EXPORT)
77 #define LDAP_DECLARE(type) __declspec(dllexport) type __stdcall
78 #define LDAP_DECLARE_NONSTD(type) __declspec(dllexport) type
79 #define LDAP_DECLARE_DATA __declspec(dllexport)
81 #define LDAP_DECLARE(type) __declspec(dllimport) type __stdcall
82 #define LDAP_DECLARE_NONSTD(type) __declspec(dllimport) type
83 #define LDAP_DECLARE_DATA __declspec(dllimport)
94 /* Values that the deref member can have */
96 never=LDAP_DEREF_NEVER,
97 searching=LDAP_DEREF_SEARCHING,
98 finding=LDAP_DEREF_FINDING,
99 always=LDAP_DEREF_ALWAYS
102 /* Structure representing an LDAP connection */
103 typedef struct util_ldap_connection_t {
105 apr_pool_t *pool; /* Pool from which this connection is created */
107 apr_thread_mutex_t *lock; /* Lock to indicate this connection is in use */
110 const char *host; /* Name of the LDAP server (or space separated list) */
111 int port; /* Port of the LDAP server */
112 deref_options deref; /* how to handle alias dereferening */
114 const char *binddn; /* DN to bind to server (can be NULL) */
115 const char *bindpw; /* Password to bind to server (can be NULL) */
117 int bound; /* Flag to indicate whether this connection is bound yet */
119 int secure; /* SSL/TLS mode of the connection */
120 apr_array_header_t *client_certs; /* Client certificates on this connection */
122 const char *reason; /* Reason for an error failure */
124 struct util_ldap_connection_t *next;
125 struct util_ldap_state_t *st; /* The LDAP vhost config this connection belongs to */
126 int keep; /* Will this connection be kept when it's unlocked */
128 int ChaseReferrals; /* [on|off] (default = AP_LDAP_CHASEREFERRALS_ON)*/
129 int ReferralHopLimit; /* # of referral hops to follow (default = AP_LDAP_DEFAULT_HOPLIMIT) */
130 apr_time_t freed; /* the time this conn was placed back in the pool */
131 apr_pool_t *rebind_pool; /* frequently cleared pool for rebind data */
132 } util_ldap_connection_t;
134 typedef struct util_ldap_config_t {
136 int ReferralHopLimit;
137 apr_array_header_t *client_certs; /* Client certificates */
138 } util_ldap_config_t;
140 /* LDAP cache state information */
141 typedef struct util_ldap_state_t {
142 apr_pool_t *pool; /* pool from which this state is allocated */
144 apr_thread_mutex_t *mutex; /* mutex lock for the connection list */
146 apr_global_mutex_t *util_ldap_cache_lock;
148 apr_size_t cache_bytes; /* Size (in bytes) of shared memory cache */
149 char *cache_file; /* filename for shm */
150 long search_cache_ttl; /* TTL for search cache */
151 long search_cache_size; /* Size (in entries) of search cache */
152 long compare_cache_ttl; /* TTL for compare cache */
153 long compare_cache_size; /* Size (in entries) of compare cache */
155 struct util_ldap_connection_t *connections;
156 apr_array_header_t *global_certs; /* Global CA certificates */
162 #if APR_HAS_SHARED_MEMORY
163 apr_shm_t *cache_shm;
164 apr_rmm_t *cache_rmm;
168 void *util_ldap_cache;
170 long connectionTimeout;
171 struct timeval *opTimeout;
173 int debug_level; /* SDK debug level */
174 apr_interval_time_t connection_pool_ttl;
175 int retries; /* number of retries for failed bind/search/compare */
176 apr_interval_time_t retry_delay; /* delay between retries of failed bind/search/compare */
179 /* Used to store arrays of attribute labels/values. */
180 struct mod_auth_ldap_groupattr_entry_t {
185 * Open a connection to an LDAP server
186 * @param ldc A structure containing the expanded details of the server
187 * to connect to. The handle to the LDAP connection is returned
189 * @tip This function connects to the LDAP server and binds. It does not
190 * connect if already connected (ldc->ldap != NULL). Does not bind
192 * @return If successful LDAP_SUCCESS is returned.
193 * @fn int util_ldap_connection_open(request_rec *r,
194 * util_ldap_connection_t *ldc)
196 APR_DECLARE_OPTIONAL_FN(int,uldap_connection_open,(request_rec *r,
197 util_ldap_connection_t *ldc));
200 * Close a connection to an LDAP server
201 * @param ldc A structure containing the expanded details of the server
202 * that was connected.
203 * @tip This function unbinds from the LDAP server, and clears ldc->ldap.
204 * It is possible to rebind to this server again using the same ldc
205 * structure, using apr_ldap_open_connection().
206 * @fn util_ldap_close_connection(util_ldap_connection_t *ldc)
208 APR_DECLARE_OPTIONAL_FN(void,uldap_connection_close,(util_ldap_connection_t *ldc));
211 * Unbind a connection to an LDAP server
212 * @param ldc A structure containing the expanded details of the server
213 * that was connected.
214 * @tip This function unbinds the LDAP connection, and disconnects from
215 * the server. It is used during error conditions, to bring the LDAP
216 * connection back to a known state.
217 * @fn apr_status_t util_ldap_connection_unbind(util_ldap_connection_t *ldc)
219 APR_DECLARE_OPTIONAL_FN(apr_status_t,uldap_connection_unbind,(void *param));
222 * Find a connection in a list of connections
223 * @param r The request record
224 * @param host The hostname to connect to (multiple hosts space separated)
225 * @param port The port to connect to
226 * @param binddn The DN to bind with
227 * @param bindpw The password to bind with
228 * @param deref The dereferencing behavior
229 * @param secure use SSL on the connection
230 * @tip Once a connection is found and returned, a lock will be acquired to
231 * lock that particular connection, so that another thread does not try and
232 * use this connection while it is busy. Once you are finished with a connection,
233 * apr_ldap_connection_close() must be called to release this connection.
234 * @fn util_ldap_connection_t *util_ldap_connection_find(request_rec *r, const char *host, int port,
235 * const char *binddn, const char *bindpw, deref_options deref,
236 * int netscapessl, int starttls)
238 APR_DECLARE_OPTIONAL_FN(util_ldap_connection_t *,uldap_connection_find,(request_rec *r, const char *host, int port,
239 const char *binddn, const char *bindpw, deref_options deref,
243 * Compare two DNs for sameness
244 * @param r The request record
245 * @param ldc The LDAP connection being used.
246 * @param url The URL of the LDAP connection - used for deciding which cache to use.
247 * @param dn The first DN to compare.
248 * @param reqdn The DN to compare the first DN to.
249 * @param compare_dn_on_server Flag to determine whether the DNs should be checked using
250 * LDAP calls or with a direct string comparision. A direct
251 * string comparison is faster, but not as accurate - false
252 * negative comparisons are possible.
253 * @tip Two DNs can be equal and still fail a string comparison. Eg "dc=example,dc=com"
254 * and "dc=example, dc=com". Use the compare_dn_on_server unless there are serious
255 * performance issues.
256 * @fn int util_ldap_cache_comparedn(request_rec *r, util_ldap_connection_t *ldc,
257 * const char *url, const char *dn, const char *reqdn,
258 * int compare_dn_on_server)
260 APR_DECLARE_OPTIONAL_FN(int,uldap_cache_comparedn,(request_rec *r, util_ldap_connection_t *ldc,
261 const char *url, const char *dn, const char *reqdn,
262 int compare_dn_on_server));
265 * A generic LDAP compare function
266 * @param r The request record
267 * @param ldc The LDAP connection being used.
268 * @param url The URL of the LDAP connection - used for deciding which cache to use.
269 * @param dn The DN of the object in which we do the compare.
270 * @param attrib The attribute within the object we are comparing for.
271 * @param value The value of the attribute we are trying to compare for.
272 * @tip Use this function to determine whether an attribute/value pair exists within an
273 * object. Typically this would be used to determine LDAP top-level group
275 * @fn int util_ldap_cache_compare(request_rec *r, util_ldap_connection_t *ldc,
276 * const char *url, const char *dn, const char *attrib, const char *value)
278 APR_DECLARE_OPTIONAL_FN(int,uldap_cache_compare,(request_rec *r, util_ldap_connection_t *ldc,
279 const char *url, const char *dn, const char *attrib, const char *value));
282 * An LDAP function that checks if the specified user is a member of a subgroup.
283 * @param r The request record
284 * @param ldc The LDAP connection being used.
285 * @param url The URL of the LDAP connection - used for deciding which cache to use.
286 * @param dn The DN of the object in which we find subgroups to search within.
287 * @param attrib The attribute within group objects that identify users.
288 * @param value The user attribute value we are trying to compare for.
289 * @param subgroupAttrs The attributes within group objects that identify subgroups.
291 * @param subgroupclasses The objectClass values used to identify groups (and
292 * subgroups). apr_array_header_t *.
293 * @param cur_subgroup_depth Current recursive depth during subgroup processing.
294 * @param max_subgroup_depth Maximum depth of recursion allowed during subgroup
296 * @tip Use this function to determine whether an attribute/value pair exists within a
297 * starting group object or one of its nested subgroups. Typically this would be
298 * used to determine LDAP nested group membership.
299 * @deffunc int util_ldap_cache_check_subgroups(request_rec *r, util_ldap_connection_t
300 * *ldc, const char *url, const char *dn,
301 * const char *attrib, const char value,
302 * char **subgroupAttrs, apr_array_header_t
303 * *subgroupclasses, int cur_subgroup_depth, int
304 * max_subgroup_depth )
306 APR_DECLARE_OPTIONAL_FN(int,uldap_cache_check_subgroups,(request_rec *r, util_ldap_connection_t *ldc,
307 const char *url, const char *dn, const char *attrib, const char *value,
308 char **subgroupAttrs, apr_array_header_t *subgroupclasses,
309 int cur_subgroup_depth, int max_subgroup_depth));
312 * Checks a username/password combination by binding to the LDAP server
313 * @param r The request record
314 * @param ldc The LDAP connection being used.
315 * @param url The URL of the LDAP connection - used for deciding which cache to use.
316 * @param basedn The Base DN to search for the user in.
317 * @param scope LDAP scope of the search.
318 * @param attrs LDAP attributes to return in search.
319 * @param filter The user to search for in the form of an LDAP filter. This filter must return
320 * exactly one user for the check to be successful.
321 * @param bindpw The user password to bind as.
322 * @param binddn The DN of the user will be returned in this variable.
323 * @param retvals The values corresponding to the attributes requested in the attrs array.
324 * @tip The filter supplied will be searched for. If a single entry is returned, an attempt
325 * is made to bind as that user. If this bind succeeds, the user is not validated.
326 * @fn int util_ldap_cache_checkuserid(request_rec *r, util_ldap_connection_t *ldc,
327 * char *url, const char *basedn, int scope, char **attrs,
328 * char *filter, char *bindpw, char **binddn, char ***retvals)
330 APR_DECLARE_OPTIONAL_FN(int,uldap_cache_checkuserid,(request_rec *r, util_ldap_connection_t *ldc,
331 const char *url, const char *basedn, int scope, char **attrs,
332 const char *filter, const char *bindpw, const char **binddn, const char ***retvals));
335 * Searches for a specified user object in an LDAP directory
336 * @param r The request record
337 * @param ldc The LDAP connection being used.
338 * @param url The URL of the LDAP connection - used for deciding which cache to use.
339 * @param basedn The Base DN to search for the user in.
340 * @param scope LDAP scope of the search.
341 * @param attrs LDAP attributes to return in search.
342 * @param filter The user to search for in the form of an LDAP filter. This filter must return
343 * exactly one user for the check to be successful.
344 * @param binddn The DN of the user will be returned in this variable.
345 * @param retvals The values corresponding to the attributes requested in the attrs array.
346 * @tip The filter supplied will be searched for. If a single entry is returned, an attempt
347 * is made to bind as that user. If this bind succeeds, the user is not validated.
348 * @fn int util_ldap_cache_getuserdn(request_rec *r, util_ldap_connection_t *ldc,
349 * char *url, const char *basedn, int scope, char **attrs,
350 * char *filter, char **binddn, char ***retvals)
352 APR_DECLARE_OPTIONAL_FN(int,uldap_cache_getuserdn,(request_rec *r, util_ldap_connection_t *ldc,
353 const char *url, const char *basedn, int scope, char **attrs,
354 const char *filter, const char **binddn, const char ***retvals));
357 * Checks if SSL support is available in mod_ldap
358 * @fn int util_ldap_ssl_supported(request_rec *r)
360 APR_DECLARE_OPTIONAL_FN(int,uldap_ssl_supported,(request_rec *r));
362 /* from apr_ldap_cache.c */
365 * Init the LDAP cache
366 * @param pool The pool to use to initialise the cache
367 * @param reqsize The size of the shared memory segment to request. A size
368 * of zero requests the max size possible from
370 * @fn void util_ldap_cache_init(apr_pool_t *p, util_ldap_state_t *st)
371 * @return The status code returned is the status code of the
372 * apr_smmem_init() call. Regardless of the status, the cache
373 * will be set up at least for in-process or in-thread operation.
375 apr_status_t util_ldap_cache_init(apr_pool_t *pool, util_ldap_state_t *st);
377 /* from apr_ldap_cache_mgr.c */
380 * Display formatted stats for cache
381 * @param The pool to allocate the returned string from
382 * @tip This function returns a string allocated from the provided pool that describes
383 * various stats about the cache.
384 * @fn char *util_ald_cache_display(apr_pool_t *pool, util_ldap_state_t *st)
386 char *util_ald_cache_display(request_rec *r, util_ldap_state_t *st);
390 #endif /* APR_HAS_LDAP */
391 #endif /* UTIL_LDAP_H */