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