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;
82 if (dbd_prepare == NULL) {
83 dbd_prepare = APR_RETRIEVE_OPTIONAL_FN(ap_dbd_prepare);
84 if (dbd_prepare == NULL) {
85 return "You must load mod_dbd to enable AuthzDBD functions";
87 dbd_handle = APR_RETRIEVE_OPTIONAL_FN(ap_dbd_acquire);
89 label = apr_psprintf(cmd->pool, "authz_dbd_%d", ++label_num);
91 dbd_prepare(cmd->server, query, label);
93 /* save the label here for our own use */
94 return ap_set_string_slot(cmd, cfg, label);
96 static const command_rec authz_dbd_cmds[] = {
97 AP_INIT_FLAG("AuthzDBDLoginToReferer", ap_set_flag_slot,
98 (void*)APR_OFFSETOF(authz_dbd_cfg, redirect), ACCESS_CONF,
99 "Whether to redirect to referer on successful login"),
100 AP_INIT_TAKE1("AuthzDBDQuery", authz_dbd_prepare,
101 (void*)APR_OFFSETOF(authz_dbd_cfg, query), ACCESS_CONF,
102 "SQL query for DBD Authz or login"),
103 AP_INIT_TAKE1("AuthzDBDRedirectQuery", authz_dbd_prepare,
104 (void*)APR_OFFSETOF(authz_dbd_cfg, redir_query), ACCESS_CONF,
105 "SQL query to get per-user redirect URL after login"),
109 static int authz_dbd_login(request_rec *r, authz_dbd_cfg *cfg,
113 const char *newuri = NULL;
116 ap_dbd_t *dbd = dbd_handle(r);
117 apr_dbd_prepared_t *query;
118 apr_dbd_results_t *res = NULL;
119 apr_dbd_row_t *row = NULL;
121 if (cfg->query == NULL) {
122 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
123 "No query configured for %s!", action);
124 return HTTP_INTERNAL_SERVER_ERROR;
126 query = apr_hash_get(dbd->prepared, cfg->query, APR_HASH_KEY_STRING);
128 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
129 "Error retrieving Query for %s!", action);
130 return HTTP_INTERNAL_SERVER_ERROR;
133 rv = apr_dbd_pvquery(dbd->driver, r->pool, dbd->handle, &nrows,
134 query, r->user, NULL);
137 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r,
138 "authz_dbd: %s of user %s updated %d rows",
139 action, r->user, nrows);
143 message = apr_dbd_error(dbd->driver, dbd->handle, rv);
144 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
145 "authz_dbd: query for %s failed; user %s [%s]",
146 action, r->user, message?message:noerror);
147 return HTTP_INTERNAL_SERVER_ERROR;
150 if (cfg->redirect == 1) {
151 newuri = apr_table_get(r->headers_in, "Referer");
154 if (!newuri && cfg->redir_query) {
155 query = apr_hash_get(dbd->prepared, cfg->redir_query,
156 APR_HASH_KEY_STRING);
158 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
159 "authz_dbd: no redirect query!");
160 /* OK, this is non-critical; we can just not-redirect */
162 else if (apr_dbd_pvselect(dbd->driver, r->pool, dbd->handle, &res,
163 query, 0, r->user, NULL) == 0) {
164 for (rv = apr_dbd_get_row(dbd->driver, r->pool, res, &row, -1);
166 rv = apr_dbd_get_row(dbd->driver, r->pool, res, &row, -1)) {
168 newuri = apr_dbd_get_entry(dbd->driver, row, 0);
171 message = apr_dbd_error(dbd->driver, dbd->handle, rv);
172 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
173 "authz_dbd in get_row; action=%s user=%s [%s]",
174 action, r->user, message?message:noerror);
179 message = apr_dbd_error(dbd->driver, dbd->handle, rv);
180 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
181 "authz_dbd/redirect for %s of %s [%s]",
182 action, r->user, message?message:noerror);
185 if (newuri != NULL) {
186 r->status = HTTP_MOVED_TEMPORARILY;
187 apr_table_set(r->err_headers_out, "Location", newuri);
188 rv = HTTP_MOVED_TEMPORARILY;
193 authz_dbd_run_client_login(r, rv, action);
197 static int authz_dbd_group_query(request_rec *r, authz_dbd_cfg *cfg,
198 apr_array_header_t *groups)
200 /* SELECT group FROM authz WHERE user = %s */
203 ap_dbd_t *dbd = dbd_handle(r);
204 apr_dbd_prepared_t *query;
205 apr_dbd_results_t *res = NULL;
206 apr_dbd_row_t *row = NULL;
209 if (cfg->query == NULL) {
210 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
211 "No query configured for dbd-group!");
212 return HTTP_INTERNAL_SERVER_ERROR;
214 query = apr_hash_get(dbd->prepared, cfg->query, APR_HASH_KEY_STRING);
216 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
217 "Error retrieving query for dbd-group!");
218 return HTTP_INTERNAL_SERVER_ERROR;
220 rv = apr_dbd_pvselect(dbd->driver, r->pool, dbd->handle, &res,
221 query, 0, r->user, NULL);
223 for (rv = apr_dbd_get_row(dbd->driver, r->pool, res, &row, -1);
225 rv = apr_dbd_get_row(dbd->driver, r->pool, res, &row, -1)) {
227 group = apr_array_push(groups);
228 *group = apr_dbd_get_entry(dbd->driver, row, 0);
231 message = apr_dbd_error(dbd->driver, dbd->handle, rv);
232 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
233 "authz_dbd in get_row; group query for user=%s [%s]",
234 r->user, message?message:noerror);
235 return HTTP_INTERNAL_SERVER_ERROR;
240 message = apr_dbd_error(dbd->driver, dbd->handle, rv);
241 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
242 "authz_dbd, in groups query for %s [%s]",
243 r->user, message?message:noerror);
244 return HTTP_INTERNAL_SERVER_ERROR;
249 static authz_status dbdgroup_check_authorization(request_rec *r,
250 const char *require_args)
254 apr_array_header_t *groups = NULL;
256 authz_dbd_cfg *cfg = ap_get_module_config(r->per_dir_config,
259 if (groups == NULL) {
260 groups = apr_array_make(r->pool, 4, sizeof(const char*));
261 rv = authz_dbd_group_query(r, cfg, groups);
263 return AUTHZ_GENERAL_ERROR;
269 w = ap_getword_white(r->pool, &t);
270 for (i=0; i < groups->nelts; ++i) {
271 if (!strcmp(w, ((const char**)groups->elts)[i])) {
272 return AUTHZ_GRANTED;
280 static authz_status dbdlogin_check_authorization(request_rec *r,
281 const char *require_args)
283 authz_dbd_cfg *cfg = ap_get_module_config(r->per_dir_config,
286 return (authz_dbd_login(r, cfg, "login") == OK ? AUTHZ_GRANTED : AUTHZ_DENIED);
289 static authz_status dbdlogout_check_authorization(request_rec *r,
290 const char *require_args)
292 authz_dbd_cfg *cfg = ap_get_module_config(r->per_dir_config,
295 return (authz_dbd_login(r, cfg, "logout") == OK ? AUTHZ_GRANTED : AUTHZ_DENIED);
298 static const authz_provider authz_dbdgroup_provider =
300 &dbdgroup_check_authorization,
303 static const authz_provider authz_dbdlogin_provider =
305 &dbdlogin_check_authorization,
309 static const authz_provider authz_dbdlogout_provider =
311 &dbdlogout_check_authorization,
314 static void authz_dbd_hooks(apr_pool_t *p)
316 ap_register_provider(p, AUTHZ_PROVIDER_GROUP, "dbd-group", "0",
317 &authz_dbdgroup_provider);
318 ap_register_provider(p, AUTHZ_PROVIDER_GROUP, "dbd-login", "0",
319 &authz_dbdlogin_provider);
320 ap_register_provider(p, AUTHZ_PROVIDER_GROUP, "dbd-logout", "0",
321 &authz_dbdlogout_provider);
324 module AP_MODULE_DECLARE_DATA authz_dbd_module =
326 STANDARD20_MODULE_STUFF,