mech_eap/gssapiP_eap.h

   1 /*
   2  * Copyright (c) 2011, JANET(UK)
   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
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * 3. Neither the name of JANET(UK) nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 #ifndef _GSSAPIP_EAP_H_
  34 #define _GSSAPIP_EAP_H_ 1
  35
  36 #include "config.h"
  37
  38 #ifdef HAVE_HEIMDAL_VERSION
  39 #define KRB5_DEPRECATED         /* so we can use krb5_free_unparsed_name() */
  40 #endif
  41
  42 #include <assert.h>
  43 #include <string.h>
  44 #include <errno.h>
  45 #include <unistd.h>
  46 #include <stdlib.h>
  47 #include <stdarg.h>
  48 #include <time.h>
  49 #include <sys/param.h>
  50
  51 /* GSS headers */
  52 #include <gssapi/gssapi.h>
  53 #include <gssapi/gssapi_krb5.h>
  54 #ifdef HAVE_HEIMDAL_VERSION
  55 typedef struct gss_any *gss_any_t;
  56 #else
  57 #include <gssapi/gssapi_ext.h>
  58 #endif
  59 #include "gssapi_eap.h"
  60
  61 /* Kerberos headers */
  62 #include <krb5.h>
  63
  64 /* EAP headers */
  65 #include <common.h>
  66 #include <eap_peer/eap.h>
  67 #include <eap_peer/eap_config.h>
  68 #include <eap_peer/eap_methods.h>
  69 #include <eap_common/eap_common.h>
  70 #include <wpabuf.h>
  71
  72 /* FreeRADIUS headers */
  73 #ifdef __cplusplus
  74 extern "C" {
  75 #define operator fr_operator
  76 #endif
  77 #include <freeradius/libradius.h>
  78 #include <freeradius/radius.h>
  79 #include <radsec/radsec.h>
  80 #include <radsec/request.h>
  81 #ifdef __cplusplus
  82 #undef operator
  83 }
  84 #endif
  85
  86 #include "gsseap_err.h"
  87 #include "radsec_err.h"
  88 #include "util.h"
  89
  90 #ifdef __cplusplus
  91 extern "C" {
  92 #endif
  93
  94 /* These name flags are informative and not actually used by anything yet */
  95 #define NAME_FLAG_NAI                       0x00000001
  96 #define NAME_FLAG_SERVICE                   0x00000002
  97 #define NAME_FLAG_COMPOSITE                 0x00000004
  98
  99 struct gss_eap_saml_attr_ctx;
 100 struct gss_eap_attr_ctx;
 101
 102 #ifdef HAVE_HEIMDAL_VERSION
 103 struct gss_name_t_desc_struct
 104 #else
 105 struct gss_name_struct
 106 #endif
 107 {
 108     GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
 109     OM_uint32 flags;
 110     gss_OID mechanismUsed; /* this is immutable */
 111     krb5_principal krbPrincipal; /* this is immutable */
 112     struct gss_eap_attr_ctx *attrCtx;
 113 };
 114
 115 #define CRED_FLAG_INITIATE                  0x00010000
 116 #define CRED_FLAG_ACCEPT                    0x00020000
 117 #define CRED_FLAG_DEFAULT_IDENTITY          0x00040000
 118 #define CRED_FLAG_PASSWORD                  0x00080000
 119 #define CRED_FLAG_DEFAULT_CCACHE            0x00100000
 120 #define CRED_FLAG_PUBLIC_MASK               0x0000FFFF
 121
 122 #ifdef HAVE_HEIMDAL_VERSION
 123 struct gss_cred_id_t_desc_struct
 124 #else
 125 struct gss_cred_id_struct
 126 #endif
 127 {
 128     GSSEAP_MUTEX mutex;
 129     OM_uint32 flags;
 130     gss_name_t name;
 131     gss_buffer_desc password;
 132     gss_OID_set mechanisms;
 133     time_t expiryTime;
 134     char *radiusConfigFile;
 135     char *radiusConfigStanza;
 136 #ifdef GSSEAP_ENABLE_REAUTH
 137     krb5_ccache krbCredCache;
 138     gss_cred_id_t krbCred;
 139 #endif
 140 };
 141
 142 #define CTX_FLAG_INITIATOR                  0x00000001
 143 #define CTX_FLAG_KRB_REAUTH                 0x00000002
 144
 145 #define CTX_IS_INITIATOR(ctx)               (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
 146
 147 #define CTX_IS_ESTABLISHED(ctx)             ((ctx)->state == GSSEAP_STATE_ESTABLISHED)
 148
 149 /* Initiator context flags */
 150 #define CTX_FLAG_EAP_SUCCESS                0x00010000
 151 #define CTX_FLAG_EAP_RESTART                0x00020000
 152 #define CTX_FLAG_EAP_FAIL                   0x00040000
 153 #define CTX_FLAG_EAP_RESP                   0x00080000
 154 #define CTX_FLAG_EAP_NO_RESP                0x00100000
 155 #define CTX_FLAG_EAP_REQ                    0x00200000
 156 #define CTX_FLAG_EAP_PORT_ENABLED           0x00400000
 157 #define CTX_FLAG_EAP_ALT_ACCEPT             0x00800000
 158 #define CTX_FLAG_EAP_ALT_REJECT             0x01000000
 159 #define CTX_FLAG_EAP_MASK                   0xFFFF0000
 160
 161 struct gss_eap_initiator_ctx {
 162     unsigned int idleWhile;
 163 #ifndef __cplusplus
 164     struct eap_peer_config eapPeerConfig;
 165     struct eap_sm *eap;
 166     struct wpabuf reqData;
 167 #endif
 168 };
 169
 170 struct gss_eap_acceptor_ctx {
 171     struct rs_context *radContext;
 172     struct rs_connection *radConn;
 173     char *radServer;
 174     gss_buffer_desc state;
 175     VALUE_PAIR *vps;
 176 };
 177
 178 #ifdef HAVE_HEIMDAL_VERSION
 179 struct gss_ctx_id_t_desc_struct
 180 #else
 181 struct gss_ctx_id_struct
 182 #endif
 183 {
 184     GSSEAP_MUTEX mutex;
 185     enum gss_eap_state state;
 186     OM_uint32 flags;
 187     OM_uint32 gssFlags;
 188     gss_OID mechanismUsed;
 189     krb5_cksumtype checksumType;
 190     krb5_enctype encryptionType;
 191     krb5_keyblock rfc3961Key;
 192     gss_name_t initiatorName;
 193     gss_name_t acceptorName;
 194     time_t expiryTime;
 195     uint64_t sendSeq, recvSeq;
 196     void *seqState;
 197     gss_cred_id_t defaultCred;
 198     union {
 199         struct gss_eap_initiator_ctx initiator;
 200         #define initiatorCtx         ctxU.initiator
 201         struct gss_eap_acceptor_ctx  acceptor;
 202         #define acceptorCtx          ctxU.acceptor
 203 #ifdef GSSEAP_ENABLE_REAUTH
 204         gss_ctx_id_t                 reauth;
 205         #define reauthCtx            ctxU.reauth
 206 #endif
 207     } ctxU;
 208 };
 209
 210 #define TOK_FLAG_SENDER_IS_ACCEPTOR         0x01
 211 #define TOK_FLAG_WRAP_CONFIDENTIAL          0x02
 212 #define TOK_FLAG_ACCEPTOR_SUBKEY            0x04
 213
 214 #define KEY_USAGE_ACCEPTOR_SEAL             22
 215 #define KEY_USAGE_ACCEPTOR_SIGN             23
 216 #define KEY_USAGE_INITIATOR_SEAL            24
 217 #define KEY_USAGE_INITIATOR_SIGN            25
 218
 219 /* wrap_iov.c */
 220 OM_uint32
 221 gssEapWrapOrGetMIC(OM_uint32 *minor,
 222                    gss_ctx_id_t ctx,
 223                    int conf_req_flag,
 224                    int *conf_state,
 225                    gss_iov_buffer_desc *iov,
 226                    int iov_count,
 227                    enum gss_eap_token_type toktype);
 228
 229 OM_uint32
 230 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
 231                         gss_ctx_id_t ctx,
 232                         int *conf_state,
 233                         gss_qop_t *qop_state,
 234                         gss_iov_buffer_desc *iov,
 235                         int iov_count,
 236                         enum gss_eap_token_type toktype);
 237
 238 OM_uint32
 239 gssEapWrapIovLength(OM_uint32 *minor,
 240                     gss_ctx_id_t ctx,
 241                     int conf_req_flag,
 242                     gss_qop_t qop_req,
 243                     int *conf_state,
 244                     gss_iov_buffer_desc *iov,
 245                     int iov_count);
 246 OM_uint32
 247 gssEapWrap(OM_uint32 *minor,
 248            gss_ctx_id_t ctx,
 249            int conf_req_flag,
 250            gss_qop_t qop_req,
 251            gss_buffer_t input_message_buffer,
 252            int *conf_state,
 253            gss_buffer_t output_message_buffer);
 254
 255 unsigned char
 256 rfc4121Flags(gss_ctx_id_t ctx, int receiving);
 257
 258 /* display_status.c */
 259 void
 260 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
 261
 262 #define IS_WIRE_ERROR(err)              ((err) > GSSEAP_RESERVED && \
 263                                          (err) <= GSSEAP_RADIUS_PROT_FAILURE)
 264
 265 /* export_sec_context.c */
 266 OM_uint32
 267 gssEapExportSecContext(OM_uint32 *minor,
 268                        gss_ctx_id_t ctx,
 269                        gss_buffer_t token);
 270
 271
 272 #ifdef __cplusplus
 273 }
 274 #endif
 275
 276 #endif /* _GSSAPIP_EAP_H_ */