gss.h

   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 /*
  33  * Most of the name attributes management code is based from
  34  * https://github.com/modauthgssapi/mod_auth_gssapi, written by Simo Sorce.
  35  */
  36
  37 #ifndef __GSS_H__
  38 #define __GSS_H__
  39
  40 #include <httpd.h>
  41 #include <http_config.h>
  42 #include <http_core.h>
  43 #include <http_log.h>
  44 #include <http_protocol.h>
  45 #include <http_request.h>
  46
  47 #include <apr_base64.h>
  48 #include <apr_strings.h>
  49
  50 #include <gssapi.h>
  51 #include <gssapi/gssapi.h>
  52 #include <gssapi/gssapi_ext.h>
  53
  54
  55 #define SERVICE_NAME "HTTP"
  56
  57 typedef struct  {
  58     char *env_name;
  59     char *attr_name;
  60 } mag_na_map;
  61
  62 typedef struct  {
  63     char output_json;
  64     int map_count;
  65     mag_na_map map[];
  66 } mag_name_attributes;
  67
  68 typedef struct {
  69    const char *name;
  70     const char *value;
  71 } mag_attr;
  72
  73 typedef struct  {
  74     gss_buffer_desc name;
  75     int authenticated;
  76     int complete;
  77     gss_buffer_desc value;
  78     gss_buffer_desc display_value;
  79     const char *env_name;
  80     int number;
  81     int more;
  82 } name_attr;
  83
  84 typedef struct {
  85     const char *service_name;
  86     const char *krb5_keytab;
  87     apr_pool_t *pool;
  88     mag_name_attributes *name_attributes;
  89 } gss_auth_config;
  90
  91 typedef struct {
  92   gss_ctx_id_t context;
  93   gss_cred_id_t server_creds;
  94   enum {
  95     GSS_CTX_EMPTY,
  96     GSS_CTX_IN_PROGRESS,
  97     GSS_CTX_FAILED,
  98     GSS_CTX_ESTABLISHED,
  99   } state;
 100   enum {
 101     GSS_FILT_NEW,
 102     GSS_FILT_INPROGRESS,
 103     GSS_FILT_ERROR,
 104   } filter_stat;
 105
 106   char *user;
 107   gss_buffer_desc output_token;
 108   unsigned int nonce;
 109   apr_pool_t *pool;
 110   int na_count;
 111   mag_attr *name_attributes;
 112 } gss_conn_ctx_t, *gss_conn_ctx;
 113
 114
 115
 116
 117 void
 118 gss_log(const char *file,
 119         int line,
 120 #if AP_SERVER_MAJORVERSION_NUMBER == 2 && AP_SERVER_MINORVERSION_NUMBER == 4
 121         int module_index,
 122 #endif
 123         int level,
 124         int status,
 125         const request_rec *r,
 126         const char *fmt, ...);
 127
 128 apr_status_t
 129 gss_cleanup_conn_ctx(void *data);
 130
 131 gss_conn_ctx
 132 gss_retrieve_conn_ctx(request_rec *r);
 133
 134 gss_conn_ctx
 135 gss_create_conn_ctx(request_rec *r, gss_auth_config *conf);
 136
 137 void *
 138 gss_config_dir_create(apr_pool_t *p, char *d);
 139
 140 const char *
 141 get_gss_error(request_rec *r, OM_uint32 err_maj, OM_uint32 err_min, char *prefix);
 142
 143 int
 144 get_gss_creds(request_rec *r, gss_auth_config *conf, gss_cred_id_t *server_creds);
 145
 146 int
 147 cmp_gss_type(gss_buffer_t token, gss_OID oid);
 148
 149 const char *
 150 mag_name_attrs(cmd_parms *parms, void *mconfig, const char *w);
 151
 152 #endif