modules/aaa/mod_authn_dbd.c

/* Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "ap_provider.h"
#include "httpd.h"
#include "http_config.h"
#include "http_log.h"
#include "apr_lib.h"
#include "apr_dbd.h"
#include "mod_dbd.h"
#include "apr_strings.h"
#include "mod_auth.h"
#include "apr_md5.h"
#include "apu_version.h"

module AP_MODULE_DECLARE_DATA authn_dbd_module;

typedef struct {
    const char *user;
    const char *realm;
} authn_dbd_conf;
typedef struct {
    const char *label;
    const char *query;
} authn_dbd_rec;

/* optional function - look it up once in post_config */
static ap_dbd_t *(*authn_dbd_acquire_fn)(request_rec*) = NULL;
static void (*authn_dbd_prepare_fn)(server_rec*, const char*, const char*) = NULL;

static void *authn_dbd_cr_conf(apr_pool_t *pool, char *dummy)
{
    authn_dbd_conf *ret = apr_pcalloc(pool, sizeof(authn_dbd_conf));
    return ret;
}
static void *authn_dbd_merge_conf(apr_pool_t *pool, void *BASE, void *ADD)
{
    authn_dbd_conf *add = ADD;
    authn_dbd_conf *base = BASE;
    authn_dbd_conf *ret = apr_palloc(pool, sizeof(authn_dbd_conf));
    ret->user = (add->user == NULL) ? base->user : add->user;
    ret->realm = (add->realm == NULL) ? base->realm : add->realm;
    return ret;
}
static const char *authn_dbd_prepare(cmd_parms *cmd, void *cfg, const char *query)
{
    static unsigned int label_num = 0;
    char *label;

    if (authn_dbd_prepare_fn == NULL) {
        authn_dbd_prepare_fn = APR_RETRIEVE_OPTIONAL_FN(ap_dbd_prepare);
        if (authn_dbd_prepare_fn == NULL) {
            return "You must load mod_dbd to enable AuthDBD functions";
        }
        authn_dbd_acquire_fn = APR_RETRIEVE_OPTIONAL_FN(ap_dbd_acquire);
    }
    label = apr_psprintf(cmd->pool, "authn_dbd_%d", ++label_num);

    authn_dbd_prepare_fn(cmd->server, query, label);

    /* save the label here for our own use */
    return ap_set_string_slot(cmd, cfg, label);
}
static const command_rec authn_dbd_cmds[] =
{
    AP_INIT_TAKE1("AuthDBDUserPWQuery", authn_dbd_prepare,
                  (void *)APR_OFFSETOF(authn_dbd_conf, user), ACCESS_CONF,
                  "Query used to fetch password for user"),
    AP_INIT_TAKE1("AuthDBDUserRealmQuery", authn_dbd_prepare,
                  (void *)APR_OFFSETOF(authn_dbd_conf, realm), ACCESS_CONF,
                  "Query used to fetch password for user+realm"),
    {NULL}
};
static authn_status authn_dbd_password(request_rec *r, const char *user,
                                       const char *password)
{
    apr_status_t rv;
    const char *dbd_password = NULL;
    apr_dbd_prepared_t *statement;
    apr_dbd_results_t *res = NULL;
    apr_dbd_row_t *row = NULL;

    authn_dbd_conf *conf = ap_get_module_config(r->per_dir_config,
                                                &authn_dbd_module);
    ap_dbd_t *dbd = authn_dbd_acquire_fn(r);
    if (dbd == NULL) {
        ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
                      "Failed to acquire database connection to look up "
                      "user '%s'", user);
        return AUTH_GENERAL_ERROR;
    }

    if (conf->user == NULL) {
        ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
                      "No AuthDBDUserPWQuery has been specified");
        return AUTH_GENERAL_ERROR;
    }

    statement = apr_hash_get(dbd->prepared, conf->user, APR_HASH_KEY_STRING);
    if (statement == NULL) {
        ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
                      "A prepared statement could not be found for "
                      "AuthDBDUserPWQuery with the key '%s'", conf->user);
        return AUTH_GENERAL_ERROR;
    }
    if (apr_dbd_pvselect(dbd->driver, r->pool, dbd->handle, &res, statement,
                              0, user, NULL) != 0) {
        ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
                      "Query execution error looking up '%s' "
                      "in database", user);
        return AUTH_GENERAL_ERROR;
    }
    for (rv = apr_dbd_get_row(dbd->driver, r->pool, res, &row, -1);
         rv != -1;
         rv = apr_dbd_get_row(dbd->driver, r->pool, res, &row, -1)) {
        if (rv != 0) {
            ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r,
                          "Error retrieving results while looking up '%s' "
                          "in database", user);
            return AUTH_GENERAL_ERROR;
        }
        if (dbd_password == NULL) {
#if APU_MAJOR_VERSION > 1 || (APU_MAJOR_VERSION == 1 && APU_MINOR_VERSION >= 3)
            /* add the rest of the columns to the environment */
            int i = 1;
            const char *name;
            for (name = apr_dbd_get_name(dbd->driver, res, i);
                 name != NULL;
                 name = apr_dbd_get_name(dbd->driver, res, i)) {

                char *str = apr_pstrcat(r->pool, AUTHN_PREFIX,
                                        name,
                                        NULL);
                int j = sizeof(AUTHN_PREFIX)-1; /* string length of "AUTHENTICATE_", excluding the trailing NIL */
                while (str[j]) {
                    if (!apr_isalnum(str[j])) {
                        str[j] = '_';
                    }
                    else {
                        str[j] = apr_toupper(str[j]);
                    }
                    j++;
                }
                apr_table_set(r->subprocess_env, str,
                              apr_dbd_get_entry(dbd->driver, row, i));
                i++;
            }
#endif
            dbd_password = apr_dbd_get_entry(dbd->driver, row, 0);
        }
        /* we can't break out here or row won't get cleaned up */
    }

    if (!dbd_password) {
        return AUTH_USER_NOT_FOUND;
    }

    rv = apr_password_validate(password, dbd_password);

    if (rv != APR_SUCCESS) {
        return AUTH_DENIED;
    }

    return AUTH_GRANTED;
}
static authn_status authn_dbd_realm(request_rec *r, const char *user,
                                    const char *realm, char **rethash)
{
    apr_status_t rv;
    const char *dbd_hash = NULL;
    apr_dbd_prepared_t *statement;
    apr_dbd_results_t *res = NULL;
    apr_dbd_row_t *row = NULL;

    authn_dbd_conf *conf = ap_get_module_config(r->per_dir_config,
                                                &authn_dbd_module);
    ap_dbd_t *dbd = authn_dbd_acquire_fn(r);
    if (dbd == NULL) {
        ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
                      "Failed to acquire database connection to look up "
                      "user '%s:%s'", user, realm);
        return AUTH_GENERAL_ERROR;
    }
    if (conf->realm == NULL) {
        ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
                      "No AuthDBDUserRealmQuery has been specified");
        return AUTH_GENERAL_ERROR;
    }
    statement = apr_hash_get(dbd->prepared, conf->realm, APR_HASH_KEY_STRING);
    if (statement == NULL) {
        ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
                      "A prepared statement could not be found for "
                      "AuthDBDUserRealmQuery with the key '%s'", conf->realm);
        return AUTH_GENERAL_ERROR;
    }
    if (apr_dbd_pvselect(dbd->driver, r->pool, dbd->handle, &res, statement,
                              0, user, realm, NULL) != 0) {
        ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
                      "Query execution error looking up '%s:%s' "
                      "in database", user, realm);
        return AUTH_GENERAL_ERROR;
    }
    for (rv = apr_dbd_get_row(dbd->driver, r->pool, res, &row, -1);
         rv != -1;
         rv = apr_dbd_get_row(dbd->driver, r->pool, res, &row, -1)) {
        if (rv != 0) {
            ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r,
                          "Error retrieving results while looking up '%s:%s' "
                          "in database", user, realm);
            return AUTH_GENERAL_ERROR;
        }
        if (dbd_hash == NULL) {
#if APU_MAJOR_VERSION > 1 || (APU_MAJOR_VERSION == 1 && APU_MINOR_VERSION >= 3)
            /* add the rest of the columns to the environment */
            int i = 1;
            const char *name;
            for (name = apr_dbd_get_name(dbd->driver, res, i);
                 name != NULL;
                 name = apr_dbd_get_name(dbd->driver, res, i)) {

                char *str = apr_pstrcat(r->pool, AUTHN_PREFIX,
                                        name,
                                        NULL);
                int j = sizeof(AUTHN_PREFIX)-1; /* string length of "AUTHENTICATE_", excluding the trailing NIL */
                while (str[j]) {
                    if (!apr_isalnum(str[j])) {
                        str[j] = '_';
                    }
                    else {
                        str[j] = apr_toupper(str[j]);
                    }
                    j++;
                }
                apr_table_set(r->subprocess_env, str,
                              apr_dbd_get_entry(dbd->driver, row, i));
                i++;
            }
#endif
            dbd_hash = apr_dbd_get_entry(dbd->driver, row, 0);
        }
        /* we can't break out here or row won't get cleaned up */
    }

    if (!dbd_hash) {
        return AUTH_USER_NOT_FOUND;
    }

    *rethash = apr_pstrdup(r->pool, dbd_hash);
    return AUTH_USER_FOUND;
}
static void authn_dbd_hooks(apr_pool_t *p)
{
    static const authn_provider authn_dbd_provider = {
        &authn_dbd_password,
        &authn_dbd_realm
    };

    ap_register_provider(p, AUTHN_PROVIDER_GROUP, "dbd", "0", &authn_dbd_provider);
}
module AP_MODULE_DECLARE_DATA authn_dbd_module =
{
    STANDARD20_MODULE_STUFF,
    authn_dbd_cr_conf,
    authn_dbd_merge_conf,
    NULL,
    NULL,
    authn_dbd_cmds,
    authn_dbd_hooks
};
1	fielding	420983	/* 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
7	niq	321247	*
8			* http://www.apache.org/licenses/LICENSE-2.0
9			*
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.
15			*/
16
17			#include "ap_provider.h"
18			#include "httpd.h"
19			#include "http_config.h"
20			#include "http_log.h"
21	minfrin	466865	#include "apr_lib.h"
22	niq	321247	#include "apr_dbd.h"
23			#include "mod_dbd.h"
24			#include "apr_strings.h"
25			#include "mod_auth.h"
26			#include "apr_md5.h"
27	minfrin	466865	#include "apu_version.h"
28	niq	321247
29			module AP_MODULE_DECLARE_DATA authn_dbd_module;
30
31			typedef struct {
32			const char *user;
33			const char *realm;
34			} authn_dbd_conf;
35			typedef struct {
36			const char *label;
37			const char *query;
38			} authn_dbd_rec;
39
40			/* optional function - look it up once in post_config */
41			static ap_dbd_t (authn_dbd_acquire_fn)(request_rec*) = NULL;
42			static void (authn_dbd_prepare_fn)(server_rec, const char, const char) = NULL;
43
44			static void authn_dbd_cr_conf(apr_pool_t pool, char *dummy)
45			{
46			authn_dbd_conf *ret = apr_pcalloc(pool, sizeof(authn_dbd_conf));
47			return ret;
48			}
49			static void authn_dbd_merge_conf(apr_pool_t pool, void BASE, void ADD)
50			{
51			authn_dbd_conf *add = ADD;
52			authn_dbd_conf *base = BASE;
53			authn_dbd_conf *ret = apr_palloc(pool, sizeof(authn_dbd_conf));
54			ret->user = (add->user == NULL) ? base->user : add->user;
55			ret->realm = (add->realm == NULL) ? base->realm : add->realm;
56			return ret;
57			}
58			static const char authn_dbd_prepare(cmd_parms cmd, void cfg, const char query)
59			{
60			static unsigned int label_num = 0;
61			char *label;
62
63			if (authn_dbd_prepare_fn == NULL) {
64			authn_dbd_prepare_fn = APR_RETRIEVE_OPTIONAL_FN(ap_dbd_prepare);
65			if (authn_dbd_prepare_fn == NULL) {
66			return "You must load mod_dbd to enable AuthDBD functions";
67			}
68			authn_dbd_acquire_fn = APR_RETRIEVE_OPTIONAL_FN(ap_dbd_acquire);
69			}
70			label = apr_psprintf(cmd->pool, "authn_dbd_%d", ++label_num);
71
72			authn_dbd_prepare_fn(cmd->server, query, label);
73
74			/* save the label here for our own use */
75	niq	344349	return ap_set_string_slot(cmd, cfg, label);
76	niq	321247	}
77			static const command_rec authn_dbd_cmds[] =
78			{
79			AP_INIT_TAKE1("AuthDBDUserPWQuery", authn_dbd_prepare,
80	niq	329497	(void *)APR_OFFSETOF(authn_dbd_conf, user), ACCESS_CONF,
81	niq	321247	"Query used to fetch password for user"),
82	niq	329497	AP_INIT_TAKE1("AuthDBDUserRealmQuery", authn_dbd_prepare,
83			(void *)APR_OFFSETOF(authn_dbd_conf, realm), ACCESS_CONF,
84	niq	321247	"Query used to fetch password for user+realm"),
85			{NULL}
86			};
87			static authn_status authn_dbd_password(request_rec r, const char user,
88			const char *password)
89			{
90			apr_status_t rv;
91			const char *dbd_password = NULL;
92			apr_dbd_prepared_t *statement;
93			apr_dbd_results_t *res = NULL;
94			apr_dbd_row_t *row = NULL;
95
96			authn_dbd_conf *conf = ap_get_module_config(r->per_dir_config,
97			&authn_dbd_module);
98			ap_dbd_t *dbd = authn_dbd_acquire_fn(r);
99			if (dbd == NULL) {
100			ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
101	chrisd	639079	"Failed to acquire database connection to look up "
102			"user '%s'", user);
103	niq	321247	return AUTH_GENERAL_ERROR;
104			}
105
106			if (conf->user == NULL) {
107	chrisd	639079	ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
108			"No AuthDBDUserPWQuery has been specified");
109	niq	321247	return AUTH_GENERAL_ERROR;
110			}
111
112			statement = apr_hash_get(dbd->prepared, conf->user, APR_HASH_KEY_STRING);
113			if (statement == NULL) {
114	chrisd	639079	ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
115			"A prepared statement could not be found for "
116			"AuthDBDUserPWQuery with the key '%s'", conf->user);
117	niq	321247	return AUTH_GENERAL_ERROR;
118			}
119			if (apr_dbd_pvselect(dbd->driver, r->pool, dbd->handle, &res, statement,
120			0, user, NULL) != 0) {
121			ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
122	chrisd	639079	"Query execution error looking up '%s' "
123			"in database", user);
124	niq	321247	return AUTH_GENERAL_ERROR;
125			}
126			for (rv = apr_dbd_get_row(dbd->driver, r->pool, res, &row, -1);
127			rv != -1;
128			rv = apr_dbd_get_row(dbd->driver, r->pool, res, &row, -1)) {
129			if (rv != 0) {
130			ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r,
131	chrisd	639079	"Error retrieving results while looking up '%s' "
132			"in database", user);
133	niq	321247	return AUTH_GENERAL_ERROR;
134			}
135			if (dbd_password == NULL) {
136	minfrin	466865	#if APU_MAJOR_VERSION > 1 \|\| (APU_MAJOR_VERSION == 1 && APU_MINOR_VERSION >= 3)
137			/* add the rest of the columns to the environment */
138			int i = 1;
139			const char *name;
140			for (name = apr_dbd_get_name(dbd->driver, res, i);
141			name != NULL;
142			name = apr_dbd_get_name(dbd->driver, res, i)) {
143
144			char *str = apr_pstrcat(r->pool, AUTHN_PREFIX,
145			name,
146			NULL);
147	minfrin	571798	int j = sizeof(AUTHN_PREFIX)-1; /* string length of "AUTHENTICATE_", excluding the trailing NIL */
148	minfrin	466865	while (str[j]) {
149			if (!apr_isalnum(str[j])) {
150			str[j] = '_';
151			}
152			else {
153			str[j] = apr_toupper(str[j]);
154			}
155			j++;
156			}
157	niq	586765	apr_table_set(r->subprocess_env, str,
158			apr_dbd_get_entry(dbd->driver, row, i));
159	minfrin	466865	i++;
160			}
161			#endif
162	bnicholes	468042	dbd_password = apr_dbd_get_entry(dbd->driver, row, 0);
163	niq	321247	}
164	niq	329497	/* we can't break out here or row won't get cleaned up */
165	niq	321247	}
166
167			if (!dbd_password) {
168			return AUTH_USER_NOT_FOUND;
169			}
170
171			rv = apr_password_validate(password, dbd_password);
172
173			if (rv != APR_SUCCESS) {
174			return AUTH_DENIED;
175			}
176
177			return AUTH_GRANTED;
178			}
179			static authn_status authn_dbd_realm(request_rec r, const char user,
180			const char realm, char *rethash)
181			{
182			apr_status_t rv;
183			const char *dbd_hash = NULL;
184			apr_dbd_prepared_t *statement;
185			apr_dbd_results_t *res = NULL;
186			apr_dbd_row_t *row = NULL;
187
188			authn_dbd_conf *conf = ap_get_module_config(r->per_dir_config,
189			&authn_dbd_module);
190			ap_dbd_t *dbd = authn_dbd_acquire_fn(r);
191			if (dbd == NULL) {
192			ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
193	chrisd	639079	"Failed to acquire database connection to look up "
194			"user '%s:%s'", user, realm);
195	niq	321247	return AUTH_GENERAL_ERROR;
196			}
197			if (conf->realm == NULL) {
198	chrisd	639079	ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
199			"No AuthDBDUserRealmQuery has been specified");
200	niq	321247	return AUTH_GENERAL_ERROR;
201			}
202			statement = apr_hash_get(dbd->prepared, conf->realm, APR_HASH_KEY_STRING);
203			if (statement == NULL) {
204	chrisd	639079	ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
205			"A prepared statement could not be found for "
206			"AuthDBDUserRealmQuery with the key '%s'", conf->realm);
207	niq	321247	return AUTH_GENERAL_ERROR;
208			}
209			if (apr_dbd_pvselect(dbd->driver, r->pool, dbd->handle, &res, statement,
210			0, user, realm, NULL) != 0) {
211			ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
212	chrisd	639079	"Query execution error looking up '%s:%s' "
213			"in database", user, realm);
214	niq	321247	return AUTH_GENERAL_ERROR;
215			}
216			for (rv = apr_dbd_get_row(dbd->driver, r->pool, res, &row, -1);
217			rv != -1;
218			rv = apr_dbd_get_row(dbd->driver, r->pool, res, &row, -1)) {
219			if (rv != 0) {
220			ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r,
221	chrisd	639079	"Error retrieving results while looking up '%s:%s' "
222			"in database", user, realm);
223	niq	321247	return AUTH_GENERAL_ERROR;
224			}
225			if (dbd_hash == NULL) {
226	minfrin	466865	#if APU_MAJOR_VERSION > 1 \|\| (APU_MAJOR_VERSION == 1 && APU_MINOR_VERSION >= 3)
227			/* add the rest of the columns to the environment */
228			int i = 1;
229			const char *name;
230			for (name = apr_dbd_get_name(dbd->driver, res, i);
231			name != NULL;
232			name = apr_dbd_get_name(dbd->driver, res, i)) {
233
234			char *str = apr_pstrcat(r->pool, AUTHN_PREFIX,
235			name,
236			NULL);
237	minfrin	571798	int j = sizeof(AUTHN_PREFIX)-1; /* string length of "AUTHENTICATE_", excluding the trailing NIL */
238	minfrin	466865	while (str[j]) {
239			if (!apr_isalnum(str[j])) {
240			str[j] = '_';
241			}
242			else {
243			str[j] = apr_toupper(str[j]);
244			}
245			j++;
246			}
247	niq	586765	apr_table_set(r->subprocess_env, str,
248			apr_dbd_get_entry(dbd->driver, row, i));
249	minfrin	466865	i++;
250			}
251			#endif
252	bnicholes	468042	dbd_hash = apr_dbd_get_entry(dbd->driver, row, 0);
253	niq	321247	}
254	niq	329497	/* we can't break out here or row won't get cleaned up */
255	niq	321247	}
256
257			if (!dbd_hash) {
258			return AUTH_USER_NOT_FOUND;
259			}
260
261			*rethash = apr_pstrdup(r->pool, dbd_hash);
262			return AUTH_USER_FOUND;
263			}
264			static void authn_dbd_hooks(apr_pool_t *p)
265			{
266			static const authn_provider authn_dbd_provider = {
267			&authn_dbd_password,
268			&authn_dbd_realm
269			};
270	jim	332306
271	niq	321247	ap_register_provider(p, AUTHN_PROVIDER_GROUP, "dbd", "0", &authn_dbd_provider);
272			}
273			module AP_MODULE_DECLARE_DATA authn_dbd_module =
274			{
275			STANDARD20_MODULE_STUFF,
276			authn_dbd_cr_conf,
277			authn_dbd_merge_conf,
278			NULL,
279			NULL,
280			authn_dbd_cmds,
281			authn_dbd_hooks
282			};