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 #include "http_config.h"
20 #include "ap_provider.h"
21 #include "http_request.h"
22 #include "http_protocol.h"
23 #include "http_core.h"
26 #include "apr_strings.h"
27 #include "mod_authz_dbd.h"
32 module AP_MODULE_DECLARE_DATA authz_dbd_module;
34 /* Export a hook for modules that manage clientside sessions
35 * (e.g. mod_auth_cookie)
36 * to deal with those when we successfully login/logout at the server
38 * XXX: WHY would this be specific to dbd_authz? Why wouldn't we track
39 * this across all authz user providers in a lower level mod, such as
40 * mod_auth_basic/digest?
42 APR_IMPLEMENT_OPTIONAL_HOOK_RUN_ALL(authz_dbd, AUTHZ_DBD, int, client_login,
43 (request_rec *r, int code, const char *action),
44 (r, code, action), OK, DECLINED)
49 const char *redir_query;
53 static ap_dbd_t *(*dbd_handle)(request_rec*) = NULL;
54 static void (*dbd_prepare)(server_rec*, const char*, const char*) = NULL;
56 static const char *const noerror = "???";
58 static void *authz_dbd_cr_cfg(apr_pool_t *pool, char *dummy)
60 authz_dbd_cfg *ret = apr_pcalloc(pool, sizeof(authz_dbd_cfg));
64 static void *authz_dbd_merge_cfg(apr_pool_t *pool, void *BASE, void *ADD)
66 authz_dbd_cfg *base = BASE;
67 authz_dbd_cfg *add = ADD;
68 authz_dbd_cfg *ret = apr_palloc(pool, sizeof(authz_dbd_cfg));
70 ret->query = (add->query == NULL) ? base->query : add->query;
71 ret->redir_query = (add->redir_query == NULL)
72 ? base->redir_query : add->redir_query;
73 ret->redirect = (add->redirect == -1) ? base->redirect : add->redirect;
76 static const char *authz_dbd_prepare(cmd_parms *cmd, void *cfg,
79 static unsigned int label_num = 0;
81 const char *err = ap_check_cmd_context(cmd, NOT_IN_HTACCESS);
85 if (dbd_prepare == NULL) {
86 dbd_prepare = APR_RETRIEVE_OPTIONAL_FN(ap_dbd_prepare);
87 if (dbd_prepare == NULL) {
88 return "You must load mod_dbd to enable AuthzDBD functions";
90 dbd_handle = APR_RETRIEVE_OPTIONAL_FN(ap_dbd_acquire);
92 label = apr_psprintf(cmd->pool, "authz_dbd_%d", ++label_num);
94 dbd_prepare(cmd->server, query, label);
96 /* save the label here for our own use */
97 return ap_set_string_slot(cmd, cfg, label);
99 static const command_rec authz_dbd_cmds[] = {
100 AP_INIT_FLAG("AuthzDBDLoginToReferer", ap_set_flag_slot,
101 (void*)APR_OFFSETOF(authz_dbd_cfg, redirect), ACCESS_CONF,
102 "Whether to redirect to referer on successful login"),
103 AP_INIT_TAKE1("AuthzDBDQuery", authz_dbd_prepare,
104 (void*)APR_OFFSETOF(authz_dbd_cfg, query), ACCESS_CONF,
105 "SQL query for DBD Authz or login"),
106 AP_INIT_TAKE1("AuthzDBDRedirectQuery", authz_dbd_prepare,
107 (void*)APR_OFFSETOF(authz_dbd_cfg, redir_query), ACCESS_CONF,
108 "SQL query to get per-user redirect URL after login"),
112 static int authz_dbd_login(request_rec *r, authz_dbd_cfg *cfg,
116 const char *newuri = NULL;
119 ap_dbd_t *dbd = dbd_handle(r);
120 apr_dbd_prepared_t *query;
121 apr_dbd_results_t *res = NULL;
122 apr_dbd_row_t *row = NULL;
124 if (cfg->query == NULL) {
125 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01642)
126 "No query configured for %s!", action);
127 return HTTP_INTERNAL_SERVER_ERROR;
130 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(02902)
131 "No db handle available for %s! "
132 "Check your database access",
134 return HTTP_INTERNAL_SERVER_ERROR;
136 query = apr_hash_get(dbd->prepared, cfg->query, APR_HASH_KEY_STRING);
138 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01643)
139 "Error retrieving Query for %s!", action);
140 return HTTP_INTERNAL_SERVER_ERROR;
143 rv = apr_dbd_pvquery(dbd->driver, r->pool, dbd->handle, &nrows,
144 query, r->user, NULL);
147 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r, APLOGNO(01644)
148 "authz_dbd: %s of user %s updated %d rows",
149 action, r->user, nrows);
153 message = apr_dbd_error(dbd->driver, dbd->handle, rv);
154 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01645)
155 "authz_dbd: query for %s failed; user %s [%s]",
156 action, r->user, message?message:noerror);
157 return HTTP_INTERNAL_SERVER_ERROR;
160 if (cfg->redirect == 1) {
161 newuri = apr_table_get(r->headers_in, "Referer");
164 if (!newuri && cfg->redir_query) {
165 query = apr_hash_get(dbd->prepared, cfg->redir_query,
166 APR_HASH_KEY_STRING);
168 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01646)
169 "authz_dbd: no redirect query!");
170 /* OK, this is non-critical; we can just not-redirect */
172 else if ((rv = apr_dbd_pvselect(dbd->driver, r->pool, dbd->handle,
173 &res, query, 0, r->user, NULL)) == 0) {
174 for (rv = apr_dbd_get_row(dbd->driver, r->pool, res, &row, -1);
176 rv = apr_dbd_get_row(dbd->driver, r->pool, res, &row, -1)) {
178 message = apr_dbd_error(dbd->driver, dbd->handle, rv);
179 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01647)
180 "authz_dbd in get_row; action=%s user=%s [%s]",
181 action, r->user, message?message:noerror);
183 else if (newuri == NULL) {
186 apr_dbd_get_entry(dbd->driver, row, 0));
188 /* we can't break out here or row won't get cleaned up */
192 message = apr_dbd_error(dbd->driver, dbd->handle, rv);
193 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01648)
194 "authz_dbd/redirect for %s of %s [%s]",
195 action, r->user, message?message:noerror);
198 if (newuri != NULL) {
199 r->status = HTTP_MOVED_TEMPORARILY;
200 apr_table_set(r->err_headers_out, "Location", newuri);
202 authz_dbd_run_client_login(r, OK, action);
206 static int authz_dbd_group_query(request_rec *r, authz_dbd_cfg *cfg,
207 apr_array_header_t *groups)
209 /* SELECT group FROM authz WHERE user = %s */
212 ap_dbd_t *dbd = dbd_handle(r);
213 apr_dbd_prepared_t *query;
214 apr_dbd_results_t *res = NULL;
215 apr_dbd_row_t *row = NULL;
217 if (cfg->query == NULL) {
218 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01649)
219 "No query configured for dbd-group!");
220 return HTTP_INTERNAL_SERVER_ERROR;
223 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(02903)
224 "No db handle available for dbd-query! "
225 "Check your database access");
226 return HTTP_INTERNAL_SERVER_ERROR;
228 query = apr_hash_get(dbd->prepared, cfg->query, APR_HASH_KEY_STRING);
230 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01650)
231 "Error retrieving query for dbd-group!");
232 return HTTP_INTERNAL_SERVER_ERROR;
234 rv = apr_dbd_pvselect(dbd->driver, r->pool, dbd->handle, &res,
235 query, 0, r->user, NULL);
237 for (rv = apr_dbd_get_row(dbd->driver, r->pool, res, &row, -1);
239 rv = apr_dbd_get_row(dbd->driver, r->pool, res, &row, -1)) {
241 APR_ARRAY_PUSH(groups, const char *) =
243 apr_dbd_get_entry(dbd->driver, row, 0));
246 message = apr_dbd_error(dbd->driver, dbd->handle, rv);
247 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01651)
248 "authz_dbd in get_row; group query for user=%s [%s]",
249 r->user, message?message:noerror);
250 return HTTP_INTERNAL_SERVER_ERROR;
255 message = apr_dbd_error(dbd->driver, dbd->handle, rv);
256 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01652)
257 "authz_dbd, in groups query for %s [%s]",
258 r->user, message?message:noerror);
259 return HTTP_INTERNAL_SERVER_ERROR;
264 static authz_status dbdgroup_check_authorization(request_rec *r,
265 const char *require_args,
266 const void *parsed_require_args)
270 apr_array_header_t *groups = NULL;
272 const char *err = NULL;
273 const ap_expr_info_t *expr = parsed_require_args;
277 authz_dbd_cfg *cfg = ap_get_module_config(r->per_dir_config,
281 return AUTHZ_DENIED_NO_USER;
284 if (groups == NULL) {
285 groups = apr_array_make(r->pool, 4, sizeof(const char*));
286 rv = authz_dbd_group_query(r, cfg, groups);
288 return AUTHZ_GENERAL_ERROR;
292 require = ap_expr_str_exec(r, expr, &err);
294 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(02590)
295 "authz_dbd authorize: require dbd-group: Can't "
296 "evaluate require expression: %s", err);
302 w = ap_getword_white(r->pool, &t);
303 for (i=0; i < groups->nelts; ++i) {
304 if (!strcmp(w, ((const char**)groups->elts)[i])) {
305 return AUTHZ_GRANTED;
313 static authz_status dbdlogin_check_authorization(request_rec *r,
314 const char *require_args,
315 const void *parsed_require_args)
317 authz_dbd_cfg *cfg = ap_get_module_config(r->per_dir_config,
321 return AUTHZ_DENIED_NO_USER;
324 return (authz_dbd_login(r, cfg, "login") == OK ? AUTHZ_GRANTED : AUTHZ_DENIED);
327 static authz_status dbdlogout_check_authorization(request_rec *r,
328 const char *require_args,
329 const void *parsed_require_args)
331 authz_dbd_cfg *cfg = ap_get_module_config(r->per_dir_config,
335 return AUTHZ_DENIED_NO_USER;
338 return (authz_dbd_login(r, cfg, "logout") == OK ? AUTHZ_GRANTED : AUTHZ_DENIED);
341 static const char *dbd_parse_config(cmd_parms *cmd, const char *require_line,
342 const void **parsed_require_line)
344 const char *expr_err = NULL;
345 ap_expr_info_t *expr;
347 expr = ap_expr_parse_cmd(cmd, require_line, AP_EXPR_FLAG_STRING_RESULT,
351 return apr_pstrcat(cmd->temp_pool,
352 "Cannot parse expression in require line: ",
355 *parsed_require_line = expr;
360 static const authz_provider authz_dbdgroup_provider =
362 &dbdgroup_check_authorization,
366 static const authz_provider authz_dbdlogin_provider =
368 &dbdlogin_check_authorization,
373 static const authz_provider authz_dbdlogout_provider =
375 &dbdlogout_check_authorization,
379 static void authz_dbd_hooks(apr_pool_t *p)
381 ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "dbd-group",
382 AUTHZ_PROVIDER_VERSION,
383 &authz_dbdgroup_provider,
384 AP_AUTH_INTERNAL_PER_CONF);
385 ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "dbd-login",
386 AUTHZ_PROVIDER_VERSION,
387 &authz_dbdlogin_provider,
388 AP_AUTH_INTERNAL_PER_CONF);
389 ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "dbd-logout",
390 AUTHZ_PROVIDER_VERSION,
391 &authz_dbdlogout_provider,
392 AP_AUTH_INTERNAL_PER_CONF);
395 AP_DECLARE_MODULE(authz_dbd) =
397 STANDARD20_MODULE_STUFF,