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 "apr_strings.h"
18 #include "apr_lib.h" /* for apr_isspace */
19 #include "apr_base64.h" /* for apr_base64_decode et al */
20 #define APR_WANT_STRFUNC /* for strcasecmp */
23 #include "ap_config.h"
25 #include "http_config.h"
26 #include "http_core.h"
28 #include "http_protocol.h"
29 #include "http_request.h"
30 #include "ap_provider.h"
35 #include "mod_session.h"
36 #include "mod_request.h"
38 #define FORM_LOGIN_HANDLER "form-login-handler"
39 #define FORM_LOGOUT_HANDLER "form-logout-handler"
40 #define FORM_REDIRECT_HANDLER "form-redirect-handler"
41 #define MOD_AUTH_FORM_HASH "site"
43 static int (*ap_session_load_fn) (request_rec * r, session_rec ** z) = NULL;
44 static apr_status_t (*ap_session_get_fn)(request_rec * r, session_rec * z,
45 const char *key, const char **value) = NULL;
46 static apr_status_t (*ap_session_set_fn)(request_rec * r, session_rec * z,
47 const char *key, const char *value) = NULL;
48 static void (*ap_request_insert_filter_fn) (request_rec * r) = NULL;
49 static void (*ap_request_remove_filter_fn) (request_rec * r) = NULL;
52 authn_provider_list *providers;
55 int authoritative_set;
65 int fakebasicauth_set;
75 int disable_no_store_set;
76 ap_expr_info_t *loginsuccess;
78 ap_expr_info_t *loginrequired;
79 int loginrequired_set;
80 ap_expr_info_t *logout;
82 } auth_form_config_rec;
84 static void *create_auth_form_dir_config(apr_pool_t * p, char *d)
86 auth_form_config_rec *conf = apr_pcalloc(p, sizeof(*conf));
89 /* Any failures are fatal. */
90 conf->authoritative = 1;
92 /* form size defaults to 8k */
93 conf->form_size = HUGE_STRING_LEN;
95 /* default form field names */
96 conf->username = "httpd_username";
97 conf->password = "httpd_password";
98 conf->location = "httpd_location";
99 conf->method = "httpd_method";
100 conf->mimetype = "httpd_mimetype";
101 conf->body = "httpd_body";
106 static void *merge_auth_form_dir_config(apr_pool_t * p, void *basev, void *addv)
108 auth_form_config_rec *new = (auth_form_config_rec *) apr_pcalloc(p, sizeof(auth_form_config_rec));
109 auth_form_config_rec *add = (auth_form_config_rec *) addv;
110 auth_form_config_rec *base = (auth_form_config_rec *) basev;
112 new->providers = !add->providers ? base->providers : add->providers;
113 new->authoritative = (add->authoritative_set == 0) ? base->authoritative : add->authoritative;
114 new->authoritative_set = add->authoritative_set || base->authoritative_set;
115 new->site = (add->site_set == 0) ? base->site : add->site;
116 new->site_set = add->site_set || base->site_set;
117 new->username = (add->username_set == 0) ? base->username : add->username;
118 new->username_set = add->username_set || base->username_set;
119 new->password = (add->password_set == 0) ? base->password : add->password;
120 new->password_set = add->password_set || base->password_set;
121 new->location = (add->location_set == 0) ? base->location : add->location;
122 new->location_set = add->location_set || base->location_set;
123 new->form_size = (add->form_size_set == 0) ? base->form_size : add->form_size;
124 new->form_size_set = add->form_size_set || base->form_size_set;
125 new->fakebasicauth = (add->fakebasicauth_set == 0) ? base->fakebasicauth : add->fakebasicauth;
126 new->fakebasicauth_set = add->fakebasicauth_set || base->fakebasicauth_set;
127 new->method = (add->method_set == 0) ? base->method : add->method;
128 new->method_set = add->method_set || base->method_set;
129 new->mimetype = (add->mimetype_set == 0) ? base->mimetype : add->mimetype;
130 new->mimetype_set = add->mimetype_set || base->mimetype_set;
131 new->body = (add->body_set == 0) ? base->body : add->body;
132 new->body_set = add->body_set || base->body_set;
133 new->disable_no_store = (add->disable_no_store_set == 0) ? base->disable_no_store : add->disable_no_store;
134 new->disable_no_store_set = add->disable_no_store_set || base->disable_no_store_set;
135 new->loginsuccess = (add->loginsuccess_set == 0) ? base->loginsuccess : add->loginsuccess;
136 new->loginsuccess_set = add->loginsuccess_set || base->loginsuccess_set;
137 new->loginrequired = (add->loginrequired_set == 0) ? base->loginrequired : add->loginrequired;
138 new->loginrequired_set = add->loginrequired_set || base->loginrequired_set;
139 new->logout = (add->logout_set == 0) ? base->logout : add->logout;
140 new->logout_set = add->logout_set || base->logout_set;
145 static const char *add_authn_provider(cmd_parms * cmd, void *config,
148 auth_form_config_rec *conf = (auth_form_config_rec *) config;
149 authn_provider_list *newp;
151 newp = apr_pcalloc(cmd->pool, sizeof(authn_provider_list));
152 newp->provider_name = arg;
154 /* lookup and cache the actual provider now */
155 newp->provider = ap_lookup_provider(AUTHN_PROVIDER_GROUP,
157 AUTHN_PROVIDER_VERSION);
159 if (newp->provider == NULL) {
161 * by the time they use it, the provider should be loaded and
162 * registered with us.
164 return apr_psprintf(cmd->pool,
165 "Unknown Authn provider: %s",
166 newp->provider_name);
169 if (!newp->provider->check_password) {
170 /* if it doesn't provide the appropriate function, reject it */
171 return apr_psprintf(cmd->pool,
172 "The '%s' Authn provider doesn't support "
173 "Form Authentication", newp->provider_name);
176 /* Add it to the list now. */
177 if (!conf->providers) {
178 conf->providers = newp;
181 authn_provider_list *last = conf->providers;
193 * Sanity check a given string that it exists, is not empty,
194 * and does not contain special characters.
196 static const char *check_string(cmd_parms * cmd, const char *string)
198 if (!string || !*string || ap_strchr_c(string, '=') || ap_strchr_c(string, '&')) {
199 return apr_pstrcat(cmd->pool, cmd->directive->directive,
200 " cannot be empty, or contain '=' or '&'.",
206 static const char *set_cookie_form_location(cmd_parms * cmd, void *config, const char *location)
208 auth_form_config_rec *conf = (auth_form_config_rec *) config;
209 conf->location = location;
210 conf->location_set = 1;
211 return check_string(cmd, location);
214 static const char *set_cookie_form_username(cmd_parms * cmd, void *config, const char *username)
216 auth_form_config_rec *conf = (auth_form_config_rec *) config;
217 conf->username = username;
218 conf->username_set = 1;
219 return check_string(cmd, username);
222 static const char *set_cookie_form_password(cmd_parms * cmd, void *config, const char *password)
224 auth_form_config_rec *conf = (auth_form_config_rec *) config;
225 conf->password = password;
226 conf->password_set = 1;
227 return check_string(cmd, password);
230 static const char *set_cookie_form_method(cmd_parms * cmd, void *config, const char *method)
232 auth_form_config_rec *conf = (auth_form_config_rec *) config;
233 conf->method = method;
234 conf->method_set = 1;
235 return check_string(cmd, method);
238 static const char *set_cookie_form_mimetype(cmd_parms * cmd, void *config, const char *mimetype)
240 auth_form_config_rec *conf = (auth_form_config_rec *) config;
241 conf->mimetype = mimetype;
242 conf->mimetype_set = 1;
243 return check_string(cmd, mimetype);
246 static const char *set_cookie_form_body(cmd_parms * cmd, void *config, const char *body)
248 auth_form_config_rec *conf = (auth_form_config_rec *) config;
251 return check_string(cmd, body);
254 static const char *set_cookie_form_size(cmd_parms * cmd, void *config,
257 auth_form_config_rec *conf = config;
260 if (APR_SUCCESS != apr_strtoff(&size, arg, NULL, 10)
261 || size < 0 || size > APR_SIZE_MAX) {
262 return "AuthCookieFormSize must be a size in bytes, or zero.";
264 conf->form_size = (apr_size_t)size;
265 conf->form_size_set = 1;
270 static const char *set_login_required_location(cmd_parms * cmd, void *config, const char *loginrequired)
272 auth_form_config_rec *conf = (auth_form_config_rec *) config;
275 conf->loginrequired = ap_expr_parse_cmd(cmd, loginrequired, AP_EXPR_FLAG_STRING_RESULT,
278 return apr_psprintf(cmd->pool,
279 "Could not parse login required expression '%s': %s",
282 conf->loginrequired_set = 1;
287 static const char *set_login_success_location(cmd_parms * cmd, void *config, const char *loginsuccess)
289 auth_form_config_rec *conf = (auth_form_config_rec *) config;
292 conf->loginsuccess = ap_expr_parse_cmd(cmd, loginsuccess, AP_EXPR_FLAG_STRING_RESULT,
295 return apr_psprintf(cmd->pool,
296 "Could not parse login success expression '%s': %s",
299 conf->loginsuccess_set = 1;
304 static const char *set_logout_location(cmd_parms * cmd, void *config, const char *logout)
306 auth_form_config_rec *conf = (auth_form_config_rec *) config;
309 conf->logout = ap_expr_parse_cmd(cmd, logout, AP_EXPR_FLAG_STRING_RESULT,
312 return apr_psprintf(cmd->pool,
313 "Could not parse logout required expression '%s': %s",
316 conf->logout_set = 1;
321 static const char *set_site_passphrase(cmd_parms * cmd, void *config, const char *site)
323 auth_form_config_rec *conf = (auth_form_config_rec *) config;
329 static const char *set_authoritative(cmd_parms * cmd, void *config, int flag)
331 auth_form_config_rec *conf = (auth_form_config_rec *) config;
332 conf->authoritative = flag;
333 conf->authoritative_set = 1;
337 static const char *set_fake_basic_auth(cmd_parms * cmd, void *config, int flag)
339 auth_form_config_rec *conf = (auth_form_config_rec *) config;
340 conf->fakebasicauth = flag;
341 conf->fakebasicauth_set = 1;
345 static const char *set_disable_no_store(cmd_parms * cmd, void *config, int flag)
347 auth_form_config_rec *conf = (auth_form_config_rec *) config;
348 conf->disable_no_store = flag;
349 conf->disable_no_store_set = 1;
353 static const command_rec auth_form_cmds[] =
355 AP_INIT_ITERATE("AuthFormProvider", add_authn_provider, NULL, OR_AUTHCFG,
356 "specify the auth providers for a directory or location"),
357 AP_INIT_TAKE1("AuthFormUsername", set_cookie_form_username, NULL, OR_AUTHCFG,
358 "The field of the login form carrying the username"),
359 AP_INIT_TAKE1("AuthFormPassword", set_cookie_form_password, NULL, OR_AUTHCFG,
360 "The field of the login form carrying the password"),
361 AP_INIT_TAKE1("AuthFormLocation", set_cookie_form_location, NULL, OR_AUTHCFG,
362 "The field of the login form carrying the URL to redirect on "
363 "successful login."),
364 AP_INIT_TAKE1("AuthFormMethod", set_cookie_form_method, NULL, OR_AUTHCFG,
365 "The field of the login form carrying the original request method."),
366 AP_INIT_TAKE1("AuthFormMimetype", set_cookie_form_mimetype, NULL, OR_AUTHCFG,
367 "The field of the login form carrying the original request mimetype."),
368 AP_INIT_TAKE1("AuthFormBody", set_cookie_form_body, NULL, OR_AUTHCFG,
369 "The field of the login form carrying the urlencoded original request "
371 AP_INIT_TAKE1("AuthFormSize", set_cookie_form_size, NULL, ACCESS_CONF,
372 "Maximum size of body parsed by the form parser"),
373 AP_INIT_TAKE1("AuthFormLoginRequiredLocation", set_login_required_location,
375 "If set, redirect the browser to this URL rather than "
376 "return 401 Not Authorized."),
377 AP_INIT_TAKE1("AuthFormLoginSuccessLocation", set_login_success_location,
379 "If set, redirect the browser to this URL when a login "
380 "processed by the login handler is successful."),
381 AP_INIT_TAKE1("AuthFormLogoutLocation", set_logout_location,
383 "The URL of the logout successful page. An attempt to access an "
384 "URL handled by the handler " FORM_LOGOUT_HANDLER " will result "
385 "in an redirect to this page after logout."),
386 AP_INIT_TAKE1("AuthFormSitePassphrase", set_site_passphrase,
388 "If set, use this passphrase to determine whether the user should "
389 "be authenticated. Bypasses the user authentication check on "
390 "every website hit, and is useful for high traffic sites."),
391 AP_INIT_FLAG("AuthFormAuthoritative", set_authoritative,
393 "Set to 'Off' to allow access control to be passed along to "
394 "lower modules if the UserID is not known to this module"),
395 AP_INIT_FLAG("AuthFormFakeBasicAuth", set_fake_basic_auth,
397 "Set to 'On' to pass through authentication to the rest of the "
398 "server as a basic authentication header."),
399 AP_INIT_FLAG("AuthFormDisableNoStore", set_disable_no_store,
401 "Set to 'on' to stop the sending of a Cache-Control no-store header with "
402 "the login screen. This allows the browser to cache the credentials, but "
403 "at the risk of it being possible for the login form to be resubmitted "
404 "and revealed to the backend server through XSS. Use at own risk."),
408 module AP_MODULE_DECLARE_DATA auth_form_module;
410 static void note_cookie_auth_failure(request_rec * r)
412 auth_form_config_rec *conf = ap_get_module_config(r->per_dir_config,
415 if (conf->location && ap_strchr_c(conf->location, ':')) {
416 apr_table_setn(r->err_headers_out, "Location", conf->location);
420 static int hook_note_cookie_auth_failure(request_rec * r,
421 const char *auth_type)
423 if (strcasecmp(auth_type, "form"))
426 note_cookie_auth_failure(r);
431 * Set the auth username and password into the main request
434 static void set_notes_auth(request_rec * r,
435 const char *user, const char *pw,
436 const char *method, const char *mimetype)
438 apr_table_t *notes = NULL;
439 const char *authname;
441 /* find the main request */
445 /* find the first redirect */
451 /* have we isolated the user and pw before? */
452 authname = ap_auth_name(r);
454 apr_table_setn(notes, apr_pstrcat(r->pool, authname, "-user", NULL), user);
457 apr_table_setn(notes, apr_pstrcat(r->pool, authname, "-pw", NULL), pw);
460 apr_table_setn(notes, apr_pstrcat(r->pool, authname, "-method", NULL), method);
463 apr_table_setn(notes, apr_pstrcat(r->pool, authname, "-mimetype", NULL), mimetype);
469 * Get the auth username and password from the main request
470 * notes table, if present.
472 static void get_notes_auth(request_rec *r,
473 const char **user, const char **pw,
474 const char **method, const char **mimetype)
476 const char *authname;
479 /* find the main request */
483 /* find the first redirect */
488 /* have we isolated the user and pw before? */
489 authname = ap_auth_name(m);
491 *user = (char *) apr_table_get(m->notes, apr_pstrcat(m->pool, authname, "-user", NULL));
494 *pw = (char *) apr_table_get(m->notes, apr_pstrcat(m->pool, authname, "-pw", NULL));
497 *method = (char *) apr_table_get(m->notes, apr_pstrcat(m->pool, authname, "-method", NULL));
500 *mimetype = (char *) apr_table_get(m->notes, apr_pstrcat(m->pool, authname, "-mimetype", NULL));
503 /* set the user, even though the user is unauthenticated at this point */
505 r->user = (char *) *user;
508 ap_log_rerror(APLOG_MARK, APLOG_TRACE1, 0, r,
509 "from notes: user: %s, pw: %s, method: %s, mimetype: %s",
510 user ? *user : "<null>", pw ? *pw : "<null>",
511 method ? *method : "<null>", mimetype ? *mimetype : "<null>");
516 * Set the auth username and password into the session.
518 * If either the username, or the password are NULL, the username
519 * and/or password will be removed from the session.
521 static apr_status_t set_session_auth(request_rec * r,
522 const char *user, const char *pw, const char *site)
524 const char *hash = NULL;
525 const char *authname = ap_auth_name(r);
526 session_rec *z = NULL;
529 hash = ap_md5(r->pool,
530 (unsigned char *) apr_pstrcat(r->pool, user, ":", site, NULL));
533 ap_session_load_fn(r, &z);
534 ap_session_set_fn(r, z, apr_pstrcat(r->pool, authname, "-" MOD_SESSION_USER, NULL), user);
535 ap_session_set_fn(r, z, apr_pstrcat(r->pool, authname, "-" MOD_SESSION_PW, NULL), pw);
536 ap_session_set_fn(r, z, apr_pstrcat(r->pool, authname, "-" MOD_AUTH_FORM_HASH, NULL), hash);
543 * Get the auth username and password from the main request
544 * notes table, if present.
546 static apr_status_t get_session_auth(request_rec * r,
547 const char **user, const char **pw, const char **hash)
549 const char *authname = ap_auth_name(r);
550 session_rec *z = NULL;
552 ap_session_load_fn(r, &z);
555 ap_session_get_fn(r, z, apr_pstrcat(r->pool, authname, "-" MOD_SESSION_USER, NULL), user);
558 ap_session_get_fn(r, z, apr_pstrcat(r->pool, authname, "-" MOD_SESSION_PW, NULL), pw);
561 ap_session_get_fn(r, z, apr_pstrcat(r->pool, authname, "-" MOD_AUTH_FORM_HASH, NULL), hash);
564 /* set the user, even though the user is unauthenticated at this point */
566 r->user = (char *) *user;
569 ap_log_rerror(APLOG_MARK, APLOG_TRACE1, 0, r,
570 "from session: " MOD_SESSION_USER ": %s, " MOD_SESSION_PW
571 ": %s, " MOD_AUTH_FORM_HASH ": %s",
572 user ? *user : "<null>", pw ? *pw : "<null>",
573 hash ? *hash : "<null>");
580 * Isolate the username and password in a POSTed form with the
581 * username in the "username" field, and the password in the
584 * If either the username or the password is missing, this
585 * function will return HTTP_UNAUTHORIZED.
587 * The location field is considered optional, and will be returned
590 static int get_form_auth(request_rec * r,
591 const char *username,
592 const char *password,
593 const char *location,
595 const char *mimetype,
597 const char **sent_user,
598 const char **sent_pw,
599 const char **sent_loc,
600 const char **sent_method,
601 const char **sent_mimetype,
602 apr_bucket_brigade **sent_body,
603 auth_form_config_rec * conf)
605 /* sanity check - are we a POST request? */
607 /* find the username and password in the form */
608 apr_array_header_t *pairs = NULL;
614 /* have we isolated the user and pw before? */
615 get_notes_auth(r, sent_user, sent_pw, sent_method, sent_mimetype);
616 if (*sent_user && *sent_pw) {
620 res = ap_parse_form_data(r, NULL, &pairs, -1, conf->form_size);
624 while (pairs && !apr_is_empty_array(pairs)) {
625 ap_form_pair_t *pair = (ap_form_pair_t *) apr_array_pop(pairs);
626 if (username && !strcmp(pair->name, username) && sent_user) {
627 apr_brigade_length(pair->value, 1, &len);
628 size = (apr_size_t) len;
629 buffer = apr_palloc(r->pool, size + 1);
630 apr_brigade_flatten(pair->value, buffer, &size);
634 else if (password && !strcmp(pair->name, password) && sent_pw) {
635 apr_brigade_length(pair->value, 1, &len);
636 size = (apr_size_t) len;
637 buffer = apr_palloc(r->pool, size + 1);
638 apr_brigade_flatten(pair->value, buffer, &size);
642 else if (location && !strcmp(pair->name, location) && sent_loc) {
643 apr_brigade_length(pair->value, 1, &len);
644 size = (apr_size_t) len;
645 buffer = apr_palloc(r->pool, size + 1);
646 apr_brigade_flatten(pair->value, buffer, &size);
650 else if (method && !strcmp(pair->name, method) && sent_method) {
651 apr_brigade_length(pair->value, 1, &len);
652 size = (apr_size_t) len;
653 buffer = apr_palloc(r->pool, size + 1);
654 apr_brigade_flatten(pair->value, buffer, &size);
656 *sent_method = buffer;
658 else if (mimetype && !strcmp(pair->name, mimetype) && sent_mimetype) {
659 apr_brigade_length(pair->value, 1, &len);
660 size = (apr_size_t) len;
661 buffer = apr_palloc(r->pool, size + 1);
662 apr_brigade_flatten(pair->value, buffer, &size);
664 *sent_mimetype = buffer;
666 else if (body && !strcmp(pair->name, body) && sent_body) {
667 *sent_body = pair->value;
671 ap_log_rerror(APLOG_MARK, APLOG_TRACE1, 0, r,
672 "from form: user: %s, pw: %s, method: %s, mimetype: %s, location: %s",
673 sent_user ? *sent_user : "<null>", sent_pw ? *sent_pw : "<null>",
674 sent_method ? *sent_method : "<null>",
675 sent_mimetype ? *sent_mimetype : "<null>",
676 sent_loc ? *sent_loc : "<null>");
678 /* set the user, even though the user is unauthenticated at this point */
679 if (sent_user && *sent_user) {
680 r->user = (char *) *sent_user;
683 /* a missing username or missing password means auth denied */
684 if (!sent_user || !*sent_user) {
686 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
687 "form parsed, but username field '%s' was missing or empty, unauthorized",
690 return HTTP_UNAUTHORIZED;
692 if (!sent_pw || !*sent_pw) {
694 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
695 "form parsed, but password field '%s' was missing or empty, unauthorized",
698 return HTTP_UNAUTHORIZED;
702 * save away the username, password, mimetype and method, so that they
703 * are available should the auth need to be run again.
705 set_notes_auth(r, *sent_user, *sent_pw, sent_method ? *sent_method : NULL,
706 sent_mimetype ? *sent_mimetype : NULL);
711 /* These functions return 0 if client is OK, and proper error status
712 * if not... either HTTP_UNAUTHORIZED, if we made a check, and it failed, or
713 * HTTP_INTERNAL_SERVER_ERROR, if things are so totally confused that we
714 * couldn't figure out how to tell if the client is authorized or not.
716 * If they return DECLINED, and all other modules also decline, that's
717 * treated by the server core as a configuration error, logged and
723 * Given a username and site passphrase hash from the session, determine
724 * whether the site passphrase is valid for this session.
726 * If the site passphrase is NULL, or if the sent_hash is NULL, this
727 * function returns DECLINED.
729 * If the site passphrase hash does not match the sent hash, this function
730 * returns AUTH_USER_NOT_FOUND.
732 * On success, returns OK.
734 static int check_site(request_rec * r, const char *site, const char *sent_user, const char *sent_hash)
737 if (site && sent_user && sent_hash) {
738 const char *hash = ap_md5(r->pool,
739 (unsigned char *) apr_pstrcat(r->pool, sent_user, ":", site, NULL));
741 if (!strcmp(sent_hash, hash)) {
745 return AUTH_USER_NOT_FOUND;
754 * Given a username and password (extracted externally from a cookie), run
755 * the authnz hooks to determine whether this request is authorized.
757 * Return an HTTP code.
759 static int check_authn(request_rec * r, const char *sent_user, const char *sent_pw)
761 authn_status auth_result;
762 authn_provider_list *current_provider;
763 auth_form_config_rec *conf = ap_get_module_config(r->per_dir_config,
766 current_provider = conf->providers;
768 const authn_provider *provider;
771 * For now, if a provider isn't set, we'll be nice and use the file
774 if (!current_provider) {
775 provider = ap_lookup_provider(AUTHN_PROVIDER_GROUP,
776 AUTHN_DEFAULT_PROVIDER,
777 AUTHN_PROVIDER_VERSION);
779 if (!provider || !provider->check_password) {
780 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01806)
781 "no authn provider configured");
782 auth_result = AUTH_GENERAL_ERROR;
785 apr_table_setn(r->notes, AUTHN_PROVIDER_NAME_NOTE, AUTHN_DEFAULT_PROVIDER);
788 provider = current_provider->provider;
789 apr_table_setn(r->notes, AUTHN_PROVIDER_NAME_NOTE, current_provider->provider_name);
792 if (!sent_user || !sent_pw) {
793 auth_result = AUTH_USER_NOT_FOUND;
797 auth_result = provider->check_password(r, sent_user, sent_pw);
799 apr_table_unset(r->notes, AUTHN_PROVIDER_NAME_NOTE);
801 /* Something occured. Stop checking. */
802 if (auth_result != AUTH_USER_NOT_FOUND) {
806 /* If we're not really configured for providers, stop now. */
807 if (!conf->providers) {
811 current_provider = current_provider->next;
812 } while (current_provider);
814 if (auth_result != AUTH_GRANTED) {
817 /* If we're not authoritative, then any error is ignored. */
818 if (!(conf->authoritative) && auth_result != AUTH_DENIED) {
822 switch (auth_result) {
824 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01807)
825 "user '%s': authentication failure for \"%s\": "
828 return_code = HTTP_UNAUTHORIZED;
830 case AUTH_USER_NOT_FOUND:
831 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01808)
832 "user '%s' not found: %s", sent_user, r->uri);
833 return_code = HTTP_UNAUTHORIZED;
835 case AUTH_GENERAL_ERROR:
838 * We'll assume that the module has already said what its error
841 return_code = HTTP_INTERNAL_SERVER_ERROR;
845 /* If we're returning 403, tell them to try again. */
846 if (return_code == HTTP_UNAUTHORIZED) {
847 note_cookie_auth_failure(r);
850 /* TODO: Flag the user somehow as to the reason for the failure */
859 /* fake the basic authentication header if configured to do so */
860 static void fake_basic_authentication(request_rec *r, auth_form_config_rec *conf,
861 const char *user, const char *pw)
863 if (conf->fakebasicauth) {
864 char *basic = apr_pstrcat(r->pool, user, ":", pw, NULL);
865 apr_size_t size = (apr_size_t) strlen(basic);
866 char *base64 = apr_palloc(r->pool,
867 apr_base64_encode_len(size + 1) * sizeof(char));
868 apr_base64_encode(base64, basic, size);
869 apr_table_setn(r->headers_in, "Authorization",
870 apr_pstrcat(r->pool, "Basic ", base64, NULL));
875 * Must we use form authentication? If so, extract the cookie and run
876 * the authnz hooks to determine if the login is valid.
878 * If the login is not valid, a 401 Not Authorized will be returned. It
879 * is up to the webmaster to ensure this screen displays a suitable login
880 * form to give the user the opportunity to log in.
882 static int authenticate_form_authn(request_rec * r)
884 auth_form_config_rec *conf = ap_get_module_config(r->per_dir_config,
886 const char *sent_user = NULL, *sent_pw = NULL, *sent_hash = NULL;
887 const char *sent_loc = NULL, *sent_method = "GET", *sent_mimetype = NULL;
888 const char *current_auth = NULL;
891 int rv = HTTP_UNAUTHORIZED;
893 /* Are we configured to be Form auth? */
894 current_auth = ap_auth_type(r);
895 if (!current_auth || strcasecmp(current_auth, "form")) {
900 * XSS security warning: using cookies to store private data only works
901 * when the administrator has full control over the source website. When
902 * in forward-proxy mode, websites are public by definition, and so can
903 * never be secure. Abort the auth attempt in this case.
905 if (PROXYREQ_PROXY == r->proxyreq) {
906 ap_log_rerror(APLOG_MARK, APLOG_ERR,
907 0, r, APLOGNO(01809) "form auth cannot be used for proxy "
908 "requests due to XSS risk, access denied: %s", r->uri);
909 return HTTP_INTERNAL_SERVER_ERROR;
912 /* We need an authentication realm. */
913 if (!ap_auth_name(r)) {
914 ap_log_rerror(APLOG_MARK, APLOG_ERR,
915 0, r, APLOGNO(01810) "need AuthName: %s", r->uri);
916 return HTTP_INTERNAL_SERVER_ERROR;
919 r->ap_auth_type = (char *) current_auth;
921 /* try get the username and password from the notes, if present */
922 get_notes_auth(r, &sent_user, &sent_pw, &sent_method, &sent_mimetype);
923 if (!sent_user || !sent_pw || !*sent_user || !*sent_pw) {
925 /* otherwise try get the username and password from a session, if present */
926 res = get_session_auth(r, &sent_user, &sent_pw, &sent_hash);
933 /* first test whether the site passphrase matches */
934 if (APR_SUCCESS == res && sent_user && sent_hash && sent_pw) {
935 rv = check_site(r, conf->site, sent_user, sent_hash);
937 fake_basic_authentication(r, conf, sent_user, sent_pw);
942 /* otherwise test for a normal password match */
943 if (APR_SUCCESS == res && sent_user && sent_pw) {
944 rv = check_authn(r, sent_user, sent_pw);
946 fake_basic_authentication(r, conf, sent_user, sent_pw);
952 * If we reach this point, the request should fail with access denied,
953 * except for one potential scenario:
955 * If the request is a POST, and the posted form contains user defined fields
956 * for a username and a password, and the username and password are correct,
957 * then return the response obtained by a GET to this URL.
959 * If an additional user defined location field is present in the form,
960 * instead of a GET of the current URL, redirect the browser to the new
963 * As a further option, if the user defined fields for the type of request,
964 * the mime type of the body of the request, and the body of the request
965 * itself are present, replace this request with a new request of the given
966 * type and with the given body.
968 * Otherwise access is denied.
970 * Reading the body requires some song and dance, because the input filters
971 * are not yet configured. To work around this problem, we create a
972 * subrequest and use that to create a sane filter stack we can read the
975 * The main request is then capped with a kept_body input filter, which has
976 * the effect of guaranteeing the input stack can be safely read a second time.
979 if (HTTP_UNAUTHORIZED == rv && r->method_number == M_POST && ap_is_initial_req(r)) {
981 apr_bucket_brigade *sent_body = NULL;
983 /* create a subrequest of our current uri */
984 rr = ap_sub_req_lookup_uri(r->uri, r, r->input_filters);
985 rr->headers_in = r->headers_in;
987 /* run the insert_filters hook on the subrequest to ensure a body read can
990 ap_run_insert_filter(rr);
992 /* parse the form by reading the subrequest */
993 rv = get_form_auth(rr, conf->username, conf->password, conf->location,
994 conf->method, conf->mimetype, conf->body,
995 &sent_user, &sent_pw, &sent_loc, &sent_method,
996 &sent_mimetype, &sent_body, conf);
998 /* make sure any user detected within the subrequest is saved back to
1001 r->user = apr_pstrdup(r->pool, rr->user);
1003 /* we cannot clean up rr at this point, as memory allocated to rr is
1004 * referenced from the main request. It will be cleaned up when the
1005 * main request is cleaned up.
1008 /* insert the kept_body filter on the main request to guarantee the
1009 * input filter stack cannot be read a second time, optionally inject
1010 * a saved body if one was specified in the login form.
1012 if (sent_body && sent_mimetype) {
1013 apr_table_set(r->headers_in, "Content-Type", sent_mimetype);
1014 r->kept_body = sent_body;
1017 r->kept_body = apr_brigade_create(r->pool, r->connection->bucket_alloc);
1019 ap_request_insert_filter_fn(r);
1021 /* did the form ask to change the method? if so, switch in the redirect handler
1022 * to relaunch this request as the subrequest with the new method. If the
1023 * form didn't specify a method, the default value GET will force a redirect.
1025 if (sent_method && strcmp(r->method, sent_method)) {
1026 r->handler = FORM_REDIRECT_HANDLER;
1029 /* check the authn in the main request, based on the username found */
1031 rv = check_authn(r, sent_user, sent_pw);
1033 fake_basic_authentication(r, conf, sent_user, sent_pw);
1034 set_session_auth(r, sent_user, sent_pw, conf->site);
1036 apr_table_set(r->headers_out, "Location", sent_loc);
1037 return HTTP_MOVED_TEMPORARILY;
1039 if (conf->loginsuccess) {
1040 const char *loginsuccess = ap_expr_str_exec(r,
1041 conf->loginsuccess, &err);
1043 apr_table_set(r->headers_out, "Location", loginsuccess);
1044 return HTTP_MOVED_TEMPORARILY;
1047 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(02339)
1048 "Can't evaluate login success expression: %s", err);
1049 return HTTP_INTERNAL_SERVER_ERROR;
1058 * did the admin prefer to be redirected to the login page on failure
1061 if (HTTP_UNAUTHORIZED == rv && conf->loginrequired) {
1062 const char *loginrequired = ap_expr_str_exec(r,
1063 conf->loginrequired, &err);
1065 apr_table_set(r->headers_out, "Location", loginrequired);
1066 return HTTP_MOVED_TEMPORARILY;
1069 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(02340)
1070 "Can't evaluate login required expression: %s", err);
1071 return HTTP_INTERNAL_SERVER_ERROR;
1075 /* did the user ask to be redirected on login success? */
1077 apr_table_set(r->headers_out, "Location", sent_loc);
1078 rv = HTTP_MOVED_TEMPORARILY;
1083 * potential security issue: if we return a login to the browser, we must
1084 * send a no-store to make sure a well behaved browser will not try and
1085 * send the login details a second time if the back button is pressed.
1087 * if the user has full control over the backend, the
1088 * AuthCookieDisableNoStore can be used to turn this off.
1090 if (HTTP_UNAUTHORIZED == rv && !conf->disable_no_store) {
1091 apr_table_addn(r->headers_out, "Cache-Control", "no-store");
1092 apr_table_addn(r->err_headers_out, "Cache-Control", "no-store");
1100 * Handle a login attempt.
1102 * If the login session is either missing or form authnz is unsuccessful, a
1103 * 401 Not Authorized will be returned to the browser. The webmaster
1104 * is expected to insert a login form into the 401 Not Authorized
1107 * If the webmaster wishes, they can point the form submission at this
1108 * handler, which will redirect the user to the correct page on success.
1109 * On failure, the 401 Not Authorized error screen will be redisplayed,
1110 * where the login attempt can be repeated.
1113 static int authenticate_form_login_handler(request_rec * r)
1115 auth_form_config_rec *conf;
1118 const char *sent_user = NULL, *sent_pw = NULL, *sent_loc = NULL;
1121 if (strcmp(r->handler, FORM_LOGIN_HANDLER)) {
1125 if (r->method_number != M_POST) {
1126 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01811)
1127 "the " FORM_LOGIN_HANDLER " only supports the POST method for %s",
1129 return HTTP_METHOD_NOT_ALLOWED;
1132 conf = ap_get_module_config(r->per_dir_config, &auth_form_module);
1134 rv = get_form_auth(r, conf->username, conf->password, conf->location,
1136 &sent_user, &sent_pw, &sent_loc,
1137 NULL, NULL, NULL, conf);
1139 rv = check_authn(r, sent_user, sent_pw);
1141 set_session_auth(r, sent_user, sent_pw, conf->site);
1143 apr_table_set(r->headers_out, "Location", sent_loc);
1144 return HTTP_MOVED_TEMPORARILY;
1146 if (conf->loginsuccess) {
1147 const char *loginsuccess = ap_expr_str_exec(r,
1148 conf->loginsuccess, &err);
1150 apr_table_set(r->headers_out, "Location", loginsuccess);
1151 return HTTP_MOVED_TEMPORARILY;
1154 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(02341)
1155 "Can't evaluate login success expression: %s", err);
1156 return HTTP_INTERNAL_SERVER_ERROR;
1163 /* did we prefer to be redirected to the login page on failure instead? */
1164 if (HTTP_UNAUTHORIZED == rv && conf->loginrequired) {
1165 const char *loginrequired = ap_expr_str_exec(r,
1166 conf->loginrequired, &err);
1168 apr_table_set(r->headers_out, "Location", loginrequired);
1169 return HTTP_MOVED_TEMPORARILY;
1172 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(02342)
1173 "Can't evaluate login required expression: %s", err);
1174 return HTTP_INTERNAL_SERVER_ERROR;
1183 * Handle a logout attempt.
1185 * If an attempt is made to access this URL, any username and password
1186 * embedded in the session is deleted.
1188 * This has the effect of logging the person out.
1190 * If a logout URI has been specified, this function will create an
1191 * internal redirect to this page.
1193 static int authenticate_form_logout_handler(request_rec * r)
1195 auth_form_config_rec *conf;
1198 if (strcmp(r->handler, FORM_LOGOUT_HANDLER)) {
1202 conf = ap_get_module_config(r->per_dir_config, &auth_form_module);
1204 /* remove the username and password, effectively logging the user out */
1205 set_session_auth(r, NULL, NULL, NULL);
1208 * make sure the logout page is never cached - otherwise the logout won't
1211 apr_table_addn(r->headers_out, "Cache-Control", "no-store");
1212 apr_table_addn(r->err_headers_out, "Cache-Control", "no-store");
1214 /* if set, internal redirect to the logout page */
1216 const char *logout = ap_expr_str_exec(r,
1217 conf->logout, &err);
1219 apr_table_addn(r->headers_out, "Location", logout);
1220 return HTTP_TEMPORARY_REDIRECT;
1223 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(02343)
1224 "Can't evaluate logout expression: %s", err);
1225 return HTTP_INTERNAL_SERVER_ERROR;
1234 * Handle a redirect attempt.
1236 * If during a form login, the method, mimetype and request body are
1237 * specified, this handler will ensure that this request is included
1238 * as an internal redirect.
1241 static int authenticate_form_redirect_handler(request_rec * r)
1244 request_rec *rr = NULL;
1245 const char *sent_method = NULL, *sent_mimetype = NULL;
1247 if (strcmp(r->handler, FORM_REDIRECT_HANDLER)) {
1251 /* get the method and mimetype from the notes */
1252 get_notes_auth(r, NULL, NULL, &sent_method, &sent_mimetype);
1254 if (r->kept_body && sent_method && sent_mimetype) {
1256 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, APLOGNO(01812)
1257 "internal redirect to method '%s' and body mimetype '%s' for the "
1258 "uri: %s", sent_method, sent_mimetype, r->uri);
1260 rr = ap_sub_req_method_uri(sent_method, r->uri, r, r->output_filters);
1261 r->status = ap_run_sub_req(rr);
1265 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(01813)
1266 "internal redirect requested but one or all of method, mimetype or "
1267 "body are NULL: %s", r->uri);
1268 return HTTP_INTERNAL_SERVER_ERROR;
1271 /* return the underlying error, or OK on success */
1272 return r->status == HTTP_OK || r->status == OK ? OK : r->status;
1276 static int authenticate_form_post_config(apr_pool_t *pconf, apr_pool_t *plog,
1277 apr_pool_t *ptemp, server_rec *s)
1280 if (!ap_session_load_fn || !ap_session_get_fn || !ap_session_set_fn) {
1281 ap_session_load_fn = APR_RETRIEVE_OPTIONAL_FN(ap_session_load);
1282 ap_session_get_fn = APR_RETRIEVE_OPTIONAL_FN(ap_session_get);
1283 ap_session_set_fn = APR_RETRIEVE_OPTIONAL_FN(ap_session_set);
1284 if (!ap_session_load_fn || !ap_session_get_fn || !ap_session_set_fn) {
1285 ap_log_error(APLOG_MARK, APLOG_CRIT, 0, NULL, APLOGNO()
1286 "You must load mod_session to enable the mod_auth_form "
1292 if (!ap_request_insert_filter_fn || !ap_request_remove_filter_fn) {
1293 ap_request_insert_filter_fn = APR_RETRIEVE_OPTIONAL_FN(ap_request_insert_filter);
1294 ap_request_remove_filter_fn = APR_RETRIEVE_OPTIONAL_FN(ap_request_remove_filter);
1295 if (!ap_request_insert_filter_fn || !ap_request_remove_filter_fn) {
1296 ap_log_error(APLOG_MARK, APLOG_CRIT, 0, NULL, APLOGNO()
1297 "You must load mod_request to enable the mod_auth_form "
1306 static void register_hooks(apr_pool_t * p)
1308 ap_hook_post_config(authenticate_form_post_config,NULL,NULL,APR_HOOK_MIDDLE);
1310 #if AP_MODULE_MAGIC_AT_LEAST(20080403,1)
1311 ap_hook_check_authn(authenticate_form_authn, NULL, NULL, APR_HOOK_MIDDLE,
1312 AP_AUTH_INTERNAL_PER_CONF);
1314 ap_hook_check_user_id(authenticate_form_authn, NULL, NULL, APR_HOOK_MIDDLE);
1316 ap_hook_handler(authenticate_form_login_handler, NULL, NULL, APR_HOOK_MIDDLE);
1317 ap_hook_handler(authenticate_form_logout_handler, NULL, NULL, APR_HOOK_MIDDLE);
1318 ap_hook_handler(authenticate_form_redirect_handler, NULL, NULL, APR_HOOK_MIDDLE);
1320 ap_hook_note_auth_failure(hook_note_cookie_auth_failure, NULL, NULL,
1324 AP_DECLARE_MODULE(auth_form) =
1326 STANDARD20_MODULE_STUFF,
1327 create_auth_form_dir_config, /* dir config creater */
1328 merge_auth_form_dir_config, /* dir merger --- default is to override */
1329 NULL, /* server config */
1330 NULL, /* merge server config */
1331 auth_form_cmds, /* command apr_table_t */
1332 register_hooks /* register hooks */