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-rc5"
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>
61 #include <apr_base64.h>
69 # include <gssapi/gssapi.h>
70 # include <gssapi/gssapi_generic.h>
71 # include <gssapi/gssapi_krb5.h>
72 # define GSS_C_NT_USER_NAME gss_nt_user_name
73 # define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
74 # define krb5_get_err_text(context,code) error_message(code)
76 #include "spnegokrb5.h"
80 /* Prevent warning about closesocket redefinition (Apache's ap_config.h and
81 * MIT Kerberos' port-sockets.h both define it as close) */
86 #include <netdb.h> /* gethostbyname() */
89 /* XXX remove dependency on unistd.h ??? */
92 #ifdef STANDARD20_MODULE_STUFF
93 module AP_MODULE_DECLARE_DATA auth_kerb_module;
95 module auth_kerb_module;
98 /***************************************************************************
99 Macros To Ease Compatibility
100 ***************************************************************************/
101 #ifdef STANDARD20_MODULE_STUFF
102 #define MK_POOL apr_pool_t
103 #define MK_TABLE_GET apr_table_get
104 #define MK_USER r->user
105 #define MK_AUTH_TYPE r->ap_auth_type
108 #define MK_TABLE_GET ap_table_get
109 #define MK_USER r->connection->user
110 #define MK_AUTH_TYPE r->connection->ap_auth_type
111 #define PROXYREQ_PROXY STD_PROXY
114 /***************************************************************************
115 Auth Configuration Structure
116 ***************************************************************************/
118 char *krb_auth_realms;
119 int krb_save_credentials;
121 char *krb_service_name;
122 int krb_authoritative;
123 int krb_delegate_basic;
126 int krb_method_gssapi;
127 int krb_method_k5pass;
131 int krb_method_k4pass;
136 set_kerb_auth_headers(request_rec *r, const kerb_auth_config *conf,
137 int use_krb4, int use_krb5pwd, char *negotiate_ret_value);
140 krb5_save_realms(cmd_parms *cmd, kerb_auth_config *sec, char *arg);
142 #ifdef STANDARD20_MODULE_STUFF
143 #define command(name, func, var, type, usage) \
144 AP_INIT_ ## type (name, func, \
145 (void*)APR_XtOffsetOf(kerb_auth_config, var), \
148 #define command(name, func, var, type, usage) \
150 (void*)XtOffsetOf(kerb_auth_config, var), \
151 OR_AUTHCFG, type, usage }
154 static const command_rec kerb_auth_cmds[] = {
155 command("KrbAuthRealms", krb5_save_realms, krb_auth_realms,
156 RAW_ARGS, "Realms to attempt authentication against (can be multiple)."),
158 command("KrbAuthRealm", krb5_save_realms, krb_auth_realms,
159 RAW_ARGS, "Alias for KrbAuthRealms."),
161 command("KrbSaveCredentials", ap_set_flag_slot, krb_save_credentials,
162 FLAG, "Save and store credentials/tickets retrieved during auth."),
164 command("KrbVerifyKDC", ap_set_flag_slot, krb_verify_kdc,
165 FLAG, "Verify tickets against keytab to prevent KDC spoofing attacks."),
167 command("KrbServiceName", ap_set_string_slot, krb_service_name,
168 TAKE1, "Service name to be used by Apache for authentication."),
170 command("KrbAuthoritative", ap_set_flag_slot, krb_authoritative,
171 FLAG, "Set to 'off' to allow access control to be passed along to lower modules iff the UserID is not known to this module."),
173 command("KrbDelegateBasic", ap_set_flag_slot, krb_delegate_basic,
174 FLAG, "Always offer Basic authentication regardless of KrbMethodK5Pass and pass on authentication to lower modules if Basic headers arrive."),
177 command("Krb5Keytab", ap_set_file_slot, krb_5_keytab,
178 TAKE1, "Location of Kerberos V5 keytab file."),
180 command("KrbMethodNegotiate", ap_set_flag_slot, krb_method_gssapi,
181 FLAG, "Enable Negotiate authentication method."),
183 command("KrbMethodK5Passwd", ap_set_flag_slot, krb_method_k5pass,
184 FLAG, "Enable Kerberos V5 password authentication."),
188 command("Krb4Srvtab", ap_set_file_slot, krb_4_srvtab,
189 TAKE1, "Location of Kerberos V4 srvtab file."),
191 command("KrbMethodK4Passwd", ap_set_flag_slot, krb_method_k4pass,
192 FLAG, "Enable Kerberos V4 password authentication."),
198 #if defined(KRB5) && !defined(HEIMDAL)
199 /* Needed to work around problems with replay caches */
200 #include "mit-internals.h"
202 /* This is our replacement krb5_rc_store function */
203 static krb5_error_code
204 mod_auth_kerb_rc_store(krb5_context context, krb5_rcache rcache,
205 krb5_donot_replay_internal *donot_replay)
210 /* And this is the operations vector for our replay cache */
211 const krb5_rc_ops_internal mod_auth_kerb_rc_ops = {
218 mod_auth_kerb_rc_store,
220 krb5_rc_dfl_get_span,
221 krb5_rc_dfl_get_name,
227 /***************************************************************************
228 Auth Configuration Initialization
229 ***************************************************************************/
230 static void *kerb_dir_create_config(MK_POOL *p, char *d)
232 kerb_auth_config *rec;
234 rec = (kerb_auth_config *) ap_pcalloc(p, sizeof(kerb_auth_config));
235 ((kerb_auth_config *)rec)->krb_verify_kdc = 1;
236 ((kerb_auth_config *)rec)->krb_service_name = "HTTP";
237 ((kerb_auth_config *)rec)->krb_authoritative = 1;
238 ((kerb_auth_config *)rec)->krb_delegate_basic = 0;
240 ((kerb_auth_config *)rec)->krb_method_k5pass = 1;
241 ((kerb_auth_config *)rec)->krb_method_gssapi = 1;
244 ((kerb_auth_config *)rec)->krb_method_k4pass = 1;
250 krb5_save_realms(cmd_parms *cmd, kerb_auth_config *sec, char *arg)
252 sec->krb_auth_realms= ap_pstrdup(cmd->pool, arg);
256 void log_rerror(const char *file, int line, int level, int status,
257 const request_rec *r, const char *fmt, ...)
263 vsnprintf(errstr, sizeof(errstr), fmt, ap);
267 #ifdef STANDARD20_MODULE_STUFF
268 ap_log_rerror(file, line, level | APLOG_NOERRNO, status, r, "%s", errstr);
270 ap_log_rerror(file, line, level | APLOG_NOERRNO, r, "%s", errstr);
275 /***************************************************************************
276 Username/Password Validation for Krb4
277 ***************************************************************************/
279 verify_krb4_user(request_rec *r, char *name, char *instance, char *realm,
280 char *password, char *linstance, char *srvtab, int krb_verify_kdc)
286 const char *hostname;
289 char lrealm[REALM_SZ];
291 ret = krb_get_pw_in_tkt(name, instance, realm, "krbtgt", realm,
292 DEFAULT_TKT_LIFE, password);
294 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
295 "Cannot get krb4 ticket: krb_get_pw_in_tkt() failed: %s",
296 krb_get_err_text(ret));
303 hostname = ap_get_server_name(r);
305 hp = gethostbyname(hostname);
308 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
309 "Cannot verify krb4 ticket: gethostbyname() failed: %s",
313 memcpy(&addr, hp->h_addr, sizeof(addr));
315 phost = krb_get_phost((char *)hostname);
317 krb_get_lrealm(lrealm, 1);
319 ret = krb_mk_req(&ticket, linstance, phost, lrealm, 0);
321 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
322 "Cannot verify krb4 ticket: krb_mk_req() failed: %s",
323 krb_get_err_text(ret));
328 ret = krb_rd_req(&ticket, linstance, phost, addr, &authdata, srvtab);
330 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
331 "Cannot verify krb4 ticket: krb_rd_req() failed: %s",
332 krb_get_err_text(ret));
340 krb4_cache_cleanup(void *data)
342 char *tkt_file = (char *) data;
344 krb_set_tkt_string(tkt_file);
350 authenticate_user_krb4pwd(request_rec *r,
351 kerb_auth_config *conf,
352 const char *auth_line)
356 const char *sent_name;
359 char *tkt_file_p = NULL;
364 char lrealm[REALM_SZ];
365 int all_principals_unkown;
367 sent_pw = ap_pbase64decode(r->pool, auth_line);
368 sent_name = ap_getword (r->pool, &sent_pw, ':');
370 /* do not allow user to override realm setting of server */
371 if (strchr(sent_name, '@')) {
372 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
373 "specifying realm in user name is prohibited");
374 return HTTP_UNAUTHORIZED;
377 sent_instance = strchr(sent_name, '.');
379 *sent_instance++ = '\0';
381 snprintf(tkt_file, sizeof(tkt_file), "/tmp/apache_tkt_XXXXXX");
382 fd = mkstemp(tkt_file);
384 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
385 "Cannot create krb4 ccache: mkstemp() failed: %s",
387 return HTTP_INTERNAL_SERVER_ERROR;
390 tkt_file_p = ap_pstrdup(r->pool, tkt_file);
391 ap_register_cleanup(r->pool, tkt_file_p,
392 krb4_cache_cleanup, ap_null_cleanup);
394 krb_set_tkt_string(tkt_file);
396 all_principals_unkown = 1;
397 realms = conf->krb_auth_realms;
399 memset(lrealm, 0, sizeof(lrealm));
402 realm = ap_getword_white(r->pool, &realms);
405 ret = krb_get_lrealm(lrealm, 1);
411 ret = verify_krb4_user(r, (char *)sent_name,
412 (sent_instance) ? sent_instance : "",
413 (char *)realm, (char *)sent_pw,
414 conf->krb_service_name,
415 conf->krb_4_srvtab, conf->krb_verify_kdc);
416 if (!conf->krb_authoritative && ret) {
417 /* if we're not authoritative, we allow authentication to pass on
418 * to another modules if (and only if) the user is not known to us */
419 if (all_principals_unkown && ret != KDC_PR_UNKNOWN)
420 all_principals_unkown = 0;
425 } while (realms && *realms);
428 /* XXX log only in the verify_krb4_user() call */
429 log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "Verifying krb4 password failed");
430 ret = (!conf->krb_authoritative && all_principals_unkown == 1 && ret == KDC_PR_UNKNOWN) ?
431 DECLINED : HTTP_UNAUTHORIZED;
435 user = ap_pstrdup(r->pool, sent_name);
437 user = ap_pstrcat(r->pool, user, ".", sent_instance, NULL);
438 user = ap_pstrcat(r->pool, user, "@", realm, NULL);
441 MK_AUTH_TYPE = "Basic";
442 ap_table_setn(r->subprocess_env, "KRBTKFILE", tkt_file_p);
444 if (!conf->krb_save_credentials)
445 krb4_cache_cleanup(tkt_file);
449 krb4_cache_cleanup(tkt_file);
458 /***************************************************************************
459 Username/Password Validation for Krb5
460 ***************************************************************************/
462 /* MIT kerberos uses replay cache checks even during credential verification
463 * (i.e. in krb5_verify_init_creds()), which is obviosuly useless. In order to
464 * avoid problems with multiple apache processes accessing the same rcache file
465 * we had to use this call instead, which is only a bit modified version of
466 * krb5_verify_init_creds() */
467 static krb5_error_code
468 verify_krb5_init_creds(krb5_context context, krb5_creds *creds,
469 krb5_principal ap_req_server, krb5_keytab ap_req_keytab)
473 krb5_ccache local_ccache = NULL;
474 krb5_creds *new_creds = NULL;
475 krb5_auth_context auth_context = NULL;
476 krb5_keytab keytab = NULL;
478 memset(&req, 0, sizeof(req));
480 if (ap_req_keytab == NULL) {
481 ret = krb5_kt_default (context, &keytab);
485 keytab = ap_req_keytab;
487 ret = krb5_cc_resolve(context, "MEMORY:", &local_ccache);
491 ret = krb5_cc_initialize(context, local_ccache, creds->client);
495 ret = krb5_cc_store_cred (context, local_ccache, creds);
499 if (!krb5_principal_compare (context, ap_req_server, creds->server)) {
500 krb5_creds match_cred;
502 memset (&match_cred, 0, sizeof(match_cred));
504 match_cred.client = creds->client;
505 match_cred.server = ap_req_server;
507 ret = krb5_get_credentials (context, 0, local_ccache,
508 &match_cred, &new_creds);
514 ret = krb5_mk_req_extended (context, &auth_context, 0, NULL, creds, &req);
518 krb5_auth_con_free (context, auth_context);
520 ret = krb5_auth_con_init(context, &auth_context);
523 /* use KRB5_AUTH_CONTEXT_DO_SEQUENCE to skip replay cache checks */
524 krb5_auth_con_setflags(context, auth_context, KRB5_AUTH_CONTEXT_DO_SEQUENCE);
526 ret = krb5_rd_req (context, &auth_context, &req, ap_req_server,
530 krb5_free_data_contents(context, &req);
532 krb5_auth_con_free (context, auth_context);
534 krb5_free_creds (context, new_creds);
535 if (ap_req_keytab == NULL && keytab)
536 krb5_kt_close (context, keytab);
538 krb5_cc_destroy (context, local_ccache);
543 /* Inspired by krb5_verify_user from Heimdal */
544 static krb5_error_code
545 verify_krb5_user(request_rec *r, krb5_context context, krb5_principal principal,
546 const char *password, const char *service, krb5_keytab keytab,
547 int krb_verify_kdc, krb5_ccache *ccache)
550 krb5_principal server = NULL;
552 krb5_ccache ret_ccache = NULL;
554 /* XXX error messages shouldn't be logged here (and in the while() loop in
555 * authenticate_user_krb5pwd() as weell), in order to avoid confusing log
556 * entries when using multiple realms */
558 memset(&creds, 0, sizeof(creds));
560 ret = krb5_get_init_creds_password(context, &creds, principal,
561 (char *)password, NULL,
562 NULL, 0, NULL, NULL);
564 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
565 "krb5_get_init_creds_password() failed: %s",
566 krb5_get_err_text(context, ret));
570 ret = krb5_sname_to_principal(context, ap_get_server_name(r), service,
571 KRB5_NT_UNKNOWN, &server);
573 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
574 "krb5_sname_to_principal() failed: %s",
575 krb5_get_err_text(context, ret));
578 /* XXX log_debug: lookig for <server_princ> in keytab */
584 krb5_get_default_realm(context, &realm);
585 log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
586 "trying to verify password using key for %s/%s@%s",
587 service, ap_get_server_name(r), realm);
591 if (krb_verify_kdc &&
592 (ret = verify_krb5_init_creds(context, &creds, server, keytab))) {
593 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
594 "failed to verify krb5 credentials: %s",
595 krb5_get_err_text(context, ret));
599 ret = krb5_cc_resolve(context, "MEMORY:", &ret_ccache);
601 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
602 "generating new memory ccache failed: %s",
603 krb5_get_err_text(context, ret));
607 ret = krb5_cc_initialize(context, ret_ccache, principal);
609 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
610 "krb5_cc_initialize() failed: %s",
611 krb5_get_err_text(context, ret));
615 ret = krb5_cc_store_cred(context, ret_ccache, &creds);
617 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
618 "krb5_cc_store_cred() failed: %s",
619 krb5_get_err_text(context, ret));
622 *ccache = ret_ccache;
626 krb5_free_cred_contents(context, &creds);
628 krb5_free_principal(context, server);
630 krb5_cc_destroy(context, ret_ccache);
636 krb5_cache_cleanup(void *data)
638 krb5_context context;
640 krb5_error_code problem;
641 char *cache_name = (char *) data;
643 problem = krb5_init_context(&context);
645 /* ap_log_error(APLOG_MARK, APLOG_ERR, 0, NULL, "krb5_init_context() failed"); */
646 return HTTP_INTERNAL_SERVER_ERROR;
649 problem = krb5_cc_resolve(context, cache_name, &cache);
651 /* log_error(APLOG_MARK, APLOG_ERR, 0, NULL,
652 "krb5_cc_resolve() failed (%s: %s)",
653 cache_name, krb5_get_err_text(context, problem)); */
654 return HTTP_INTERNAL_SERVER_ERROR;
657 krb5_cc_destroy(context, cache);
658 krb5_free_context(context);
663 create_krb5_ccache(krb5_context kcontext,
665 kerb_auth_config *conf,
666 krb5_principal princ,
671 krb5_error_code problem;
673 krb5_ccache tmp_ccache = NULL;
675 ccname = ap_psprintf(r->pool, "FILE:%s/krb5cc_apache_XXXXXX", P_tmpdir);
676 fd = mkstemp(ccname + strlen("FILE:"));
678 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
679 "mkstemp() failed: %s", strerror(errno));
680 ret = HTTP_INTERNAL_SERVER_ERROR;
685 problem = krb5_cc_resolve(kcontext, ccname, &tmp_ccache);
687 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
688 "krb5_cc_resolve() failed: %s",
689 krb5_get_err_text(kcontext, problem));
690 ret = HTTP_INTERNAL_SERVER_ERROR;
695 problem = krb5_cc_initialize(kcontext, tmp_ccache, princ);
697 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
698 "Cannot initialize krb5 ccache %s: krb5_cc_initialize() failed: %s",
699 ccname, krb5_get_err_text(kcontext, problem));
700 ret = HTTP_INTERNAL_SERVER_ERROR;
704 ap_table_setn(r->subprocess_env, "KRB5CCNAME", ccname);
705 ap_register_cleanup(r->pool, ccname,
706 krb5_cache_cleanup, ap_null_cleanup);
708 *ccache = tmp_ccache;
715 krb5_cc_destroy(kcontext, tmp_ccache);
721 store_krb5_creds(krb5_context kcontext,
723 kerb_auth_config *conf,
724 krb5_ccache delegated_cred)
727 krb5_error_code problem;
728 krb5_principal princ;
732 problem = krb5_cc_get_principal(kcontext, delegated_cred, &princ);
734 snprintf(errstr, sizeof(errstr), "krb5_cc_get_principal() failed: %s",
735 krb5_get_err_text(kcontext, problem));
736 return HTTP_INTERNAL_SERVER_ERROR;
739 ret = create_krb5_ccache(kcontext, r, conf, princ, &ccache);
741 krb5_free_principal(kcontext, princ);
746 problem = krb5_cc_copy_cache(kcontext, delegated_cred, ccache);
748 problem = krb5_cc_copy_creds(kcontext, delegated_cred, ccache);
750 krb5_free_principal(kcontext, princ);
752 snprintf(errstr, sizeof(errstr), "Failed to store credentials: %s",
753 krb5_get_err_text(kcontext, problem));
754 krb5_cc_destroy(kcontext, ccache);
755 return HTTP_INTERNAL_SERVER_ERROR;
758 krb5_cc_close(kcontext, ccache);
763 int authenticate_user_krb5pwd(request_rec *r,
764 kerb_auth_config *conf,
765 const char *auth_line)
767 const char *sent_pw = NULL;
768 const char *sent_name = NULL;
769 const char *realms = NULL;
770 krb5_context kcontext = NULL;
771 krb5_error_code code;
772 krb5_principal client = NULL;
773 krb5_ccache ccache = NULL;
774 krb5_keytab keytab = NULL;
777 int all_principals_unkown;
779 code = krb5_init_context(&kcontext);
781 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
782 "Cannot initialize Kerberos5 context (%d)", code);
783 return HTTP_INTERNAL_SERVER_ERROR;
786 sent_pw = ap_pbase64decode(r->pool, auth_line);
787 sent_name = ap_getword (r->pool, &sent_pw, ':');
788 /* do not allow user to override realm setting of server */
789 if (strchr(sent_name, '@')) {
790 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
791 "specifying realm in user name is prohibited");
792 ret = HTTP_UNAUTHORIZED;
796 if (sent_pw == NULL || *sent_pw == '\0') {
797 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
798 "empty passwords are not accepted");
799 ret = HTTP_UNAUTHORIZED;
803 if (conf->krb_5_keytab)
804 krb5_kt_resolve(kcontext, conf->krb_5_keytab, &keytab);
806 all_principals_unkown = 1;
807 realms = conf->krb_auth_realms;
809 if (realms && (code = krb5_set_default_realm(kcontext,
810 ap_getword_white(r->pool, &realms)))){
811 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
812 "krb5_set_default_realm() failed: %s",
813 krb5_get_err_text(kcontext, code));
818 krb5_free_principal(kcontext, client);
821 code = krb5_parse_name(kcontext, sent_name, &client);
823 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
824 "krb5_parse_name() failed: %s",
825 krb5_get_err_text(kcontext, code));
829 code = verify_krb5_user(r, kcontext, client, sent_pw,
830 conf->krb_service_name,
831 keytab, conf->krb_verify_kdc, &ccache);
832 if (!conf->krb_authoritative && code) {
833 /* if we're not authoritative, we allow authentication to pass on
834 * to another modules if (and only if) the user is not known to us */
835 if (all_principals_unkown && code != KRB5KDC_ERR_C_PRINCIPAL_UNKNOWN)
836 all_principals_unkown = 0;
842 /* ap_getword_white() used above shifts the parameter, so it's not
843 needed to touch the realms variable */
844 } while (realms && *realms);
846 memset((char *)sent_pw, 0, strlen(sent_pw));
849 if (!conf->krb_authoritative && all_principals_unkown == 1 && code == KRB5KDC_ERR_C_PRINCIPAL_UNKNOWN)
852 ret = HTTP_UNAUTHORIZED;
857 code = krb5_unparse_name(kcontext, client, &name);
859 log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "krb5_unparse_name() failed: %s",
860 krb5_get_err_text(kcontext, code));
861 ret = HTTP_UNAUTHORIZED;
864 MK_USER = ap_pstrdup (r->pool, name);
865 MK_AUTH_TYPE = "Basic";
868 if (conf->krb_save_credentials)
869 store_krb5_creds(kcontext, r, conf, ccache);
875 krb5_free_principal(kcontext, client);
877 krb5_cc_destroy(kcontext, ccache);
879 krb5_kt_close(kcontext, keytab);
880 krb5_free_context(kcontext);
885 /*********************************************************************
886 * GSSAPI Authentication
887 ********************************************************************/
890 get_gss_error(MK_POOL *p, OM_uint32 err_maj, OM_uint32 err_min, char *prefix)
892 OM_uint32 maj_stat, min_stat;
893 OM_uint32 msg_ctx = 0;
894 gss_buffer_desc status_string;
897 err_msg = ap_pstrdup(p, prefix);
899 maj_stat = gss_display_status (&min_stat,
905 if (GSS_ERROR(maj_stat))
907 err_msg = ap_pstrcat(p, err_msg, ": ", (char*) status_string.value, NULL);
908 gss_release_buffer(&min_stat, &status_string);
910 maj_stat = gss_display_status (&min_stat,
916 if (!GSS_ERROR(maj_stat)) {
917 err_msg = ap_pstrcat(p, err_msg,
918 " (", (char*) status_string.value, ")", NULL);
919 gss_release_buffer(&min_stat, &status_string);
921 } while (!GSS_ERROR(maj_stat) && msg_ctx != 0);
927 store_gss_creds(request_rec *r, kerb_auth_config *conf, char *princ_name,
928 gss_cred_id_t delegated_cred)
930 OM_uint32 maj_stat, min_stat;
931 krb5_principal princ = NULL;
932 krb5_ccache ccache = NULL;
933 krb5_error_code problem;
934 krb5_context context;
935 int ret = HTTP_INTERNAL_SERVER_ERROR;
937 problem = krb5_init_context(&context);
939 log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "Cannot initialize krb5 context");
940 return HTTP_INTERNAL_SERVER_ERROR;
943 problem = krb5_parse_name(context, princ_name, &princ);
945 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
946 "Cannot parse delegated username (%s)", krb5_get_err_text(context, problem));
950 problem = create_krb5_ccache(context, r, conf, princ, &ccache);
952 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
953 "Cannot create krb5 ccache (%s)", krb5_get_err_text(context, problem));
957 maj_stat = gss_krb5_copy_ccache(&min_stat, delegated_cred, ccache);
958 if (GSS_ERROR(maj_stat)) {
959 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
960 "Cannot store delegated credential (%s)",
961 get_gss_error(r->pool, maj_stat, min_stat, "gss_krb5_copy_ccache"));
965 krb5_cc_close(context, ccache);
971 krb5_free_principal(context, princ);
973 krb5_cc_destroy(context, ccache);
974 krb5_free_context(context);
979 get_gss_creds(request_rec *r,
980 kerb_auth_config *conf,
981 gss_cred_id_t *server_creds)
983 gss_buffer_desc input_token = GSS_C_EMPTY_BUFFER;
984 OM_uint32 major_status, minor_status, minor_status2;
985 gss_name_t server_name = GSS_C_NO_NAME;
988 snprintf(buf, sizeof(buf), "%s@%s", conf->krb_service_name,
989 ap_get_server_name(r));
991 input_token.value = buf;
992 input_token.length = strlen(buf) + 1;
994 major_status = gss_import_name(&minor_status, &input_token,
995 GSS_C_NT_HOSTBASED_SERVICE,
997 if (GSS_ERROR(major_status)) {
998 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
999 "%s", get_gss_error(r->pool, major_status, minor_status,
1000 "gss_import_name() failed"));
1001 return HTTP_INTERNAL_SERVER_ERROR;
1004 log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, "Acquiring creds for %s", buf);
1006 major_status = gss_acquire_cred(&minor_status, server_name, GSS_C_INDEFINITE,
1007 GSS_C_NO_OID_SET, GSS_C_ACCEPT,
1008 server_creds, NULL, NULL);
1009 gss_release_name(&minor_status2, &server_name);
1010 if (GSS_ERROR(major_status)) {
1011 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1012 "%s", get_gss_error(r->pool, major_status, minor_status,
1013 "gss_acquire_cred() failed"));
1014 return HTTP_INTERNAL_SERVER_ERROR;
1019 * With MIT Kerberos 5 1.3.x the gss_cred_id_t is the same as
1020 * krb5_gss_cred_id_t and krb5_gss_cred_id_rec contains a pointer to
1022 * This allows us to override the replay cache function vector with
1024 * Note that this is a dirty hack to get things working and there may
1025 * well be unknown side-effects.
1028 krb5_gss_cred_id_t gss_creds = (krb5_gss_cred_id_t) *server_creds;
1030 if (gss_creds && gss_creds->rcache && gss_creds->rcache->ops &&
1031 gss_creds->rcache->ops->type &&
1032 memcmp(gss_creds->rcache->ops->type, "dfl", 3) == 0)
1033 /* Override the rcache operations */
1034 gss_creds->rcache->ops = &mod_auth_kerb_rc_ops;
1042 cmp_gss_type(gss_buffer_t token, gss_OID oid)
1047 if (token->length == 0)
1048 return GSS_S_DEFECTIVE_TOKEN;
1050 /* XXX if (token->value == NTLMSSP) log_debug("NTLM mechanism used"); */
1054 return GSS_S_DEFECTIVE_TOKEN;
1057 if ((len & 0x7f) > 4)
1058 return GSS_S_DEFECTIVE_TOKEN;
1062 return GSS_S_DEFECTIVE_TOKEN;
1064 if (((OM_uint32) *p++) != oid->length)
1065 return GSS_S_DEFECTIVE_TOKEN;
1067 return memcmp(p, oid->elements, oid->length);
1071 authenticate_user_gss(request_rec *r, kerb_auth_config *conf,
1072 const char *auth_line, char **negotiate_ret_value)
1074 OM_uint32 major_status, minor_status, minor_status2;
1075 gss_buffer_desc input_token = GSS_C_EMPTY_BUFFER;
1076 gss_buffer_desc output_token = GSS_C_EMPTY_BUFFER;
1077 const char *auth_param = NULL;
1079 gss_name_t client_name = GSS_C_NO_NAME;
1080 gss_cred_id_t delegated_cred = GSS_C_NO_CREDENTIAL;
1081 OM_uint32 (*accept_sec_token)();
1082 gss_OID_desc spnego_oid;
1083 gss_ctx_id_t context = GSS_C_NO_CONTEXT;
1084 gss_cred_id_t server_creds = GSS_C_NO_CREDENTIAL;
1086 *negotiate_ret_value = "\0";
1088 spnego_oid.length = 6;
1089 spnego_oid.elements = (void *)"\x2b\x06\x01\x05\x05\x02";
1091 if (conf->krb_5_keytab) {
1093 /* we don't use the ap_* calls here, since the string passed to putenv()
1094 * will become part of the enviroment and shouldn't be free()ed by apache
1096 ktname = malloc(strlen("KRB5_KTNAME=") + strlen(conf->krb_5_keytab) + 1);
1097 if (ktname == NULL) {
1098 log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "malloc() failed: not enough memory");
1099 ret = HTTP_INTERNAL_SERVER_ERROR;
1102 sprintf(ktname, "KRB5_KTNAME=%s", conf->krb_5_keytab);
1106 ret = get_gss_creds(r, conf, &server_creds);
1110 /* ap_getword() shifts parameter */
1111 auth_param = ap_getword_white(r->pool, &auth_line);
1112 if (auth_param == NULL) {
1113 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1114 "No Authorization parameter in request from client");
1115 ret = HTTP_UNAUTHORIZED;
1119 input_token.length = ap_base64decode_len(auth_param) + 1;
1120 input_token.value = ap_pcalloc(r->connection->pool, input_token.length);
1121 if (input_token.value == NULL) {
1122 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1123 "ap_pcalloc() failed (not enough memory)");
1124 ret = HTTP_INTERNAL_SERVER_ERROR;
1127 input_token.length = ap_base64decode(input_token.value, auth_param);
1129 accept_sec_token = (cmp_gss_type(&input_token, &spnego_oid) == 0) ?
1130 gss_accept_sec_context_spnego : gss_accept_sec_context;
1132 log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, "Verifying client data using %s",
1133 (accept_sec_token == gss_accept_sec_context)
1135 : "SPNEGO GSS-API");
1137 major_status = accept_sec_token(&minor_status,
1141 GSS_C_NO_CHANNEL_BINDINGS,
1148 log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1149 "Verification returned code %d", major_status);
1150 if (output_token.length) {
1154 len = ap_base64encode_len(output_token.length) + 1;
1155 token = ap_pcalloc(r->connection->pool, len + 1);
1156 if (token == NULL) {
1157 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1158 "ap_pcalloc() failed (not enough memory)");
1159 ret = HTTP_INTERNAL_SERVER_ERROR;
1160 gss_release_buffer(&minor_status2, &output_token);
1163 ap_base64encode(token, output_token.value, output_token.length);
1165 *negotiate_ret_value = token;
1166 log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r,
1167 "GSS-API token of length %d bytes will be sent back",
1168 major_status, output_token.length);
1169 gss_release_buffer(&minor_status2, &output_token);
1172 if (GSS_ERROR(major_status)) {
1173 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1174 "%s", get_gss_error(r->pool, major_status, minor_status,
1175 "gss_accept_sec_context() failed"));
1176 /* Don't offer the Negotiate method again if call to GSS layer failed */
1177 *negotiate_ret_value = NULL;
1178 ret = HTTP_UNAUTHORIZED;
1183 /* This is a _Kerberos_ module so multiple authentication rounds aren't
1184 * supported. If we wanted a generic GSS authentication we would have to do
1185 * some magic with exporting context etc. */
1186 if (major_status & GSS_S_CONTINUE_NEEDED) {
1187 ret = HTTP_UNAUTHORIZED;
1192 major_status = gss_display_name(&minor_status, client_name, &output_token, NULL);
1193 gss_release_name(&minor_status, &client_name);
1194 if (GSS_ERROR(major_status)) {
1195 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1196 "%s", get_gss_error(r->pool, major_status, minor_status,
1197 "gss_export_name() failed"));
1198 ret = HTTP_INTERNAL_SERVER_ERROR;
1202 MK_AUTH_TYPE = "Negotiate";
1203 MK_USER = ap_pstrdup(r->pool, output_token.value);
1205 if (conf->krb_save_credentials && delegated_cred != GSS_C_NO_CREDENTIAL)
1206 store_gss_creds(r, conf, (char *)output_token.value, delegated_cred);
1208 if (*negotiate_ret_value)
1209 set_kerb_auth_headers(r, conf, 0, 0, *negotiate_ret_value);
1211 gss_release_buffer(&minor_status, &output_token);
1217 gss_release_cred(&minor_status, &delegated_cred);
1219 if (output_token.length)
1220 gss_release_buffer(&minor_status, &output_token);
1222 if (client_name != GSS_C_NO_NAME)
1223 gss_release_name(&minor_status, &client_name);
1225 if (server_creds != GSS_C_NO_CREDENTIAL)
1226 gss_release_cred(&minor_status, &server_creds);
1228 if (context != GSS_C_NO_CONTEXT)
1229 gss_delete_sec_context(&minor_status, &context, GSS_C_NO_BUFFER);
1236 already_succeeded(request_rec *r)
1238 if (ap_is_initial_req(r) || MK_AUTH_TYPE == NULL)
1240 if (strcmp(MK_AUTH_TYPE, "Negotiate") ||
1241 (strcmp(MK_AUTH_TYPE, "Basic") && strchr(MK_USER, '@')))
1247 set_kerb_auth_headers(request_rec *r, const kerb_auth_config *conf,
1248 int use_krb4, int use_krb5pwd, char *negotiate_ret_value)
1250 const char *auth_name = NULL;
1252 char *negoauth_param;
1253 const char *header_name =
1254 (r->proxyreq == PROXYREQ_PROXY) ? "Proxy-Authenticate" : "WWW-Authenticate";
1256 /* get the user realm specified in .htaccess */
1257 auth_name = ap_auth_name(r);
1259 /* XXX should the WWW-Authenticate header be cleared first?
1260 * apache in the proxy mode should retain client's authN headers? */
1262 if (negotiate_ret_value != NULL && conf->krb_method_gssapi) {
1263 negoauth_param = (*negotiate_ret_value == '\0') ? "Negotiate" :
1264 ap_pstrcat(r->pool, "Negotiate ", negotiate_ret_value, NULL);
1265 ap_table_add(r->err_headers_out, header_name, negoauth_param);
1267 if ((use_krb5pwd && conf->krb_method_k5pass) || conf->krb_delegate_basic) {
1268 ap_table_add(r->err_headers_out, header_name,
1269 ap_pstrcat(r->pool, "Basic realm=\"", auth_name, "\"", NULL));
1276 ((use_krb4 && conf->krb_method_k4pass) || conf->krb_delegate_basic))
1277 ap_table_add(r->err_headers_out, header_name,
1278 ap_pstrcat(r->pool, "Basic realm=\"", auth_name, "\"", NULL));
1282 int kerb_authenticate_user(request_rec *r)
1284 kerb_auth_config *conf =
1285 (kerb_auth_config *) ap_get_module_config(r->per_dir_config,
1287 const char *auth_type = NULL;
1288 const char *auth_line = NULL;
1289 const char *type = NULL;
1290 int use_krb5 = 0, use_krb4 = 0;
1292 static int last_return = HTTP_UNAUTHORIZED;
1293 char *negotiate_ret_value = NULL;
1295 /* get the type specified in .htaccess */
1296 type = ap_auth_type(r);
1298 if (type && strcasecmp(type, "Kerberos") == 0)
1299 use_krb5 = use_krb4 = 1;
1300 else if(type && strcasecmp(type, "KerberosV5") == 0)
1302 else if(type && strcasecmp(type, "KerberosV4") == 0)
1307 /* get what the user sent us in the HTTP header */
1308 auth_line = MK_TABLE_GET(r->headers_in, (r->proxyreq == PROXYREQ_PROXY)
1309 ? "Proxy-Authorization"
1312 set_kerb_auth_headers(r, conf, use_krb4, use_krb5,
1313 (use_krb5) ? "\0" : NULL);
1314 return HTTP_UNAUTHORIZED;
1316 auth_type = ap_getword_white(r->pool, &auth_line);
1318 /* If we are delegating Basic to other modules, DECLINE the request */
1319 if (conf->krb_delegate_basic &&
1321 !conf->krb_method_k5pass &&
1324 !conf->krb_method_k4pass &&
1326 (strcasecmp(auth_type, "Basic") == 0))
1329 if (already_succeeded(r))
1332 ret = HTTP_UNAUTHORIZED;
1335 if (use_krb5 && conf->krb_method_gssapi &&
1336 strcasecmp(auth_type, "Negotiate") == 0) {
1337 ret = authenticate_user_gss(r, conf, auth_line, &negotiate_ret_value);
1338 } else if (use_krb5 && conf->krb_method_k5pass &&
1339 strcasecmp(auth_type, "Basic") == 0) {
1340 ret = authenticate_user_krb5pwd(r, conf, auth_line);
1345 if (ret == HTTP_UNAUTHORIZED && use_krb4 && conf->krb_method_k4pass &&
1346 strcasecmp(auth_type, "Basic") == 0)
1347 ret = authenticate_user_krb4pwd(r, conf, auth_line);
1350 if (ret == HTTP_UNAUTHORIZED)
1351 set_kerb_auth_headers(r, conf, use_krb4, use_krb5, negotiate_ret_value);
1353 /* XXX log_debug: if ret==OK, log(user XY authenticated) */
1360 /***************************************************************************
1361 Module Setup/Configuration
1362 ***************************************************************************/
1363 #ifndef STANDARD20_MODULE_STUFF
1364 module MODULE_VAR_EXPORT auth_kerb_module = {
1365 STANDARD_MODULE_STUFF,
1366 NULL, /* module initializer */
1367 kerb_dir_create_config, /* per-directory config creator */
1368 NULL, /* per-directory config merger */
1369 NULL, /* per-server config creator */
1370 NULL, /* per-server config merger */
1371 kerb_auth_cmds, /* command table */
1372 NULL, /* [ 9] content handlers */
1373 NULL, /* [ 2] URI-to-filename translation */
1374 kerb_authenticate_user, /* [ 5] check/validate user_id */
1375 NULL, /* [ 6] check user_id is valid *here* */
1376 NULL, /* [ 4] check access by host address */
1377 NULL, /* [ 7] MIME type checker/setter */
1378 NULL, /* [ 8] fixups */
1379 NULL, /* [10] logger */
1380 NULL, /* [ 3] header parser */
1381 NULL, /* process initialization */
1382 NULL, /* process exit/cleanup */
1383 NULL /* [ 1] post read_request handling */
1385 ,NULL, /* EAPI: add_module */
1386 NULL, /* EAPI: remove_module */
1387 NULL, /* EAPI: rewrite_command */
1388 NULL /* EAPI: new_connection */
1393 kerb_init_handler(apr_pool_t *p, apr_pool_t *plog,
1394 apr_pool_t *ptemp, server_rec *s)
1396 ap_add_version_component(p, "mod_auth_kerb/" MODAUTHKERB_VERSION);
1400 void kerb_register_hooks(apr_pool_t *p)
1402 ap_hook_post_config(kerb_init_handler, NULL, NULL, APR_HOOK_MIDDLE);
1403 ap_hook_check_user_id(kerb_authenticate_user, NULL, NULL, APR_HOOK_MIDDLE);
1406 module AP_MODULE_DECLARE_DATA auth_kerb_module =
1408 STANDARD20_MODULE_STUFF,
1409 kerb_dir_create_config, /* create per-dir conf structures */
1410 NULL, /* merge per-dir conf structures */
1411 NULL, /* create per-server conf structures */
1412 NULL, /* merge per-server conf structures */
1413 kerb_auth_cmds, /* table of configuration directives */
1414 kerb_register_hooks /* register hooks */