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