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 struct eap_gss_saml_assertion;
  64 struct eap_gss_avp_list;
  65
  66 struct gss_name_struct {
  67     GSSEAP_MUTEX mutex; /* mutex protecting attributes */
  68     OM_uint32 flags;
  69     krb5_principal krbPrincipal; /* this is immutable */
  70     struct eap_gss_saml_assertion *assertion;
  71     struct eap_gss_avp_list *avps;
  72 };
  73
  74 #define CRED_FLAG_INITIATOR                 0x00000001
  75 #define CRED_FLAG_ACCEPTOR                  0x00000002
  76 #define CRED_FLAG_DEFAULT_IDENTITY          0x00000004
  77 #define CRED_FLAG_PASSWORD                  0x00000008
  78
  79 struct gss_cred_id_struct {
  80     GSSEAP_MUTEX mutex;
  81     OM_uint32 flags;
  82     gss_name_t name;
  83     gss_buffer_desc password;
  84     time_t expiryTime;
  85 };
  86
  87 #define CTX_FLAG_INITIATOR                  0x00000001
  88
  89 #define CTX_IS_INITIATOR(ctx)               (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
  90
  91 enum eap_gss_state {
  92     EAP_STATE_AUTHENTICATE = 1,
  93     EAP_STATE_KEY_TRANSPORT,
  94     EAP_STATE_SECURE_ASSOCIATION,
  95     EAP_STATE_GSS_CHANNEL_BINDINGS,
  96     EAP_STATE_ESTABLISHED
  97 };
  98
  99 #define CTX_IS_ESTABLISHED(ctx)             ((ctx)->state == EAP_STATE_ESTABLISHED)
 100
 101 /* Initiator context flags */
 102 #define CTX_FLAG_EAP_SUCCESS                0x00010000
 103 #define CTX_FLAG_EAP_RESTART                0x00020000
 104 #define CTX_FLAG_EAP_FAIL                   0x00040000
 105 #define CTX_FLAG_EAP_RESP                   0x00080000
 106 #define CTX_FLAG_EAP_NO_RESP                0x00100000
 107 #define CTX_FLAG_EAP_REQ                    0x00200000
 108 #define CTX_FLAG_EAP_PORT_ENABLED           0x00400000
 109 #define CTX_FLAG_EAP_ALT_ACCEPT             0x00800000
 110 #define CTX_FLAG_EAP_ALT_REJECT             0x01000000
 111
 112 struct eap_gss_initiator_ctx {
 113     struct wpabuf *eapReqData;
 114     unsigned int idleWhile;
 115     struct eap_peer_config eapConfig;
 116     struct eap_sm *eap;
 117 };
 118
 119 /* Acceptor context flags */
 120 struct eap_gss_acceptor_ctx {
 121 };
 122
 123 struct gss_ctx_id_struct {
 124     GSSEAP_MUTEX mutex;
 125     enum eap_gss_state state;
 126     OM_uint32 flags;
 127     OM_uint32 gssFlags;
 128     gss_OID mechanismUsed;
 129     krb5_enctype encryptionType;
 130     krb5_cksumtype checksumType;
 131     krb5_keyblock rfc3961Key;
 132     gss_name_t initiatorName;
 133     gss_name_t acceptorName;
 134     time_t expiryTime;
 135     union {
 136         struct eap_gss_initiator_ctx initiator;
 137         #define initiatorCtx         ctxU.initiator
 138         struct eap_gss_acceptor_ctx  acceptor;
 139         #define acceptorCtx          ctxU.acceptor
 140     } ctxU;
 141     uint64_t sendSeq, recvSeq;
 142     void *seqState;
 143 };
 144
 145 #define TOK_FLAG_SENDER_IS_ACCEPTOR         0x01
 146 #define TOK_FLAG_WRAP_CONFIDENTIAL          0x02
 147 #define TOK_FLAG_ACCEPTOR_SUBKEY            0x04
 148
 149 #define KEY_USAGE_ACCEPTOR_SEAL             22
 150 #define KEY_USAGE_ACCEPTOR_SIGN             23
 151 #define KEY_USAGE_INITIATOR_SEAL            24
 152 #define KEY_USAGE_INITIATOR_SIGN            25
 153
 154 /* wrap_iov.c */
 155 OM_uint32
 156 gssEapWrapOrGetMIC(OM_uint32 *minor,
 157                    gss_ctx_id_t ctx,
 158                    int conf_req_flag,
 159                    int *conf_state,
 160                    gss_iov_buffer_desc *iov,
 161                    int iov_count,
 162                    enum gss_eap_token_type toktype);
 163
 164 OM_uint32
 165 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
 166                         gss_ctx_id_t ctx,
 167                         int *conf_state,
 168                         gss_qop_t *qop_state,
 169                         gss_iov_buffer_desc *iov,
 170                         int iov_count,
 171                         enum gss_eap_token_type toktype);
 172
 173
 174 #endif /* _GSSAPIP_EAP_H_ */