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
  48 /* Kerberos includes */
  49 #include <krb5.h>
  50
  51 /* EAP includes */
  52 #ifndef __cplusplus
  53 #include <common.h>
  54 #include <eap_peer/eap.h>
  55 #include <eap_peer/eap_config.h>
  56 #include <crypto/tls.h>
  57 #include <wpabuf.h>
  58 #endif
  59
  60 #include <freeradius-client.h>
  61 #include <freeradius/radius.h>
  62
  63 #include "util.h"
  64
  65 /* These name flags are informative and not actually used by anything yet */
  66 #define NAME_FLAG_NAI                       0x00000001
  67 #define NAME_FLAG_SERVICE                   0x00000002
  68 #define NAME_FLAG_COMPOSITE                 0x00000004
  69
  70 struct gss_eap_saml_attr_ctx;
  71 struct gss_eap_attr_ctx;
  72
  73 struct gss_name_struct {
  74     GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
  75     OM_uint32 flags;
  76     krb5_principal krbPrincipal; /* this is immutable */
  77     struct gss_eap_attr_ctx *attrCtx;
  78 };
  79
  80 #define CRED_FLAG_INITIATE                  0x00010000
  81 #define CRED_FLAG_ACCEPT                    0x00020000
  82 #define CRED_FLAG_DEFAULT_IDENTITY          0x00040000
  83 #define CRED_FLAG_PASSWORD                  0x00080000
  84 #define CRED_FLAG_PUBLIC_MASK               0x0000FFFF
  85
  86 struct gss_cred_id_struct {
  87     GSSEAP_MUTEX mutex;
  88     OM_uint32 flags;
  89     gss_name_t name;
  90     gss_buffer_desc password;
  91     gss_OID_set mechanisms;
  92     time_t expiryTime;
  93     char *radiusConfigFile;
  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_IDENTITY = 0,
 102     EAP_STATE_AUTHENTICATE,
 103     EAP_STATE_GSS_CHANNEL_BINDINGS,
 104     EAP_STATE_ESTABLISHED
 105 };
 106
 107 #define CTX_IS_ESTABLISHED(ctx)             ((ctx)->state == EAP_STATE_ESTABLISHED)
 108
 109 /* Initiator context flags */
 110 #define CTX_FLAG_EAP_SUCCESS                0x00010000
 111 #define CTX_FLAG_EAP_RESTART                0x00020000
 112 #define CTX_FLAG_EAP_FAIL                   0x00040000
 113 #define CTX_FLAG_EAP_RESP                   0x00080000
 114 #define CTX_FLAG_EAP_NO_RESP                0x00100000
 115 #define CTX_FLAG_EAP_REQ                    0x00200000
 116 #define CTX_FLAG_EAP_PORT_ENABLED           0x00400000
 117 #define CTX_FLAG_EAP_ALT_ACCEPT             0x00800000
 118 #define CTX_FLAG_EAP_ALT_REJECT             0x01000000
 119 #define CTX_FLAG_EAP_MASK                   0xFFFF0000
 120
 121 struct gss_eap_initiator_ctx {
 122     unsigned int idleWhile;
 123 #ifndef __cplusplus
 124     struct eap_peer_config eapPeerConfig;
 125     struct eap_sm *eap;
 126     struct wpabuf reqData;
 127 #endif
 128 };
 129
 130 struct gss_eap_acceptor_ctx {
 131     rc_handle *radHandle;
 132     int lastStatus;
 133     VALUE_PAIR *avps;
 134     gss_buffer_desc state;
 135 };
 136
 137 struct gss_ctx_id_struct {
 138     GSSEAP_MUTEX mutex;
 139     enum gss_eap_state state;
 140     OM_uint32 flags;
 141     OM_uint32 gssFlags;
 142     gss_OID mechanismUsed;
 143     krb5_cksumtype checksumType;
 144     krb5_enctype encryptionType;
 145     krb5_keyblock rfc3961Key;
 146     gss_name_t initiatorName;
 147     gss_name_t acceptorName;
 148     time_t expiryTime;
 149     uint64_t sendSeq, recvSeq;
 150     void *seqState;
 151     union {
 152         struct gss_eap_initiator_ctx initiator;
 153         #define initiatorCtx         ctxU.initiator
 154         struct gss_eap_acceptor_ctx  acceptor;
 155         #define acceptorCtx          ctxU.acceptor
 156     } ctxU;
 157 };
 158
 159 #define TOK_FLAG_SENDER_IS_ACCEPTOR         0x01
 160 #define TOK_FLAG_WRAP_CONFIDENTIAL          0x02
 161 #define TOK_FLAG_ACCEPTOR_SUBKEY            0x04
 162
 163 #define KEY_USAGE_ACCEPTOR_SEAL             22
 164 #define KEY_USAGE_ACCEPTOR_SIGN             23
 165 #define KEY_USAGE_INITIATOR_SEAL            24
 166 #define KEY_USAGE_INITIATOR_SIGN            25
 167 #define KEY_USAGE_CHANNEL_BINDINGS          64
 168
 169 /* wrap_iov.c */
 170 OM_uint32
 171 gssEapWrapOrGetMIC(OM_uint32 *minor,
 172                    gss_ctx_id_t ctx,
 173                    int conf_req_flag,
 174                    int *conf_state,
 175                    gss_iov_buffer_desc *iov,
 176                    int iov_count,
 177                    enum gss_eap_token_type toktype);
 178
 179 OM_uint32
 180 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
 181                         gss_ctx_id_t ctx,
 182                         int *conf_state,
 183                         gss_qop_t *qop_state,
 184                         gss_iov_buffer_desc *iov,
 185                         int iov_count,
 186                         enum gss_eap_token_type toktype);
 187
 188 OM_uint32
 189 gssEapWrapIovLength(OM_uint32 *minor,
 190                     gss_ctx_id_t ctx,
 191                     int conf_req_flag,
 192                     gss_qop_t qop_req,
 193                     int *conf_state,
 194                     gss_iov_buffer_desc *iov,
 195                     int iov_count);
 196
 197 #endif /* _GSSAPIP_EAP_H_ */