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