]> andersk Git - mod-vhost-ldap.git/blobdiff - mod_vhost_ldap.c
Add NEWS file
[mod-vhost-ldap.git] / mod_vhost_ldap.c
index cdfe89ca2e3fc7047762ed54574c85793493a4c4..cf89f8407fab47dfa0993c29cf114064ccbd66ba 100644 (file)
 #include "http_core.h"
 #include "http_log.h"
 #include "http_request.h"
+#include "apr_version.h"
 #include "apr_ldap.h"
 #include "apr_strings.h"
 #include "apr_reslist.h"
 #include "util_ldap.h"
 
-#ifndef APU_HAS_LDAP
+#if !defined(APU_HAS_LDAP) && !defined(APR_HAS_LDAP)
 #error mod_vhost_ldap requires APR-util to have LDAP support built in
 #endif
 
@@ -49,6 +50,8 @@
 #define MIN_UID 100
 #define MIN_GID 100
 
+#define MAX_FAILURES 5
+
 module AP_MODULE_DECLARE_DATA vhost_ldap_module;
 
 typedef enum {
@@ -88,11 +91,65 @@ typedef struct mod_vhost_ldap_request_t {
     char *cgiroot;                     /* ScriptAlias */
     char *uid;                         /* Suexec Uid */
     char *gid;                         /* Suexec Gid */
+    char *saved_docroot;                /* Saved DocumentRoot */
 } mod_vhost_ldap_request_t;
 
 char *attributes[] =
   { "apacheServerName", "apacheDocumentRoot", "apacheScriptAlias", "apacheSuexecUid", "apacheSuexecGid", "apacheServerAdmin", 0 };
 
+#if (APR_MAJOR_VERSION >= 1)
+static APR_OPTIONAL_FN_TYPE(uldap_connection_close) *util_ldap_connection_close;
+static APR_OPTIONAL_FN_TYPE(uldap_connection_find) *util_ldap_connection_find;
+static APR_OPTIONAL_FN_TYPE(uldap_cache_comparedn) *util_ldap_cache_comparedn;
+static APR_OPTIONAL_FN_TYPE(uldap_cache_compare) *util_ldap_cache_compare;
+static APR_OPTIONAL_FN_TYPE(uldap_cache_checkuserid) *util_ldap_cache_checkuserid;
+static APR_OPTIONAL_FN_TYPE(uldap_cache_getuserdn) *util_ldap_cache_getuserdn;
+static APR_OPTIONAL_FN_TYPE(uldap_ssl_supported) *util_ldap_ssl_supported;
+
+static void ImportULDAPOptFn(void)
+{
+    util_ldap_connection_close  = APR_RETRIEVE_OPTIONAL_FN(uldap_connection_close);
+    util_ldap_connection_find   = APR_RETRIEVE_OPTIONAL_FN(uldap_connection_find);
+    util_ldap_cache_comparedn   = APR_RETRIEVE_OPTIONAL_FN(uldap_cache_comparedn);
+    util_ldap_cache_compare     = APR_RETRIEVE_OPTIONAL_FN(uldap_cache_compare);
+    util_ldap_cache_checkuserid = APR_RETRIEVE_OPTIONAL_FN(uldap_cache_checkuserid);
+    util_ldap_cache_getuserdn   = APR_RETRIEVE_OPTIONAL_FN(uldap_cache_getuserdn);
+    util_ldap_ssl_supported     = APR_RETRIEVE_OPTIONAL_FN(uldap_ssl_supported);
+}
+#endif 
+
+/* Taken from server/core.c */
+static int set_document_root(request_rec *r, const char *arg)
+{
+    void *sconf = r->server->module_config;
+    core_server_config *conf = ap_get_module_config(sconf, &core_module);
+
+    /* Make it absolute, relative to ServerRoot */
+    arg = ap_server_root_relative(r->pool, arg);
+
+    if (arg == NULL) {
+        ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r, 
+                      "[mod_vhost_ldap.c] set_document_root: DocumentRoot [%s] must be a directory",
+                     arg);
+
+        return HTTP_INTERNAL_SERVER_ERROR;
+    }
+
+    /* TODO: ap_configtestonly && ap_docrootcheck && */
+    if (apr_filepath_merge((char**)&conf->ap_document_root, NULL, arg,
+                           APR_FILEPATH_TRUENAME, r->pool) != APR_SUCCESS
+        || !ap_is_directory(r->pool, arg)) {
+
+        ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0,
+                     r,
+                     "[mod_vhost_ldap.c] set_document_root: Warning: DocumentRoot [%s] does not exist",
+                     arg);
+        conf->ap_document_root = arg;
+    }
+    return OK;
+}
+
+
 static int mod_vhost_ldap_post_config(apr_pool_t *p, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s)
 {
     /* make sure that mod_ldap (util_ldap) is loaded */
@@ -185,6 +242,9 @@ static const char *mod_vhost_ldap_parse_url(cmd_parms *cmd,
 {
     int result;
     apr_ldap_url_desc_t *urld;
+#if (APR_MAJOR_VERSION >= 1)
+    apr_ldap_err_t *result_err;
+#endif
 
     mod_vhost_ldap_config_t *conf =
        (mod_vhost_ldap_config_t *)ap_get_module_config(cmd->server->module_config,
@@ -193,22 +253,29 @@ static const char *mod_vhost_ldap_parse_url(cmd_parms *cmd,
     ap_log_error(APLOG_MARK, APLOG_DEBUG|APLOG_NOERRNO, 0,
                 cmd->server, "[mod_vhost_ldap.c] url parse: `%s'", 
                 url);
-
+    
+#if (APR_MAJOR_VERSION >= 1)    /* for apache >= 2.2 */
+    result = apr_ldap_url_parse(cmd->pool, url, &(urld), &(result_err));
+    if (result != LDAP_SUCCESS) {
+        return result_err->reason;
+    }
+#else
     result = apr_ldap_url_parse(url, &(urld));
     if (result != LDAP_SUCCESS) {
         switch (result) {
-        case LDAP_URL_ERR_NOTLDAP:
-            return "LDAP URL does not begin with ldap://";
-        case LDAP_URL_ERR_NODN:
-            return "LDAP URL does not have a DN";
-        case LDAP_URL_ERR_BADSCOPE:
-            return "LDAP URL has an invalid scope";
-        case LDAP_URL_ERR_MEM:
-            return "Out of memory parsing LDAP URL";
-        default:
-            return "Could not parse LDAP URL";
+            case LDAP_URL_ERR_NOTLDAP:
+                return "LDAP URL does not begin with ldap://";
+            case LDAP_URL_ERR_NODN:
+                return "LDAP URL does not have a DN";
+            case LDAP_URL_ERR_BADSCOPE:
+                return "LDAP URL has an invalid scope";
+            case LDAP_URL_ERR_MEM:
+                return "Out of memory parsing LDAP URL";
+            default:
+                return "Could not parse LDAP URL";
         }
     }
+#endif
     conf->url = apr_pstrdup(cmd->pool, url);
 
     ap_log_error(APLOG_MARK, APLOG_DEBUG|APLOG_NOERRNO, 0,
@@ -278,7 +345,9 @@ static const char *mod_vhost_ldap_parse_url(cmd_parms *cmd,
     }
 
     conf->have_ldap_url = 1;
+#if (APR_MAJOR_VERSION < 1) /* free only required for older apr */
     apr_ldap_free_urldesc(urld);
+#endif
     return NULL;
 }
 
@@ -395,17 +464,19 @@ static int mod_vhost_ldap_translate_name(request_rec *r)
     char filtbuf[FILTER_LENGTH];
     mod_vhost_ldap_config_t *conf =
        (mod_vhost_ldap_config_t *)ap_get_module_config(r->server->module_config, &vhost_ldap_module);
-    core_server_config * core =
-       (core_server_config *) ap_get_module_config(r->server->module_config, &core_module);
     util_ldap_connection_t *ldc = NULL;
     int result = 0;
     const char *dn = NULL;
     char *cgi;
     const char *hostname = NULL;
     int is_fallback = 0;
+    int sleep0 = 0;
+    int sleep1 = 1;
+    int sleep;
 
     reqc =
        (mod_vhost_ldap_request_t *)apr_pcalloc(r->pool, sizeof(mod_vhost_ldap_request_t));
+    memset(reqc, 0, sizeof(mod_vhost_ldap_request_t)); 
 
     ap_set_module_config(r->request_config, &vhost_ldap_module, reqc);
 
@@ -424,7 +495,7 @@ start_over:
     else {
         ap_log_rerror(APLOG_MARK, APLOG_WARNING|APLOG_NOERRNO, 0, r, 
                       "[mod_vhost_ldap.c] translate: no conf->host - weird...?");
-        return DECLINED;
+        return HTTP_INTERNAL_SERVER_ERROR;
     }
 
     hostname = r->hostname;
@@ -432,7 +503,7 @@ start_over:
 fallback:
 
     ap_log_rerror(APLOG_MARK, APLOG_DEBUG|APLOG_NOERRNO, 0, r,
-                  "[mod_vhost_ldap.c]: translating %s", r->uri);
+                 "[mod_vhost_ldap.c]: translating hostname [%s], uri [%s]", hostname, r->uri);
 
     apr_snprintf(filtbuf, FILTER_LENGTH, "(&(%s)(|(apacheServerName=%s)(apacheServerAlias=%s)))", conf->filter, hostname, hostname);
 
@@ -442,13 +513,24 @@ fallback:
     util_ldap_connection_close(ldc);
 
     /* sanity check - if server is down, retry it up to 5 times */
-    if (result == LDAP_SERVER_DOWN) {
-        if (failures++ <= 5) {
+    if (AP_LDAP_IS_SERVER_DOWN(result) ||
+       (result == LDAP_TIMEOUT) ||
+       (result == LDAP_CONNECT_ERROR)) {
+        sleep = sleep0 + sleep1;
+        ap_log_rerror(APLOG_MARK, APLOG_WARNING|APLOG_NOERRNO, 0, r,
+                     "[mod_vhost_ldap.c]: lookup failure, retry number #[%d], sleeping for [%d] seconds", failures, sleep);
+        if (failures++ < MAX_FAILURES) {
+           /* Back-off exponentially */
+           apr_sleep(apr_time_from_sec(sleep));
+           sleep0 = sleep1;
+           sleep1 = sleep;
             goto start_over;
-        }
+        } else {
+           return HTTP_GATEWAY_TIME_OUT;
+       }
     }
 
-    if ((result == LDAP_NO_SUCH_OBJECT)) {
+    if (result == LDAP_NO_SUCH_OBJECT) {
        if (conf->fallback && (is_fallback++ <= 0)) {
            ap_log_rerror(APLOG_MARK, APLOG_NOTICE|APLOG_NOERRNO, 0, r,
                          "[mod_vhost_ldap.c] translate: "
@@ -463,7 +545,7 @@ fallback:
                      "virtual host %s not found",
                      hostname);
 
-       return DECLINED;
+       return HTTP_BAD_REQUEST;
     }
 
     /* handle bind failure */
@@ -472,7 +554,7 @@ fallback:
                       "[mod_vhost_ldap.c] translate: "
                       "translate failed; virtual host %s; URI %s [%s]",
                      hostname, r->uri, ldap_err2string(result));
-       return DECLINED;
+       return HTTP_INTERNAL_SERVER_ERROR;
     }
 
     /* mark the user and DN */
@@ -519,7 +601,7 @@ fallback:
         ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, 0, r, 
                       "[mod_vhost_ldap.c] translate: "
                       "translate failed; ServerName or DocumentRoot not defined");
-       return DECLINED;
+       return HTTP_INTERNAL_SERVER_ERROR;
     }
 
     cgi = NULL;
@@ -531,31 +613,54 @@ fallback:
        }
     }
     if (cgi) {
-       r->filename = apr_pstrcat (r->pool, reqc->cgiroot, cgi + strlen("cgi-bin"), NULL);
-       r->handler = "cgi-script";
-       apr_table_setn(r->notes, "alias-forced-type", r->handler);
+        /* Set exact filename for CGI script */
+        cgi = apr_pstrcat(r->pool, reqc->cgiroot, cgi + strlen("cgi-bin"), NULL);
+        if ((cgi = ap_server_root_relative(r->pool, cgi))) {
+         ap_log_rerror(APLOG_MARK, APLOG_DEBUG|APLOG_NOERRNO, 0, r,
+                       "[mod_vhost_ldap.c]: ap_document_root is: %s", ap_document_root(r));
+         r->filename = cgi;
+         r->handler = "cgi-script";
+         apr_table_setn(r->notes, "alias-forced-type", r->handler);
+       }
     } else if (r->uri[0] == '/') {
-       r->filename = apr_pstrcat (r->pool, reqc->docroot, r->uri, NULL);
+        /* we don't set r->filename here, and let other modules do it
+         * this allows other modules (mod_rewrite.c) to work as usual
+        */
+        /* r->filename = apr_pstrcat (r->pool, reqc->docroot, r->uri, NULL); */
     } else {
+        /* We don't handle non-file requests here */
        return DECLINED;
     }
 
-    r->server->server_hostname = apr_pstrdup (top->pool, reqc->name);
+    top->server->server_hostname = apr_pstrdup (top->pool, reqc->name);
 
     if (reqc->admin) {
-       r->server->server_admin = apr_pstrdup (top->pool, reqc->admin);
+       top->server->server_admin = apr_pstrdup (top->pool, reqc->admin);
+    }
+
+    reqc->saved_docroot = apr_pstrdup(top->pool, ap_document_root(r));
+
+    result = set_document_root(r, reqc->docroot);
+    if (result != OK) {
+        return HTTP_INTERNAL_SERVER_ERROR;
     }
 
     // set environment variables
     e = top->subprocess_env;
-    apr_table_addn (e, "SERVER_ROOT", reqc->docroot);
+    apr_table_addn(e, "DOCUMENT_ROOT", reqc->docroot);
 
-    core->ap_document_root = apr_pstrdup(top->pool, reqc->docroot);
+    /* Hack to allow post-processing by other modules (mod_rewrite, mod_alias) */
+    return DECLINED;
+}
 
