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