mech_eap/gssapiP_eap.h

   1 /*
   2  * Copyright (c) 2011, 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
  38 #ifdef HAVE_HEIMDAL_VERSION
  39 #define KRB5_DEPRECATED         /* so we can use krb5_free_unparsed_name() */
  40 #endif
  41
  42 #include <assert.h>
  43 #include <string.h>
  44 #include <errno.h>
  45 #include <unistd.h>
  46 #include <stdlib.h>
  47 #include <time.h>
  48 #include <sys/param.h>
  49
  50 /* GSS headers */
  51 #include <gssapi/gssapi.h>
  52 #include <gssapi/gssapi_krb5.h>
  53 #ifndef HAVE_HEIMDAL_VERSION
  54 #include <gssapi/gssapi_ext.h>
  55 #endif
  56 #include "gssapi_eap.h"
  57
  58 /* Kerberos headers */
  59 #include <krb5.h>
  60
  61 /* EAP headers */
  62 #include <common.h>
  63 #include <eap_peer/eap.h>
  64 #include <eap_peer/eap_config.h>
  65 #include <eap_peer/eap_methods.h>
  66 #include <eap_common/eap_common.h>
  67 #include <wpabuf.h>
  68
  69 /* FreeRADIUS headers */
  70 #ifdef __cplusplus
  71 extern "C" {
  72 #define operator fr_operator
  73 #endif
  74 #include <freeradius/libradius.h>
  75 #include <freeradius/radius.h>
  76 #include <radsec/radsec.h>
  77 #include <radsec/request.h>
  78 #ifdef __cplusplus
  79 #undef operator
  80 }
  81 #endif
  82
  83 #include "gsseap_err.h"
  84 #include "radsec_err.h"
  85 #include "util.h"
  86
  87 #ifdef __cplusplus
  88 extern "C" {
  89 #endif
  90
  91 /* These name flags are informative and not actually used by anything yet */
  92 #define NAME_FLAG_NAI                       0x00000001
  93 #define NAME_FLAG_SERVICE                   0x00000002
  94 #define NAME_FLAG_COMPOSITE                 0x00000004
  95
  96 struct gss_eap_saml_attr_ctx;
  97 struct gss_eap_attr_ctx;
  98
  99 #ifdef HAVE_HEIMDAL_VERSION
 100 struct gss_name_t_desc_struct
 101 #else
 102 struct gss_name_struct
 103 #endif
 104 {
 105     GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
 106     OM_uint32 flags;
 107     krb5_principal krbPrincipal; /* this is immutable */
 108     struct gss_eap_attr_ctx *attrCtx;
 109 };
 110
 111 #define CRED_FLAG_INITIATE                  0x00010000
 112 #define CRED_FLAG_ACCEPT                    0x00020000
 113 #define CRED_FLAG_DEFAULT_IDENTITY          0x00040000
 114 #define CRED_FLAG_PASSWORD                  0x00080000
 115 #define CRED_FLAG_DEFAULT_CCACHE            0x00100000
 116 #define CRED_FLAG_PUBLIC_MASK               0x0000FFFF
 117
 118 #ifdef HAVE_HEIMDAL_VERSION
 119 struct gss_cred_id_t_desc_struct
 120 #else
 121 struct gss_cred_id_struct
 122 #endif
 123 {
 124     GSSEAP_MUTEX mutex;
 125     OM_uint32 flags;
 126     gss_name_t name;
 127     gss_buffer_desc password;
 128     gss_OID_set mechanisms;
 129     time_t expiryTime;
 130     char *radiusConfigFile;
 131     char *radiusConfigStanza;
 132 #ifdef GSSEAP_ENABLE_REAUTH
 133     krb5_ccache krbCredCache;
 134     gss_cred_id_t krbCred;
 135 #endif
 136 };
 137
 138 #define CTX_FLAG_INITIATOR                  0x00000001
 139 #define CTX_FLAG_KRB_REAUTH                 0x00000002
 140
 141 #define CTX_IS_INITIATOR(ctx)               (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
 142
 143 enum gss_eap_state {
 144     GSSEAP_STATE_INITIAL        = 0x01,     /* initial state */
 145     GSSEAP_STATE_AUTHENTICATE   = 0x02,     /* exchange EAP messages */
 146     GSSEAP_STATE_NEGO_EXT       = 0x04,     /* negotiate extensions */
 147     GSSEAP_STATE_ESTABLISHED    = 0x08,     /* context established */
 148     GSSEAP_STATE_ALL            = 0x0F
 149 };
 150
 151 #define GSSEAP_STATE_NEXT(s)    ((s) << 1)
 152
 153 /* state machine entry */
 154 struct gss_eap_sm {
 155     OM_uint32 inputTokenType;
 156     OM_uint32 outputTokenType;
 157     enum gss_eap_state validStates;
 158     int critical;
 159     int required;
 160     OM_uint32 (*processToken)(OM_uint32 *,
 161                               gss_cred_id_t,
 162                               gss_ctx_id_t,
 163                               gss_name_t,
 164                               gss_OID,
 165                               OM_uint32,
 166                               OM_uint32,
 167                               gss_channel_bindings_t,
 168                               gss_buffer_t,
 169                               gss_buffer_t,
 170                               int *);
 171 };
 172
 173 #define CTX_IS_ESTABLISHED(ctx)             ((ctx)->state == GSSEAP_STATE_ESTABLISHED)
 174
 175 /* Initiator context flags */
 176 #define CTX_FLAG_EAP_SUCCESS                0x00010000
 177 #define CTX_FLAG_EAP_RESTART                0x00020000
 178 #define CTX_FLAG_EAP_FAIL                   0x00040000
 179 #define CTX_FLAG_EAP_RESP                   0x00080000
 180 #define CTX_FLAG_EAP_NO_RESP                0x00100000
 181 #define CTX_FLAG_EAP_REQ                    0x00200000
 182 #define CTX_FLAG_EAP_PORT_ENABLED           0x00400000
 183 #define CTX_FLAG_EAP_ALT_ACCEPT             0x00800000
 184 #define CTX_FLAG_EAP_ALT_REJECT             0x01000000
 185 #define CTX_FLAG_EAP_MASK                   0xFFFF0000
 186
 187 struct gss_eap_initiator_ctx {
 188     unsigned int idleWhile;
 189 #ifndef __cplusplus
 190     struct eap_peer_config eapPeerConfig;
 191     struct eap_sm *eap;
 192     struct wpabuf reqData;
 193 #endif
 194 };
 195
 196 struct gss_eap_acceptor_ctx {
 197     struct rs_context *radContext;
 198     struct rs_connection *radConn;
 199     char *radServer;
 200     gss_buffer_desc state;
 201     VALUE_PAIR *vps;
 202 };
 203
 204 #ifdef HAVE_HEIMDAL_VERSION
 205 struct gss_ctx_id_t_desc_struct
 206 #else
 207 struct gss_ctx_id_struct
 208 #endif
 209 {
 210     GSSEAP_MUTEX mutex;
 211     enum gss_eap_state state;
 212     OM_uint32 flags;
 213     OM_uint32 gssFlags;
 214     gss_OID mechanismUsed;
 215     krb5_cksumtype checksumType;
 216     krb5_enctype encryptionType;
 217     krb5_keyblock rfc3961Key;
 218     gss_name_t initiatorName;
 219     gss_name_t acceptorName;
 220     time_t expiryTime;
 221     uint64_t sendSeq, recvSeq;
 222     void *seqState;
 223     gss_cred_id_t defaultCred;
 224     union {
 225         struct gss_eap_initiator_ctx initiator;
 226         #define initiatorCtx         ctxU.initiator
 227         struct gss_eap_acceptor_ctx  acceptor;
 228         #define acceptorCtx          ctxU.acceptor
 229 #ifdef GSSEAP_ENABLE_REAUTH
 230         gss_ctx_id_t                 kerberos;
 231         #define kerberosCtx          ctxU.kerberos
 232 #endif
 233     } ctxU;
 234 };
 235
 236 #define TOK_FLAG_SENDER_IS_ACCEPTOR         0x01
 237 #define TOK_FLAG_WRAP_CONFIDENTIAL          0x02
 238 #define TOK_FLAG_ACCEPTOR_SUBKEY            0x04
 239
 240 #define KEY_USAGE_ACCEPTOR_SEAL             22
 241 #define KEY_USAGE_ACCEPTOR_SIGN             23
 242 #define KEY_USAGE_INITIATOR_SEAL            24
 243 #define KEY_USAGE_INITIATOR_SIGN            25
 244
 245 /* wrap_iov.c */
 246 OM_uint32
 247 gssEapWrapOrGetMIC(OM_uint32 *minor,
 248                    gss_ctx_id_t ctx,
 249                    int conf_req_flag,
 250                    int *conf_state,
 251                    gss_iov_buffer_desc *iov,
 252                    int iov_count,
 253                    enum gss_eap_token_type toktype);
 254
 255 OM_uint32
 256 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
 257                         gss_ctx_id_t ctx,
 258                         int *conf_state,
 259                         gss_qop_t *qop_state,
 260                         gss_iov_buffer_desc *iov,
 261                         int iov_count,
 262                         enum gss_eap_token_type toktype);
 263
 264 OM_uint32
 265 gssEapWrapIovLength(OM_uint32 *minor,
 266                     gss_ctx_id_t ctx,
 267                     int conf_req_flag,
 268                     gss_qop_t qop_req,
 269                     int *conf_state,
 270                     gss_iov_buffer_desc *iov,
 271                     int iov_count);
 272 OM_uint32
 273 gssEapWrap(OM_uint32 *minor,
 274            gss_ctx_id_t ctx,
 275            int conf_req_flag,
 276            gss_qop_t qop_req,
 277            gss_buffer_t input_message_buffer,
 278            int *conf_state,
 279            gss_buffer_t output_message_buffer);
 280
 281 unsigned char
 282 rfc4121Flags(gss_ctx_id_t ctx, int receiving);
 283
 284 /* display_status.c */
 285 void
 286 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
 287
 288 #define IS_WIRE_ERROR(err)              ((err) > GSSEAP_RESERVED && \
 289                                          (err) <= GSSEAP_RADIUS_PROT_FAILURE)
 290
 291 #ifdef __cplusplus
 292 }
 293 #endif
 294
 295 #endif /* _GSSAPIP_EAP_H_ */