-    ap_log_rerror(APLOG_MARK, APLOG_DEBUG|APLOG_NOERRNO, 0, r,
-                 "[mod_vhost_ldap.c]: translated to %s", r->filename);
+static int mod_vhost_ldap_cleanup(request_rec * r)
+{
+    mod_vhost_ldap_request_t *reqc =
+      (mod_vhost_ldap_request_t *)ap_get_module_config(r->request_config,
+                                                      &vhost_ldap_module);
 
-    return OK;
+    /* Set ap_document_root back to saved value */
+    return set_document_root(r, reqc->saved_docroot);
 }
 
 #ifdef HAVE_UNIX_SUEXEC
@@ -603,11 +708,21 @@ static ap_unix_identity_t *mod_vhost_ldap_get_suexec_id_doer(const request_rec *
 static void
 mod_vhost_ldap_register_hooks (apr_pool_t * p)
 {
+
+    /*
+     * Run before mod_rewrite
+     */
+    static const char * const aszRewrite[]={ "mod_rewrite.c", NULL };
+
     ap_hook_post_config(mod_vhost_ldap_post_config, NULL, NULL, APR_HOOK_MIDDLE);
-    ap_hook_translate_name(mod_vhost_ldap_translate_name, NULL, NULL, APR_HOOK_MIDDLE);
+    ap_hook_translate_name(mod_vhost_ldap_translate_name, NULL, aszRewrite, APR_HOOK_FIRST);
+    ap_hook_fixups(mod_vhost_ldap_cleanup, aszRewrite, NULL, APR_HOOK_MIDDLE);
 #ifdef HAVE_UNIX_SUEXEC
     ap_hook_get_suexec_identity(mod_vhost_ldap_get_suexec_id_doer, NULL, NULL, APR_HOOK_MIDDLE);
 #endif
+#if (APR_MAJOR_VERSION >= 1)
+    ap_hook_optional_fn_retrieve(ImportULDAPOptFn,NULL,NULL,APR_HOOK_MIDDLE);
+#endif
 }
 
 module AP_MODULE_DECLARE_DATA vhost_ldap_module = {
This page took 0.636212 seconds and 4 git commands to generate.