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 "config.h"
  37 #include <assert.h>
  38 #include <string.h>
  39 #include <errno.h>
  40 #include <unistd.h>
  41 #include <stdlib.h>
  42 #include <time.h>
  43 #include <sys/param.h>
  44
  45 /* GSS includes */
  46 #include <gssapi/gssapi.h>
  47 #include <gssapi/gssapi_krb5.h>
  48 #include <gssapi/gssapi_ext.h>
  49 #include "gssapi_eap.h"
  50
  51 /* Kerberos includes */
  52 #include <krb5.h>
  53
  54 /* EAP includes (not C++ clean) */
  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>
  60 #include <wpabuf.h>
  61 #endif
  62
  63 /* Workaround for FreeRADIUS not being C++ clean */
  64 #ifdef __cplusplus
  65 extern "C" {
  66 #define operator fr_operator
  67 #endif
  68 #include <freeradius/libradius.h>
  69 #include <freeradius/radius.h>
  70 #include <radsec/radsec.h>
  71 #ifdef __cplusplus
  72 #undef operator
  73 }
  74 #endif
  75
  76 #include "util.h"
  77
  78 #ifdef __cplusplus
  79 extern "C" {
  80 #endif
  81
  82 /* These name flags are informative and not actually used by anything yet */
  83 #define NAME_FLAG_NAI                       0x00000001
  84 #define NAME_FLAG_SERVICE                   0x00000002
  85 #define NAME_FLAG_COMPOSITE                 0x00000004
  86
  87 struct gss_eap_saml_attr_ctx;
  88 struct gss_eap_attr_ctx;
  89
  90 struct gss_name_struct {
  91     GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
  92     OM_uint32 flags;
  93     krb5_principal krbPrincipal; /* this is immutable */
  94     struct gss_eap_attr_ctx *attrCtx;
  95 };
  96
  97 #define CRED_FLAG_INITIATE                  0x00010000
  98 #define CRED_FLAG_ACCEPT                    0x00020000
  99 #define CRED_FLAG_DEFAULT_IDENTITY          0x00040000
 100 #define CRED_FLAG_PASSWORD                  0x00080000
 101 #define CRED_FLAG_DEFAULT_CCACHE            0x00100000
 102 #define CRED_FLAG_PUBLIC_MASK               0x0000FFFF
 103
 104 struct gss_cred_id_struct {
 105     GSSEAP_MUTEX mutex;
 106     OM_uint32 flags;
 107     gss_name_t name;
 108     gss_buffer_desc password;
 109     gss_OID_set mechanisms;
 110     time_t expiryTime;
 111     char *radiusConfigFile;
 112     char *radiusConfigStanza;
 113 #ifdef GSSEAP_ENABLE_REAUTH
 114     krb5_ccache krbCredCache;
 115     gss_cred_id_t krbCred;
 116 #endif
 117 };
 118
 119 #define CTX_FLAG_INITIATOR                  0x00000001
 120 #define CTX_FLAG_KRB_REAUTH_GSS             0x00000002
 121
 122 #define CTX_IS_INITIATOR(ctx)               (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
 123
 124 enum gss_eap_state {
 125     EAP_STATE_IDENTITY = 0,
 126     EAP_STATE_AUTHENTICATE,
 127     EAP_STATE_EXTENSIONS_REQ,
 128     EAP_STATE_EXTENSIONS_RESP,
 129     EAP_STATE_ESTABLISHED,
 130 #ifdef GSSEAP_ENABLE_REAUTH
 131     EAP_STATE_KRB_REAUTH_GSS
 132 #endif
 133 };
 134
 135 #define CTX_IS_ESTABLISHED(ctx)             ((ctx)->state == EAP_STATE_ESTABLISHED)
 136
 137 /* Initiator context flags */
 138 #define CTX_FLAG_EAP_SUCCESS                0x00010000
 139 #define CTX_FLAG_EAP_RESTART                0x00020000
 140 #define CTX_FLAG_EAP_FAIL                   0x00040000
 141 #define CTX_FLAG_EAP_RESP                   0x00080000
 142 #define CTX_FLAG_EAP_NO_RESP                0x00100000
 143 #define CTX_FLAG_EAP_REQ                    0x00200000
 144 #define CTX_FLAG_EAP_PORT_ENABLED           0x00400000
 145 #define CTX_FLAG_EAP_ALT_ACCEPT             0x00800000
 146 #define CTX_FLAG_EAP_ALT_REJECT             0x01000000
 147 #define CTX_FLAG_EAP_MASK                   0xFFFF0000
 148
 149 struct gss_eap_initiator_ctx {
 150     gss_cred_id_t defaultCred;
 151     unsigned int idleWhile;
 152 #ifndef __cplusplus
 153     struct eap_peer_config eapPeerConfig;
 154     struct eap_sm *eap;
 155     struct wpabuf reqData;
 156 #endif
 157 };
 158
 159 struct gss_eap_acceptor_ctx {
 160     struct rs_handle *radHandle;
 161     struct rs_connection *radConn;
 162     char *radServer;
 163     gss_buffer_desc state;
 164     VALUE_PAIR *vps;
 165 };
 166
 167 struct gss_ctx_id_struct {
 168     GSSEAP_MUTEX mutex;
 169     enum gss_eap_state state;
 170     OM_uint32 flags;
 171     OM_uint32 gssFlags;
 172     gss_OID mechanismUsed;
 173     krb5_cksumtype checksumType;
 174     krb5_enctype encryptionType;
 175     krb5_keyblock rfc3961Key;
 176     gss_name_t initiatorName;
 177     gss_name_t acceptorName;
 178     time_t expiryTime;
 179     uint64_t sendSeq, recvSeq;
 180     void *seqState;
 181     union {
 182         struct gss_eap_initiator_ctx initiator;
 183         #define initiatorCtx         ctxU.initiator
 184         struct gss_eap_acceptor_ctx  acceptor;
 185         #define acceptorCtx          ctxU.acceptor
 186 #ifdef GSSEAP_ENABLE_REAUTH
 187         gss_ctx_id_t                 kerberos;
 188         #define kerberosCtx          ctxU.kerberos
 189 #endif
 190     } ctxU;
 191 };
 192
 193 #define TOK_FLAG_SENDER_IS_ACCEPTOR         0x01
 194 #define TOK_FLAG_WRAP_CONFIDENTIAL          0x02
 195 #define TOK_FLAG_ACCEPTOR_SUBKEY            0x04
 196
 197 #define KEY_USAGE_ACCEPTOR_SEAL             22
 198 #define KEY_USAGE_ACCEPTOR_SIGN             23
 199 #define KEY_USAGE_INITIATOR_SEAL            24
 200 #define KEY_USAGE_INITIATOR_SIGN            25
 201 #define KEY_USAGE_CHANNEL_BINDINGS          64
 202
 203 /* wrap_iov.c */
 204 OM_uint32
 205 gssEapWrapOrGetMIC(OM_uint32 *minor,
 206                    gss_ctx_id_t ctx,
 207                    int conf_req_flag,
 208                    int *conf_state,
 209                    gss_iov_buffer_desc *iov,
 210                    int iov_count,
 211                    enum gss_eap_token_type toktype);
 212
 213 OM_uint32
 214 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
 215                         gss_ctx_id_t ctx,
 216                         int *conf_state,
 217                         gss_qop_t *qop_state,
 218                         gss_iov_buffer_desc *iov,
 219                         int iov_count,
 220                         enum gss_eap_token_type toktype);
 221
 222 OM_uint32
 223 gssEapWrapIovLength(OM_uint32 *minor,
 224                     gss_ctx_id_t ctx,
 225                     int conf_req_flag,
 226                     gss_qop_t qop_req,
 227                     int *conf_state,
 228                     gss_iov_buffer_desc *iov,
 229                     int iov_count);
 230 OM_uint32
 231 gssEapWrap(OM_uint32 *minor,
 232            gss_ctx_id_t ctx,
 233            int conf_req_flag,
 234            gss_qop_t qop_req,
 235            gss_buffer_t input_message_buffer,
 236            int *conf_state,
 237            gss_buffer_t output_message_buffer);
 238
 239 unsigned char
 240 rfc4121Flags(gss_ctx_id_t ctx, int receiving);
 241
 242 /* display_status.c */
 243 void
 244 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
 245
 246 #ifdef __cplusplus
 247 }
 248 #endif
 249
 250 #endif /* _GSSAPIP_EAP_H_ */