www.project-moonshot.org Git - mech_eap.orig/blob - 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
  46 /* EAP includes */
  47 #define IEEE8021X_EAPOL 1
  48
  49 #include <common.h>
  50 #include <eap_peer/eap.h>
  51 #include <eap_peer/eap_config.h>
  52 #include <wpabuf.h>
  53
  54 /* Kerberos includes */
  55 #include <krb5.h>
  56
  57 struct gss_name_struct {
  58     OM_uint32 flags;
  59     krb5_principal kerberosName;
  60     void *aaa;
  61     void *assertion;
  62 };
  63
  64 #define CRED_FLAG_INITIATOR                 0x00000001
  65 #define CRED_FLAG_ACCEPTOR                  0x00000002
  66 #define CRED_FLAG_DEFAULT_IDENTITY          0x00000004
  67 #define CRED_FLAG_PASSWORD                  0x00000008
  68
  69 struct gss_cred_id_struct {
  70     OM_uint32 flags;
  71     gss_name_t name;
  72     gss_buffer_desc password;
  73     time_t expiryTime;
  74 };
  75
  76 #define CTX_FLAG_INITIATOR                  0x00000001
  77
  78 #define CTX_IS_INITIATOR(ctx)               (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
  79
  80 enum eap_gss_state {
  81     EAP_STATE_AUTHENTICATE = 1,
  82     EAP_STATE_KEY_TRANSPORT,
  83     EAP_STATE_SECURE_ASSOCIATION,
  84     EAP_STATE_GSS_CHANNEL_BINDINGS,
  85     EAP_STATE_ESTABLISHED
  86 };
  87
  88 #define CTX_IS_ESTABLISHED(ctx)             ((ctx)->state == EAP_STATE_ESTABLISHED)
  89
  90 /* Initiator context flags */
  91 #define CTX_FLAG_EAP_SUCCESS                0x00010000
  92 #define CTX_FLAG_EAP_RESTART                0x00020000
  93 #define CTX_FLAG_EAP_FAIL                   0x00040000
  94 #define CTX_FLAG_EAP_RESP                   0x00080000
  95 #define CTX_FLAG_EAP_NO_RESP                0x00100000
  96 #define CTX_FLAG_EAP_REQ                    0x00200000
  97 #define CTX_FLAG_EAP_PORT_ENABLED           0x00400000
  98 #define CTX_FLAG_EAP_ALT_ACCEPT             0x00800000
  99 #define CTX_FLAG_EAP_ALT_REJECT             0x01000000
 100
 101 struct eap_gss_initiator_ctx {
 102     struct wpabuf *eapReqData;
 103     unsigned int idleWhile;
 104     struct eap_peer_config eapConfig;
 105     struct eap_sm *eap;
 106 };
 107
 108 /* Acceptor context flags */
 109 struct eap_gss_acceptor_ctx {
 110 };
 111
 112 struct gss_ctx_id_struct {
 113     enum eap_gss_state state;
 114     OM_uint32 flags;
 115     OM_uint32 gssFlags;
 116     krb5_context kerberosCtx;
 117     gss_OID mechanismUsed;
 118     krb5_enctype encryptionType;
 119     krb5_cksumtype checksumType;
 120     krb5_keyblock *encryptionKey;
 121     gss_name_t initiatorName;
 122     gss_name_t acceptorName;
 123     time_t expiryTime;
 124     union {
 125         struct eap_gss_initiator_ctx initiator;
 126         #define initiatorCtx         ctxU.initiator
 127         struct eap_gss_acceptor_ctx  acceptor;
 128         #define acceptorCtx          ctxU.acceptor
 129     } ctxU;
 130     uint64_t sendSeq, recvSeq;
 131     void *seqState;
 132 };
 133
 134 #define TOK_FLAG_SENDER_IS_ACCEPTOR         0x01
 135 #define TOK_FLAG_WRAP_CONFIDENTIAL          0x02
 136 #define TOK_FLAG_ACCEPTOR_SUBKEY            0x04
 137
 138 enum gss_eap_token_type {
 139     TOK_TYPE_MIC     = 0x0404,
 140     TOK_TYPE_WRAP    = 0x0504,
 141     TOK_TYPE_DELETE  = 0x0405
 142 };
 143
 144 /* Helper APIs */
 145 OM_uint32 gssEapAllocContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
 146 OM_uint32 gssEapReleaseContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
 147
 148 OM_uint32 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName);
 149 OM_uint32 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName);
 150
 151 OM_uint32 gssEapAllocCred(OM_uint32 *minor, gss_cred_id_t *pCred);
 152 OM_uint32 gssEapReleaseCred(OM_uint32 *minor, gss_cred_id_t *pCred);
 153
 154 /* Kerberos token services */
 155 #define KRB_USAGE_ACCEPTOR_SEAL             22
 156 #define KRB_USAGE_ACCEPTOR_SIGN             23
 157 #define KRB_USAGE_INITIATOR_SEAL            24
 158 #define KRB_USAGE_INITIATOR_SIGN            25
 159
 160 #if 0
 161 #define KRB_KEYTYPE(key)                    ((key)->keytype)
 162 #else
 163 #define KRB_KEYTYPE(key)                    ((key)->enctype)
 164 #endif
 165
 166 /* util_crypt.c */
 167 int
 168 gssEapEncrypt(krb5_context context, int dce_style, size_t ec,
 169               size_t rrc, krb5_keyblock *key, int usage, krb5_pointer iv,
 170               gss_iov_buffer_desc *iov, int iov_count);
 171
 172 int
 173 gssEapDecrypt(krb5_context context, int dce_style, size_t ec,
 174               size_t rrc, krb5_keyblock *key, int usage, krb5_pointer iv,
 175               gss_iov_buffer_desc *iov, int iov_count);
 176
 177 krb5_cryptotype
 178 gssEapTranslateCryptoFlag(OM_uint32 type);
 179
 180 gss_iov_buffer_t
 181 gssEapLocateIov(gss_iov_buffer_desc *iov,
 182                 int iov_count,
 183                 OM_uint32 type);
 184
 185 void
 186 gssEapIovMessageLength(gss_iov_buffer_desc *iov,
 187                        int iov_count,
 188                        size_t *data_length,
 189                        size_t *assoc_data_length);
 190
 191 void
 192 gssEapReleaseIov(gss_iov_buffer_desc *iov, int iov_count);
 193
 194 int
 195 gssEapIsIntegrityOnly(gss_iov_buffer_desc *iov, int iov_count);
 196
 197 int
 198 gssEapAllocIov(gss_iov_buffer_t iov, size_t size);
 199
 200 /* util_cksum.c */
 201 int
 202 gssEapSign(krb5_context context,
 203            krb5_cksumtype type,
 204            size_t rrc,
 205            krb5_keyblock *key,
 206            krb5_keyusage sign_usage,
 207            gss_iov_buffer_desc *iov,
 208            int iov_count);
 209
 210 int
 211 gssEapVerify(krb5_context context,
 212              krb5_cksumtype type,
 213              size_t rrc,
 214              krb5_keyblock *key,
 215              krb5_keyusage sign_usage,
 216              gss_iov_buffer_desc *iov,
 217              int iov_count,
 218              int *valid);
 219
 220 /* wrap_iov.c */
 221 OM_uint32
 222 gssEapWrapOrGetMIC(OM_uint32 *minor,
 223                    gss_ctx_id_t ctx,
 224                    int conf_req_flag,
 225                    int *conf_state,
 226                    gss_iov_buffer_desc *iov,
 227                    int iov_count,
 228                    enum gss_eap_token_type toktype);
 229
 230 OM_uint32
 231 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
 232                         gss_ctx_id_t ctx,
 233                         int *conf_state,
 234                         gss_qop_t *qop_state,
 235                         gss_iov_buffer_desc *iov,
 236                         int iov_count,
 237                         enum gss_eap_token_type toktype);
 238
 239 /* Helper macros */
 240 #define GSSEAP_CALLOC(count, size)      (calloc((count), (size)))
 241 #define GSSEAP_FREE(ptr)                (free((ptr)))
 242 #define GSSEAP_MALLOC(size)             (malloc((size)))
 243 #define GSSEAP_REALLOC(ptr, size)       (realloc((ptr), (size)))
 244
 245 #define GSSEAP_NOT_IMPLEMENTED          do {            \
 246         assert(0 && "not implemented");                 \
 247         *minor = ENOSYS;                                \
 248         return GSS_S_FAILURE;                           \
 249     } while (0)
 250
 251 #endif /* _GSSAPIP_EAP_H_ */
 252