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>
13 /* ====================================================================
14 * The Apache Software License, Version 1.1
16 * Copyright (c) 2000-2003 The Apache Software Foundation. All rights
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
23 * 1. Redistributions of source code must retain the above copyright
24 * notice, this list of conditions and the following disclaimer.
26 * 2. Redistributions in binary form must reproduce the above copyright
27 * notice, this list of conditions and the following disclaimer in
28 * the documentation and/or other materials provided with the
31 * 3. The end-user documentation included with the redistribution,
32 * if any, must include the following acknowledgment:
33 * "This product includes software developed by the
34 * Apache Software Foundation (http://www.apache.org/)."
35 * Alternately, this acknowledgment may appear in the software itself,
36 * if and wherever such third-party acknowledgments normally appear.
38 * 4. The names "Apache" and "Apache Software Foundation" must
39 * not be used to endorse or promote products derived from this
40 * software without prior written permission. For written
41 * permission, please contact apache@apache.org.
43 * 5. Products derived from this software may not be called "Apache",
44 * nor may "Apache" appear in their name, without prior written
45 * permission of the Apache Software Foundation.
47 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
48 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
49 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
50 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
51 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
52 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
53 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
54 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
55 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
56 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
57 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59 * ====================================================================
61 * This software consists of voluntary contributions made by many
62 * individuals on behalf of the Apache Software Foundation. For more
63 * information on the Apache Software Foundation, please see
64 * <http://www.apache.org/>.
66 * Portions of this software are based upon public domain software
67 * originally written at the National Center for Supercomputing Applications,
68 * University of Illinois, Urbana-Champaign.
75 #define MODAUTHKERB_VERSION "5.0-rc4"
78 #include "ap_compat.h"
79 #include "apr_strings.h"
82 #include "http_config.h"
83 #include "http_core.h"
85 #include "http_protocol.h"
86 #include "http_request.h"
93 # include <gssapi/gssapi.h>
94 # include <gssapi/gssapi_generic.h>
95 # define GSS_C_NT_USER_NAME gss_nt_user_name
96 # define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
97 # define krb5_get_err_text(context,code) error_message(code)
99 #include "spnegokrb5.h"
103 /*Prevent warning about closesocket redefinition (Apache's ap_config.h and
104 * MIT Kerberos' port-sockets.h both define it as close) */
109 #include <netdb.h> /* gethostbyname() */
113 module auth_kerb_module;
115 module AP_MODULE_DECLARE_DATA auth_kerb_module;
118 /***************************************************************************
119 Macros To Ease Compatibility
120 ***************************************************************************/
123 #define MK_TABLE_GET ap_table_get
124 #define MK_USER r->connection->user
125 #define MK_AUTH_TYPE r->connection->ap_auth_type
126 #define PROXYREQ_PROXY STD_PROXY
128 #define MK_POOL apr_pool_t
129 #define MK_TABLE_GET apr_table_get
130 #define MK_USER r->user
131 #define MK_AUTH_TYPE r->ap_auth_type
135 /***************************************************************************
136 Auth Configuration Structure
137 ***************************************************************************/
139 char *krb_auth_realms;
140 int krb_save_credentials;
142 char *krb_service_name;
143 int krb_authoritative;
146 int krb_method_gssapi;
147 int krb_method_k5pass;
151 int krb_method_k4pass;
156 krb5_save_realms(cmd_parms *cmd, kerb_auth_config *sec, char *arg);
159 #define command(name, func, var, type, usage) \
161 (void*)XtOffsetOf(kerb_auth_config, var), \
162 OR_AUTHCFG, type, usage }
164 #define command(name, func, var, type, usage) \
165 AP_INIT_ ## type (name, func, \
166 (void*)APR_XtOffsetOf(kerb_auth_config, var), \
170 static const command_rec kerb_auth_cmds[] = {
171 command("KrbAuthRealms", krb5_save_realms, krb_auth_realms,
172 RAW_ARGS, "Realms to attempt authentication against (can be multiple)."),
174 command("KrbAuthRealm", krb5_save_realms, krb_auth_realms,
175 RAW_ARGS, "Alias for KrbAuthRealms."),
177 command("KrbSaveCredentials", ap_set_flag_slot, krb_save_credentials,
178 FLAG, "Save and store credentials/tickets retrieved during auth."),
180 command("KrbVerifyKDC", ap_set_flag_slot, krb_verify_kdc,
181 FLAG, "Verify tickets against keytab to prevent KDC spoofing attacks."),
183 command("KrbServiceName", ap_set_string_slot, krb_service_name,
184 TAKE1, "Service name to be used by Apache for authentication."),
186 command("KrbAuthoritative", ap_set_flag_slot, krb_authoritative,
187 FLAG, "Set to 'off' to allow access control to be passed along to lower modules if the UserID is not known to this module."),
190 command("Krb5Keytab", ap_set_file_slot, krb_5_keytab,
191 TAKE1, "Location of Kerberos V5 keytab file."),
193 command("KrbMethodNegotiate", ap_set_flag_slot, krb_method_gssapi,
194 FLAG, "Enable Negotiate authentication method."),
196 command("KrbMethodK5Passwd", ap_set_flag_slot, krb_method_k5pass,
197 FLAG, "Enable Kerberos V5 password authentication."),
201 command("Krb4Srvtab", ap_set_file_slot, krb_4_srvtab,
202 TAKE1, "Location of Kerberos V4 srvtab file."),
204 command("KrbMethodK4Passwd", ap_set_flag_slot, krb_method_k4pass,
205 FLAG, "Enable Kerberos V4 password authentication."),
213 gss_ctx_id_t context;
214 gss_cred_id_t server_creds;
217 static gss_connection_t *gss_connection = NULL;
219 static const char *EMPTY_STRING = "\0";
223 /***************************************************************************
224 Auth Configuration Initialization
225 ***************************************************************************/
226 static void *kerb_dir_create_config(MK_POOL *p, char *d)
228 kerb_auth_config *rec;
230 rec = (kerb_auth_config *) ap_pcalloc(p, sizeof(kerb_auth_config));
231 ((kerb_auth_config *)rec)->krb_verify_kdc = 1;
232 ((kerb_auth_config *)rec)->krb_service_name = "HTTP";
233 ((kerb_auth_config *)rec)->krb_authoritative = 1;
235 ((kerb_auth_config *)rec)->krb_method_k5pass = 1;
236 ((kerb_auth_config *)rec)->krb_method_gssapi = 1;
239 ((kerb_auth_config *)rec)->krb_method_k4pass = 1;
245 krb5_save_realms(cmd_parms *cmd, kerb_auth_config *sec, char *arg)
247 sec->krb_auth_realms= ap_pstrdup(cmd->pool, arg);
251 void log_rerror(const char *file, int line, int level, int status,
252 const request_rec *r, const char *fmt, ...)
258 vsnprintf(errstr, sizeof(errstr), fmt, ap);
263 ap_log_rerror(file, line, level | APLOG_NOERRNO, r, "%s", errstr);
265 ap_log_rerror(file, line, level | APLOG_NOERRNO, status, r, "%s", errstr);
270 /***************************************************************************
271 Username/Password Validation for Krb4
272 ***************************************************************************/
274 verify_krb4_user(request_rec *r, char *name, char *instance, char *realm,
275 char *password, char *linstance, char *srvtab, int krb_verify_kdc)
281 const char *hostname;
284 char lrealm[REALM_SZ];
286 ret = krb_get_pw_in_tkt(name, instance, realm, "krbtgt", realm,
287 DEFAULT_TKT_LIFE, password);
289 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
290 "Cannot get krb4 ticket: krb_get_pw_in_tkt() failed: %s",
291 krb_get_err_text(ret));
298 hostname = ap_get_server_name(r);
300 hp = gethostbyname(hostname);
303 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
304 "Cannot verify krb4 ticket: gethostbyname() failed: %s",
308 memcpy(&addr, hp->h_addr, sizeof(addr));
310 phost = krb_get_phost((char *)hostname);
312 krb_get_lrealm(lrealm, 1);
314 ret = krb_mk_req(&ticket, linstance, phost, lrealm, 0);
316 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
317 "Cannot verify krb4 ticket: krb_mk_req() failed: %s",
318 krb_get_err_text(ret));
323 ret = krb_rd_req(&ticket, linstance, phost, addr, &authdata, srvtab);
325 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
326 "Cannot verify krb4 ticket: krb_rd_req() failed: %s",
327 krb_get_err_text(ret));
335 krb4_cache_cleanup(void *data)
337 char *tkt_file = (char *) data;
339 krb_set_tkt_string(tkt_file);
345 authenticate_user_krb4pwd(request_rec *r,
346 kerb_auth_config *conf,
347 const char *auth_line)
351 const char *sent_name;
354 char *tkt_file_p = NULL;
359 char lrealm[REALM_SZ];
360 int all_principals_unkown;
362 sent_pw = ap_pbase64decode(r->pool, auth_line);
363 sent_name = ap_getword (r->pool, &sent_pw, ':');
365 /* do not allow user to override realm setting of server */
366 if (strchr(sent_name, '@')) {
367 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
368 "specifying realm in user name is prohibited");
369 return HTTP_UNAUTHORIZED;
372 sent_instance = strchr(sent_name, '.');
374 *sent_instance++ = '\0';
376 snprintf(tkt_file, sizeof(tkt_file), "/tmp/apache_tkt_XXXXXX");
377 fd = mkstemp(tkt_file);
379 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
380 "Cannot create krb4 ccache: mkstemp() failed: %s",
382 return HTTP_INTERNAL_SERVER_ERROR;
385 tkt_file_p = ap_pstrdup(r->pool, tkt_file);
386 ap_register_cleanup(r->pool, tkt_file_p,
387 krb4_cache_cleanup, ap_null_cleanup);
389 krb_set_tkt_string(tkt_file);
391 all_principals_unkown = 1;
392 realms = conf->krb_auth_realms;
394 memset(lrealm, 0, sizeof(lrealm));
397 realm = ap_getword_white(r->pool, &realms);
400 ret = krb_get_lrealm(lrealm, 1);
406 ret = verify_krb4_user(r, (char *)sent_name,
407 (sent_instance) ? sent_instance : "",
408 (char *)realm, (char *)sent_pw,
409 conf->krb_service_name,
410 conf->krb_4_srvtab, conf->krb_verify_kdc);
411 if (!conf->krb_authoritative && ret) {
412 /* if we're not authoritative, we allow authentication to pass on
413 * to another modules if (and only if) the user is not known to us */
414 if (all_principals_unkown && ret != KDC_PR_UNKNOWN)
415 all_principals_unkown = 0;
420 } while (realms && *realms);
423 /* XXX log only in the verify_krb4_user() call */
424 log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "Verifying krb4 password failed");
425 ret = (!conf->krb_authoritative && all_principals_unkown == 1 && ret == KDC_PR_UNKNOWN) ?
426 DECLINED : HTTP_UNAUTHORIZED;
430 user = ap_pstrdup(r->pool, sent_name);
432 user = ap_pstrcat(r->pool, user, ".", sent_instance, NULL);
433 user = ap_pstrcat(r->pool, user, "@", realm, NULL);
436 MK_AUTH_TYPE = "Basic";
437 ap_table_setn(r->subprocess_env, "KRBTKFILE", tkt_file_p);
439 if (!conf->krb_save_credentials)
440 krb4_cache_cleanup(tkt_file);
444 krb4_cache_cleanup(tkt_file);
453 /***************************************************************************
454 Username/Password Validation for Krb5
455 ***************************************************************************/
456 /* Inspired by krb5_verify_user from Heimdal */
457 static krb5_error_code
458 verify_krb5_user(request_rec *r, krb5_context context, krb5_principal principal,
459 krb5_ccache ccache, const char *password, const char *service,
460 krb5_keytab keytab, int krb_verify_kdc)
463 krb5_principal server = NULL;
465 krb5_verify_init_creds_opt opt;
467 memset(&creds, 0, sizeof(creds));
469 ret = krb5_get_init_creds_password(context, &creds, principal,
470 (char *)password, krb5_prompter_posix,
471 NULL, 0, NULL, NULL);
475 ret = krb5_sname_to_principal(context, ap_get_server_name(r), service,
476 KRB5_NT_SRV_HST, &server);
480 krb5_verify_init_creds_opt_init(&opt);
481 krb5_verify_init_creds_opt_set_ap_req_nofail(&opt, krb_verify_kdc);
483 ret = krb5_verify_init_creds(context, &creds, server, keytab, NULL, &opt);
488 ret = krb5_cc_initialize(context, ccache, principal);
490 ret = krb5_cc_store_cred(context, ccache, &creds);
494 krb5_free_cred_contents(context, &creds);
496 krb5_free_principal(context, server);
501 krb5_cache_cleanup(void *data)
503 krb5_context context;
505 krb5_error_code problem;
506 char *cache_name = (char *) data;
508 problem = krb5_init_context(&context);
510 /* ap_log_error(APLOG_MARK, APLOG_ERR, 0, NULL, "krb5_init_context() failed"); */
511 return HTTP_INTERNAL_SERVER_ERROR;
514 problem = krb5_cc_resolve(context, cache_name, &cache);
516 /* log_error(APLOG_MARK, APLOG_ERR, 0, NULL,
517 "krb5_cc_resolve() failed (%s: %s)",
518 cache_name, krb5_get_err_text(context, problem)); */
519 return HTTP_INTERNAL_SERVER_ERROR;
522 krb5_cc_destroy(context, cache);
523 krb5_free_context(context);
528 create_krb5_ccache(krb5_context kcontext,
530 kerb_auth_config *conf,
531 krb5_principal princ,
536 krb5_error_code problem;
538 krb5_ccache tmp_ccache = NULL;
540 ccname = ap_psprintf(r->pool, "FILE:%s/krb5cc_apache_XXXXXX", P_tmpdir);
541 fd = mkstemp(ccname + strlen("FILE:"));
543 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
544 "mkstemp() failed: %s", strerror(errno));
545 ret = HTTP_INTERNAL_SERVER_ERROR;
550 problem = krb5_cc_resolve(kcontext, ccname, &tmp_ccache);
552 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
553 "krb5_cc_resolve() failed: %s",
554 krb5_get_err_text(kcontext, problem));
555 ret = HTTP_INTERNAL_SERVER_ERROR;
560 problem = krb5_cc_initialize(kcontext, tmp_ccache, princ);
562 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
563 "Cannot initialize krb5 ccache %s: krb5_cc_initialize() failed: %s",
564 ccname, krb5_get_err_text(kcontext, problem));
565 ret = HTTP_INTERNAL_SERVER_ERROR;
569 ap_table_setn(r->subprocess_env, "KRB5CCNAME", ccname);
570 ap_register_cleanup(r->pool, ccname,
571 krb5_cache_cleanup, ap_null_cleanup);
573 *ccache = tmp_ccache;
580 krb5_cc_destroy(kcontext, tmp_ccache);
586 store_krb5_creds(krb5_context kcontext,
588 kerb_auth_config *conf,
589 krb5_ccache delegated_cred)
592 krb5_error_code problem;
593 krb5_principal princ;
597 problem = krb5_cc_get_principal(kcontext, delegated_cred, &princ);
599 snprintf(errstr, sizeof(errstr), "krb5_cc_get_principal() failed: %s",
600 krb5_get_err_text(kcontext, problem));
601 return HTTP_INTERNAL_SERVER_ERROR;
604 ret = create_krb5_ccache(kcontext, r, conf, princ, &ccache);
606 krb5_free_principal(kcontext, princ);
611 problem = krb5_cc_copy_cache(kcontext, delegated_cred, ccache);
613 problem = krb5_cc_copy_creds(kcontext, delegated_cred, ccache);
615 krb5_free_principal(kcontext, princ);
617 snprintf(errstr, sizeof(errstr), "Failed to store credentials: %s",
618 krb5_get_err_text(kcontext, problem));
619 krb5_cc_destroy(kcontext, ccache);
620 return HTTP_INTERNAL_SERVER_ERROR;
623 krb5_cc_close(kcontext, ccache);
628 int authenticate_user_krb5pwd(request_rec *r,
629 kerb_auth_config *conf,
630 const char *auth_line)
632 const char *sent_pw = NULL;
633 const char *sent_name = NULL;
634 const char *realms = NULL;
635 krb5_context kcontext = NULL;
636 krb5_error_code code;
637 krb5_principal client = NULL;
638 krb5_ccache ccache = NULL;
639 krb5_keytab keytab = NULL;
642 int all_principals_unkown;
646 code = krb5_init_context(&kcontext);
648 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
649 "Cannot initialize Kerberos5 context (%d)", code);
650 return HTTP_INTERNAL_SERVER_ERROR;
653 sent_pw = ap_pbase64decode(r->pool, auth_line);
654 sent_name = ap_getword (r->pool, &sent_pw, ':');
655 /* do not allow user to override realm setting of server */
656 if (strchr(sent_name, '@')) {
657 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
658 "specifying realm in user name is prohibited");
659 ret = HTTP_UNAUTHORIZED;
663 if (sent_pw == NULL || *sent_pw == '\0') {
664 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
665 "empty passwords are not accepted");
666 ret = HTTP_UNAUTHORIZED;
671 code = krb5_cc_gen_new(kcontext, &krb5_mcc_ops, &ccache);
673 code = krb5_cc_resolve(kcontext, "MEMORY:", &ccache);
676 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
677 "generating new memory ccache failed: %s",
678 krb5_get_err_text(kcontext, code));
679 ret = HTTP_INTERNAL_SERVER_ERROR;
684 if (conf->krb_5_keytab)
685 krb5_kt_resolve(kcontext, conf->krb_5_keytab, &keytab);
687 all_principals_unkown = 1;
688 realms = conf->krb_auth_realms;
690 if (realms && (code = krb5_set_default_realm(kcontext,
691 ap_getword_white(r->pool, &realms))))
695 krb5_free_principal(kcontext, client);
698 code = krb5_parse_name(kcontext, sent_name, &client);
702 code = verify_krb5_user(r, kcontext, client, ccache, sent_pw,
703 conf->krb_service_name,
704 keytab, conf->krb_verify_kdc);
705 if (!conf->krb_authoritative && code) {
706 /* if we're not authoritative, we allow authentication to pass on
707 * to another modules if (and only if) the user is not known to us */
708 if (all_principals_unkown && code != KRB5KDC_ERR_C_PRINCIPAL_UNKNOWN)
709 all_principals_unkown = 0;
715 /* ap_getword_white() used above shifts the parameter, so it's not
716 needed to touch the realms variable */
717 } while (realms && *realms);
719 memset((char *)sent_pw, 0, strlen(sent_pw));
722 /* XXX log only in the verify_krb5_user() call */
723 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
724 "Verifying krb5 password failed: %s",
725 krb5_get_err_text(kcontext, code));
726 if (!conf->krb_authoritative && all_principals_unkown == 1 && code == KRB5KDC_ERR_C_PRINCIPAL_UNKNOWN)
729 ret = HTTP_UNAUTHORIZED;
734 code = krb5_unparse_name(kcontext, client, &name);
736 log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "krb5_unparse_name() failed: %s",
737 krb5_get_err_text(kcontext, code));
738 ret = HTTP_UNAUTHORIZED;
741 MK_USER = ap_pstrdup (r->pool, name);
742 MK_AUTH_TYPE = "Basic";
745 if (conf->krb_save_credentials)
746 store_krb5_creds(kcontext, r, conf, ccache);
752 krb5_free_principal(kcontext, client);
754 krb5_cc_destroy(kcontext, ccache);
756 krb5_kt_close(kcontext, keytab);
757 krb5_free_context(kcontext);
762 /*********************************************************************
763 * GSSAPI Authentication
764 ********************************************************************/
767 get_gss_error(MK_POOL *p, OM_uint32 err_maj, OM_uint32 err_min, char *prefix)
769 OM_uint32 maj_stat, min_stat;
770 OM_uint32 msg_ctx = 0;
771 gss_buffer_desc status_string;
775 err_msg = ap_pstrdup(p, prefix);
777 maj_stat = gss_display_status (&min_stat,
783 if (GSS_ERROR(maj_stat))
785 err_msg = ap_pstrcat(p, err_msg, ": ", (char*) status_string.value, NULL);
786 gss_release_buffer(&min_stat, &status_string);
788 maj_stat = gss_display_status (&min_stat,
794 if (!GSS_ERROR(maj_stat)) {
795 err_msg = ap_pstrcat(p, err_msg,
796 " (", (char*) status_string.value, ")", NULL);
797 gss_release_buffer(&min_stat, &status_string);
799 } while (!GSS_ERROR(maj_stat) && msg_ctx != 0);
805 cleanup_gss_connection(void *data)
807 OM_uint32 minor_status;
808 gss_connection_t *gss_conn = (gss_connection_t *)data;
812 if (gss_conn->context != GSS_C_NO_CONTEXT)
813 gss_delete_sec_context(&minor_status, &gss_conn->context,
815 if (gss_conn->server_creds != GSS_C_NO_CREDENTIAL)
816 gss_release_cred(&minor_status, &gss_conn->server_creds);
818 gss_connection = NULL;
824 store_gss_creds(request_rec *r, kerb_auth_config *conf, char *princ_name,
825 gss_cred_id_t delegated_cred)
827 OM_uint32 maj_stat, min_stat;
828 krb5_principal princ = NULL;
829 krb5_ccache ccache = NULL;
830 krb5_error_code problem;
831 krb5_context context;
832 int ret = HTTP_INTERNAL_SERVER_ERROR;
834 problem = krb5_init_context(&context);
836 log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "Cannot initialize krb5 context");
837 return HTTP_INTERNAL_SERVER_ERROR;
840 problem = krb5_parse_name(context, princ_name, &princ);
842 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
843 "Cannot parse delegated username (%s)", krb5_get_err_text(context, problem));
847 problem = create_krb5_ccache(context, r, conf, princ, &ccache);
849 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
850 "Cannot create krb5 ccache (%s)", krb5_get_err_text(context, problem));
854 maj_stat = gss_krb5_copy_ccache(&min_stat, delegated_cred, ccache);
855 if (GSS_ERROR(maj_stat)) {
856 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
857 "Cannot store delegated credential (%s)",
858 get_gss_error(r->pool, maj_stat, min_stat, "gss_krb5_copy_ccache"));
862 krb5_cc_close(context, ccache);
868 krb5_free_principal(context, princ);
870 krb5_cc_destroy(context, ccache);
871 krb5_free_context(context);
876 get_gss_creds(request_rec *r,
877 kerb_auth_config *conf,
878 gss_cred_id_t *server_creds)
880 gss_buffer_desc input_token = GSS_C_EMPTY_BUFFER;
881 OM_uint32 major_status, minor_status, minor_status2;
882 gss_name_t server_name = GSS_C_NO_NAME;
885 snprintf(buf, sizeof(buf), "%s/%s", conf->krb_service_name, ap_get_server_name(r));
887 input_token.value = buf;
888 input_token.length = strlen(buf) + 1;
890 major_status = gss_import_name(&minor_status, &input_token,
893 if (GSS_ERROR(major_status)) {
894 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
895 "%s", get_gss_error(r->pool, major_status, minor_status,
896 "gss_import_name() failed"));
897 return HTTP_INTERNAL_SERVER_ERROR;
900 major_status = gss_acquire_cred(&minor_status, server_name, GSS_C_INDEFINITE,
901 GSS_C_NO_OID_SET, GSS_C_ACCEPT,
902 server_creds, NULL, NULL);
903 gss_release_name(&minor_status2, &server_name);
904 if (GSS_ERROR(major_status)) {
905 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
906 "%s", get_gss_error(r->pool, major_status, minor_status,
907 "gss_acquire_cred() failed"));
908 return HTTP_INTERNAL_SERVER_ERROR;
915 cmp_gss_type(gss_buffer_t token, gss_OID oid)
920 if (token->length == 0)
921 return GSS_S_DEFECTIVE_TOKEN;
925 return GSS_S_DEFECTIVE_TOKEN;
928 if ((len & 0x7f) > 4)
929 return GSS_S_DEFECTIVE_TOKEN;
933 return GSS_S_DEFECTIVE_TOKEN;
935 if (((OM_uint32) *p++) != oid->length)
936 return GSS_S_DEFECTIVE_TOKEN;
938 return memcmp(p, oid->elements, oid->length);
942 authenticate_user_gss(request_rec *r, kerb_auth_config *conf,
943 const char *auth_line, char **negotiate_ret_value)
945 OM_uint32 major_status, minor_status, minor_status2;
946 gss_buffer_desc input_token = GSS_C_EMPTY_BUFFER;
947 gss_buffer_desc output_token = GSS_C_EMPTY_BUFFER;
948 const char *auth_param = NULL;
950 gss_name_t client_name = GSS_C_NO_NAME;
951 gss_cred_id_t delegated_cred = GSS_C_NO_CREDENTIAL;
952 OM_uint32 (*accept_sec_token)();
953 gss_OID_desc spnego_oid;
955 *negotiate_ret_value = (char *)EMPTY_STRING;
957 spnego_oid.length = 6;
958 spnego_oid.elements = (void *)"\x2b\x06\x01\x05\x05\x02";
960 if (gss_connection == NULL) {
961 gss_connection = ap_pcalloc(r->connection->pool, sizeof(*gss_connection));
962 if (gss_connection == NULL) {
963 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
964 "ap_pcalloc() failed (not enough memory)");
965 ret = HTTP_INTERNAL_SERVER_ERROR;
968 memset(gss_connection, 0, sizeof(*gss_connection));
969 ap_register_cleanup(r->connection->pool, gss_connection, cleanup_gss_connection, ap_null_cleanup);
972 if (conf->krb_5_keytab) {
974 /* we don't use the ap_* calls here, since the string passed to putenv()
975 * will become part of the enviroment and shouldn't be free()ed by apache
977 ktname = malloc(strlen("KRB5_KTNAME=") + strlen(conf->krb_5_keytab) + 1);
978 if (ktname == NULL) {
979 log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "malloc() failed: not enough memory");
980 ret = HTTP_INTERNAL_SERVER_ERROR;
983 sprintf(ktname, "KRB5_KTNAME=%s", conf->krb_5_keytab);
987 if (gss_connection->server_creds == GSS_C_NO_CREDENTIAL) {
988 ret = get_gss_creds(r, conf, &gss_connection->server_creds);
993 /* ap_getword() shifts parameter */
994 auth_param = ap_getword_white(r->pool, &auth_line);
995 if (auth_param == NULL) {
996 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
997 "No Authorization parameter in request from client");
998 ret = HTTP_UNAUTHORIZED;
1002 input_token.length = ap_base64decode_len(auth_param) + 1;
1003 input_token.value = ap_pcalloc(r->connection->pool, input_token.length);
1004 if (input_token.value == NULL) {
1005 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1006 "ap_pcalloc() failed (not enough memory)");
1007 ret = HTTP_INTERNAL_SERVER_ERROR;
1010 input_token.length = ap_base64decode(input_token.value, auth_param);
1012 accept_sec_token = (cmp_gss_type(&input_token, &spnego_oid) == 0) ?
1013 gss_accept_sec_context_spnego : gss_accept_sec_context;
1015 major_status = accept_sec_token(&minor_status,
1016 &gss_connection->context,
1017 gss_connection->server_creds,
1019 GSS_C_NO_CHANNEL_BINDINGS,
1026 if (output_token.length) {
1030 len = ap_base64encode_len(output_token.length) + 1;
1031 token = ap_pcalloc(r->connection->pool, len + 1);
1032 if (token == NULL) {
1033 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1034 "ap_pcalloc() failed (not enough memory)");
1035 ret = HTTP_INTERNAL_SERVER_ERROR;
1036 gss_release_buffer(&minor_status2, &output_token);
1039 ap_base64encode(token, output_token.value, output_token.length);
1041 *negotiate_ret_value = token;
1042 gss_release_buffer(&minor_status2, &output_token);
1045 if (GSS_ERROR(major_status)) {
1046 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1047 "%s", get_gss_error(r->pool, major_status, minor_status,
1048 "gss_accept_sec_context() failed"));
1049 /* Don't offer the Negotiate method again if call to GSS layer failed */
1050 *negotiate_ret_value = NULL;
1051 ret = HTTP_UNAUTHORIZED;
1055 if (major_status & GSS_S_CONTINUE_NEEDED) {
1056 /* Some GSSAPI mechanism (eg GSI from Globus) may require multiple
1057 * iterations to establish authentication */
1058 ret = HTTP_UNAUTHORIZED;
1062 major_status = gss_display_name(&minor_status, client_name, &output_token, NULL);
1063 gss_release_name(&minor_status, &client_name);
1064 if (GSS_ERROR(major_status)) {
1065 log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1066 "%s", get_gss_error(r->pool, major_status, minor_status,
1067 "gss_export_name() failed"));
1068 ret = HTTP_INTERNAL_SERVER_ERROR;
1072 MK_AUTH_TYPE = "Negotiate";
1073 MK_USER = ap_pstrdup(r->pool, output_token.value);
1075 if (conf->krb_save_credentials && delegated_cred != GSS_C_NO_CREDENTIAL)
1076 store_gss_creds(r, conf, (char *)output_token.value, delegated_cred);
1078 gss_release_buffer(&minor_status, &output_token);
1084 gss_release_cred(&minor_status, &delegated_cred);
1086 if (output_token.length)
1087 gss_release_buffer(&minor_status, &output_token);
1089 if (client_name != GSS_C_NO_NAME)
1090 gss_release_name(&minor_status, &client_name);
1092 cleanup_gss_connection(gss_connection);
1099 already_succeeded(request_rec *r)
1101 if (ap_is_initial_req(r) || MK_AUTH_TYPE == NULL)
1103 if (strcmp(MK_AUTH_TYPE, "Negotiate") ||
1104 (strcmp(MK_AUTH_TYPE, "Basic") && strchr(MK_USER, '@')))
1110 note_kerb_auth_failure(request_rec *r, const kerb_auth_config *conf,
1111 int use_krb4, int use_krb5, char *negotiate_ret_value)
1113 const char *auth_name = NULL;
1115 char *negoauth_param;
1116 const char *header_name =
1117 (r->proxyreq == PROXYREQ_PROXY) ? "Proxy-Authenticate" : "WWW-Authenticate";
1119 /* get the user realm specified in .htaccess */
1120 auth_name = ap_auth_name(r);
1122 /* XXX should the WWW-Authenticate header be cleared first? */
1124 if (use_krb5 && conf->krb_method_gssapi && negotiate_ret_value != NULL) {
1125 negoauth_param = (*negotiate_ret_value == '\0') ? "Negotiate" :
1126 ap_pstrcat(r->pool, "Negotiate ", negotiate_ret_value, NULL);
1127 ap_table_add(r->err_headers_out, header_name, negoauth_param);
1129 if (use_krb5 && conf->krb_method_k5pass) {
1130 ap_table_add(r->err_headers_out, header_name,
1131 ap_pstrcat(r->pool, "Basic realm=\"", auth_name, "\"", NULL));
1137 if (use_krb4 && conf->krb_method_k4pass && !set_basic)
1138 ap_table_add(r->err_headers_out, header_name,
1139 ap_pstrcat(r->pool, "Basic realm=\"", auth_name, "\"", NULL));
1143 int kerb_authenticate_user(request_rec *r)
1145 kerb_auth_config *conf =
1146 (kerb_auth_config *) ap_get_module_config(r->per_dir_config,
1148 const char *auth_type = NULL;
1149 const char *auth_line = NULL;
1150 const char *type = NULL;
1151 int use_krb5 = 0, use_krb4 = 0;
1153 static int last_return = HTTP_UNAUTHORIZED;
1154 char *negotiate_ret_value;
1156 /* get the type specified in .htaccess */
1157 type = ap_auth_type(r);
1159 if (type && strcasecmp(type, "Kerberos") == 0)
1160 use_krb5 = use_krb4 = 1;
1161 else if(type && strcasecmp(type, "KerberosV5") == 0)
1163 else if(type && strcasecmp(type, "KerberosV4") == 0)
1168 /* get what the user sent us in the HTTP header */
1169 auth_line = MK_TABLE_GET(r->headers_in, "Authorization");
1171 auth_line = MK_TABLE_GET(r->headers_in, "Proxy-Authorization");
1173 note_kerb_auth_failure(r, conf, use_krb4, use_krb5, "\0");
1174 return HTTP_UNAUTHORIZED;
1177 auth_type = ap_getword_white(r->pool, &auth_line);
1179 if (already_succeeded(r))
1182 ret = HTTP_UNAUTHORIZED;
1185 if (use_krb5 && conf->krb_method_gssapi &&
1186 strcasecmp(auth_type, "Negotiate") == 0) {
1187 ret = authenticate_user_gss(r, conf, auth_line, &negotiate_ret_value);
1188 } else if (use_krb5 && conf->krb_method_k5pass &&
1189 strcasecmp(auth_type, "Basic") == 0) {
1190 ret = authenticate_user_krb5pwd(r, conf, auth_line);
1195 if (ret == HTTP_UNAUTHORIZED && use_krb4 && conf->krb_method_k4pass &&
1196 strcasecmp(auth_type, "Basic") == 0)
1197 ret = authenticate_user_krb4pwd(r, conf, auth_line);
1200 if (ret == HTTP_UNAUTHORIZED)
1201 note_kerb_auth_failure(r, conf, use_krb4, use_krb5, negotiate_ret_value);
1208 /***************************************************************************
1209 Module Setup/Configuration
1210 ***************************************************************************/
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 */