mod_auth_gssapi.c

   1 /*
   2  * Copyright (c) 2010 CESNET
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  *    this list of conditions and the following disclaimer.
  10  *
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * 3. Neither the name of CESNET nor the names of its contributors may
  16  *    be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #include "mod_auth_gssapi.h"
  33
  34 module AP_MODULE_DECLARE_DATA auth_gssapi_module;
  35
  36 #define command(name, func, var, type, usage)           \
  37   AP_INIT_ ## type (name, (void*) func,                 \
  38         (void*)APR_OFFSETOF(gss_auth_config, var),      \
  39         OR_AUTHCFG | RSRC_CONF, usage)
  40
  41 static const command_rec gss_config_cmds[] = {
  42     command("GSSServiceName", ap_set_string_slot, service_name,
  43             TAKE1, "Service name used for Apache authentication."),
  44
  45     command("GSSKrb5Keytab", ap_set_string_slot, krb5_keytab,
  46             TAKE1, "Location of Kerberos V5 keytab file."),
  47
  48     { NULL }
  49 };
  50
  51 static void
  52 set_http_headers(request_rec *r, const gss_auth_config *conf,
  53                  char *negotiate_ret_value)
  54 {
  55     char *negoauth_param;
  56     const char *header_name = (r->proxyreq == PROXYREQ_PROXY) ?
  57         "Proxy-Authenticate" : "WWW-Authenticate";
  58
  59     if (negotiate_ret_value == NULL)
  60         return;
  61
  62     negoauth_param = (*negotiate_ret_value == '\0') ? "Negotiate" :
  63         apr_pstrcat(r->pool, "Negotiate ", negotiate_ret_value, NULL);
  64     apr_table_add(r->err_headers_out, header_name, negoauth_param);
  65 }
  66
  67 static int
  68 gss_authenticate(request_rec *r, gss_auth_config *conf, gss_conn_ctx ctx,
  69                  const char *auth_line, char **negotiate_ret_value)
  70 {
  71   OM_uint32 major_status, minor_status, minor_status2;
  72   gss_buffer_desc input_token = GSS_C_EMPTY_BUFFER;
  73   gss_buffer_desc output_token = GSS_C_EMPTY_BUFFER;
  74   const char *auth_param = NULL;
  75   int ret;
  76   gss_name_t client_name = GSS_C_NO_NAME;
  77   gss_cred_id_t delegated_cred = GSS_C_NO_CREDENTIAL;
  78   gss_cred_id_t server_creds = GSS_C_NO_CREDENTIAL;
  79   OM_uint32 ret_flags = 0;
  80   gss_OID_desc spnego_oid;
  81   OM_uint32 (*accept_sec_context)
  82                 (OM_uint32 *, gss_ctx_id_t *, const gss_cred_id_t,
  83                  const gss_buffer_t, const gss_channel_bindings_t,
  84                  gss_name_t *, gss_OID *, gss_buffer_t, OM_uint32 *,
  85                  OM_uint32 *, gss_cred_id_t *);
  86
  87   *negotiate_ret_value = "\0";
  88
  89   spnego_oid.length = 6;
  90   spnego_oid.elements = (void *)"\x2b\x06\x01\x05\x05\x02";
  91
  92   if (conf->krb5_keytab) {
  93      char *ktname;
  94      /* we don't use the ap_* calls here, since the string passed to putenv()
  95       * will become part of the enviroment and shouldn't be free()ed by apache
  96       */
  97      ktname = malloc(strlen("KRB5_KTNAME=") + strlen(conf->krb5_keytab) + 1);
  98      if (ktname == NULL) {
  99         gss_log(APLOG_MARK, APLOG_ERR, 0, r, "malloc() failed: not enough memory");
 100         ret = HTTP_INTERNAL_SERVER_ERROR;
 101         goto end;
 102      }
 103      sprintf(ktname, "KRB5_KTNAME=%s", conf->krb5_keytab);
 104      putenv(ktname);
 105 #ifdef HEIMDAL
 106      /* Seems to be also supported by latest MIT */
 107      gsskrb5_register_acceptor_identity(conf->krb_5_keytab);
 108 #endif
 109   }
 110
 111   /* ap_getword() shifts parameter */
 112   auth_param = ap_getword_white(r->pool, &auth_line);
 113   if (auth_param == NULL) {
 114      gss_log(APLOG_MARK, APLOG_ERR, 0, r,
 115              "No Authorization parameter in request from client");
 116      ret = HTTP_UNAUTHORIZED;
 117      goto end;
 118   }
 119
 120   if (ctx->state == GSS_CTX_ESTABLISHED) {
 121       gss_delete_sec_context(&minor_status, &ctx->context, GSS_C_NO_BUFFER);
 122       ctx->context = GSS_C_NO_CONTEXT;
 123       ctx->state = GSS_CTX_EMPTY;
 124   }
 125
 126   input_token.length = apr_base64_decode_len(auth_param) + 1;
 127   input_token.value = apr_pcalloc(r->connection->pool, input_token.length);
 128   if (input_token.value == NULL) {
 129      gss_log(APLOG_MARK, APLOG_ERR, 0, r,
 130              "ap_pcalloc() failed (not enough memory)");
 131      ret = HTTP_INTERNAL_SERVER_ERROR;
 132      goto end;
 133   }
 134   input_token.length = apr_base64_decode(input_token.value, auth_param);
 135
 136   /* LOG length, type */
 137
 138 #ifdef GSSAPI_SUPPORTS_SPNEGO
 139   accept_sec_context = gss_accept_sec_context;
 140 #else
 141   accept_sec_context = (cmp_gss_type(&input_token, &spnego_oid) == 0) ?
 142                       gss_accept_sec_context_spnego : gss_accept_sec_context;
 143 #endif
 144
 145   major_status = accept_sec_context(&minor_status,
 146                                   &ctx->context,
 147                                   server_creds,
 148                                   &input_token,
 149                                   GSS_C_NO_CHANNEL_BINDINGS,
 150                                   NULL,
 151                                   NULL,
 152                                   &output_token,
 153                                   &ret_flags,
 154                                   NULL,
 155                                   &delegated_cred);
 156   gss_log(APLOG_MARK, APLOG_DEBUG, 0, r,
 157           "Client %s us their credential",
 158           (ret_flags & GSS_C_DELEG_FLAG) ? "delegated" : "didn't delegate");
 159   if (output_token.length) {
 160      char *token = NULL;
 161      size_t len;
 162
 163      len = apr_base64_encode_len(output_token.length) + 1;
 164      token = apr_pcalloc(r->connection->pool, len + 1);
 165      if (token == NULL) {
 166         gss_log(APLOG_MARK, APLOG_ERR, 0, r,
 167                 "ap_pcalloc() failed (not enough memory)");
 168         ret = HTTP_INTERNAL_SERVER_ERROR;
 169         gss_release_buffer(&minor_status2, &output_token);
 170         goto end;
 171      }
 172      apr_base64_encode(token, output_token.value, output_token.length);
 173      token[len] = '\0';
 174      *negotiate_ret_value = token;
 175      gss_log(APLOG_MARK, APLOG_DEBUG, 0, r,
 176              "GSS-API token of length %d bytes will be sent back",
 177              output_token.length);
 178      gss_release_buffer(&minor_status2, &output_token);
 179   }
 180
 181   if (GSS_ERROR(major_status)) {
 182      gss_log(APLOG_MARK, APLOG_ERR, 0, r,
 183              "%s", get_gss_error(r, major_status, minor_status,
 184                                  "Failed to establish authentication"));
 185 #if 0
 186      /* Don't offer the Negotiate method again if call to GSS layer failed */
 187      /* XXX ... which means we don't return the "error" output */
 188      *negotiate_ret_value = NULL;
 189 #endif
 190      gss_delete_sec_context(&minor_status, &ctx->context, GSS_C_NO_BUFFER);
 191      ctx->context = GSS_C_NO_CONTEXT;
 192      ctx->state = GSS_CTX_EMPTY;
 193      ret = HTTP_UNAUTHORIZED;
 194      goto end;
 195   }
 196
 197   if (major_status & GSS_S_CONTINUE_NEEDED) {
 198      ctx->state = GSS_CTX_IN_PROGRESS;
 199      ret = HTTP_UNAUTHORIZED;
 200      goto end;
 201   }
 202
 203   major_status = gss_inquire_context(&minor_status, ctx->context, &client_name,
 204                                      NULL, NULL, NULL, NULL, NULL, NULL);
 205   if (GSS_ERROR(major_status)) {
 206       gss_log(APLOG_MARK, APLOG_ERR, 0, r,
 207               "%s", get_gss_error(r, major_status, minor_status, "gss_inquire_context() failed"));
 208       ret = HTTP_INTERNAL_SERVER_ERROR;
 209       goto end;
 210   }
 211
 212   major_status = gss_display_name(&minor_status, client_name, &output_token, NULL);
 213   gss_release_name(&minor_status, &client_name);
 214   if (GSS_ERROR(major_status)) {
 215     gss_log(APLOG_MARK, APLOG_ERR, 0, r,
 216             "%s", get_gss_error(r, major_status, minor_status,
 217                                 "gss_display_name() failed"));
 218     ret = HTTP_INTERNAL_SERVER_ERROR;
 219     goto end;
 220   }
 221
 222   ctx->state = GSS_CTX_ESTABLISHED;
 223   ctx->user = apr_pstrdup(r->pool, output_token.value);
 224   gss_release_buffer(&minor_status, &output_token);
 225
 226   ret = OK;
 227
 228 end:
 229   if (delegated_cred)
 230      gss_release_cred(&minor_status, &delegated_cred);
 231
 232   if (output_token.length)
 233      gss_release_buffer(&minor_status, &output_token);
 234
 235   if (client_name != GSS_C_NO_NAME)
 236      gss_release_name(&minor_status, &client_name);
 237
 238   if (server_creds != GSS_C_NO_CREDENTIAL)
 239      gss_release_cred(&minor_status, &server_creds);
 240
 241   return ret;
 242 }
 243
 244 static int
 245 gss_authenticate_user(request_rec *r)
 246 {
 247     gss_auth_config *conf =
 248         (gss_auth_config *) ap_get_module_config(r->per_dir_config,
 249                                                 &auth_gssapi_module);
 250     const char *auth_line = NULL;
 251     const char *type = NULL;
 252     char *auth_type = NULL;
 253     char *negotiate_ret_value = NULL;
 254     gss_conn_ctx conn_ctx = NULL;
 255     int ret;
 256
 257     gss_log(APLOG_MARK, APLOG_DEBUG, 0, r, "Entering GSSAPI authentication");
 258
 259     /* get the type specified in Apache configuration */
 260     type = ap_auth_type(r);
 261     if (type == NULL || strcmp(type, "Negotiate") != 0) {
 262         gss_log(APLOG_MARK, APLOG_DEBUG, 0, r,
 263                 "AuthType '%s' is not for us, bailing out",
 264                 (type) ? type : "(NULL)");
 265
 266         return DECLINED;
 267     }
 268
 269     /* get what the user sent us in the HTTP header */
 270     auth_line = apr_table_get(r->headers_in, (r->proxyreq == PROXYREQ_PROXY)
 271                                             ? "Proxy-Authorization"
 272                                             : "Authorization");
 273     if (auth_line == NULL) {
 274         gss_log(APLOG_MARK, APLOG_DEBUG, 0, r,
 275                 "Client hasn't sent any authentication data, giving up");
 276         set_http_headers(r, conf, "\0");
 277         return HTTP_UNAUTHORIZED;
 278     }
 279
 280     auth_type = ap_getword_white(r->pool, &auth_line);
 281     if (strcasecmp(auth_type, "Negotiate") != 0) {
 282         gss_log(APLOG_MARK, APLOG_DEBUG, 0, r,
 283                 "Unsupported authentication type (%s) requested by client",
 284                 (auth_type) ? auth_type : "(NULL)");
 285         set_http_headers(r, conf, "\0");
 286         return HTTP_UNAUTHORIZED;
 287     }
 288
 289     if ((NULL == (conn_ctx = gss_retrieve_conn_ctx(r))) &&
 290         (NULL == (conn_ctx = gss_create_conn_ctx(r, conf)))) {
 291         gss_log(APLOG_MARK, APLOG_ERR, 0, r,
 292                 "Failed to create internal context: probably not enough memory");
 293         return HTTP_INTERNAL_SERVER_ERROR;
 294     }
 295
 296     /* optimizing hack */
 297     if (conn_ctx->state == GSS_CTX_ESTABLISHED && auth_line == NULL) {
 298         r->user = apr_pstrdup(r->pool, conn_ctx->user);
 299         r->ap_auth_type = "Negotiate";
 300         return OK;
 301     }
 302
 303     /* XXXX subrequests ignored, only successful accesses taken into account! */
 304     if (!ap_is_initial_req(r) && conn_ctx->state == GSS_CTX_ESTABLISHED) {
 305         r->user = apr_pstrdup(r->pool, conn_ctx->user);
 306         r->ap_auth_type = "Negotiate";
 307         return OK;
 308     }
 309
 310     ret = gss_authenticate(r, conf, conn_ctx,
 311                            auth_line, &negotiate_ret_value);
 312     if (ret == HTTP_UNAUTHORIZED || ret == OK) {
 313         /* LOG?? */
 314         set_http_headers(r, conf, negotiate_ret_value);
 315     }
 316
 317     if (ret == OK) {
 318         r->user = apr_pstrdup(r->pool, conn_ctx->user);
 319         r->ap_auth_type = "Negotiate";
 320     }
 321
 322     /* debug LOG ??? */
 323
 324     return ret;
 325 }
 326
 327 static void
 328 gss_register_hooks(apr_pool_t *p)
 329 {
 330     ap_hook_check_user_id(gss_authenticate_user, NULL, NULL, APR_HOOK_MIDDLE);
 331 }
 332
 333 module AP_MODULE_DECLARE_DATA auth_gssapi_module = {
 334     STANDARD20_MODULE_STUFF,
 335     gss_config_dir_create,
 336     NULL,
 337     NULL,
 338     NULL,
 339     gss_config_cmds,
 340     gss_register_hooks
 341 };