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