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