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.
17 #include "ap_provider.h"
19 #include "http_config.h"
20 #include "ap_provider.h"
21 #include "http_core.h"
23 #include "http_protocol.h"
24 #include "http_request.h"
25 #include "util_ldap.h"
29 #include "apr_strings.h"
30 #include "apr_xlate.h"
31 #define APR_WANT_STRFUNC
38 #error mod_authnz_ldap requires APR-util to have LDAP support built in. To fix add --with-ldap to ./configure.
41 static char *default_attributes[3] = { "member", "uniqueMember", NULL };
44 apr_pool_t *pool; /* Pool that this config is allocated from */
46 apr_thread_mutex_t *lock; /* Lock for this config */
49 /* These parameters are all derived from the AuthLDAPURL directive */
50 char *url; /* String representation of the URL */
52 char *host; /* Name of the LDAP server (or space separated list) */
53 int port; /* Port of the LDAP server */
54 char *basedn; /* Base DN to do all searches from */
55 char *attribute; /* Attribute to search for */
56 char **attributes; /* Array of all the attributes to return */
57 int scope; /* Scope of the search */
58 char *filter; /* Filter to further limit the search */
59 deref_options deref; /* how to handle alias dereferening */
60 char *binddn; /* DN to bind to server (can be NULL) */
61 char *bindpw; /* Password to bind to server (can be NULL) */
62 int bind_authoritative; /* If true, will return errors when bind fails */
64 int user_is_dn; /* If true, connection->user is DN instead of userid */
65 char *remote_user_attribute; /* If set, connection->user is this attribute instead of userid */
66 int compare_dn_on_server; /* If true, will use server to do DN compare */
68 int have_ldap_url; /* Set if we have found an LDAP url */
70 apr_array_header_t *groupattr; /* List of Group attributes identifying user members. Default:"member uniqueMember" */
71 int group_attrib_is_dn; /* If true, the group attribute is the DN, otherwise,
72 it's the exact string passed by the HTTP client */
73 char **sgAttributes; /* Array of strings constructed (post-config) from subgroupattrs. Last entry is NULL. */
74 apr_array_header_t *subgroupclasses; /* List of object classes of sub-groups. Default:"groupOfNames groupOfUniqueNames" */
75 int maxNestingDepth; /* Maximum recursive nesting depth permitted during subgroup processing. Default: 10 */
77 int secure; /* True if SSL connections are requested */
78 char *authz_prefix; /* Prefix for environment variables added during authz */
79 int initial_bind_as_user; /* true if we should try to bind (to lookup DN) directly with the basic auth username */
80 ap_regex_t *bind_regex; /* basic auth -> bind'able username regex */
81 const char *bind_subst; /* basic auth -> bind'able username substitution */
82 int search_as_user; /* true if authz searches should be done with the users credentials (when we did authn) */
83 int compare_as_user; /* true if authz compares should be done with the users credentials (when we did authn) */
84 } authn_ldap_config_t;
87 char *dn; /* The saved dn from a successful search */
88 char *user; /* The username provided by the client */
89 const char **vals; /* The additional values pulled during the DN search*/
90 char *password; /* if this module successfully authenticates, the basic auth password, else null */
91 } authn_ldap_request_t;
93 enum auth_ldap_phase {
94 LDAP_AUTHN, LDAP_AUTHZ
97 enum auth_ldap_optype {
98 LDAP_SEARCH, LDAP_COMPARE, LDAP_COMPARE_AND_SEARCH /* nested groups */
101 /* maximum group elements supported */
102 #define GROUPATTR_MAX_ELTS 10
104 module AP_MODULE_DECLARE_DATA authnz_ldap_module;
106 static APR_OPTIONAL_FN_TYPE(uldap_connection_close) *util_ldap_connection_close;
107 static APR_OPTIONAL_FN_TYPE(uldap_connection_find) *util_ldap_connection_find;
108 static APR_OPTIONAL_FN_TYPE(uldap_cache_comparedn) *util_ldap_cache_comparedn;
109 static APR_OPTIONAL_FN_TYPE(uldap_cache_compare) *util_ldap_cache_compare;
110 static APR_OPTIONAL_FN_TYPE(uldap_cache_check_subgroups) *util_ldap_cache_check_subgroups;
111 static APR_OPTIONAL_FN_TYPE(uldap_cache_checkuserid) *util_ldap_cache_checkuserid;
112 static APR_OPTIONAL_FN_TYPE(uldap_cache_getuserdn) *util_ldap_cache_getuserdn;
113 static APR_OPTIONAL_FN_TYPE(uldap_ssl_supported) *util_ldap_ssl_supported;
115 static apr_hash_t *charset_conversions = NULL;
116 static char *to_charset = NULL; /* UTF-8 identifier derived from the charset.conv file */
119 /* Derive a code page ID give a language name or ID */
120 static char* derive_codepage_from_lang (apr_pool_t *p, char *language)
124 if (!language) /* our default codepage */
125 return apr_pstrdup(p, "ISO-8859-1");
127 charset = (char*) apr_hash_get(charset_conversions, language, APR_HASH_KEY_STRING);
131 charset = (char*) apr_hash_get(charset_conversions, language, APR_HASH_KEY_STRING);
135 charset = apr_pstrdup(p, charset);
141 static apr_xlate_t* get_conv_set (request_rec *r)
143 char *lang_line = (char*)apr_table_get(r->headers_in, "accept-language");
145 apr_xlate_t *convset;
148 lang_line = apr_pstrdup(r->pool, lang_line);
149 for (lang = lang_line;*lang;lang++) {
150 if ((*lang == ',') || (*lang == ';')) {
155 lang = derive_codepage_from_lang(r->pool, lang_line);
157 if (lang && (apr_xlate_open(&convset, to_charset, lang, r->pool) == APR_SUCCESS)) {
166 static const char* authn_ldap_xlate_password(request_rec *r,
167 const char* sent_password)
169 apr_xlate_t *convset = NULL;
174 if (charset_conversions && (convset = get_conv_set(r)) ) {
175 inbytes = strlen(sent_password);
176 outbytes = (inbytes+1)*3;
177 outbuf = apr_pcalloc(r->pool, outbytes);
179 /* Convert the password to UTF-8. */
180 if (apr_xlate_conv_buffer(convset, sent_password, &inbytes, outbuf,
181 &outbytes) == APR_SUCCESS)
185 return sent_password;
190 * Build the search filter, or at least as much of the search filter that
191 * will fit in the buffer. We don't worry about the buffer not being able
192 * to hold the entire filter. If the buffer wasn't big enough to hold the
193 * filter, ldap_search_s will complain, but the only situation where this
194 * is likely to happen is if the client sent a really, really long
195 * username, most likely as part of an attack.
197 * The search filter consists of the filter provided with the URL,
198 * combined with a filter made up of the attribute provided with the URL,
199 * and the actual username passed by the HTTP client. For example, assume
200 * that the LDAP URL is
202 * ldap://ldap.airius.com/ou=People, o=Airius?uid??(posixid=*)
204 * Further, assume that the userid passed by the client was `userj'. The
205 * search filter will be (&(posixid=*)(uid=userj)).
207 #define FILTER_LENGTH MAX_STRING_LEN
208 static void authn_ldap_build_filter(char *filtbuf,
210 const char* sent_user,
211 const char* sent_filter,
212 authn_ldap_config_t *sec)
214 char *p, *q, *filtbuf_end;
216 apr_xlate_t *convset = NULL;
221 if (sent_user != NULL) {
222 user = apr_pstrdup (r->pool, sent_user);
227 if (sent_filter != NULL) {
228 filter = apr_pstrdup (r->pool, sent_filter);
231 filter = sec->filter;
233 if (charset_conversions) {
234 convset = get_conv_set(r);
238 inbytes = strlen(user);
239 outbytes = (inbytes+1)*3;
240 outbuf = apr_pcalloc(r->pool, outbytes);
242 /* Convert the user name to UTF-8. This is only valid for LDAP v3 */
243 if (apr_xlate_conv_buffer(convset, user, &inbytes, outbuf, &outbytes) == APR_SUCCESS) {
244 user = apr_pstrdup(r->pool, outbuf);
249 * Create the first part of the filter, which consists of the
250 * config-supplied portions.
252 apr_snprintf(filtbuf, FILTER_LENGTH, "(&(%s)(%s=", filter, sec->attribute);
255 * Now add the client-supplied username to the filter, ensuring that any
256 * LDAP filter metachars are escaped.
258 filtbuf_end = filtbuf + FILTER_LENGTH - 1;
259 #if APR_HAS_MICROSOFT_LDAPSDK
260 for (p = user, q=filtbuf + strlen(filtbuf);
261 *p && q < filtbuf_end; ) {
262 if (strchr("*()\\", *p) != NULL) {
263 if ( q + 3 >= filtbuf_end)
264 break; /* Don't write part of escape sequence if we can't write all of it */
290 for (p = user, q=filtbuf + strlen(filtbuf);
291 *p && q < filtbuf_end; *q++ = *p++) {
292 if (strchr("*()\\", *p) != NULL) {
294 if (q >= filtbuf_end) {
303 * Append the closing parens of the filter, unless doing so would
304 * overrun the buffer.
306 if (q + 2 <= filtbuf_end)
307 strcat(filtbuf, "))");
310 static void *create_authnz_ldap_dir_config(apr_pool_t *p, char *d)
312 authn_ldap_config_t *sec =
313 (authn_ldap_config_t *)apr_pcalloc(p, sizeof(authn_ldap_config_t));
317 apr_thread_mutex_create(&sec->lock, APR_THREAD_MUTEX_DEFAULT, p);
320 sec->authz_enabled = 1;
322 sec->groupattr = apr_array_make(p, GROUPATTR_MAX_ELTS,
323 sizeof(struct mod_auth_ldap_groupattr_entry_t));
324 sec->subgroupclasses = apr_array_make(p, GROUPATTR_MAX_ELTS,
325 sizeof(struct mod_auth_ldap_groupattr_entry_t));
327 sec->have_ldap_url = 0;
332 sec->bind_authoritative = 1;
334 sec->group_attrib_is_dn = 1;
335 sec->secure = -1; /*Initialize to unset*/
336 sec->maxNestingDepth = 10;
337 sec->sgAttributes = apr_pcalloc(p, sizeof (char *) * GROUPATTR_MAX_ELTS + 1);
340 sec->remote_user_attribute = NULL;
341 sec->compare_dn_on_server = 0;
343 sec->authz_prefix = AUTHZ_PREFIX;
348 static apr_status_t authnz_ldap_cleanup_connection_close(void *param)
350 util_ldap_connection_t *ldc = param;
351 util_ldap_connection_close(ldc);
355 static int set_request_vars(request_rec *r, enum auth_ldap_phase phase) {
358 int remote_user_attribute_set = 0;
359 authn_ldap_request_t *req =
360 (authn_ldap_request_t *)ap_get_module_config(r->request_config, &authnz_ldap_module);
361 authn_ldap_config_t *sec =
362 (authn_ldap_config_t *)ap_get_module_config(r->per_dir_config, &authnz_ldap_module);
363 const char **vals = req->vals;
365 prefix = (phase == LDAP_AUTHN) ? AUTHN_PREFIX : sec->authz_prefix;
366 prefix_len = strlen(prefix);
368 if (sec->attributes && vals) {
369 apr_table_t *e = r->subprocess_env;
371 while (sec->attributes[i]) {
372 char *str = apr_pstrcat(r->pool, prefix, sec->attributes[i], NULL);
375 str[j] = apr_toupper(str[j]);
378 apr_table_setn(e, str, vals[i] ? vals[i] : "");
380 /* handle remote_user_attribute, if set */
381 if ((phase == LDAP_AUTHN) &&
382 sec->remote_user_attribute &&
383 !strcmp(sec->remote_user_attribute, sec->attributes[i])) {
384 r->user = (char *)apr_pstrdup(r->pool, vals[i]);
385 remote_user_attribute_set = 1;
390 return remote_user_attribute_set;
393 static const char *ldap_determine_binddn(request_rec *r, const char *user) {
394 authn_ldap_config_t *sec =
395 (authn_ldap_config_t *)ap_get_module_config(r->per_dir_config, &authnz_ldap_module);
396 const char *result = user;
397 ap_regmatch_t regm[AP_MAX_REG_MATCH];
399 if (NULL == user || NULL == sec || !sec->bind_regex || !sec->bind_subst) {
403 if (!ap_regexec(sec->bind_regex, user, AP_MAX_REG_MATCH, regm, 0)) {
404 char *substituted = ap_pregsub(r->pool, sec->bind_subst, user, AP_MAX_REG_MATCH, regm);
405 if (NULL != substituted) {
406 result = substituted;
410 apr_table_set(r->subprocess_env, "LDAP_BINDASUSER", result);
416 /* Some LDAP servers restrict who can search or compare, and the hard-coded ID
417 * might be good for the DN lookup but not for later operations.
419 static util_ldap_connection_t *get_connection_for_authz(request_rec *r, enum auth_ldap_optype type) {
420 authn_ldap_request_t *req =
421 (authn_ldap_request_t *)ap_get_module_config(r->request_config, &authnz_ldap_module);
422 authn_ldap_config_t *sec =
423 (authn_ldap_config_t *)ap_get_module_config(r->per_dir_config, &authnz_ldap_module);
425 char *binddn = sec->binddn;
426 char *bindpw = sec->bindpw;
428 /* If the per-request config isn't set, we didn't authenticate this user, and leave the default credentials */
429 if (req && req->password &&
430 ((type == LDAP_SEARCH && sec->search_as_user) ||
431 (type == LDAP_COMPARE && sec->compare_as_user) ||
432 (type == LDAP_COMPARE_AND_SEARCH && sec->compare_as_user && sec->search_as_user))){
434 bindpw = req->password;
437 return util_ldap_connection_find(r, sec->host, sec->port,
439 sec->deref, sec->secure);
442 * Authentication Phase
443 * --------------------
445 * This phase authenticates the credentials the user has sent with
446 * the request (ie the username and password are checked). This is done
447 * by making an attempt to bind to the LDAP server using this user's
448 * DN and the supplied password.
451 static authn_status authn_ldap_check_password(request_rec *r, const char *user,
452 const char *password)
454 char filtbuf[FILTER_LENGTH];
455 authn_ldap_config_t *sec =
456 (authn_ldap_config_t *)ap_get_module_config(r->per_dir_config, &authnz_ldap_module);
458 util_ldap_connection_t *ldc = NULL;
460 int remote_user_attribute_set = 0;
461 const char *dn = NULL;
462 const char *utfpassword;
464 authn_ldap_request_t *req =
465 (authn_ldap_request_t *)apr_pcalloc(r->pool, sizeof(authn_ldap_request_t));
466 ap_set_module_config(r->request_config, &authnz_ldap_module, req);
470 return AUTH_USER_NOT_FOUND;
475 * Basic sanity checks before any LDAP operations even happen.
477 if (!sec->have_ldap_url) {
478 return AUTH_GENERAL_ERROR;
481 /* There is a good AuthLDAPURL, right? */
483 const char *binddn = sec->binddn;
484 const char *bindpw = sec->bindpw;
485 if (sec->initial_bind_as_user) {
487 binddn = ldap_determine_binddn(r, user);
490 ldc = util_ldap_connection_find(r, sec->host, sec->port,
492 sec->deref, sec->secure);
495 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
496 "auth_ldap authenticate: no sec->host - weird...?");
497 return AUTH_GENERAL_ERROR;
500 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
501 "auth_ldap authenticate: using URL %s", sec->url);
503 /* Get the password that the client sent */
504 if (password == NULL) {
505 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
506 "auth_ldap authenticate: no password specified");
507 util_ldap_connection_close(ldc);
508 return AUTH_GENERAL_ERROR;
512 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
513 "auth_ldap authenticate: no user specified");
514 util_ldap_connection_close(ldc);
515 return AUTH_GENERAL_ERROR;
518 /* build the username filter */
519 authn_ldap_build_filter(filtbuf, r, user, NULL, sec);
521 ap_log_rerror(APLOG_MARK, APLOG_TRACE1, 0, r,
522 "auth_ldap authenticate: final authn filter is %s", filtbuf);
524 /* convert password to utf-8 */
525 utfpassword = authn_ldap_xlate_password(r, password);
527 /* do the user search */
528 result = util_ldap_cache_checkuserid(r, ldc, sec->url, sec->basedn, sec->scope,
529 sec->attributes, filtbuf, utfpassword,
531 util_ldap_connection_close(ldc);
533 /* handle bind failure */
534 if (result != LDAP_SUCCESS) {
535 if (!sec->bind_authoritative) {
536 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
537 "auth_ldap authenticate: user %s authentication failed; "
538 "URI %s [%s][%s] (not authoritative)",
539 user, r->uri, ldc->reason, ldap_err2string(result));
540 return AUTH_USER_NOT_FOUND;
543 ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
544 "auth_ldap authenticate: "
545 "user %s authentication failed; URI %s [%s][%s]",
546 user, r->uri, ldc->reason, ldap_err2string(result));
548 return (LDAP_NO_SUCH_OBJECT == result) ? AUTH_USER_NOT_FOUND
549 #ifdef LDAP_SECURITY_ERROR
550 : (LDAP_SECURITY_ERROR(result)) ? AUTH_DENIED
552 : (LDAP_INAPPROPRIATE_AUTH == result) ? AUTH_DENIED
553 : (LDAP_INVALID_CREDENTIALS == result) ? AUTH_DENIED
554 #ifdef LDAP_INSUFFICIENT_ACCESS
555 : (LDAP_INSUFFICIENT_ACCESS == result) ? AUTH_DENIED
557 #ifdef LDAP_INSUFFICIENT_RIGHTS
558 : (LDAP_INSUFFICIENT_RIGHTS == result) ? AUTH_DENIED
561 #ifdef LDAP_CONSTRAINT_VIOLATION
562 /* At least Sun Directory Server sends this if a user is
563 * locked. This is not covered by LDAP_SECURITY_ERROR.
565 : (LDAP_CONSTRAINT_VIOLATION == result) ? AUTH_DENIED
567 : AUTH_GENERAL_ERROR;
570 /* mark the user and DN */
571 req->dn = apr_pstrdup(r->pool, dn);
572 req->user = apr_pstrdup(r->pool, user);
573 req->password = apr_pstrdup(r->pool, password);
574 if (sec->user_is_dn) {
578 /* add environment variables */
579 remote_user_attribute_set = set_request_vars(r, LDAP_AUTHN);
582 if (sec->remote_user_attribute && !remote_user_attribute_set) {
583 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
584 "auth_ldap authenticate: "
585 "REMOTE_USER was to be set with attribute '%s', "
586 "but this attribute was not requested for in the "
587 "LDAP query for the user. REMOTE_USER will fall "
588 "back to username or DN as appropriate.",
589 sec->remote_user_attribute);
592 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
593 "auth_ldap authenticate: accepting %s", user);
598 static authz_status ldapuser_check_authorization(request_rec *r,
599 const char *require_args,
600 const void *parsed_require_args)
603 authn_ldap_request_t *req =
604 (authn_ldap_request_t *)ap_get_module_config(r->request_config, &authnz_ldap_module);
605 authn_ldap_config_t *sec =
606 (authn_ldap_config_t *)ap_get_module_config(r->per_dir_config, &authnz_ldap_module);
608 util_ldap_connection_t *ldc = NULL;
613 char filtbuf[FILTER_LENGTH];
614 const char *dn = NULL;
617 return AUTHZ_DENIED_NO_USER;
620 if (!sec->have_ldap_url) {
625 ldc = get_connection_for_authz(r, LDAP_COMPARE);
626 apr_pool_cleanup_register(r->pool, ldc,
627 authnz_ldap_cleanup_connection_close,
628 apr_pool_cleanup_null);
631 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
632 "auth_ldap authorize: no sec->host - weird...?");
637 * If we have been authenticated by some other module than mod_authnz_ldap,
638 * the req structure needed for authorization needs to be created
639 * and populated with the userid and DN of the account in LDAP
643 if (!strlen(r->user)) {
644 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
645 "ldap authorize: Userid is blank, AuthType=%s",
650 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
651 "ldap authorize: Creating LDAP req structure");
653 req = (authn_ldap_request_t *)apr_pcalloc(r->pool,
654 sizeof(authn_ldap_request_t));
656 /* Build the username filter */
657 authn_ldap_build_filter(filtbuf, r, r->user, NULL, sec);
659 /* Search for the user DN */
660 result = util_ldap_cache_getuserdn(r, ldc, sec->url, sec->basedn,
661 sec->scope, sec->attributes, filtbuf, &dn, &(req->vals));
663 /* Search failed, log error and return failure */
664 if(result != LDAP_SUCCESS) {
665 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
666 "auth_ldap authorise: User DN not found, %s", ldc->reason);
670 ap_set_module_config(r->request_config, &authnz_ldap_module, req);
671 req->dn = apr_pstrdup(r->pool, dn);
676 if (req->dn == NULL || strlen(req->dn) == 0) {
677 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
678 "auth_ldap authorize: require user: user's DN has not "
679 "been defined; failing authorization");
684 * First do a whole-line compare, in case it's something like
685 * require user Babs Jensen
687 result = util_ldap_cache_compare(r, ldc, sec->url, req->dn, sec->attribute, require_args);
689 case LDAP_COMPARE_TRUE: {
690 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
691 "auth_ldap authorize: require user: authorization "
693 set_request_vars(r, LDAP_AUTHZ);
694 return AUTHZ_GRANTED;
697 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
698 "auth_ldap authorize: require user: "
699 "authorization failed [%s][%s]",
700 ldc->reason, ldap_err2string(result));
705 * Now break apart the line and compare each word on it
708 while ((w = ap_getword_conf(r->pool, &t)) && w[0]) {
709 result = util_ldap_cache_compare(r, ldc, sec->url, req->dn, sec->attribute, w);
711 case LDAP_COMPARE_TRUE: {
712 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
713 "auth_ldap authorize: "
714 "require user: authorization successful");
715 set_request_vars(r, LDAP_AUTHZ);
716 return AUTHZ_GRANTED;
719 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
720 "auth_ldap authorize: "
721 "require user: authorization failed [%s][%s]",
722 ldc->reason, ldap_err2string(result));
727 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
728 "auth_ldap authorize user: authorization denied for "
735 static authz_status ldapgroup_check_authorization(request_rec *r,
736 const char *require_args,
737 const void *parsed_require_args)
740 authn_ldap_request_t *req =
741 (authn_ldap_request_t *)ap_get_module_config(r->request_config, &authnz_ldap_module);
742 authn_ldap_config_t *sec =
743 (authn_ldap_config_t *)ap_get_module_config(r->per_dir_config, &authnz_ldap_module);
745 util_ldap_connection_t *ldc = NULL;
749 char filtbuf[FILTER_LENGTH];
750 const char *dn = NULL;
751 struct mod_auth_ldap_groupattr_entry_t *ent;
755 return AUTHZ_DENIED_NO_USER;
758 if (!sec->have_ldap_url) {
763 ldc = get_connection_for_authz(r, LDAP_COMPARE); /* for the top-level group only */
764 apr_pool_cleanup_register(r->pool, ldc,
765 authnz_ldap_cleanup_connection_close,
766 apr_pool_cleanup_null);
769 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
770 "auth_ldap authorize: no sec->host - weird...?");
775 * If there are no elements in the group attribute array, the default should be
776 * member and uniquemember; populate the array now.
778 if (sec->groupattr->nelts == 0) {
779 struct mod_auth_ldap_groupattr_entry_t *grp;
781 apr_thread_mutex_lock(sec->lock);
783 grp = apr_array_push(sec->groupattr);
784 grp->name = "member";
785 grp = apr_array_push(sec->groupattr);
786 grp->name = "uniqueMember";
788 apr_thread_mutex_unlock(sec->lock);
793 * If there are no elements in the sub group classes array, the default
794 * should be groupOfNames and groupOfUniqueNames; populate the array now.
796 if (sec->subgroupclasses->nelts == 0) {
797 struct mod_auth_ldap_groupattr_entry_t *grp;
799 apr_thread_mutex_lock(sec->lock);
801 grp = apr_array_push(sec->subgroupclasses);
802 grp->name = "groupOfNames";
803 grp = apr_array_push(sec->subgroupclasses);
804 grp->name = "groupOfUniqueNames";
806 apr_thread_mutex_unlock(sec->lock);
811 * If we have been authenticated by some other module than mod_auth_ldap,
812 * the req structure needed for authorization needs to be created
813 * and populated with the userid and DN of the account in LDAP
816 if (!strlen(r->user)) {
817 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
818 "ldap authorize: Userid is blank, AuthType=%s",
823 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
824 "ldap authorize: Creating LDAP req structure");
826 req = (authn_ldap_request_t *)apr_pcalloc(r->pool,
827 sizeof(authn_ldap_request_t));
828 /* Build the username filter */
829 authn_ldap_build_filter(filtbuf, r, r->user, NULL, sec);
831 /* Search for the user DN */
832 result = util_ldap_cache_getuserdn(r, ldc, sec->url, sec->basedn,
833 sec->scope, sec->attributes, filtbuf, &dn, &(req->vals));
835 /* Search failed, log error and return failure */
836 if(result != LDAP_SUCCESS) {
837 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
838 "auth_ldap authorise: User DN not found, %s", ldc->reason);
842 ap_set_module_config(r->request_config, &authnz_ldap_module, req);
843 req->dn = apr_pstrdup(r->pool, dn);
847 ent = (struct mod_auth_ldap_groupattr_entry_t *) sec->groupattr->elts;
849 if (sec->group_attrib_is_dn) {
850 if (req->dn == NULL || strlen(req->dn) == 0) {
851 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
852 "auth_ldap authorize: require group: user's DN has "
853 "not been defined; failing authorization for user %s",
859 if (req->user == NULL || strlen(req->user) == 0) {
860 /* We weren't called in the authentication phase, so we didn't have a
861 * chance to set the user field. Do so now. */
868 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
869 "auth_ldap authorize: require group: testing for group "
870 "membership in \"%s\"",
873 for (i = 0; i < sec->groupattr->nelts; i++) {
874 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
875 "auth_ldap authorize: require group: testing for %s: "
878 sec->group_attrib_is_dn ? req->dn : req->user, t);
880 result = util_ldap_cache_compare(r, ldc, sec->url, t, ent[i].name,
881 sec->group_attrib_is_dn ? req->dn : req->user);
883 case LDAP_COMPARE_TRUE: {
884 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
885 "auth_ldap authorize: require group: "
886 "authorization successful (attribute %s) "
888 ent[i].name, ldc->reason, result,
889 ldap_err2string(result));
890 set_request_vars(r, LDAP_AUTHZ);
891 return AUTHZ_GRANTED;
893 case LDAP_NO_SUCH_ATTRIBUTE:
894 case LDAP_COMPARE_FALSE: {
895 /* nested groups need searches and compares, so grab a new handle */
896 authnz_ldap_cleanup_connection_close(ldc);
897 apr_pool_cleanup_kill(r->pool, ldc,authnz_ldap_cleanup_connection_close);
899 ldc = get_connection_for_authz(r, LDAP_COMPARE_AND_SEARCH);
900 apr_pool_cleanup_register(r->pool, ldc,
901 authnz_ldap_cleanup_connection_close,
902 apr_pool_cleanup_null);
904 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
905 "auth_ldap authorise: require group \"%s\": "
906 "failed [%s][%d - %s], checking sub-groups",
907 t, ldc->reason, result, ldap_err2string(result));
909 result = util_ldap_cache_check_subgroups(r, ldc, sec->url, t, ent[i].name,
910 sec->group_attrib_is_dn ? req->dn : req->user,
911 sec->sgAttributes[0] ? sec->sgAttributes : default_attributes,
912 sec->subgroupclasses,
913 0, sec->maxNestingDepth);
914 if(result == LDAP_COMPARE_TRUE) {
915 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
916 "auth_ldap authorise: require group "
917 "(sub-group): authorisation successful "
918 "(attribute %s) [%s][%d - %s]",
919 ent[i].name, ldc->reason, result,
920 ldap_err2string(result));
921 set_request_vars(r, LDAP_AUTHZ);
922 return AUTHZ_GRANTED;
925 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
926 "auth_ldap authorise: require group "
927 "(sub-group) \"%s\": authorisation failed "
929 t, ldc->reason, result,
930 ldap_err2string(result));
935 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
936 "auth_ldap authorize: require group \"%s\": "
937 "authorization failed [%s][%d - %s]",
938 t, ldc->reason, result, ldap_err2string(result));
943 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
944 "auth_ldap authorize group: authorization denied for "
951 static authz_status ldapdn_check_authorization(request_rec *r,
952 const char *require_args,
953 const void *parsed_require_args)
956 authn_ldap_request_t *req =
957 (authn_ldap_request_t *)ap_get_module_config(r->request_config, &authnz_ldap_module);
958 authn_ldap_config_t *sec =
959 (authn_ldap_config_t *)ap_get_module_config(r->per_dir_config, &authnz_ldap_module);
961 util_ldap_connection_t *ldc = NULL;
965 char filtbuf[FILTER_LENGTH];
966 const char *dn = NULL;
969 return AUTHZ_DENIED_NO_USER;
972 if (!sec->have_ldap_url) {
977 ldc = get_connection_for_authz(r, LDAP_SEARCH); /* _comparedn is a searche */
978 apr_pool_cleanup_register(r->pool, ldc,
979 authnz_ldap_cleanup_connection_close,
980 apr_pool_cleanup_null);
983 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
984 "auth_ldap authorize: no sec->host - weird...?");
989 * If we have been authenticated by some other module than mod_auth_ldap,
990 * the req structure needed for authorization needs to be created
991 * and populated with the userid and DN of the account in LDAP
994 if (!strlen(r->user)) {
995 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
996 "ldap authorize: Userid is blank, AuthType=%s",
1001 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1002 "ldap authorize: Creating LDAP req structure");
1004 req = (authn_ldap_request_t *)apr_pcalloc(r->pool,
1005 sizeof(authn_ldap_request_t));
1006 /* Build the username filter */
1007 authn_ldap_build_filter(filtbuf, r, r->user, NULL, sec);
1009 /* Search for the user DN */
1010 result = util_ldap_cache_getuserdn(r, ldc, sec->url, sec->basedn,
1011 sec->scope, sec->attributes, filtbuf, &dn, &(req->vals));
1013 /* Search failed, log error and return failure */
1014 if(result != LDAP_SUCCESS) {
1015 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1016 "auth_ldap authorise: User DN not found with filter %s: %s", filtbuf, ldc->reason);
1017 return AUTHZ_DENIED;
1020 ap_set_module_config(r->request_config, &authnz_ldap_module, req);
1021 req->dn = apr_pstrdup(r->pool, dn);
1022 req->user = r->user;
1027 if (req->dn == NULL || strlen(req->dn) == 0) {
1028 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1029 "auth_ldap authorize: require dn: user's DN has not "
1030 "been defined; failing authorization");
1031 return AUTHZ_DENIED;
1034 result = util_ldap_cache_comparedn(r, ldc, sec->url, req->dn, t, sec->compare_dn_on_server);
1036 case LDAP_COMPARE_TRUE: {
1037 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1038 "auth_ldap authorize: "
1039 "require dn: authorization successful");
1040 set_request_vars(r, LDAP_AUTHZ);
1041 return AUTHZ_GRANTED;
1044 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1045 "auth_ldap authorize: "
1046 "require dn \"%s\": LDAP error [%s][%s]",
1047 t, ldc->reason, ldap_err2string(result));
1052 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1053 "auth_ldap authorize dn: authorization denied for "
1057 return AUTHZ_DENIED;
1060 static authz_status ldapattribute_check_authorization(request_rec *r,
1061 const char *require_args,
1062 const void *parsed_require_args)
1065 authn_ldap_request_t *req =
1066 (authn_ldap_request_t *)ap_get_module_config(r->request_config, &authnz_ldap_module);
1067 authn_ldap_config_t *sec =
1068 (authn_ldap_config_t *)ap_get_module_config(r->per_dir_config, &authnz_ldap_module);
1070 util_ldap_connection_t *ldc = NULL;
1075 char filtbuf[FILTER_LENGTH];
1076 const char *dn = NULL;
1079 return AUTHZ_DENIED_NO_USER;
1082 if (!sec->have_ldap_url) {
1083 return AUTHZ_DENIED;
1087 ldc = get_connection_for_authz(r, LDAP_COMPARE);
1088 apr_pool_cleanup_register(r->pool, ldc,
1089 authnz_ldap_cleanup_connection_close,
1090 apr_pool_cleanup_null);
1093 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
1094 "auth_ldap authorize: no sec->host - weird...?");
1095 return AUTHZ_DENIED;
1099 * If we have been authenticated by some other module than mod_auth_ldap,
1100 * the req structure needed for authorization needs to be created
1101 * and populated with the userid and DN of the account in LDAP
1104 if (!strlen(r->user)) {
1105 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
1106 "ldap authorize: Userid is blank, AuthType=%s",
1111 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1112 "ldap authorize: Creating LDAP req structure");
1114 req = (authn_ldap_request_t *)apr_pcalloc(r->pool,
1115 sizeof(authn_ldap_request_t));
1116 /* Build the username filter */
1117 authn_ldap_build_filter(filtbuf, r, r->user, NULL, sec);
1119 /* Search for the user DN */
1120 result = util_ldap_cache_getuserdn(r, ldc, sec->url, sec->basedn,
1121 sec->scope, sec->attributes, filtbuf, &dn, &(req->vals));
1123 /* Search failed, log error and return failure */
1124 if(result != LDAP_SUCCESS) {
1125 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1126 "auth_ldap authorise: User DN not found with filter %s: %s", filtbuf, ldc->reason);
1127 return AUTHZ_DENIED;
1130 ap_set_module_config(r->request_config, &authnz_ldap_module, req);
1131 req->dn = apr_pstrdup(r->pool, dn);
1132 req->user = r->user;
1135 if (req->dn == NULL || strlen(req->dn) == 0) {
1136 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1137 "auth_ldap authorize: require ldap-attribute: user's DN "
1138 "has not been defined; failing authorization");
1139 return AUTHZ_DENIED;
1144 w = ap_getword(r->pool, &t, '=');
1145 value = ap_getword_conf(r->pool, &t);
1147 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1148 "auth_ldap authorize: checking attribute %s has value %s",
1150 result = util_ldap_cache_compare(r, ldc, sec->url, req->dn, w, value);
1152 case LDAP_COMPARE_TRUE: {
1153 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1154 "auth_ldap authorize: "
1155 "require attribute: authorization successful");
1156 set_request_vars(r, LDAP_AUTHZ);
1157 return AUTHZ_GRANTED;
1160 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1161 "auth_ldap authorize: require attribute: "
1162 "authorization failed [%s][%s]",
1163 ldc->reason, ldap_err2string(result));
1168 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1169 "auth_ldap authorize attribute: authorization denied for "
1173 return AUTHZ_DENIED;
1176 static authz_status ldapfilter_check_authorization(request_rec *r,
1177 const char *require_args,
1178 const void *parsed_require_args)
1181 authn_ldap_request_t *req =
1182 (authn_ldap_request_t *)ap_get_module_config(r->request_config, &authnz_ldap_module);
1183 authn_ldap_config_t *sec =
1184 (authn_ldap_config_t *)ap_get_module_config(r->per_dir_config, &authnz_ldap_module);
1186 util_ldap_connection_t *ldc = NULL;
1189 char filtbuf[FILTER_LENGTH];
1190 const char *dn = NULL;
1193 return AUTHZ_DENIED_NO_USER;
1196 if (!sec->have_ldap_url) {
1197 return AUTHZ_DENIED;
1201 ldc = get_connection_for_authz(r, LDAP_SEARCH);
1202 apr_pool_cleanup_register(r->pool, ldc,
1203 authnz_ldap_cleanup_connection_close,
1204 apr_pool_cleanup_null);
1207 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
1208 "auth_ldap authorize: no sec->host - weird...?");
1209 return AUTHZ_DENIED;
1213 * If we have been authenticated by some other module than mod_auth_ldap,
1214 * the req structure needed for authorization needs to be created
1215 * and populated with the userid and DN of the account in LDAP
1218 if (!strlen(r->user)) {
1219 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
1220 "ldap authorize: Userid is blank, AuthType=%s",
1225 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1226 "ldap authorize: Creating LDAP req structure");
1228 req = (authn_ldap_request_t *)apr_pcalloc(r->pool,
1229 sizeof(authn_ldap_request_t));
1230 /* Build the username filter */
1231 authn_ldap_build_filter(filtbuf, r, r->user, NULL, sec);
1233 /* Search for the user DN */
1234 result = util_ldap_cache_getuserdn(r, ldc, sec->url, sec->basedn,
1235 sec->scope, sec->attributes, filtbuf, &dn, &(req->vals));
1237 /* Search failed, log error and return failure */
1238 if(result != LDAP_SUCCESS) {
1239 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1240 "auth_ldap authorise: User DN not found with filter %s: %s", filtbuf, ldc->reason);
1241 return AUTHZ_DENIED;
1244 ap_set_module_config(r->request_config, &authnz_ldap_module, req);
1245 req->dn = apr_pstrdup(r->pool, dn);
1246 req->user = r->user;
1249 if (req->dn == NULL || strlen(req->dn) == 0) {
1250 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1251 "auth_ldap authorize: require ldap-filter: user's DN "
1252 "has not been defined; failing authorization");
1253 return AUTHZ_DENIED;
1259 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1260 "auth_ldap authorize: checking filter %s", t);
1262 /* Build the username filter */
1263 authn_ldap_build_filter(filtbuf, r, req->user, t, sec);
1265 /* Search for the user DN */
1266 result = util_ldap_cache_getuserdn(r, ldc, sec->url, sec->basedn,
1267 sec->scope, sec->attributes, filtbuf, &dn, &(req->vals));
1269 /* Make sure that the filtered search returned the correct user dn */
1270 if (result == LDAP_SUCCESS) {
1271 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1272 "auth_ldap authorize: checking dn match %s", dn);
1273 if (sec->compare_as_user) {
1274 /* ldap-filter is the only authz that requires a search and a compare */
1275 apr_pool_cleanup_kill(r->pool, ldc, authnz_ldap_cleanup_connection_close);
1276 authnz_ldap_cleanup_connection_close(ldc);
1277 ldc = get_connection_for_authz(r, LDAP_COMPARE);
1279 result = util_ldap_cache_comparedn(r, ldc, sec->url, req->dn, dn,
1280 sec->compare_dn_on_server);
1284 case LDAP_COMPARE_TRUE: {
1285 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1286 "auth_ldap authorize: require ldap-filter: "
1287 "authorization successful");
1288 set_request_vars(r, LDAP_AUTHZ);
1289 return AUTHZ_GRANTED;
1291 case LDAP_FILTER_ERROR: {
1292 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1293 "auth_ldap authorize: require ldap-filter: "
1294 "%s authorization failed [%s][%s]",
1295 filtbuf, ldc->reason, ldap_err2string(result));
1299 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1300 "auth_ldap authorize: require ldap-filter: "
1301 "authorization failed [%s][%s]",
1302 ldc->reason, ldap_err2string(result));
1307 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1308 "auth_ldap authorize filter: authorization denied for "
1312 return AUTHZ_DENIED;
1317 * Use the ldap url parsing routines to break up the ldap url into
1320 static const char *mod_auth_ldap_parse_url(cmd_parms *cmd,
1326 apr_ldap_url_desc_t *urld;
1327 apr_ldap_err_t *result;
1329 authn_ldap_config_t *sec = config;
1331 rc = apr_ldap_url_parse(cmd->pool, url, &(urld), &(result));
1332 if (rc != APR_SUCCESS) {
1333 return result->reason;
1335 sec->url = apr_pstrdup(cmd->pool, url);
1337 /* Set all the values, or at least some sane defaults */
1339 sec->host = apr_pstrcat(cmd->pool, urld->lud_host, " ", sec->host, NULL);
1342 sec->host = urld->lud_host? apr_pstrdup(cmd->pool, urld->lud_host) : "localhost";
1344 sec->basedn = urld->lud_dn? apr_pstrdup(cmd->pool, urld->lud_dn) : "";
1345 if (urld->lud_attrs && urld->lud_attrs[0]) {
1347 while (urld->lud_attrs[i]) {
1350 sec->attributes = apr_pcalloc(cmd->pool, sizeof(char *) * (i+1));
1352 while (urld->lud_attrs[i]) {
1353 sec->attributes[i] = apr_pstrdup(cmd->pool, urld->lud_attrs[i]);
1356 sec->attribute = sec->attributes[0];
1359 sec->attribute = "uid";
1362 sec->scope = urld->lud_scope == LDAP_SCOPE_ONELEVEL ?
1363 LDAP_SCOPE_ONELEVEL : LDAP_SCOPE_SUBTREE;
1365 if (urld->lud_filter) {
1366 if (urld->lud_filter[0] == '(') {
1368 * Get rid of the surrounding parens; later on when generating the
1369 * filter, they'll be put back.
1371 sec->filter = apr_pstrmemdup(cmd->pool, urld->lud_filter+1,
1372 strlen(urld->lud_filter)-2);
1375 sec->filter = apr_pstrdup(cmd->pool, urld->lud_filter);
1379 sec->filter = "objectclass=*";
1383 if (0 == strcasecmp("NONE", mode)) {
1384 sec->secure = APR_LDAP_NONE;
1386 else if (0 == strcasecmp("SSL", mode)) {
1387 sec->secure = APR_LDAP_SSL;
1389 else if (0 == strcasecmp("TLS", mode) || 0 == strcasecmp("STARTTLS", mode)) {
1390 sec->secure = APR_LDAP_STARTTLS;
1393 return "Invalid LDAP connection mode setting: must be one of NONE, "
1394 "SSL, or TLS/STARTTLS";
1398 /* "ldaps" indicates secure ldap connections desired
1400 if (strncasecmp(url, "ldaps", 5) == 0)
1402 sec->secure = APR_LDAP_SSL;
1403 sec->port = urld->lud_port? urld->lud_port : LDAPS_PORT;
1407 sec->port = urld->lud_port? urld->lud_port : LDAP_PORT;
1410 sec->have_ldap_url = 1;
1412 ap_log_error(APLOG_MARK, APLOG_TRACE1, 0, cmd->server,
1413 "auth_ldap url parse: `%s', Host: %s, Port: %d, DN: %s, "
1414 "attrib: %s, scope: %s, filter: %s, connection mode: %s",
1419 urld->lud_attrs? urld->lud_attrs[0] : "(null)",
1420 (urld->lud_scope == LDAP_SCOPE_SUBTREE? "subtree" :
1421 urld->lud_scope == LDAP_SCOPE_BASE? "base" :
1422 urld->lud_scope == LDAP_SCOPE_ONELEVEL? "onelevel" : "unknown"),
1424 sec->secure == APR_LDAP_SSL ? "using SSL": "not using SSL"
1430 static const char *mod_auth_ldap_set_deref(cmd_parms *cmd, void *config, const char *arg)
1432 authn_ldap_config_t *sec = config;
1434 if (strcmp(arg, "never") == 0 || strcasecmp(arg, "off") == 0) {
1437 else if (strcmp(arg, "searching") == 0) {
1438 sec->deref = searching;
1440 else if (strcmp(arg, "finding") == 0) {
1441 sec->deref = finding;
1443 else if (strcmp(arg, "always") == 0 || strcasecmp(arg, "on") == 0) {
1444 sec->deref = always;
1447 return "Unrecognized value for AuthLDAPAliasDereference directive";
1452 static const char *mod_auth_ldap_add_subgroup_attribute(cmd_parms *cmd, void *config, const char *arg)
1456 authn_ldap_config_t *sec = config;
1458 for (i = 0; sec->sgAttributes[i]; i++) {
1461 if (i == GROUPATTR_MAX_ELTS)
1462 return "Too many AuthLDAPSubGroupAttribute values";
1464 sec->sgAttributes[i] = apr_pstrdup(cmd->pool, arg);
1469 static const char *mod_auth_ldap_add_subgroup_class(cmd_parms *cmd, void *config, const char *arg)
1471 struct mod_auth_ldap_groupattr_entry_t *new;
1473 authn_ldap_config_t *sec = config;
1475 if (sec->subgroupclasses->nelts > GROUPATTR_MAX_ELTS)
1476 return "Too many AuthLDAPSubGroupClass values";
1478 new = apr_array_push(sec->subgroupclasses);
1479 new->name = apr_pstrdup(cmd->pool, arg);
1484 static const char *mod_auth_ldap_set_subgroup_maxdepth(cmd_parms *cmd,
1486 const char *max_depth)
1488 authn_ldap_config_t *sec = config;
1490 sec->maxNestingDepth = atol(max_depth);
1495 static const char *mod_auth_ldap_add_group_attribute(cmd_parms *cmd, void *config, const char *arg)
1497 struct mod_auth_ldap_groupattr_entry_t *new;
1499 authn_ldap_config_t *sec = config;
1501 if (sec->groupattr->nelts > GROUPATTR_MAX_ELTS)
1502 return "Too many AuthLDAPGroupAttribute directives";
1504 new = apr_array_push(sec->groupattr);
1505 new->name = apr_pstrdup(cmd->pool, arg);
1510 static const char *set_charset_config(cmd_parms *cmd, void *config, const char *arg)
1512 ap_set_module_config(cmd->server->module_config, &authnz_ldap_module,
1517 static const char *set_bind_pattern(cmd_parms *cmd, void *_cfg, const char *exp, const char *subst)
1519 authn_ldap_config_t *sec = _cfg;
1522 regexp = ap_pregcomp(cmd->pool, exp, AP_REG_EXTENDED);
1525 return apr_pstrcat(cmd->pool, "AuthLDAPInitialBindPattern: cannot compile regular "
1526 "expression '", exp, "'", NULL);
1529 sec->bind_regex = regexp;
1530 sec->bind_subst = apr_pstrdup(cmd->pool, subst);
1535 static const command_rec authnz_ldap_cmds[] =
1537 AP_INIT_TAKE12("AuthLDAPURL", mod_auth_ldap_parse_url, NULL, OR_AUTHCFG,
1538 "URL to define LDAP connection. This should be an RFC 2255 compliant\n"
1539 "URL of the form ldap://host[:port]/basedn[?attrib[?scope[?filter]]].\n"
1541 "<li>Host is the name of the LDAP server. Use a space separated list of hosts \n"
1542 "to specify redundant servers.\n"
1543 "<li>Port is optional, and specifies the port to connect to.\n"
1544 "<li>basedn specifies the base DN to start searches from\n"
1545 "<li>Attrib specifies what attribute to search for in the directory. If not "
1546 "provided, it defaults to <b>uid</b>.\n"
1547 "<li>Scope is the scope of the search, and can be either <b>sub</b> or "
1548 "<b>one</b>. If not provided, the default is <b>sub</b>.\n"
1549 "<li>Filter is a filter to use in the search. If not provided, "
1550 "defaults to <b>(objectClass=*)</b>.\n"
1552 "Searches are performed using the attribute and the filter combined. "
1553 "For example, assume that the\n"
1554 "LDAP URL is <b>ldap://ldap.airius.com/ou=People, o=Airius?uid?sub?(posixid=*)</b>. "
1556 "be done using the filter <b>(&((posixid=*))(uid=<i>username</i>))</b>, "
1557 "where <i>username</i>\n"
1558 "is the user name passed by the HTTP client. The search will be a subtree "
1559 "search on the branch <b>ou=People, o=Airius</b>."),
1561 AP_INIT_TAKE1("AuthLDAPBindDN", ap_set_string_slot,
1562 (void *)APR_OFFSETOF(authn_ldap_config_t, binddn), OR_AUTHCFG,
1563 "DN to use to bind to LDAP server. If not provided, will do an anonymous bind."),
1565 AP_INIT_TAKE1("AuthLDAPBindPassword", ap_set_string_slot,
1566 (void *)APR_OFFSETOF(authn_ldap_config_t, bindpw), OR_AUTHCFG,
1567 "Password to use to bind to LDAP server. If not provided, will do an anonymous bind."),
1569 AP_INIT_FLAG("AuthLDAPBindAuthoritative", ap_set_flag_slot,
1570 (void *)APR_OFFSETOF(authn_ldap_config_t, bind_authoritative), OR_AUTHCFG,
1571 "Set to 'on' to return failures when user-specific bind fails - defaults to on."),
1573 AP_INIT_FLAG("AuthLDAPRemoteUserIsDN", ap_set_flag_slot,
1574 (void *)APR_OFFSETOF(authn_ldap_config_t, user_is_dn), OR_AUTHCFG,
1575 "Set to 'on' to set the REMOTE_USER environment variable to be the full "
1576 "DN of the remote user. By default, this is set to off, meaning that "
1577 "the REMOTE_USER variable will contain whatever value the remote user sent."),
1579 AP_INIT_TAKE1("AuthLDAPRemoteUserAttribute", ap_set_string_slot,
1580 (void *)APR_OFFSETOF(authn_ldap_config_t, remote_user_attribute), OR_AUTHCFG,
1581 "Override the user supplied username and place the "
1582 "contents of this attribute in the REMOTE_USER "
1583 "environment variable."),
1585 AP_INIT_FLAG("AuthLDAPCompareDNOnServer", ap_set_flag_slot,
1586 (void *)APR_OFFSETOF(authn_ldap_config_t, compare_dn_on_server), OR_AUTHCFG,
1587 "Set to 'on' to force auth_ldap to do DN compares (for the \"require dn\" "
1588 "directive) using the server, and set it 'off' to do the compares locally "
1589 "(at the expense of possible false matches). See the documentation for "
1590 "a complete description of this option."),
1592 AP_INIT_ITERATE("AuthLDAPSubGroupAttribute", mod_auth_ldap_add_subgroup_attribute, NULL, OR_AUTHCFG,
1593 "Attribute labels used to define sub-group (or nested group) membership in groups - "
1594 "defaults to member and uniqueMember"),
1596 AP_INIT_ITERATE("AuthLDAPSubGroupClass", mod_auth_ldap_add_subgroup_class, NULL, OR_AUTHCFG,
1597 "LDAP objectClass values used to identify sub-group instances - "
1598 "defaults to groupOfNames and groupOfUniqueNames"),
1600 AP_INIT_TAKE1("AuthLDAPMaxSubGroupDepth", mod_auth_ldap_set_subgroup_maxdepth, NULL, OR_AUTHCFG,
1601 "Maximum subgroup nesting depth to be evaluated - defaults to 10 (top-level group = 0)"),
1603 AP_INIT_ITERATE("AuthLDAPGroupAttribute", mod_auth_ldap_add_group_attribute, NULL, OR_AUTHCFG,
1604 "A list of attribute labels used to identify the user members of groups - defaults to "
1605 "member and uniquemember"),
1607 AP_INIT_FLAG("AuthLDAPGroupAttributeIsDN", ap_set_flag_slot,
1608 (void *)APR_OFFSETOF(authn_ldap_config_t, group_attrib_is_dn), OR_AUTHCFG,
1609 "If set to 'on', auth_ldap uses the DN that is retrieved from the server for"
1610 "subsequent group comparisons. If set to 'off', auth_ldap uses the string"
1611 "provided by the client directly. Defaults to 'on'."),
1613 AP_INIT_TAKE1("AuthLDAPDereferenceAliases", mod_auth_ldap_set_deref, NULL, OR_AUTHCFG,
1614 "Determines how aliases are handled during a search. Can be one of the"
1615 "values \"never\", \"searching\", \"finding\", or \"always\". "
1616 "Defaults to always."),
1618 AP_INIT_TAKE1("AuthLDAPCharsetConfig", set_charset_config, NULL, RSRC_CONF,
1619 "Character set conversion configuration file. If omitted, character set"
1620 "conversion is disabled."),
1622 AP_INIT_TAKE1("AuthLDAPAuthorizePrefix", ap_set_string_slot,
1623 (void *)APR_OFFSETOF(authn_ldap_config_t, authz_prefix), OR_AUTHCFG,
1624 "The prefix to add to environment variables set during "
1625 "successful authorization, default '" AUTHZ_PREFIX "'"),
1627 AP_INIT_FLAG("AuthLDAPInitialBindAsUser", ap_set_flag_slot,
1628 (void *)APR_OFFSETOF(authn_ldap_config_t, initial_bind_as_user), OR_AUTHCFG,
1629 "Set to 'on' to perform the initial DN lookup with the basic auth credentials "
1630 "instead of anonymous or hard-coded credentials"),
1632 AP_INIT_TAKE2("AuthLDAPInitialBindPattern", set_bind_pattern, NULL, OR_AUTHCFG,
1633 "The regex and substitution to determine a username that can bind based on an HTTP basic auth username"),
1635 AP_INIT_FLAG("AuthLDAPSearchAsUser", ap_set_flag_slot,
1636 (void *)APR_OFFSETOF(authn_ldap_config_t, search_as_user), OR_AUTHCFG,
1637 "Set to 'on' to perform authorization-based searches with the users credentials, when this module"
1638 " has also performed authentication. Does not affect nested groups lookup."),
1639 AP_INIT_FLAG("AuthLDAPCompareAsUser", ap_set_flag_slot,
1640 (void *)APR_OFFSETOF(authn_ldap_config_t, compare_as_user), OR_AUTHCFG,
1641 "Set to 'on' to perform authorization-based compares with the users credentials, when this module"
1642 " has also performed authentication. Does not affect nested groups lookups."),
1646 static int authnz_ldap_post_config(apr_pool_t *p, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s)
1649 char l[MAX_STRING_LEN];
1650 const char *charset_confname = ap_get_module_config(s->module_config,
1651 &authnz_ldap_module);
1652 apr_status_t status;
1655 authn_ldap_config_t *sec = (authn_ldap_config_t *)
1656 ap_get_module_config(s->module_config,
1657 &authnz_ldap_module);
1661 if (!util_ldap_ssl_supported(s))
1663 ap_log_error(APLOG_MARK, APLOG_CRIT, 0, s,
1664 "LDAP: SSL connections (ldaps://) not supported by utilLDAP");
1670 /* make sure that mod_ldap (util_ldap) is loaded */
1671 if (ap_find_linked_module("util_ldap.c") == NULL) {
1672 ap_log_error(APLOG_MARK, APLOG_ERR, 0, s,
1673 "Module mod_ldap missing. Mod_ldap (aka. util_ldap) "
1674 "must be loaded in order for mod_authnz_ldap to function properly");
1675 return HTTP_INTERNAL_SERVER_ERROR;
1679 if (!charset_confname) {
1683 charset_confname = ap_server_root_relative(p, charset_confname);
1684 if (!charset_confname) {
1685 ap_log_error(APLOG_MARK, APLOG_ERR, APR_EBADPATH, s,
1686 "Invalid charset conversion config path %s",
1687 (const char *)ap_get_module_config(s->module_config,
1688 &authnz_ldap_module));
1689 return HTTP_INTERNAL_SERVER_ERROR;
1691 if ((status = ap_pcfg_openfile(&f, ptemp, charset_confname))
1693 ap_log_error(APLOG_MARK, APLOG_ERR, status, s,
1694 "could not open charset conversion config file %s.",
1696 return HTTP_INTERNAL_SERVER_ERROR;
1699 charset_conversions = apr_hash_make(p);
1701 while (!(ap_cfg_getline(l, MAX_STRING_LEN, f))) {
1708 lang = ap_getword_conf(p, &ll);
1709 ap_str_tolower(lang);
1712 char *charset = ap_getword_conf(p, &ll);
1713 apr_hash_set(charset_conversions, lang, APR_HASH_KEY_STRING, charset);
1716 ap_cfg_closefile(f);
1718 to_charset = derive_codepage_from_lang (p, "utf-8");
1719 if (to_charset == NULL) {
1720 ap_log_error(APLOG_MARK, APLOG_ERR, status, s,
1721 "could not find the UTF-8 charset in the file %s.",
1723 return HTTP_INTERNAL_SERVER_ERROR;
1729 static const authn_provider authn_ldap_provider =
1731 &authn_ldap_check_password,
1734 static const authz_provider authz_ldapuser_provider =
1736 &ldapuser_check_authorization,
1739 static const authz_provider authz_ldapgroup_provider =
1741 &ldapgroup_check_authorization,
1745 static const authz_provider authz_ldapdn_provider =
1747 &ldapdn_check_authorization,
1751 static const authz_provider authz_ldapattribute_provider =
1753 &ldapattribute_check_authorization,
1757 static const authz_provider authz_ldapfilter_provider =
1759 &ldapfilter_check_authorization,
1763 static void ImportULDAPOptFn(void)
1765 util_ldap_connection_close = APR_RETRIEVE_OPTIONAL_FN(uldap_connection_close);
1766 util_ldap_connection_find = APR_RETRIEVE_OPTIONAL_FN(uldap_connection_find);
1767 util_ldap_cache_comparedn = APR_RETRIEVE_OPTIONAL_FN(uldap_cache_comparedn);
1768 util_ldap_cache_compare = APR_RETRIEVE_OPTIONAL_FN(uldap_cache_compare);
1769 util_ldap_cache_checkuserid = APR_RETRIEVE_OPTIONAL_FN(uldap_cache_checkuserid);
1770 util_ldap_cache_getuserdn = APR_RETRIEVE_OPTIONAL_FN(uldap_cache_getuserdn);
1771 util_ldap_ssl_supported = APR_RETRIEVE_OPTIONAL_FN(uldap_ssl_supported);
1772 util_ldap_cache_check_subgroups = APR_RETRIEVE_OPTIONAL_FN(uldap_cache_check_subgroups);
1775 static void register_hooks(apr_pool_t *p)
1777 /* Register authn provider */
1778 ap_register_auth_provider(p, AUTHN_PROVIDER_GROUP, "ldap",
1779 AUTHN_PROVIDER_VERSION,
1780 &authn_ldap_provider, AP_AUTH_INTERNAL_PER_CONF);
1782 /* Register authz providers */
1783 ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "ldap-user",
1784 AUTHZ_PROVIDER_VERSION,
1785 &authz_ldapuser_provider,
1786 AP_AUTH_INTERNAL_PER_CONF);
1787 ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "ldap-group",
1788 AUTHZ_PROVIDER_VERSION,
1789 &authz_ldapgroup_provider,
1790 AP_AUTH_INTERNAL_PER_CONF);
1791 ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "ldap-dn",
1792 AUTHZ_PROVIDER_VERSION,
1793 &authz_ldapdn_provider,
1794 AP_AUTH_INTERNAL_PER_CONF);
1795 ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "ldap-attribute",
1796 AUTHZ_PROVIDER_VERSION,
1797 &authz_ldapattribute_provider,
1798 AP_AUTH_INTERNAL_PER_CONF);
1799 ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "ldap-filter",
1800 AUTHZ_PROVIDER_VERSION,
1801 &authz_ldapfilter_provider,
1802 AP_AUTH_INTERNAL_PER_CONF);
1804 ap_hook_post_config(authnz_ldap_post_config,NULL,NULL,APR_HOOK_MIDDLE);
1806 ap_hook_optional_fn_retrieve(ImportULDAPOptFn,NULL,NULL,APR_HOOK_MIDDLE);
1809 AP_DECLARE_MODULE(authnz_ldap) =
1811 STANDARD20_MODULE_STUFF,
1812 create_authnz_ldap_dir_config, /* dir config creater */
1813 NULL, /* dir merger --- default is to override */
1814 NULL, /* server config */
1815 NULL, /* merge server config */
1816 authnz_ldap_cmds, /* command apr_table_t */
1817 register_hooks /* register hooks */