4 Copyright (C) 2014 Simo Sorce <simo@redhat.com>
6 Permission is hereby granted, free of charge, to any person obtaining a
7 copy of this software and associated documentation files (the "Software"),
8 to deal in the Software without restriction, including without limitation
9 the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 and/or sell copies of the Software, and to permit persons to whom the
11 Software is furnished to do so, subject to the following conditions:
13 The above copyright notice and this permission notice shall be included in
14 all copies or substantial portions of the Software.
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 DEALINGS IN THE SOFTWARE.
25 #include "mod_auth_gssapi.h"
27 const gss_OID_desc gss_mech_spnego = {
28 6, "\x2b\x06\x01\x05\x05\x02"
31 const gss_OID_desc gss_mech_ntlmssp = {
32 GSS_NTLMSSP_OID_LENGTH, GSS_NTLMSSP_OID_STRING
35 const gss_OID_set_desc gss_mech_set_ntlmssp = {
36 1, discard_const(&gss_mech_ntlmssp)
39 #define MOD_AUTH_GSSAPI_VERSION PACKAGE_NAME "/" PACKAGE_VERSION
41 module AP_MODULE_DECLARE_DATA auth_gssapi_module;
43 APLOG_USE_MODULE(auth_gssapi);
45 static char *mag_status(request_rec *req, int type, uint32_t err)
47 uint32_t maj_ret, min_ret;
56 maj_ret = gss_display_status(&min_ret, err, type,
57 GSS_C_NO_OID, &msg_ctx, &text);
58 if (maj_ret != GSS_S_COMPLETE) {
64 msg_ret = apr_psprintf(req->pool, "%s, %*s",
65 msg_ret, len, (char *)text.value);
67 msg_ret = apr_psprintf(req->pool, "%*s", len, (char *)text.value);
69 gss_release_buffer(&min_ret, &text);
70 } while (msg_ctx != 0);
75 static char *mag_error(request_rec *req, const char *msg,
76 uint32_t maj, uint32_t min)
81 msg_maj = mag_status(req, GSS_C_GSS_CODE, maj);
82 msg_min = mag_status(req, GSS_C_MECH_CODE, min);
83 return apr_psprintf(req->pool, "%s: [%s (%s)]", msg, msg_maj, msg_min);
86 static APR_OPTIONAL_FN_TYPE(ssl_is_https) *mag_is_https = NULL;
88 static int mag_post_config(apr_pool_t *cfgpool, apr_pool_t *log,
89 apr_pool_t *temp, server_rec *s)
91 /* FIXME: create mutex to deal with connections and contexts ? */
92 mag_is_https = APR_RETRIEVE_OPTIONAL_FN(ssl_is_https);
93 mag_post_config_session();
94 ap_add_version_component(cfgpool, MOD_AUTH_GSSAPI_VERSION);
99 static int mag_pre_connection(conn_rec *c, void *csd)
103 mc = mag_new_conn_ctx(c->pool);
104 ap_set_module_config(c->conn_config, &auth_gssapi_module, (void*)mc);
108 static apr_status_t mag_conn_destroy(void *ptr)
110 struct mag_conn *mc = (struct mag_conn *)ptr;
114 (void)gss_delete_sec_context(&min, &mc->ctx, GSS_C_NO_BUFFER);
119 struct mag_conn *mag_new_conn_ctx(apr_pool_t *pool)
123 mc = apr_pcalloc(pool, sizeof(struct mag_conn));
124 apr_pool_create(&mc->pool, pool);
125 /* register the context in the memory pool, so it can be freed
126 * when the connection/request is terminated */
127 apr_pool_cleanup_register(mc->pool, (void *)mc,
128 mag_conn_destroy, apr_pool_cleanup_null);
133 static void mag_conn_clear(struct mag_conn *mc)
135 (void)mag_conn_destroy(mc);
138 apr_pool_clear(mc->pool);
140 memset(mc, 0, sizeof(struct mag_conn));
144 static bool mag_conn_is_https(conn_rec *c)
147 if (mag_is_https(c)) return true;
153 static bool mag_acquire_creds(request_rec *req,
154 struct mag_config *cfg,
155 gss_OID_set desired_mechs,
156 gss_cred_usage_t cred_usage,
157 gss_cred_id_t *creds,
158 gss_OID_set *actual_mechs)
161 #ifdef HAVE_CRED_STORE
162 gss_const_key_value_set_t store = cfg->cred_store;
164 maj = gss_acquire_cred_from(&min, GSS_C_NO_NAME, GSS_C_INDEFINITE,
165 desired_mechs, cred_usage, store, creds,
168 maj = gss_acquire_cred(&min, GSS_C_NO_NAME, GSS_C_INDEFINITE,
169 desired_mechs, cred_usage, creds,
173 if (GSS_ERROR(maj)) {
174 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req, "%s",
175 mag_error(req, "gss_acquire_cred[_from]() "
176 "failed to get server creds",
184 #ifdef HAVE_CRED_STORE
185 static char *escape(apr_pool_t *pool, const char *name,
186 char find, const char *replace)
188 char *escaped = NULL;
193 namecopy = apr_pstrdup(pool, name);
195 p = strchr(namecopy, find);
196 if (!p) return namecopy;
201 /* terminate previous segment */
204 escaped = apr_pstrcat(pool, escaped, n, replace, NULL);
206 escaped = apr_pstrcat(pool, n, replace, NULL);
208 /* move to next segment */
212 /* append last segment if any */
214 escaped = apr_pstrcat(pool, escaped, n, NULL);
220 static char *mag_gss_name_to_ccache_name(request_rec *req,
221 char *dir, const char *gss_name)
225 /* We need to escape away '/', we can't have path separators in
226 * a ccache file name */
227 /* first double escape the esacping char (~) if any */
228 escaped = escape(req->pool, gss_name, '~', "~~");
229 /* then escape away the separator (/) if any */
230 escaped = escape(req->pool, escaped, '/', "~");
232 return apr_psprintf(req->pool, "%s/%s", dir, escaped);
235 static void mag_set_KRB5CCANME(request_rec *req, char *ccname)
241 status = apr_stat(&finfo, ccname, APR_FINFO_MIN, req->pool);
242 if (status != APR_SUCCESS && status != APR_INCOMPLETE) {
243 /* set the file cache anyway, but warn */
244 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, 0, req,
245 "KRB5CCNAME file (%s) lookup failed!", ccname);
248 value = apr_psprintf(req->pool, "FILE:%s", ccname);
249 apr_table_set(req->subprocess_env, "KRB5CCNAME", value);
252 static void mag_store_deleg_creds(request_rec *req,
253 char *dir, char *clientname,
254 gss_cred_id_t delegated_cred,
257 gss_key_value_element_desc element;
258 gss_key_value_set_desc store;
261 element.key = "ccache";
262 store.elements = &element;
265 ccname = mag_gss_name_to_ccache_name(req, dir, clientname);
266 element.value = apr_psprintf(req->pool, "FILE:%s", ccname);
268 maj = gss_store_cred_into(&min, delegated_cred, GSS_C_INITIATE,
269 GSS_C_NULL_OID, 1, 1, &store, NULL, NULL);
270 if (GSS_ERROR(maj)) {
271 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req, "%s",
272 mag_error(req, "failed to store delegated creds",
276 *ccachefile = ccname;
280 static bool parse_auth_header(apr_pool_t *pool, const char **auth_header,
283 char *auth_header_value;
285 auth_header_value = ap_getword_white(pool, auth_header);
286 if (!auth_header_value) return false;
287 value->length = apr_base64_decode_len(auth_header_value) + 1;
288 value->value = apr_pcalloc(pool, value->length);
289 if (!value->value) return false;
290 value->length = apr_base64_decode(value->value, auth_header_value);
295 static bool is_mech_allowed(struct mag_config *cfg, gss_const_OID mech)
297 if (cfg->allowed_mechs == GSS_C_NO_OID_SET) return true;
299 for (int i = 0; i < cfg->allowed_mechs->count; i++) {
300 if (gss_oid_equal(&cfg->allowed_mechs->elements[i], mech)) {
307 #define AUTH_TYPE_NEGOTIATE 0
308 #define AUTH_TYPE_BASIC 1
309 #define AUTH_TYPE_RAW_NTLM 2
310 const char *auth_types[] = {
317 static void mag_set_req_data(request_rec *req,
318 struct mag_config *cfg,
321 apr_table_set(req->subprocess_env, "GSS_NAME", mc->gss_name);
322 apr_table_set(req->subprocess_env, "GSS_SESSION_EXPIRATION",
323 apr_psprintf(req->pool,
324 "%ld", (long)mc->expiration));
325 req->ap_auth_type = apr_pstrdup(req->pool,
326 auth_types[mc->auth_type]);
327 req->user = apr_pstrdup(req->pool, mc->user_name);
328 if (cfg->deleg_ccache_dir && mc->delegated) {
330 ccname = mag_gss_name_to_ccache_name(req,
331 cfg->deleg_ccache_dir,
334 mag_set_KRB5CCANME(req, ccname);
339 gss_OID_set mag_filter_unwanted_mechs(gss_OID_set src)
341 gss_const_OID unwanted_mechs[] = {
352 for (int i = 0; unwanted_mechs[i] != GSS_C_NO_OID; i++) {
353 maj = gss_test_oid_set_member(&min,
354 discard_const(unwanted_mechs[i]),
359 maj = gss_create_empty_oid_set(&min, &dst);
360 if (maj != GSS_S_COMPLETE) {
361 return GSS_C_NO_OID_SET;
363 for (int i = 0; i < src->count; i++) {
365 for (int j = 0; unwanted_mechs[j] != GSS_C_NO_OID; j++) {
366 if (gss_oid_equal(&src->elements[i], unwanted_mechs[j])) {
371 if (present) continue;
372 maj = gss_add_oid_set_member(&min, &src->elements[i], &dst);
373 if (maj != GSS_S_COMPLETE) {
374 gss_release_oid_set(&min, &dst);
375 return GSS_C_NO_OID_SET;
383 static bool mag_auth_basic(request_rec *req,
384 struct mag_config *cfg,
385 gss_buffer_desc ba_user,
386 gss_buffer_desc ba_pwd,
387 gss_cred_usage_t cred_usage,
390 gss_cred_id_t *delegated_cred,
393 #ifdef HAVE_GSS_KRB5_CCACHE_NAME
394 const char *user_ccache = NULL;
395 const char *orig_ccache = NULL;
396 long long unsigned int rndname;
399 gss_name_t user = GSS_C_NO_NAME;
400 gss_cred_id_t user_cred = GSS_C_NO_CREDENTIAL;
401 gss_ctx_id_t user_ctx = GSS_C_NO_CONTEXT;
402 gss_name_t server = GSS_C_NO_NAME;
403 gss_cred_id_t server_cred = GSS_C_NO_CREDENTIAL;
404 gss_ctx_id_t server_ctx = GSS_C_NO_CONTEXT;
405 gss_cred_id_t acquired_cred = GSS_C_NO_CREDENTIAL;
406 gss_buffer_desc input = GSS_C_EMPTY_BUFFER;
407 gss_buffer_desc output = GSS_C_EMPTY_BUFFER;
408 gss_OID_set indicated_mechs = GSS_C_NO_OID_SET;
409 gss_OID_set allowed_mechs;
410 gss_OID_set filtered_mechs;
411 gss_OID_set actual_mechs = GSS_C_NO_OID_SET;
412 uint32_t init_flags = 0;
417 maj = gss_import_name(&min, &ba_user, GSS_C_NT_USER_NAME, &user);
418 if (GSS_ERROR(maj)) {
419 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req,
421 mag_error(req, "gss_import_name() failed",
426 if (cfg->basic_mechs) {
427 allowed_mechs = cfg->basic_mechs;
428 } else if (cfg->allowed_mechs) {
429 allowed_mechs = cfg->allowed_mechs;
431 /* Try to fetch the default set if not explicitly configured,
432 * We need to do this because gss_acquire_cred_with_password()
433 * is currently limited to acquire creds for a single "default"
434 * mechanism if no desired mechanisms are passed in. This causes
435 * authentication to fail for secondary mechanisms as no user
436 * credentials are generated for those. */
437 maj = gss_indicate_mechs(&min, &indicated_mechs);
438 if (maj != GSS_S_COMPLETE) {
439 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, req, "%s",
440 mag_error(req, "gss_indicate_mechs() failed",
442 /* if indicated _mechs failed, set GSS_C_NO_OID_SET. This
443 * generally causes only the krb5 mechanism to be tried due
444 * to implementation constraints, but may change in future. */
445 allowed_mechs = GSS_C_NO_OID_SET;
447 allowed_mechs = indicated_mechs;
451 /* Remove Spnego if present, or we'd repeat failed authentiations
452 * multiple times, one within Spnego and then again with an explicit
453 * mechanism. We would normally just force Spnego and use
454 * gss_set_neg_mechs, but due to the way we source the server name
455 * and the fact MIT up to 1.14 at least does no handle union names,
456 * we can't provide spnego with a server name that can be used by
457 * multiple mechanisms, causing any but the first mechanism to fail.
458 * Also remove unwanted krb mechs, or AS requests will be repeated
459 * multiple times uselessly.
461 filtered_mechs = mag_filter_unwanted_mechs(allowed_mechs);
462 if (filtered_mechs == GSS_C_NO_OID_SET) {
463 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, req, "Fatal "
464 "failure while filtering mechs, aborting");
466 } else if (filtered_mechs != allowed_mechs) {
467 /* if indicated_mechs where sourced then free them here before
468 * reusing the pointer */
469 gss_release_oid_set(&min, &indicated_mechs);
471 /* mark the list of mechs needs to be freed */
472 indicated_mechs = filtered_mechs;
474 /* use the filtered list */
475 allowed_mechs = filtered_mechs;
478 #ifdef HAVE_GSS_KRB5_CCACHE_NAME
479 /* If we are using the krb5 mechanism make sure to set a per thread
480 * memory ccache so that there can't be interferences between threads.
481 * Also make sure we have new cache so no cached results end up being
482 * used. Some implementations of gss_acquire_cred_with_password() do
483 * not reacquire creds if cached ones are around, failing to check
484 * again for the password. */
485 maj = gss_test_oid_set_member(&min, discard_const(gss_mech_krb5),
486 allowed_mechs, &present);
487 if (GSS_ERROR(maj)) {
488 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req,
490 mag_error(req, "gss_test_oid_set_member() failed",
495 rs = apr_generate_random_bytes((unsigned char *)(&rndname),
496 sizeof(long long unsigned int));
497 if (rs != APR_SUCCESS) {
498 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req,
499 "Failed to generate random ccache name");
502 user_ccache = apr_psprintf(req->pool, "MEMORY:user_%qu", rndname);
503 maj = gss_krb5_ccache_name(&min, user_ccache, &orig_ccache);
504 if (GSS_ERROR(maj)) {
505 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req,
507 mag_error(req, "gss_krb5_ccache_name() "
508 "failed", maj, min));
514 maj = gss_acquire_cred_with_password(&min, user, &ba_pwd,
518 &user_cred, &actual_mechs, NULL);
519 if (GSS_ERROR(maj)) {
520 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req,
522 mag_error(req, "gss_acquire_cred_with_password() "
523 "failed", maj, min));
527 /* must acquire creds based on the actual mechs we want to try */
528 if (!mag_acquire_creds(req, cfg, actual_mechs,
529 cred_usage, &acquired_cred, NULL)) {
533 if (cred_usage == GSS_C_BOTH) {
534 /* must acquire with GSS_C_ACCEPT to get the server name */
535 if (!mag_acquire_creds(req, cfg, actual_mechs,
536 GSS_C_ACCEPT, &server_cred, NULL)) {
540 server_cred = acquired_cred;
543 #ifdef HAVE_CRED_STORE
544 if (cfg->deleg_ccache_dir) {
545 /* delegate ourselves credentials so we store them as requested */
546 init_flags |= GSS_C_DELEG_FLAG;
550 for (int i = 0; i < actual_mechs->count; i++) {
552 /* skip spnego if present */
553 if (gss_oid_equal(&actual_mechs->elements[i],
558 /* free these if looping */
559 gss_release_buffer(&min, &output);
560 gss_release_buffer(&min, &input);
561 gss_release_name(&min, &server);
563 maj = gss_inquire_cred_by_mech(&min, server_cred,
564 &actual_mechs->elements[i],
565 &server, NULL, NULL, NULL);
566 if (GSS_ERROR(maj)) {
567 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req,
568 "%s", mag_error(req, "gss_inquired_cred_by_mech() "
569 "failed", maj, min));
574 /* output and input are inverted here, this is intentional */
575 maj = gss_init_sec_context(&min, user_cred, &user_ctx, server,
576 &actual_mechs->elements[i], init_flags,
577 300, GSS_C_NO_CHANNEL_BINDINGS, &output,
578 NULL, &input, NULL, NULL);
579 if (GSS_ERROR(maj)) {
580 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req,
581 "%s", mag_error(req, "gss_init_sec_context() "
582 "failed", maj, min));
585 gss_release_buffer(&min, &output);
586 maj = gss_accept_sec_context(&min, &server_ctx, acquired_cred,
587 &input, GSS_C_NO_CHANNEL_BINDINGS,
588 client, mech_type, &output, NULL,
589 vtime, delegated_cred);
590 if (GSS_ERROR(maj)) {
591 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req,
592 "%s", mag_error(req, "gss_accept_sec_context()"
593 " failed", maj, min));
596 gss_release_buffer(&min, &input);
597 } while (maj == GSS_S_CONTINUE_NEEDED);
599 if (maj == GSS_S_COMPLETE) {
606 gss_release_buffer(&min, &output);
607 gss_release_buffer(&min, &input);
608 gss_release_name(&min, &server);
609 if (server_cred != acquired_cred)
610 gss_release_cred(&min, &server_cred);
611 gss_delete_sec_context(&min, &server_ctx, GSS_C_NO_BUFFER);
612 gss_release_cred(&min, &acquired_cred);
613 gss_release_name(&min, &user);
614 gss_release_cred(&min, &user_cred);
615 gss_delete_sec_context(&min, &user_ctx, GSS_C_NO_BUFFER);
616 gss_release_oid_set(&min, &actual_mechs);
617 gss_release_oid_set(&min, &indicated_mechs);
618 #ifdef HAVE_GSS_KRB5_CCACHE_NAME
619 if (user_ccache != NULL) {
620 maj = gss_krb5_ccache_name(&min, orig_ccache, NULL);
621 if (maj != GSS_S_COMPLETE) {
622 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req,
623 "Failed to restore per-thread ccache, %s",
624 mag_error(req, "gss_krb5_ccache_name() "
625 "failed", maj, min));
633 static int mag_auth(request_rec *req)
637 struct mag_config *cfg;
638 const char *auth_header;
639 char *auth_header_type;
640 int ret = HTTP_UNAUTHORIZED;
641 gss_ctx_id_t ctx = GSS_C_NO_CONTEXT;
643 gss_buffer_desc input = GSS_C_EMPTY_BUFFER;
644 gss_buffer_desc output = GSS_C_EMPTY_BUFFER;
645 gss_buffer_desc name = GSS_C_EMPTY_BUFFER;
646 gss_buffer_desc ba_user;
647 gss_buffer_desc ba_pwd;
648 gss_name_t client = GSS_C_NO_NAME;
649 gss_cred_id_t acquired_cred = GSS_C_NO_CREDENTIAL;
650 gss_cred_id_t delegated_cred = GSS_C_NO_CREDENTIAL;
651 gss_cred_usage_t cred_usage = GSS_C_ACCEPT;
657 gss_OID mech_type = GSS_C_NO_OID;
658 gss_OID_set desired_mechs = GSS_C_NO_OID_SET;
659 gss_OID_set indicated_mechs = GSS_C_NO_OID_SET;
660 gss_buffer_desc lname = GSS_C_EMPTY_BUFFER;
661 struct mag_conn *mc = NULL;
665 type = ap_auth_type(req);
666 if ((type == NULL) || (strcasecmp(type, "GSSAPI") != 0)) {
670 cfg = ap_get_module_config(req->per_dir_config, &auth_gssapi_module);
672 if (cfg->allowed_mechs) {
673 desired_mechs = cfg->allowed_mechs;
675 /* Try to fetch the default set if not explicitly configured */
676 maj = gss_indicate_mechs(&min, &indicated_mechs);
677 if (maj != GSS_S_COMPLETE) {
678 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, req, "%s",
679 mag_error(req, "gss_indicate_mechs() failed",
682 desired_mechs = indicated_mechs;
685 /* implicit auth for subrequests if main auth already happened */
686 if (!ap_is_initial_req(req) && req->main != NULL) {
687 type = ap_auth_type(req->main);
688 if ((type != NULL) && (strcasecmp(type, "GSSAPI") == 0)) {
689 /* warn if the subrequest location and the main request
690 * location have different configs */
691 if (cfg != ap_get_module_config(req->main->per_dir_config,
692 &auth_gssapi_module)) {
693 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0,
694 req, "Subrequest authentication bypass on "
695 "location with different configuration!");
697 if (req->main->user) {
698 req->user = apr_pstrdup(req->pool, req->main->user);
701 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req,
702 "The main request is tasked to establish the "
703 "security context, can't proceed!");
704 return HTTP_UNAUTHORIZED;
707 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, req,
708 "Subrequest GSSAPI auth with no auth on the main "
709 "request. This operation may fail if other "
710 "subrequests already established a context or the "
711 "mechanism requires multiple roundtrips.");
716 if (!mag_conn_is_https(req->connection)) {
717 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req,
718 "Not a TLS connection, refusing to authenticate!");
723 if (cfg->gss_conn_ctx) {
724 mc = (struct mag_conn *)ap_get_module_config(
725 req->connection->conn_config,
726 &auth_gssapi_module);
728 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, req,
729 "Failed to retrieve connection context!");
734 /* if available, session always supersedes connection bound data */
735 if (cfg->use_sessions) {
736 mag_check_session(req, cfg, &mc);
739 auth_header = apr_table_get(req->headers_in, "Authorization");
742 if (mc->established &&
743 (auth_header == NULL) &&
744 (mc->auth_type != AUTH_TYPE_BASIC)) {
745 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, req,
746 "Already established context found!");
747 mag_set_req_data(req, cfg, mc);
756 /* We can proceed only if we do have an auth header */
757 if (!auth_header) goto done;
759 auth_header_type = ap_getword_white(req->pool, &auth_header);
760 if (!auth_header_type) goto done;
762 for (i = 0; auth_types[i] != NULL; i++) {
763 if (strcasecmp(auth_header_type, auth_types[i]) == 0) {
770 case AUTH_TYPE_NEGOTIATE:
771 if (!parse_auth_header(req->pool, &auth_header, &input)) {
775 case AUTH_TYPE_BASIC:
776 if (!cfg->use_basic_auth) {
780 ba_pwd.value = ap_pbase64decode(req->pool, auth_header);
781 if (!ba_pwd.value) goto done;
782 ba_user.value = ap_getword_nulls_nc(req->pool,
783 (char **)&ba_pwd.value, ':');
784 if (!ba_user.value) goto done;
785 if (((char *)ba_user.value)[0] == '\0' ||
786 ((char *)ba_pwd.value)[0] == '\0') {
787 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req,
788 "Invalid empty user or password for Basic Auth");
791 ba_user.length = strlen(ba_user.value);
792 ba_pwd.length = strlen(ba_pwd.value);
794 if (mc && mc->established &&
795 mag_basic_check(cfg, mc, ba_user, ba_pwd)) {
796 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, req,
797 "Already established BASIC AUTH context found!");
798 mag_set_req_data(req, cfg, mc);
805 case AUTH_TYPE_RAW_NTLM:
806 if (!is_mech_allowed(cfg, &gss_mech_ntlmssp)) {
807 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, req,
808 "NTLM Authentication is not allowed!");
812 if (!parse_auth_header(req->pool, &auth_header, &input)) {
816 desired_mechs = discard_const(&gss_mech_set_ntlmssp);
823 if (mc && mc->established) {
824 /* if we are re-authenticating make sure the conn context
825 * is cleaned up so we do not accidentally reuse an existing
826 * established context */
830 req->ap_auth_type = apr_pstrdup(req->pool, auth_types[auth_type]);
832 #ifdef HAVE_CRED_STORE
833 if (cfg->use_s4u2proxy) {
834 cred_usage = GSS_C_BOTH;
838 if (auth_type == AUTH_TYPE_BASIC) {
839 if (mag_auth_basic(req, cfg, ba_user, ba_pwd,
840 cred_usage, &client, &mech_type,
841 &delegated_cred, &vtime)) {
847 if (!mag_acquire_creds(req, cfg, desired_mechs,
848 cred_usage, &acquired_cred, NULL)) {
852 if (auth_type == AUTH_TYPE_NEGOTIATE &&
853 cfg->allowed_mechs != GSS_C_NO_OID_SET) {
854 maj = gss_set_neg_mechs(&min, acquired_cred, cfg->allowed_mechs);
855 if (GSS_ERROR(maj)) {
856 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req, "%s",
857 mag_error(req, "gss_set_neg_mechs() failed",
863 maj = gss_accept_sec_context(&min, pctx, acquired_cred,
864 &input, GSS_C_NO_CHANNEL_BINDINGS,
865 &client, &mech_type, &output, NULL, &vtime,
867 if (GSS_ERROR(maj)) {
868 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req, "%s",
869 mag_error(req, "gss_accept_sec_context() failed",
872 } else if (maj == GSS_S_CONTINUE_NEEDED) {
874 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req,
875 "Mechanism needs continuation but neither "
876 "GssapiConnectionBound nor "
877 "GssapiUseSessions are available");
878 gss_release_buffer(&min, &output);
881 /* auth not complete send token and wait next packet */
886 /* Always set the GSS name in an env var */
887 maj = gss_display_name(&min, client, &name, NULL);
888 if (GSS_ERROR(maj)) {
889 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req, "%s",
890 mag_error(req, "gss_display_name() failed",
894 clientname = apr_pstrndup(req->pool, name.value, name.length);
895 apr_table_set(req->subprocess_env, "GSS_NAME", clientname);
896 expiration = time(NULL) + vtime;
897 apr_table_set(req->subprocess_env, "GSS_SESSION_EXPIRATION",
898 apr_psprintf(req->pool, "%ld", (long)expiration));
900 #ifdef HAVE_CRED_STORE
901 if (cfg->deleg_ccache_dir && delegated_cred != GSS_C_NO_CREDENTIAL) {
902 char *ccachefile = NULL;
904 mag_store_deleg_creds(req, cfg->deleg_ccache_dir, clientname,
905 delegated_cred, &ccachefile);
908 mag_set_KRB5CCANME(req, ccachefile);
912 mc->delegated = true;
917 if (cfg->map_to_local) {
918 maj = gss_localname(&min, client, mech_type, &lname);
919 if (maj != GSS_S_COMPLETE) {
920 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, req, "%s",
921 mag_error(req, "gss_localname() failed", maj, min));
924 req->user = apr_pstrndup(req->pool, lname.value, lname.length);
926 req->user = clientname;
930 mc->user_name = apr_pstrdup(mc->pool, req->user);
931 mc->gss_name = apr_pstrdup(mc->pool, clientname);
932 mc->established = true;
933 if (vtime == GSS_C_INDEFINITE || vtime < MIN_SESS_EXP_TIME) {
934 vtime = MIN_SESS_EXP_TIME;
936 mc->expiration = expiration;
937 mc->auth_type = auth_type;
938 if (auth_type == AUTH_TYPE_BASIC) {
939 mag_basic_cache(cfg, mc, ba_user, ba_pwd);
941 if (cfg->use_sessions) {
942 mag_attempt_session(req, cfg, mc);
946 if (cfg->send_persist)
947 apr_table_set(req->headers_out, "Persistent-Auth",
948 cfg->gss_conn_ctx ? "true" : "false");
953 if ((auth_type != AUTH_TYPE_BASIC) && (output.length != 0)) {
954 int prefixlen = strlen(auth_types[auth_type]) + 1;
955 replen = apr_base64_encode_len(output.length) + 1;
956 reply = apr_pcalloc(req->pool, prefixlen + replen);
958 memcpy(reply, auth_types[auth_type], prefixlen - 1);
959 reply[prefixlen - 1] = ' ';
960 apr_base64_encode(&reply[prefixlen], output.value, output.length);
961 apr_table_add(req->err_headers_out,
962 "WWW-Authenticate", reply);
964 } else if (ret == HTTP_UNAUTHORIZED) {
965 apr_table_add(req->err_headers_out, "WWW-Authenticate", "Negotiate");
966 if (is_mech_allowed(cfg, &gss_mech_ntlmssp)) {
967 apr_table_add(req->err_headers_out, "WWW-Authenticate", "NTLM");
969 if (cfg->use_basic_auth) {
970 apr_table_add(req->err_headers_out,
972 apr_psprintf(req->pool, "Basic realm=\"%s\"",
976 gss_release_oid_set(&min, &indicated_mechs);
977 if (ctx != GSS_C_NO_CONTEXT)
978 gss_delete_sec_context(&min, &ctx, GSS_C_NO_BUFFER);
979 gss_release_cred(&min, &acquired_cred);
980 gss_release_cred(&min, &delegated_cred);
981 gss_release_buffer(&min, &output);
982 gss_release_name(&min, &client);
983 gss_release_buffer(&min, &name);
984 gss_release_buffer(&min, &lname);
989 static void *mag_create_dir_config(apr_pool_t *p, char *dir)
991 struct mag_config *cfg;
993 cfg = (struct mag_config *)apr_pcalloc(p, sizeof(struct mag_config));
999 static const char *mag_ssl_only(cmd_parms *parms, void *mconfig, int on)
1001 struct mag_config *cfg = (struct mag_config *)mconfig;
1002 cfg->ssl_only = on ? true : false;
1006 static const char *mag_map_to_local(cmd_parms *parms, void *mconfig, int on)
1008 struct mag_config *cfg = (struct mag_config *)mconfig;
1009 cfg->map_to_local = on ? true : false;
1013 static const char *mag_conn_ctx(cmd_parms *parms, void *mconfig, int on)
1015 struct mag_config *cfg = (struct mag_config *)mconfig;
1016 cfg->gss_conn_ctx = on ? true : false;
1020 static const char *mag_send_persist(cmd_parms *parms, void *mconfig, int on)
1022 struct mag_config *cfg = (struct mag_config *)mconfig;
1023 cfg->send_persist = on ? true : false;
1027 static const char *mag_use_sess(cmd_parms *parms, void *mconfig, int on)
1029 struct mag_config *cfg = (struct mag_config *)mconfig;
1030 cfg->use_sessions = on ? true : false;
1034 #ifdef HAVE_CRED_STORE
1035 static const char *mag_use_s4u2p(cmd_parms *parms, void *mconfig, int on)
1037 struct mag_config *cfg = (struct mag_config *)mconfig;
1038 cfg->use_s4u2proxy = on ? true : false;
1040 if (cfg->deleg_ccache_dir == NULL) {
1041 cfg->deleg_ccache_dir = apr_pstrdup(parms->pool, "/tmp");
1047 static const char *mag_sess_key(cmd_parms *parms, void *mconfig, const char *w)
1049 struct mag_config *cfg = (struct mag_config *)mconfig;
1050 struct databuf keys;
1056 if (strncmp(w, "key:", 4) != 0) {
1057 ap_log_error(APLOG_MARK, APLOG_ERR, 0, parms->server,
1058 "Invalid key format, expected prefix 'key:'");
1063 l = apr_base64_decode_len(k);
1064 val = apr_palloc(parms->temp_pool, l);
1066 keys.length = (int)apr_base64_decode_binary(val, k);
1067 keys.value = (unsigned char *)val;
1069 if (keys.length != 32) {
1070 ap_log_error(APLOG_MARK, APLOG_ERR, 0, parms->server,
1071 "Invalid key length, expected 32 got %d", keys.length);
1075 rc = SEAL_KEY_CREATE(cfg->pool, &cfg->mag_skey, &keys);
1077 ap_log_error(APLOG_MARK, APLOG_ERR, 0, parms->server,
1078 "Failed to import sealing key!");
1083 #ifdef HAVE_CRED_STORE
1085 #define MAX_CRED_OPTIONS 10
1087 static const char *mag_cred_store(cmd_parms *parms, void *mconfig,
1090 struct mag_config *cfg = (struct mag_config *)mconfig;
1091 gss_key_value_element_desc *elements;
1100 ap_log_error(APLOG_MARK, APLOG_ERR, 0, parms->server,
1101 "%s [%s]", "Invalid syntax for GssapiCredStore option", w);
1105 key = apr_pstrndup(parms->pool, w, (p-w));
1106 value = apr_pstrdup(parms->pool, p + 1);
1108 if (!cfg->cred_store) {
1109 cfg->cred_store = apr_pcalloc(parms->pool,
1110 sizeof(gss_key_value_set_desc));
1111 size = sizeof(gss_key_value_element_desc) * MAX_CRED_OPTIONS;
1112 cfg->cred_store->elements = apr_palloc(parms->pool, size);
1115 elements = cfg->cred_store->elements;
1116 count = cfg->cred_store->count;
1118 if (count >= MAX_CRED_OPTIONS) {
1119 ap_log_error(APLOG_MARK, APLOG_ERR, 0, parms->server,
1120 "Too many GssapiCredStore options (MAX: %d)",
1124 cfg->cred_store->count++;
1126 elements[count].key = key;
1127 elements[count].value = value;
1132 static const char *mag_deleg_ccache_dir(cmd_parms *parms, void *mconfig,
1135 struct mag_config *cfg = (struct mag_config *)mconfig;
1137 cfg->deleg_ccache_dir = apr_pstrdup(parms->pool, value);
1143 #ifdef HAVE_GSS_ACQUIRE_CRED_WITH_PASSWORD
1144 static const char *mag_use_basic_auth(cmd_parms *parms, void *mconfig, int on)
1146 struct mag_config *cfg = (struct mag_config *)mconfig;
1148 cfg->use_basic_auth = on ? true : false;
1153 static apr_status_t mag_oid_set_destroy(void *ptr)
1156 gss_OID_set set = (gss_OID_set)ptr;
1157 (void)gss_release_oid_set(&min, &set);
1161 static void mag_list_of_mechs(cmd_parms *parms, gss_OID_set *oidset,
1162 bool add_spnego, const char *w)
1164 gss_buffer_desc buf = { 0 };
1168 bool release_oid = false;
1170 if (NULL == *oidset) {
1171 maj = gss_create_empty_oid_set(&min, &set);
1172 if (maj != GSS_S_COMPLETE) {
1173 ap_log_error(APLOG_MARK, APLOG_ERR, 0, parms->server,
1174 "gss_create_empty_oid_set() failed.");
1175 *oidset = GSS_C_NO_OID_SET;
1179 oid = discard_const(&gss_mech_spnego);
1180 maj = gss_add_oid_set_member(&min, oid, &set);
1181 if (maj != GSS_S_COMPLETE) {
1182 ap_log_error(APLOG_MARK, APLOG_ERR, 0, parms->server,
1183 "gss_add_oid_set_member() failed.");
1184 (void)gss_release_oid_set(&min, &set);
1185 *oidset = GSS_C_NO_OID_SET;
1189 /* register in the pool so it can be released once the server
1191 apr_pool_cleanup_register(parms->pool, (void *)set,
1192 mag_oid_set_destroy,
1193 apr_pool_cleanup_null);
1199 if (strcmp(w, "krb5") == 0) {
1200 oid = discard_const(gss_mech_krb5);
1201 } else if (strcmp(w, "iakerb") == 0) {
1202 oid = discard_const(gss_mech_iakerb);
1203 } else if (strcmp(w, "ntlmssp") == 0) {
1204 oid = discard_const(&gss_mech_ntlmssp);
1206 buf.value = discard_const(w);
1207 buf.length = strlen(w);
1208 maj = gss_str_to_oid(&min, &buf, &oid);
1209 if (maj != GSS_S_COMPLETE) {
1210 ap_log_error(APLOG_MARK, APLOG_ERR, 0, parms->server,
1211 "Unrecognized GSSAPI Mechanism: [%s]", w);
1216 maj = gss_add_oid_set_member(&min, oid, &set);
1217 if (maj != GSS_S_COMPLETE) {
1218 ap_log_error(APLOG_MARK, APLOG_ERR, 0, parms->server,
1219 "gss_add_oid_set_member() failed for [%s].", w);
1222 (void)gss_release_oid(&min, &oid);
1226 static const char *mag_allow_mech(cmd_parms *parms, void *mconfig,
1229 struct mag_config *cfg = (struct mag_config *)mconfig;
1231 mag_list_of_mechs(parms, &cfg->allowed_mechs, true, w);
1236 #ifdef HAVE_GSS_ACQUIRE_CRED_WITH_PASSWORD
1237 static const char *mag_basic_auth_mechs(cmd_parms *parms, void *mconfig,
1240 struct mag_config *cfg = (struct mag_config *)mconfig;
1242 mag_list_of_mechs(parms, &cfg->basic_mechs, false, w);
1248 static const command_rec mag_commands[] = {
1249 AP_INIT_FLAG("GssapiSSLonly", mag_ssl_only, NULL, OR_AUTHCFG,
1250 "Work only if connection is SSL Secured"),
1251 AP_INIT_FLAG("GssapiLocalName", mag_map_to_local, NULL, OR_AUTHCFG,
1252 "Translate principals to local names"),
1253 AP_INIT_FLAG("GssapiConnectionBound", mag_conn_ctx, NULL, OR_AUTHCFG,
1254 "Authentication is bound to the TCP connection"),
1255 AP_INIT_FLAG("GssapiSignalPersistentAuth", mag_send_persist, NULL, OR_AUTHCFG,
1256 "Send Persitent-Auth header according to connection bound"),
1257 AP_INIT_FLAG("GssapiUseSessions", mag_use_sess, NULL, OR_AUTHCFG,
1258 "Authentication uses mod_sessions to hold status"),
1259 AP_INIT_RAW_ARGS("GssapiSessionKey", mag_sess_key, NULL, OR_AUTHCFG,
1260 "Key Used to seal session data."),
1261 #ifdef HAVE_CRED_STORE
1262 AP_INIT_FLAG("GssapiUseS4U2Proxy", mag_use_s4u2p, NULL, OR_AUTHCFG,
1263 "Initializes credentials for s4u2proxy usage"),
1264 AP_INIT_ITERATE("GssapiCredStore", mag_cred_store, NULL, OR_AUTHCFG,
1265 "Credential Store"),
1266 AP_INIT_RAW_ARGS("GssapiDelegCcacheDir", mag_deleg_ccache_dir, NULL,
1267 OR_AUTHCFG, "Directory to store delegated credentials"),
1269 #ifdef HAVE_GSS_ACQUIRE_CRED_WITH_PASSWORD
1270 AP_INIT_FLAG("GssapiBasicAuth", mag_use_basic_auth, NULL, OR_AUTHCFG,
1271 "Allows use of Basic Auth for authentication"),
1272 AP_INIT_ITERATE("GssapiBasicAuthMech", mag_basic_auth_mechs, NULL,
1273 OR_AUTHCFG, "Mechanisms to use for basic auth"),
1275 AP_INIT_ITERATE("GssapiAllowedMech", mag_allow_mech, NULL, OR_AUTHCFG,
1276 "Allowed Mechanisms"),
1281 mag_register_hooks(apr_pool_t *p)
1283 ap_hook_check_user_id(mag_auth, NULL, NULL, APR_HOOK_MIDDLE);
1284 ap_hook_post_config(mag_post_config, NULL, NULL, APR_HOOK_MIDDLE);
1285 ap_hook_pre_connection(mag_pre_connection, NULL, NULL, APR_HOOK_MIDDLE);
1288 module AP_MODULE_DECLARE_DATA auth_gssapi_module =
1290 STANDARD20_MODULE_STUFF,
1291 mag_create_dir_config,