2 * Daniel Kouril <kouril@users.sourceforge.net>
4 * Source and Documentation can be found at:
5 * http://modauthkerb.sourceforge.net/
8 * James E. Robinson, III <james@ncstate.net>
9 * Daniel Henninger <daniel@ncsu.edu>
10 * Ludek Sulak <xsulak@fi.muni.cz>
14 * Copyright (c) 2004 Masarykova universita
15 * (Masaryk University, Brno, Czech Republic)
16 * All rights reserved.
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions are met:
21 * 1. Redistributions of source code must retain the above copyright notice,
22 * this list of conditions and the following disclaimer.
24 * 2. Redistributions in binary form must reproduce the above copyright
25 * notice, this list of conditions and the following disclaimer in the
26 * documentation and/or other materials provided with the distribution.
28 * 3. Neither the name of the University nor the names of its contributors may
29 * be used to endorse or promote products derived from this software
30 * without specific prior written permission.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
33 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
34 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
35 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
36 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
37 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
38 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
39 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
40 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGE.
49 #define MODAUTHKERB_VERSION "5.0-rc4"
52 #include <http_config.h>
53 #include <http_core.h>
55 #include <http_protocol.h>
56 #include <http_request.h>
58 #ifdef STANDARD20_MODULE_STUFF
59 #include <ap_compat.h>
60 #include <apr_strings.h>
69 # include <gssapi/gssapi.h>
70 # include <gssapi/gssapi_generic.h>
71 # define GSS_C_NT_USER_NAME gss_nt_user_name
72 # define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
73 # define krb5_get_err_text(context,code) error_message(code)
75 #include "spnegokrb5.h"
79 /*Prevent warning about closesocket redefinition (Apache's ap_config.h and
80 * MIT Kerberos' port-sockets.h both define it as close) */
85 #include <netdb.h> /* gethostbyname() */
88 #ifdef STANDARD20_MODULE_STUFF
89 module AP_MODULE_DECLARE_DATA auth_kerb_module;
91 module auth_kerb_module;
94 /***************************************************************************
95 Macros To Ease Compatibility
96 ***************************************************************************/
97 #ifdef STANDARD20_MODULE_STUFF
98 #define MK_POOL apr_pool_t
99 #define MK_TABLE_GET apr_table_get
100 #define MK_USER r->user
101 #define MK_AUTH_TYPE r->ap_auth_type
104 #define MK_TABLE_GET ap_table_get
105 #define MK_USER r->connection->user
106 #define MK_AUTH_TYPE r->connection->ap_auth_type
107 #define PROXYREQ_PROXY STD_PROXY
110 /***************************************************************************
111 Auth Configuration Structure
112 ***************************************************************************/
114 char *krb_auth_realms;
115 int krb_save_credentials;
117 char *krb_service_name;
118 int krb_authoritative;
121 int krb_method_gssapi;
122 int krb_method_k5pass;
126 int krb_method_k4pass;
131 set_kerb_auth_headers(request_rec *r, const kerb_auth_config *conf,
132 int use_krb4, int use_krb5pwd, char *negotiate_ret_value);
135 krb5_save_realms(cmd_parms *cmd, kerb_auth_config *sec, char *arg);
137 #ifdef STANDARD20_MODULE_STUFF
138 #define command(name, func, var, type, usage) \
139 AP_INIT_ ## type (name, func, \
140 (void*)APR_XtOffsetOf(kerb_auth_config, var), \
143 #define command(name, func, var, type, usage) \
145 (void*)XtOffsetOf(kerb_auth_config, var), \
146 OR_AUTHCFG, type, usage }
149 static const command_rec kerb_auth_cmds[] = {
150 command("KrbAuthRealms", krb5_save_realms, krb_auth_realms,
151 RAW_ARGS, "Realms to attempt authentication against (can be multiple)."),
153 command("KrbAuthRealm", krb5_save_realms, krb_auth_realms,
154 RAW_ARGS, "Alias for KrbAuthRealms."),
156 command("KrbSaveCredentials", ap_set_flag_slot, krb_save_credentials,
157 FLAG, "Save and store credentials/tickets retrieved during auth."),
159 command("KrbVerifyKDC", ap_set_flag_slot, krb_verify_kdc,
160 FLAG, "Verify tickets against keytab to prevent KDC spoofing attacks."),
162 command("KrbServiceName", ap_set_string_slot, krb_service_name,
163 TAKE1, "Service name to be used by Apache for authentication."),
165 command("KrbAuthoritative", ap_set_flag_slot, krb_authoritative,
166 FLAG, "Set to 'off' to allow access control to be passed along to lower modules if the UserID is not known to this module."),
169 command("Krb5Keytab", ap_set_file_slot, krb_5_keytab,
170 TAKE1, "Location of Kerberos V5 keytab file."),
172 command("KrbMethodNegotiate", ap_set_flag_slot, krb_method_gssapi,
173 FLAG, "Enable Negotiate authentication method."),
175 command("KrbMethodK5Passwd", ap_set_flag_slot, krb_method_k5pass,
176 FLAG, "Enable Kerberos V5 password authentication."),
180 command("Krb4Srvtab", ap_set_file_slot, krb_4_srvtab,
181 TAKE1, "Location of Kerberos V4 srvtab file."),
183 command("KrbMethodK4Passwd", ap_set_flag_slot, krb_method_k4pass,
184 FLAG, "Enable Kerberos V4 password authentication."),
190 /***************************************************************************
191 Auth Configuration Initialization
192 ***************************************************************************/
193 static void *kerb_dir_create_config(MK_POOL *p, char *d)
195 kerb_auth_config *rec;
197 rec = (kerb_auth_config *) ap_pcalloc(p, sizeof(kerb_auth_config));
198 ((kerb_auth_config *)rec)->krb_verify_kdc = 1;
199 ((kerb_auth_config *)rec)->krb_service_name = "HTTP";
200 ((kerb_auth_config *)rec)->krb_authoritative = 1;
202 ((kerb_auth_config *)rec)->krb_method_k5pass = 1;
203 ((kerb_auth_config *)rec)->krb_method_gssapi = 1;
206 ((kerb_auth_config *)rec)->krb_method_k4pass = 1;
212 krb5_save_realms(cmd_parms *cmd, kerb_auth_config *sec, char *arg)
214 sec->krb_auth_realms= ap_pstrdup(cmd->pool, arg);
218 void log_rerror(const char *file, int line, int level, int status,
219 const request_rec *r, const char *fmt, ...)
225 vsnprintf(errstr, sizeof(errstr), fmt, ap);
229 #ifdef STANDARD20_MODULE_STUFF
230 ap_log_rerror(file, line, level | APLOG_NOERRNO, status, r, "%s", errstr);
232 ap_log_rerror(file, line, level | APLOG_NOERRNO, r, "%s", errstr);
237 /***************************************************************************
238 Username/Password Validation for Krb4
239 ***************************************************************************/
241 verify_krb4_user(request_rec *r, char *name, char *instance, char *realm,
242 char *password, char *linstance, char *srvtab, int krb_verify_kdc)
248 const char *hostname;
251 char lrealm[REALM_SZ];
253 ret = krb_get_pw_in_tkt(name, instance, realm, "krbtgt", realm,
254 DEFAULT_TKT_LIFE, password);
256 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
257 "Cannot get krb4 ticket: krb_get_pw_in_tkt() failed: %s",
258 krb_get_err_text(ret));
265 hostname = ap_get_server_name(r);
267 hp = gethostbyname(hostname);
270 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
271 "Cannot verify krb4 ticket: gethostbyname() failed: %s",
275 memcpy(&addr, hp->h_addr, sizeof(addr));
277 phost = krb_get_phost((char *)hostname);
279 krb_get_lrealm(lrealm, 1);
281 ret = krb_mk_req(&ticket, linstance, phost, lrealm, 0);
283 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
284 "Cannot verify krb4 ticket: krb_mk_req() failed: %s",
285 krb_get_err_text(ret));
290 ret = krb_rd_req(&ticket, linstance, phost, addr, &authdata, srvtab);
292 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
293 "Cannot verify krb4 ticket: krb_rd_req() failed: %s",
294 krb_get_err_text(ret));
302 krb4_cache_cleanup(void *data)
304 char *tkt_file = (char *) data;
306 krb_set_tkt_string(tkt_file);
312 authenticate_user_krb4pwd(request_rec *r,
313 kerb_auth_config *conf,
314 const char *auth_line)
318 const char *sent_name;
321 char *tkt_file_p = NULL;
326 char lrealm[REALM_SZ];
327 int all_principals_unkown;
329 sent_pw = ap_pbase64decode(r->pool, auth_line);
330 sent_name = ap_getword (r->pool, &sent_pw, ':');
332 /* do not allow user to override realm setting of server */
333 if (strchr(sent_name, '@')) {
334 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
335 "specifying realm in user name is prohibited");
336 return HTTP_UNAUTHORIZED;
339 sent_instance = strchr(sent_name, '.');
341 *sent_instance++ = '\0';
343 snprintf(tkt_file, sizeof(tkt_file), "/tmp/apache_tkt_XXXXXX");
344 fd = mkstemp(tkt_file);
346 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
347 "Cannot create krb4 ccache: mkstemp() failed: %s",
349 return HTTP_INTERNAL_SERVER_ERROR;
352 tkt_file_p = ap_pstrdup(r->pool, tkt_file);
353 ap_register_cleanup(r->pool, tkt_file_p,
354 krb4_cache_cleanup, ap_null_cleanup);
356 krb_set_tkt_string(tkt_file);
358 all_principals_unkown = 1;
359 realms = conf->krb_auth_realms;
361 memset(lrealm, 0, sizeof(lrealm));
364 realm = ap_getword_white(r->pool, &realms);
367 ret = krb_get_lrealm(lrealm, 1);
373 ret = verify_krb4_user(r, (char *)sent_name,
374 (sent_instance) ? sent_instance : "",
375 (char *)realm, (char *)sent_pw,
376 conf->krb_service_name,
377 conf->krb_4_srvtab, conf->krb_verify_kdc);
378 if (!conf->krb_authoritative && ret) {
379 /* if we're not authoritative, we allow authentication to pass on
380 * to another modules if (and only if) the user is not known to us */
381 if (all_principals_unkown && ret != KDC_PR_UNKNOWN)
382 all_principals_unkown = 0;
387 } while (realms && *realms);
390 /* XXX log only in the verify_krb4_user() call */
391 log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "Verifying krb4 password failed");
392 ret = (!conf->krb_authoritative && all_principals_unkown == 1 && ret == KDC_PR_UNKNOWN) ?
393 DECLINED : HTTP_UNAUTHORIZED;
397 user = ap_pstrdup(r->pool, sent_name);
399 user = ap_pstrcat(r->pool, user, ".", sent_instance, NULL);
400 user = ap_pstrcat(r->pool, user, "@", realm, NULL);
403 MK_AUTH_TYPE = "Basic";
404 ap_table_setn(r->subprocess_env, "KRBTKFILE", tkt_file_p);
406 if (!conf->krb_save_credentials)
407 krb4_cache_cleanup(tkt_file);
411 krb4_cache_cleanup(tkt_file);
420 /***************************************************************************
421 Username/Password Validation for Krb5
422 ***************************************************************************/
423 /* Inspired by krb5_verify_user from Heimdal */
424 static krb5_error_code
425 verify_krb5_user(request_rec *r, krb5_context context, krb5_principal principal,
426 krb5_ccache ccache, const char *password, const char *service,
427 krb5_keytab keytab, int krb_verify_kdc)
430 krb5_principal server = NULL;
432 krb5_verify_init_creds_opt opt;
434 /* XXX error messages shouldn't be logged here (and in the while() loop in
435 * authenticate_user_krb5pwd() as weell), in order to avoid confusing log
436 * entries when using multiple realms */
438 memset(&creds, 0, sizeof(creds));
440 ret = krb5_get_init_creds_password(context, &creds, principal,
441 (char *)password, NULL,
442 NULL, 0, NULL, NULL);
444 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
445 "krb5_get_init_creds_password() failed: %s",
446 krb5_get_err_text(context, ret));
450 ret = krb5_sname_to_principal(context, ap_get_server_name(r), service,
451 KRB5_NT_UNKNOWN, &server);
453 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
454 "krb5_sname_to_principal() failed: %s",
455 krb5_get_err_text(context, ret));
458 /* XXX log_debug: lookig for <server_princ> in keytab */
464 krb5_get_default_realm(context, &realm);
465 log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
466 "trying to verify password using key for %s/%s@%s",
467 service, ap_get_server_name(r), realm);
471 krb5_verify_init_creds_opt_init(&opt);
472 krb5_verify_init_creds_opt_set_ap_req_nofail(&opt, krb_verify_kdc);
474 ret = krb5_verify_init_creds(context, &creds, server, keytab, NULL, &opt);
476 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
477 "krb5_verify_init_creds() failed: %s",
478 krb5_get_err_text(context, ret));
483 ret = krb5_cc_initialize(context, ccache, principal);
485 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
486 "krb5_cc_initialize() failed: %s",
487 krb5_get_err_text(context, ret));
491 ret = krb5_cc_store_cred(context, ccache, &creds);
493 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
494 "krb5_cc_store_cred() failed: %s",
495 krb5_get_err_text(context, ret));
501 krb5_free_cred_contents(context, &creds);
503 krb5_free_principal(context, server);
508 krb5_cache_cleanup(void *data)
510 krb5_context context;
512 krb5_error_code problem;
513 char *cache_name = (char *) data;
515 problem = krb5_init_context(&context);
517 /* ap_log_error(APLOG_MARK, APLOG_ERR, 0, NULL, "krb5_init_context() failed"); */
518 return HTTP_INTERNAL_SERVER_ERROR;
521 problem = krb5_cc_resolve(context, cache_name, &cache);
523 /* log_error(APLOG_MARK, APLOG_ERR, 0, NULL,
524 "krb5_cc_resolve() failed (%s: %s)",
525 cache_name, krb5_get_err_text(context, problem)); */
526 return HTTP_INTERNAL_SERVER_ERROR;
529 krb5_cc_destroy(context, cache);
530 krb5_free_context(context);
535 create_krb5_ccache(krb5_context kcontext,
537 kerb_auth_config *conf,
538 krb5_principal princ,
543 krb5_error_code problem;
545 krb5_ccache tmp_ccache = NULL;
547 ccname = ap_psprintf(r->pool, "FILE:%s/krb5cc_apache_XXXXXX", P_tmpdir);
548 fd = mkstemp(ccname + strlen("FILE:"));
550 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
551 "mkstemp() failed: %s", strerror(errno));
552 ret = HTTP_INTERNAL_SERVER_ERROR;
557 problem = krb5_cc_resolve(kcontext, ccname, &tmp_ccache);
559 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
560 "krb5_cc_resolve() failed: %s",
561 krb5_get_err_text(kcontext, problem));
562 ret = HTTP_INTERNAL_SERVER_ERROR;
567 problem = krb5_cc_initialize(kcontext, tmp_ccache, princ);
569 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
570 "Cannot initialize krb5 ccache %s: krb5_cc_initialize() failed: %s",
571 ccname, krb5_get_err_text(kcontext, problem));
572 ret = HTTP_INTERNAL_SERVER_ERROR;
576 ap_table_setn(r->subprocess_env, "KRB5CCNAME", ccname);
577 ap_register_cleanup(r->pool, ccname,
578 krb5_cache_cleanup, ap_null_cleanup);
580 *ccache = tmp_ccache;
587 krb5_cc_destroy(kcontext, tmp_ccache);
593 store_krb5_creds(krb5_context kcontext,
595 kerb_auth_config *conf,
596 krb5_ccache delegated_cred)
599 krb5_error_code problem;
600 krb5_principal princ;
604 problem = krb5_cc_get_principal(kcontext, delegated_cred, &princ);
606 snprintf(errstr, sizeof(errstr), "krb5_cc_get_principal() failed: %s",
607 krb5_get_err_text(kcontext, problem));
608 return HTTP_INTERNAL_SERVER_ERROR;
611 ret = create_krb5_ccache(kcontext, r, conf, princ, &ccache);
613 krb5_free_principal(kcontext, princ);
618 problem = krb5_cc_copy_cache(kcontext, delegated_cred, ccache);
620 problem = krb5_cc_copy_creds(kcontext, delegated_cred, ccache);
622 krb5_free_principal(kcontext, princ);
624 snprintf(errstr, sizeof(errstr), "Failed to store credentials: %s",
625 krb5_get_err_text(kcontext, problem));
626 krb5_cc_destroy(kcontext, ccache);
627 return HTTP_INTERNAL_SERVER_ERROR;
630 krb5_cc_close(kcontext, ccache);
635 int authenticate_user_krb5pwd(request_rec *r,
636 kerb_auth_config *conf,
637 const char *auth_line)
639 const char *sent_pw = NULL;
640 const char *sent_name = NULL;
641 const char *realms = NULL;
642 krb5_context kcontext = NULL;
643 krb5_error_code code;
644 krb5_principal client = NULL;
645 krb5_ccache ccache = NULL;
646 krb5_keytab keytab = NULL;
649 int all_principals_unkown;
653 code = krb5_init_context(&kcontext);
655 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
656 "Cannot initialize Kerberos5 context (%d)", code);
657 return HTTP_INTERNAL_SERVER_ERROR;
660 sent_pw = ap_pbase64decode(r->pool, auth_line);
661 sent_name = ap_getword (r->pool, &sent_pw, ':');
662 /* do not allow user to override realm setting of server */
663 if (strchr(sent_name, '@')) {
664 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
665 "specifying realm in user name is prohibited");
666 ret = HTTP_UNAUTHORIZED;
670 if (sent_pw == NULL || *sent_pw == '\0') {
671 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
672 "empty passwords are not accepted");
673 ret = HTTP_UNAUTHORIZED;
677 code = krb5_cc_resolve(kcontext, "MEMORY:", &ccache);
679 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
680 "generating new memory ccache failed: %s",
681 krb5_get_err_text(kcontext, code));
682 ret = HTTP_INTERNAL_SERVER_ERROR;
687 if (conf->krb_5_keytab)
688 krb5_kt_resolve(kcontext, conf->krb_5_keytab, &keytab);
690 all_principals_unkown = 1;
691 realms = conf->krb_auth_realms;
693 if (realms && (code = krb5_set_default_realm(kcontext,
694 ap_getword_white(r->pool, &realms)))){
695 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
696 "krb5_set_default_realm() failed: %s",
697 krb5_get_err_text(kcontext, code));
702 krb5_free_principal(kcontext, client);
705 code = krb5_parse_name(kcontext, sent_name, &client);
707 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
708 "krb5_parse_name() failed: %s",
709 krb5_get_err_text(kcontext, code));
713 code = verify_krb5_user(r, kcontext, client, ccache, sent_pw,
714 conf->krb_service_name,
715 keytab, conf->krb_verify_kdc);
716 if (!conf->krb_authoritative && code) {
717 /* if we're not authoritative, we allow authentication to pass on
718 * to another modules if (and only if) the user is not known to us */
719 if (all_principals_unkown && code != KRB5KDC_ERR_C_PRINCIPAL_UNKNOWN)
720 all_principals_unkown = 0;
726 /* ap_getword_white() used above shifts the parameter, so it's not
727 needed to touch the realms variable */
728 } while (realms && *realms);
730 memset((char *)sent_pw, 0, strlen(sent_pw));
733 if (!conf->krb_authoritative && all_principals_unkown == 1 && code == KRB5KDC_ERR_C_PRINCIPAL_UNKNOWN)
736 ret = HTTP_UNAUTHORIZED;
741 code = krb5_unparse_name(kcontext, client, &name);
743 log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "krb5_unparse_name() failed: %s",
744 krb5_get_err_text(kcontext, code));
745 ret = HTTP_UNAUTHORIZED;
748 MK_USER = ap_pstrdup (r->pool, name);
749 MK_AUTH_TYPE = "Basic";
752 if (conf->krb_save_credentials)
753 store_krb5_creds(kcontext, r, conf, ccache);
759 krb5_free_principal(kcontext, client);
761 krb5_cc_destroy(kcontext, ccache);
763 krb5_kt_close(kcontext, keytab);
764 krb5_free_context(kcontext);
769 /*********************************************************************
770 * GSSAPI Authentication
771 ********************************************************************/
774 get_gss_error(MK_POOL *p, OM_uint32 err_maj, OM_uint32 err_min, char *prefix)
776 OM_uint32 maj_stat, min_stat;
777 OM_uint32 msg_ctx = 0;
778 gss_buffer_desc status_string;
782 err_msg = ap_pstrdup(p, prefix);
784 maj_stat = gss_display_status (&min_stat,
790 if (GSS_ERROR(maj_stat))
792 err_msg = ap_pstrcat(p, err_msg, ": ", (char*) status_string.value, NULL);
793 gss_release_buffer(&min_stat, &status_string);
795 maj_stat = gss_display_status (&min_stat,
801 if (!GSS_ERROR(maj_stat)) {
802 err_msg = ap_pstrcat(p, err_msg,
803 " (", (char*) status_string.value, ")", NULL);
804 gss_release_buffer(&min_stat, &status_string);
806 } while (!GSS_ERROR(maj_stat) && msg_ctx != 0);
812 store_gss_creds(request_rec *r, kerb_auth_config *conf, char *princ_name,
813 gss_cred_id_t delegated_cred)
815 OM_uint32 maj_stat, min_stat;
816 krb5_principal princ = NULL;
817 krb5_ccache ccache = NULL;
818 krb5_error_code problem;
819 krb5_context context;
820 int ret = HTTP_INTERNAL_SERVER_ERROR;
822 problem = krb5_init_context(&context);
824 log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "Cannot initialize krb5 context");
825 return HTTP_INTERNAL_SERVER_ERROR;
828 problem = krb5_parse_name(context, princ_name, &princ);
830 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
831 "Cannot parse delegated username (%s)", krb5_get_err_text(context, problem));
835 problem = create_krb5_ccache(context, r, conf, princ, &ccache);
837 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
838 "Cannot create krb5 ccache (%s)", krb5_get_err_text(context, problem));
842 maj_stat = gss_krb5_copy_ccache(&min_stat, delegated_cred, ccache);
843 if (GSS_ERROR(maj_stat)) {
844 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
845 "Cannot store delegated credential (%s)",
846 get_gss_error(r->pool, maj_stat, min_stat, "gss_krb5_copy_ccache"));
850 krb5_cc_close(context, ccache);
856 krb5_free_principal(context, princ);
858 krb5_cc_destroy(context, ccache);
859 krb5_free_context(context);
864 get_gss_creds(request_rec *r,
865 kerb_auth_config *conf,
866 gss_cred_id_t *server_creds)
868 gss_buffer_desc input_token = GSS_C_EMPTY_BUFFER;
869 OM_uint32 major_status, minor_status, minor_status2;
870 gss_name_t server_name = GSS_C_NO_NAME;
874 /* Don't specify service name. This makes MIT 1.3 not to use replay caches,
875 * which causes large problems with the Microsoft krb5 implementation. MS
876 * obviously uses a format of the krb5 authenticator that is considered by
877 * the MIT as replay (Two valid MS authenticators may contain the same time
878 * and utime fields and only differ in the sequential numbers).
880 snprintf(buf, sizeof(buf), "%s@%s", conf->krb_service_name,
881 ap_get_server_name(r));
883 input_token.value = buf;
884 input_token.length = strlen(buf) + 1;
886 major_status = gss_import_name(&minor_status, &input_token,
887 GSS_C_NT_HOSTBASED_SERVICE,
889 if (GSS_ERROR(major_status)) {
890 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
891 "%s", get_gss_error(r->pool, major_status, minor_status,
892 "gss_import_name() failed"));
893 return HTTP_INTERNAL_SERVER_ERROR;
897 major_status = gss_acquire_cred(&minor_status, server_name, GSS_C_INDEFINITE,
898 GSS_C_NO_OID_SET, GSS_C_ACCEPT,
899 server_creds, NULL, NULL);
900 gss_release_name(&minor_status2, &server_name);
901 if (GSS_ERROR(major_status)) {
902 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
903 "%s", get_gss_error(r->pool, major_status, minor_status,
904 "gss_acquire_cred() failed"));
905 return HTTP_INTERNAL_SERVER_ERROR;
912 cmp_gss_type(gss_buffer_t token, gss_OID oid)
917 if (token->length == 0)
918 return GSS_S_DEFECTIVE_TOKEN;
920 /* XXX if (token->value == NTLMSSP) log_debug("NTLM mechanism used"); */
924 return GSS_S_DEFECTIVE_TOKEN;
927 if ((len & 0x7f) > 4)
928 return GSS_S_DEFECTIVE_TOKEN;
932 return GSS_S_DEFECTIVE_TOKEN;
934 if (((OM_uint32) *p++) != oid->length)
935 return GSS_S_DEFECTIVE_TOKEN;
937 return memcmp(p, oid->elements, oid->length);
941 authenticate_user_gss(request_rec *r, kerb_auth_config *conf,
942 const char *auth_line, char **negotiate_ret_value)
944 OM_uint32 major_status, minor_status, minor_status2;
945 gss_buffer_desc input_token = GSS_C_EMPTY_BUFFER;
946 gss_buffer_desc output_token = GSS_C_EMPTY_BUFFER;
947 const char *auth_param = NULL;
949 gss_name_t client_name = GSS_C_NO_NAME;
950 gss_cred_id_t delegated_cred = GSS_C_NO_CREDENTIAL;
951 OM_uint32 (*accept_sec_token)();
952 gss_OID_desc spnego_oid;
953 gss_ctx_id_t context = GSS_C_NO_CONTEXT;
954 gss_cred_id_t server_creds = GSS_C_NO_CREDENTIAL;
956 *negotiate_ret_value = "\0";
958 spnego_oid.length = 6;
959 spnego_oid.elements = (void *)"\x2b\x06\x01\x05\x05\x02";
961 if (conf->krb_5_keytab) {
963 /* we don't use the ap_* calls here, since the string passed to putenv()
964 * will become part of the enviroment and shouldn't be free()ed by apache
966 ktname = malloc(strlen("KRB5_KTNAME=") + strlen(conf->krb_5_keytab) + 1);
967 if (ktname == NULL) {
968 log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "malloc() failed: not enough memory");
969 ret = HTTP_INTERNAL_SERVER_ERROR;
972 sprintf(ktname, "KRB5_KTNAME=%s", conf->krb_5_keytab);
976 ret = get_gss_creds(r, conf, &server_creds);
980 /* ap_getword() shifts parameter */
981 auth_param = ap_getword_white(r->pool, &auth_line);
982 if (auth_param == NULL) {
983 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
984 "No Authorization parameter in request from client");
985 ret = HTTP_UNAUTHORIZED;
989 input_token.length = ap_base64decode_len(auth_param) + 1;
990 input_token.value = ap_pcalloc(r->connection->pool, input_token.length);
991 if (input_token.value == NULL) {
992 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
993 "ap_pcalloc() failed (not enough memory)");
994 ret = HTTP_INTERNAL_SERVER_ERROR;
997 input_token.length = ap_base64decode(input_token.value, auth_param);
999 accept_sec_token = (cmp_gss_type(&input_token, &spnego_oid) == 0) ?
1000 gss_accept_sec_context_spnego : gss_accept_sec_context;
1002 major_status = accept_sec_token(&minor_status,
1006 GSS_C_NO_CHANNEL_BINDINGS,
1013 if (output_token.length) {
1017 len = ap_base64encode_len(output_token.length) + 1;
1018 token = ap_pcalloc(r->connection->pool, len + 1);
1019 if (token == NULL) {
1020 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1021 "ap_pcalloc() failed (not enough memory)");
1022 ret = HTTP_INTERNAL_SERVER_ERROR;
1023 gss_release_buffer(&minor_status2, &output_token);
1026 ap_base64encode(token, output_token.value, output_token.length);
1028 *negotiate_ret_value = token;
1029 gss_release_buffer(&minor_status2, &output_token);
1032 if (GSS_ERROR(major_status)) {
1033 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1034 "%s", get_gss_error(r->pool, major_status, minor_status,
1035 "gss_accept_sec_context() failed"));
1036 /* Don't offer the Negotiate method again if call to GSS layer failed */
1037 *negotiate_ret_value = NULL;
1038 ret = HTTP_UNAUTHORIZED;
1043 /* This is a _Kerberos_ module so multiple authentication rounds aren't
1044 * supported. If we wanted a generic GSS authentication we would have to do
1045 * some magic with exporting context etc. */
1046 if (major_status & GSS_S_CONTINUE_NEEDED) {
1047 ret = HTTP_UNAUTHORIZED;
1052 major_status = gss_display_name(&minor_status, client_name, &output_token, NULL);
1053 gss_release_name(&minor_status, &client_name);
1054 if (GSS_ERROR(major_status)) {
1055 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1056 "%s", get_gss_error(r->pool, major_status, minor_status,
1057 "gss_export_name() failed"));
1058 ret = HTTP_INTERNAL_SERVER_ERROR;
1062 MK_AUTH_TYPE = "Negotiate";
1063 MK_USER = ap_pstrdup(r->pool, output_token.value);
1065 if (conf->krb_save_credentials && delegated_cred != GSS_C_NO_CREDENTIAL)
1066 store_gss_creds(r, conf, (char *)output_token.value, delegated_cred);
1068 if (*negotiate_ret_value)
1069 set_kerb_auth_headers(r, conf, 0, 0, *negotiate_ret_value);
1071 gss_release_buffer(&minor_status, &output_token);
1077 gss_release_cred(&minor_status, &delegated_cred);
1079 if (output_token.length)
1080 gss_release_buffer(&minor_status, &output_token);
1082 if (client_name != GSS_C_NO_NAME)
1083 gss_release_name(&minor_status, &client_name);
1085 if (server_creds != GSS_C_NO_CREDENTIAL)
1086 gss_release_cred(&minor_status, &server_creds);
1088 if (context != GSS_C_NO_CONTEXT)
1089 gss_delete_sec_context(&minor_status, &context, GSS_C_NO_BUFFER);
1096 already_succeeded(request_rec *r)
1098 if (ap_is_initial_req(r) || MK_AUTH_TYPE == NULL)
1100 if (strcmp(MK_AUTH_TYPE, "Negotiate") ||
1101 (strcmp(MK_AUTH_TYPE, "Basic") && strchr(MK_USER, '@')))
1107 set_kerb_auth_headers(request_rec *r, const kerb_auth_config *conf,
1108 int use_krb4, int use_krb5pwd, char *negotiate_ret_value)
1110 const char *auth_name = NULL;
1112 char *negoauth_param;
1113 const char *header_name =
1114 (r->proxyreq == PROXYREQ_PROXY) ? "Proxy-Authenticate" : "WWW-Authenticate";
1116 /* get the user realm specified in .htaccess */
1117 auth_name = ap_auth_name(r);
1119 /* XXX should the WWW-Authenticate header be cleared first? */
1121 if (negotiate_ret_value != NULL && conf->krb_method_gssapi) {
1122 negoauth_param = (*negotiate_ret_value == '\0') ? "Negotiate" :
1123 ap_pstrcat(r->pool, "Negotiate ", negotiate_ret_value, NULL);
1124 ap_table_add(r->err_headers_out, header_name, negoauth_param);
1126 if (use_krb5pwd && conf->krb_method_k5pass) {
1127 ap_table_add(r->err_headers_out, header_name,
1128 ap_pstrcat(r->pool, "Basic realm=\"", auth_name, "\"", NULL));
1134 if (use_krb4 && conf->krb_method_k4pass && !set_basic)
1135 ap_table_add(r->err_headers_out, header_name,
1136 ap_pstrcat(r->pool, "Basic realm=\"", auth_name, "\"", NULL));
1140 int kerb_authenticate_user(request_rec *r)
1142 kerb_auth_config *conf =
1143 (kerb_auth_config *) ap_get_module_config(r->per_dir_config,
1145 const char *auth_type = NULL;
1146 const char *auth_line = NULL;
1147 const char *type = NULL;
1148 int use_krb5 = 0, use_krb4 = 0;
1150 static int last_return = HTTP_UNAUTHORIZED;
1151 char *negotiate_ret_value = NULL;
1153 /* get the type specified in .htaccess */
1154 type = ap_auth_type(r);
1156 if (type && strcasecmp(type, "Kerberos") == 0)
1157 use_krb5 = use_krb4 = 1;
1158 else if(type && strcasecmp(type, "KerberosV5") == 0)
1160 else if(type && strcasecmp(type, "KerberosV4") == 0)
1165 /* get what the user sent us in the HTTP header */
1166 auth_line = MK_TABLE_GET(r->headers_in, "Authorization");
1168 auth_line = MK_TABLE_GET(r->headers_in, "Proxy-Authorization");
1170 set_kerb_auth_headers(r, conf, use_krb4, use_krb5,
1171 (use_krb5) ? "\0" : NULL);
1172 return HTTP_UNAUTHORIZED;
1175 auth_type = ap_getword_white(r->pool, &auth_line);
1177 if (already_succeeded(r))
1180 ret = HTTP_UNAUTHORIZED;
1183 if (use_krb5 && conf->krb_method_gssapi &&
1184 strcasecmp(auth_type, "Negotiate") == 0) {
1185 ret = authenticate_user_gss(r, conf, auth_line, &negotiate_ret_value);
1186 } else if (use_krb5 && conf->krb_method_k5pass &&
1187 strcasecmp(auth_type, "Basic") == 0) {
1188 ret = authenticate_user_krb5pwd(r, conf, auth_line);
1193 if (ret == HTTP_UNAUTHORIZED && use_krb4 && conf->krb_method_k4pass &&
1194 strcasecmp(auth_type, "Basic") == 0)
1195 ret = authenticate_user_krb4pwd(r, conf, auth_line);
1198 if (ret == HTTP_UNAUTHORIZED)
1199 set_kerb_auth_headers(r, conf, use_krb4, use_krb5, negotiate_ret_value);
1201 /* XXX log_debug: if ret==OK, log(user XY authenticated) */
1208 /***************************************************************************
1209 Module Setup/Configuration
1210 ***************************************************************************/
1211 #ifndef STANDARD20_MODULE_STUFF
1212 module MODULE_VAR_EXPORT auth_kerb_module = {
1213 STANDARD_MODULE_STUFF,
1214 NULL, /* module initializer */
1215 kerb_dir_create_config, /* per-directory config creator */
1216 NULL, /* per-directory config merger */
1217 NULL, /* per-server config creator */
1218 NULL, /* per-server config merger */
1219 kerb_auth_cmds, /* command table */
1220 NULL, /* [ 9] content handlers */
1221 NULL, /* [ 2] URI-to-filename translation */
1222 kerb_authenticate_user, /* [ 5] check/validate user_id */
1223 NULL, /* [ 6] check user_id is valid *here* */
1224 NULL, /* [ 4] check access by host address */
1225 NULL, /* [ 7] MIME type checker/setter */
1226 NULL, /* [ 8] fixups */
1227 NULL, /* [10] logger */
1228 NULL, /* [ 3] header parser */
1229 NULL, /* process initialization */
1230 NULL, /* process exit/cleanup */
1231 NULL /* [ 1] post read_request handling */
1235 kerb_init_handler(apr_pool_t *p, apr_pool_t *plog,
1236 apr_pool_t *ptemp, server_rec *s)
1238 ap_add_version_component(p, "mod_auth_kerb/" MODAUTHKERB_VERSION);
1242 void kerb_register_hooks(apr_pool_t *p)
1244 ap_hook_post_config(kerb_init_handler, NULL, NULL, APR_HOOK_MIDDLE);
1245 ap_hook_check_user_id(kerb_authenticate_user, NULL, NULL, APR_HOOK_MIDDLE);
1248 module AP_MODULE_DECLARE_DATA auth_kerb_module =
1250 STANDARD20_MODULE_STUFF,
1251 kerb_dir_create_config, /* create per-dir conf structures */
1252 NULL, /* merge per-dir conf structures */
1253 NULL, /* create per-server conf structures */
1254 NULL, /* merge per-server conf structures */
1255 kerb_auth_cmds, /* table of configuration directives */
1256 kerb_register_hooks /* register hooks */