gssapiP_eap.h

   1 /*
   2  * Copyright (c) 2010, 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 #include <assert.h>
  38 #include <string.h>
  39 #include <errno.h>
  40 #include <unistd.h>
  41 #include <stdlib.h>
  42 #include <time.h>
  43 #include <sys/param.h>
  44
  45 /* GSS includes */
  46 #include <gssapi/gssapi.h>
  47 #include <gssapi/gssapi_krb5.h>
  48 #include <gssapi/gssapi_ext.h>
  49 #include "gssapi_eap.h"
  50
  51 /* Kerberos includes */
  52 #include <krb5.h>
  53
  54 /* EAP includes (not C++ clean) */
  55 #ifndef __cplusplus
  56 #include <common.h>
  57 #include <eap_peer/eap.h>
  58 #include <eap_peer/eap_config.h>
  59 #include <crypto/tls.h>
  60 #include <wpabuf.h>
  61 #endif
  62
  63 /* Workaround for FreeRADIUS not being C++ clean */
  64 #ifdef __cplusplus
  65 extern "C" {
  66 #define operator fr_operator
  67 #endif
  68 #include <freeradius/libradius.h>
  69 #include <freeradius/radius.h>
  70 #include <radsec/radsec.h>
  71 #ifdef __cplusplus
  72 #undef operator
  73 }
  74 #endif
  75
  76 #include "util.h"
  77
  78 #ifdef __cplusplus
  79 extern "C" {
  80 #endif
  81
  82 /* These name flags are informative and not actually used by anything yet */
  83 #define NAME_FLAG_NAI                       0x00000001
  84 #define NAME_FLAG_SERVICE                   0x00000002
  85 #define NAME_FLAG_COMPOSITE                 0x00000004
  86
  87 struct gss_eap_saml_attr_ctx;
  88 struct gss_eap_attr_ctx;
  89
  90 struct gss_name_struct {
  91     GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
  92     OM_uint32 flags;
  93     krb5_principal krbPrincipal; /* this is immutable */
  94     struct gss_eap_attr_ctx *attrCtx;
  95 };
  96
  97 #define CRED_FLAG_INITIATE                  0x00010000
  98 #define CRED_FLAG_ACCEPT                    0x00020000
  99 #define CRED_FLAG_DEFAULT_IDENTITY          0x00040000
 100 #define CRED_FLAG_PASSWORD                  0x00080000
 101 #define CRED_FLAG_DEFAULT_CCACHE            0x00100000
 102 #define CRED_FLAG_PUBLIC_MASK               0x0000FFFF
 103
 104 struct gss_cred_id_struct {
 105     GSSEAP_MUTEX mutex;
 106     OM_uint32 flags;
 107     gss_name_t name;
 108     gss_buffer_desc password;
 109     gss_OID_set mechanisms;
 110     time_t expiryTime;
 111     char *radiusConfigFile;
 112 #ifdef GSSEAP_ENABLE_REAUTH
 113     krb5_ccache krbCredCache;
 114     gss_cred_id_t krbCred;
 115 #endif
 116 };
 117
 118 #define CTX_FLAG_INITIATOR                  0x00000001
 119 #define CTX_FLAG_KRB_REAUTH_GSS             0x00000002
 120
 121 #define CTX_IS_INITIATOR(ctx)               (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
 122
 123 enum gss_eap_state {
 124     EAP_STATE_IDENTITY = 0,
 125     EAP_STATE_AUTHENTICATE,
 126     EAP_STATE_EXTENSIONS_REQ,
 127     EAP_STATE_EXTENSIONS_RESP,
 128     EAP_STATE_ESTABLISHED,
 129 #ifdef GSSEAP_ENABLE_REAUTH
 130     EAP_STATE_KRB_REAUTH_GSS
 131 #endif
 132 };
 133
 134 #define CTX_IS_ESTABLISHED(ctx)             ((ctx)->state == EAP_STATE_ESTABLISHED)
 135
 136 /* Initiator context flags */
 137 #define CTX_FLAG_EAP_SUCCESS                0x00010000
 138 #define CTX_FLAG_EAP_RESTART                0x00020000
 139 #define CTX_FLAG_EAP_FAIL                   0x00040000
 140 #define CTX_FLAG_EAP_RESP                   0x00080000
 141 #define CTX_FLAG_EAP_NO_RESP                0x00100000
 142 #define CTX_FLAG_EAP_REQ                    0x00200000
 143 #define CTX_FLAG_EAP_PORT_ENABLED           0x00400000
 144 #define CTX_FLAG_EAP_ALT_ACCEPT             0x00800000
 145 #define CTX_FLAG_EAP_ALT_REJECT             0x01000000
 146 #define CTX_FLAG_EAP_MASK                   0xFFFF0000
 147
 148 struct gss_eap_initiator_ctx {
 149     gss_cred_id_t defaultCred;
 150     unsigned int idleWhile;
 151 #ifndef __cplusplus
 152     struct eap_peer_config eapPeerConfig;
 153     struct eap_sm *eap;
 154     struct wpabuf reqData;
 155 #endif
 156 };
 157
 158 struct gss_eap_acceptor_ctx {
 159     struct rs_handle *radHandle;
 160     struct rs_connection *radConn;
 161     char *radServer;
 162     gss_buffer_desc state;
 163     VALUE_PAIR *avps;
 164 };
 165
 166 struct gss_ctx_id_struct {
 167     GSSEAP_MUTEX mutex;
 168     enum gss_eap_state state;
 169     OM_uint32 flags;
 170     OM_uint32 gssFlags;
 171     gss_OID mechanismUsed;
 172     krb5_cksumtype checksumType;
 173     krb5_enctype encryptionType;
 174     krb5_keyblock rfc3961Key;
 175     gss_name_t initiatorName;
 176     gss_name_t acceptorName;
 177     time_t expiryTime;
 178     uint64_t sendSeq, recvSeq;
 179     void *seqState;
 180     union {
 181         struct gss_eap_initiator_ctx initiator;
 182         #define initiatorCtx         ctxU.initiator
 183         struct gss_eap_acceptor_ctx  acceptor;
 184         #define acceptorCtx          ctxU.acceptor
 185 #ifdef GSSEAP_ENABLE_REAUTH
 186         gss_ctx_id_t                 kerberos;
 187         #define kerberosCtx          ctxU.kerberos
 188 #endif
 189     } ctxU;
 190 };
 191
 192 #define TOK_FLAG_SENDER_IS_ACCEPTOR         0x01
 193 #define TOK_FLAG_WRAP_CONFIDENTIAL          0x02
 194 #define TOK_FLAG_ACCEPTOR_SUBKEY            0x04
 195
 196 #define KEY_USAGE_ACCEPTOR_SEAL             22
 197 #define KEY_USAGE_ACCEPTOR_SIGN             23
 198 #define KEY_USAGE_INITIATOR_SEAL            24
 199 #define KEY_USAGE_INITIATOR_SIGN            25
 200 #define KEY_USAGE_CHANNEL_BINDINGS          64
 201
 202 /* wrap_iov.c */
 203 OM_uint32
 204 gssEapWrapOrGetMIC(OM_uint32 *minor,
 205                    gss_ctx_id_t ctx,
 206                    int conf_req_flag,
 207                    int *conf_state,
 208                    gss_iov_buffer_desc *iov,
 209                    int iov_count,
 210                    enum gss_eap_token_type toktype);
 211
 212 OM_uint32
 213 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
 214                         gss_ctx_id_t ctx,
 215                         int *conf_state,
 216                         gss_qop_t *qop_state,
 217                         gss_iov_buffer_desc *iov,
 218                         int iov_count,
 219                         enum gss_eap_token_type toktype);
 220
 221 OM_uint32
 222 gssEapWrapIovLength(OM_uint32 *minor,
 223                     gss_ctx_id_t ctx,
 224                     int conf_req_flag,
 225                     gss_qop_t qop_req,
 226                     int *conf_state,
 227                     gss_iov_buffer_desc *iov,
 228                     int iov_count);
 229 OM_uint32
 230 gssEapWrap(OM_uint32 *minor,
 231            gss_ctx_id_t ctx,
 232            int conf_req_flag,
 233            gss_qop_t qop_req,
 234            gss_buffer_t input_message_buffer,
 235            int *conf_state,
 236            gss_buffer_t output_message_buffer);
 237
 238 unsigned char
 239 rfc4121Flags(gss_ctx_id_t ctx, int receiving);
 240
 241 /* display_status.c */
 242 void
 243 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
 244
 245 #ifdef __cplusplus
 246 }
 247 #endif
 248
 249 #endif /* _GSSAPIP_EAP_H_ */