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 <assert.h>
  37 #include <string.h>
  38 #include <errno.h>
  39 #include <time.h>
  40
  41 /* GSS includes */
  42 #include <gssapi/gssapi.h>
  43 #include <gssapi/gssapi_ext.h>
  44 #include "gssapi_eap.h"
  45 #include "util.h"
  46
  47 /* EAP includes */
  48 #define IEEE8021X_EAPOL 1
  49
  50 #include <common.h>
  51 #include <eap_peer/eap.h>
  52 #include <eap_peer/eap_config.h>
  53 #include <wpabuf.h>
  54
  55 /* Kerberos includes */
  56 #include <krb5.h>
  57
  58 #define NAME_FLAG_NAI                       0x00000001
  59 #define NAME_FLAG_SERVICE                   0x00000002
  60 #define NAME_FLAG_SAML                      0x00000010
  61 #define NAME_FLAG_RADIUS                    0x00000020
  62
  63 #define NAME_HAS_ATTRIBUTES(name)           ((name)->flags & \
  64                                              (NAME_FLAG_SAML | NAME_FLAG_RADIUS))
  65
  66 struct eap_gss_saml_assertion;
  67 struct eap_gss_avp_list;
  68
  69 struct gss_name_struct {
  70     GSSEAP_MUTEX mutex; /* mutex protecting attributes */
  71     OM_uint32 flags;
  72     krb5_principal krbPrincipal; /* this is immutable */
  73     struct eap_gss_saml_assertion *assertion;
  74     struct eap_gss_avp_list *avps;
  75 };
  76
  77 #define CRED_FLAG_INITIATE                  0x00000001
  78 #define CRED_FLAG_ACCEPT                    0x00000002
  79 #define CRED_FLAG_DEFAULT_IDENTITY          0x00000004
  80 #define CRED_FLAG_PASSWORD                  0x00000008
  81
  82 struct gss_cred_id_struct {
  83     GSSEAP_MUTEX mutex;
  84     OM_uint32 flags;
  85     gss_name_t name;
  86     gss_buffer_desc password;
  87     gss_OID_set mechanisms;
  88     time_t expiryTime;
  89 };
  90
  91 #define CTX_FLAG_INITIATOR                  0x00000001
  92
  93 #define CTX_IS_INITIATOR(ctx)               (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
  94
  95 enum eap_gss_state {
  96     EAP_STATE_AUTHENTICATE = 1,
  97     EAP_STATE_KEY_TRANSPORT,
  98     EAP_STATE_SECURE_ASSOCIATION,
  99     EAP_STATE_GSS_CHANNEL_BINDINGS,
 100     EAP_STATE_ESTABLISHED
 101 };
 102
 103 #define CTX_IS_ESTABLISHED(ctx)             ((ctx)->state == EAP_STATE_ESTABLISHED)
 104
 105 /* Initiator context flags */
 106 #define CTX_FLAG_EAP_SUCCESS                0x00010000
 107 #define CTX_FLAG_EAP_RESTART                0x00020000
 108 #define CTX_FLAG_EAP_FAIL                   0x00040000
 109 #define CTX_FLAG_EAP_RESP                   0x00080000
 110 #define CTX_FLAG_EAP_NO_RESP                0x00100000
 111 #define CTX_FLAG_EAP_REQ                    0x00200000
 112 #define CTX_FLAG_EAP_PORT_ENABLED           0x00400000
 113 #define CTX_FLAG_EAP_ALT_ACCEPT             0x00800000
 114 #define CTX_FLAG_EAP_ALT_REJECT             0x01000000
 115
 116 struct eap_gss_initiator_ctx {
 117     struct wpabuf *eapReqData;
 118     unsigned int idleWhile;
 119     struct eap_peer_config eapConfig;
 120     struct eap_sm *eap;
 121 };
 122
 123 typedef OM_uint32 (*eap_gss_initiator_sm)(OM_uint32 *,
 124                                           gss_cred_id_t,
 125                                           gss_ctx_id_t *,
 126                                           gss_OID,
 127                                           OM_uint32,
 128                                           OM_uint32,
 129                                           gss_channel_bindings_t,
 130                                           gss_buffer_t,
 131                                           gss_OID *,
 132                                           gss_buffer_t,
 133                                           OM_uint32 *,
 134                                           OM_uint32 *);
 135
 136 /* Acceptor context flags */
 137 struct eap_gss_acceptor_ctx {
 138 };
 139
 140 typedef OM_uint32 (*eap_gss_acceptor_sm)(OM_uint32 *,
 141                                          gss_ctx_id_t *,
 142                                          gss_cred_id_t,
 143                                          gss_buffer_t,
 144                                          gss_channel_bindings_t,
 145                                          gss_name_t *,
 146                                          gss_buffer_t,
 147                                          OM_uint32 *,
 148                                          OM_uint32 *,
 149                                          gss_cred_id_t *);
 150
 151 struct gss_ctx_id_struct {
 152     GSSEAP_MUTEX mutex;
 153     enum eap_gss_state state;
 154     OM_uint32 flags;
 155     OM_uint32 gssFlags;
 156     gss_OID mechanismUsed;
 157     krb5_enctype encryptionType;
 158     krb5_cksumtype checksumType;
 159     krb5_keyblock rfc3961Key;
 160     gss_name_t initiatorName;
 161     gss_name_t acceptorName;
 162     time_t expiryTime;
 163     union {
 164         struct eap_gss_initiator_ctx initiator;
 165         #define initiatorCtx         ctxU.initiator
 166         struct eap_gss_acceptor_ctx  acceptor;
 167         #define acceptorCtx          ctxU.acceptor
 168     } ctxU;
 169     uint64_t sendSeq, recvSeq;
 170     void *seqState;
 171 };
 172
 173 #define TOK_FLAG_SENDER_IS_ACCEPTOR         0x01
 174 #define TOK_FLAG_WRAP_CONFIDENTIAL          0x02
 175 #define TOK_FLAG_ACCEPTOR_SUBKEY            0x04
 176
 177 #define KEY_USAGE_ACCEPTOR_SEAL             22
 178 #define KEY_USAGE_ACCEPTOR_SIGN             23
 179 #define KEY_USAGE_INITIATOR_SEAL            24
 180 #define KEY_USAGE_INITIATOR_SIGN            25
 181
 182 /* wrap_iov.c */
 183 OM_uint32
 184 gssEapWrapOrGetMIC(OM_uint32 *minor,
 185                    gss_ctx_id_t ctx,
 186                    int conf_req_flag,
 187                    int *conf_state,
 188                    gss_iov_buffer_desc *iov,
 189                    int iov_count,
 190                    enum gss_eap_token_type toktype);
 191
 192 OM_uint32
 193 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
 194                         gss_ctx_id_t ctx,
 195                         int *conf_state,
 196                         gss_qop_t *qop_state,
 197                         gss_iov_buffer_desc *iov,
 198                         int iov_count,
 199                         enum gss_eap_token_type toktype);
 200
 201
 202 #endif /* _GSSAPIP_EAP_H_ */