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 #ifdef HAVE_UNISTD_H
  46 #include <unistd.h>
  47 #endif
  48 #ifdef HAVE_STDLIB_H
  49 #include <stdlib.h>
  50 #endif
  51 #ifdef HAVE_STDARG_H
  52 #include <stdarg.h>
  53 #endif
  54 #include <time.h>
  55 #ifdef HAVE_SYS_PARAM_H
  56 #include <sys/param.h>
  57 #endif
  58
  59 #ifdef WIN32
  60 #ifndef MAXHOSTNAMELEN
  61 # include <WinSock2.h>
  62 # define MAXHOSTNAMELEN NI_MAXHOST
  63 #endif
  64 #endif
  65
  66 /* GSS headers */
  67 #include <gssapi/gssapi.h>
  68 #include <gssapi/gssapi_krb5.h>
  69 #ifdef HAVE_HEIMDAL_VERSION
  70 typedef struct gss_any *gss_any_t;
  71 #else
  72 #include <gssapi/gssapi_ext.h>
  73 #endif
  74 #include "gssapi_eap.h"
  75
  76 #ifndef HAVE_GSS_INQUIRE_ATTRS_FOR_MECH
  77 typedef const gss_OID_desc *gss_const_OID;
  78 #endif
  79
  80 #ifndef GSS_IOV_BUFFER_TYPE_MIC_TOKEN
  81 #define GSS_IOV_BUFFER_TYPE_MIC_TOKEN      12  /* MIC token destination */
  82 #endif
  83
  84 /* Kerberos headers */
  85 #include <krb5.h>
  86
  87 /* EAP headers */
  88 #include <includes.h>
  89 #include <common.h>
  90 #include <eap_peer/eap.h>
  91 #include <eap_peer/eap_config.h>
  92 #include <eap_peer/eap_methods.h>
  93 #include <eap_common/eap_common.h>
  94 #include <wpabuf.h>
  95
  96 #ifdef GSSEAP_ENABLE_ACCEPTOR
  97 /* libradsec headers */
  98 #include <radsec/radsec.h>
  99 #include <radsec/request.h>
 100 #include <radsec/radius.h>
 101 #endif
 102
 103 #include "gsseap_err.h"
 104 #include "radsec_err.h"
 105 #include "util.h"
 106
 107 #ifdef __cplusplus
 108 extern "C" {
 109 #endif
 110
 111 /* These name flags are informative and not actually used by anything yet */
 112 #define NAME_FLAG_NAI                       0x00000001
 113 #define NAME_FLAG_SERVICE                   0x00000002
 114 #define NAME_FLAG_COMPOSITE                 0x00000004
 115
 116 struct gss_eap_saml_attr_ctx;
 117 struct gss_eap_attr_ctx;
 118
 119 #ifdef HAVE_HEIMDAL_VERSION
 120 struct gss_name_t_desc_struct
 121 #else
 122 struct gss_name_struct
 123 #endif
 124 {
 125     GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
 126     OM_uint32 flags;
 127     gss_OID mechanismUsed; /* this is immutable */
 128     krb5_principal krbPrincipal; /* this is immutable */
 129 #ifdef GSSEAP_ENABLE_ACCEPTOR
 130     struct gss_eap_attr_ctx *attrCtx;
 131 #endif
 132 };
 133
 134 #define CRED_FLAG_INITIATE                  0x00010000
 135 #define CRED_FLAG_ACCEPT                    0x00020000
 136 #define CRED_FLAG_PASSWORD                  0x00040000
 137 #define CRED_FLAG_DEFAULT_CCACHE            0x00080000
 138 #define CRED_FLAG_RESOLVED                  0x00100000
 139 #define CRED_FLAG_TARGET                    0x00200000
 140 #define CRED_FLAG_CERTIFICATE               0x00400000
 141 #define CRED_FLAG_CONFIG_BLOB               0x00800000
 142 #define CRED_FLAG_PUBLIC_MASK               0x0000FFFF
 143
 144 #ifdef HAVE_HEIMDAL_VERSION
 145 struct gss_cred_id_t_desc_struct
 146 #else
 147 struct gss_cred_id_struct
 148 #endif
 149 {
 150     GSSEAP_MUTEX mutex;
 151     OM_uint32 flags;
 152     gss_name_t name;
 153     gss_name_t target; /* for initiator */
 154     gss_buffer_desc password;
 155     gss_OID_set mechanisms;
 156     time_t expiryTime;
 157     gss_buffer_desc radiusConfigFile;
 158     gss_buffer_desc radiusConfigStanza;
 159     gss_buffer_desc caCertificate;
 160     gss_buffer_desc subjectNameConstraint;
 161     gss_buffer_desc subjectAltNameConstraint;
 162     gss_buffer_desc clientCertificate;
 163     gss_buffer_desc privateKey;
 164     gss_buffer_desc caCertificateBlob;
 165 #ifdef GSSEAP_ENABLE_REAUTH
 166     krb5_ccache krbCredCache;
 167     gss_cred_id_t reauthCred;
 168 #endif
 169 };
 170
 171 #define CTX_FLAG_INITIATOR                  0x00000001
 172 #define CTX_FLAG_KRB_REAUTH                 0x00000002
 173 #define CTX_FLAG_CHANNEL_BINDINGS_VERIFIED  0x00000004
 174
 175 #define CTX_IS_INITIATOR(ctx)               (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
 176
 177 #define CTX_IS_ESTABLISHED(ctx)             ((ctx)->state == GSSEAP_STATE_ESTABLISHED)
 178
 179 /* Initiator context flags */
 180 #define CTX_FLAG_EAP_SUCCESS                0x00010000
 181 #define CTX_FLAG_EAP_RESTART                0x00020000
 182 #define CTX_FLAG_EAP_FAIL                   0x00040000
 183 #define CTX_FLAG_EAP_RESP                   0x00080000
 184 #define CTX_FLAG_EAP_NO_RESP                0x00100000
 185 #define CTX_FLAG_EAP_REQ                    0x00200000
 186 #define CTX_FLAG_EAP_PORT_ENABLED           0x00400000
 187 #define CTX_FLAG_EAP_ALT_ACCEPT             0x00800000
 188 #define CTX_FLAG_EAP_ALT_REJECT             0x01000000
 189 #define CTX_FLAG_EAP_CHBIND_ACCEPT          0x02000000
 190 #define CTX_FLAG_EAP_MASK                   0xFFFF0000
 191
 192 #define CONFIG_BLOB_CLIENT_CERT             0
 193 #define CONFIG_BLOB_PRIVATE_KEY             1
 194 #define CONFIG_BLOB_CA_CERT                 2
 195 #define CONFIG_BLOB_MAX                     3
 196
 197 struct gss_eap_initiator_ctx {
 198     unsigned int idleWhile;
 199     struct eap_peer_config eapPeerConfig;
 200     struct eap_sm *eap;
 201     struct wpabuf reqData;
 202     struct wpabuf *chbindData;
 203     unsigned int chbindReqFlags;
 204     struct wpa_config_blob configBlobs[CONFIG_BLOB_MAX];
 205 };
 206
 207 #ifdef GSSEAP_ENABLE_ACCEPTOR
 208 struct gss_eap_acceptor_ctx {
 209     struct rs_context *radContext;
 210     struct rs_connection *radConn;
 211     char *radServer;
 212     gss_buffer_desc state;
 213     rs_avp *vps;
 214 };
 215 #endif
 216
 217 #ifdef HAVE_HEIMDAL_VERSION
 218 struct gss_ctx_id_t_desc_struct
 219 #else
 220 struct gss_ctx_id_struct
 221 #endif
 222 {
 223     GSSEAP_MUTEX mutex;
 224     enum gss_eap_state state;
 225     OM_uint32 flags;
 226     OM_uint32 gssFlags;
 227     gss_OID mechanismUsed;
 228     krb5_cksumtype checksumType;
 229     krb5_enctype encryptionType;
 230     krb5_keyblock rfc3961Key;
 231     gss_name_t initiatorName;
 232     gss_name_t acceptorName;
 233     time_t expiryTime;
 234     uint64_t sendSeq, recvSeq;
 235     void *seqState;
 236     gss_cred_id_t cred;
 237     union {
 238         struct gss_eap_initiator_ctx initiator;
 239         #define initiatorCtx         ctxU.initiator
 240 #ifdef GSSEAP_ENABLE_ACCEPTOR
 241         struct gss_eap_acceptor_ctx  acceptor;
 242         #define acceptorCtx          ctxU.acceptor
 243 #endif
 244 #ifdef GSSEAP_ENABLE_REAUTH
 245         gss_ctx_id_t                 reauth;
 246         #define reauthCtx            ctxU.reauth
 247 #endif
 248     } ctxU;
 249     const struct gss_eap_token_buffer_set *inputTokens;
 250     const struct gss_eap_token_buffer_set *outputTokens;
 251 };
 252
 253 #define TOK_FLAG_SENDER_IS_ACCEPTOR         0x01
 254 #define TOK_FLAG_WRAP_CONFIDENTIAL          0x02
 255 #define TOK_FLAG_ACCEPTOR_SUBKEY            0x04
 256
 257 #define KEY_USAGE_ACCEPTOR_SEAL             22
 258 #define KEY_USAGE_ACCEPTOR_SIGN             23
 259 #define KEY_USAGE_INITIATOR_SEAL            24
 260 #define KEY_USAGE_INITIATOR_SIGN            25
 261
 262 #define KEY_USAGE_GSSEAP_CHBIND_MIC         60
 263 #define KEY_USAGE_GSSEAP_ACCTOKEN_MIC       61
 264 #define KEY_USAGE_GSSEAP_INITOKEN_MIC       62
 265
 266 /* accept_sec_context.c */
 267 OM_uint32
 268 gssEapAcceptSecContext(OM_uint32 *minor,
 269                        gss_ctx_id_t ctx,
 270                        gss_cred_id_t cred,
 271                        gss_buffer_t input_token,
 272                        gss_channel_bindings_t input_chan_bindings,
 273                        gss_name_t *src_name,
 274                        gss_OID *mech_type,
 275                        gss_buffer_t output_token,
 276                        OM_uint32 *ret_flags,
 277                        OM_uint32 *time_rec,
 278                        gss_cred_id_t *delegated_cred_handle);
 279
 280 /* init_sec_context.c */
 281 OM_uint32
 282 gssEapInitSecContext(OM_uint32 *minor,
 283                      gss_cred_id_t cred,
 284                      gss_ctx_id_t ctx,
 285                      gss_name_t target_name,
 286                      gss_OID mech_type,
 287                      OM_uint32 req_flags,
 288                      OM_uint32 time_req,
 289                      gss_channel_bindings_t input_chan_bindings,
 290                      gss_buffer_t input_token,
 291                      gss_OID *actual_mech_type,
 292                      gss_buffer_t output_token,
 293                      OM_uint32 *ret_flags,
 294                      OM_uint32 *time_rec);
 295
 296 /* wrap_iov.c */
 297 OM_uint32
 298 gssEapWrapOrGetMIC(OM_uint32 *minor,
 299                    gss_ctx_id_t ctx,
 300                    int conf_req_flag,
 301                    int *conf_state,
 302                    gss_iov_buffer_desc *iov,
 303                    int iov_count,
 304                    enum gss_eap_token_type toktype);
 305
 306 OM_uint32
 307 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
 308                         gss_ctx_id_t ctx,
 309                         int *conf_state,
 310                         gss_qop_t *qop_state,
 311                         gss_iov_buffer_desc *iov,
 312                         int iov_count,
 313                         enum gss_eap_token_type toktype);
 314
 315 OM_uint32
 316 gssEapWrapIovLength(OM_uint32 *minor,
 317                     gss_ctx_id_t ctx,
 318                     int conf_req_flag,
 319                     gss_qop_t qop_req,
 320                     int *conf_state,
 321                     gss_iov_buffer_desc *iov,
 322                     int iov_count,
 323                     enum gss_eap_token_type tokType);
 324
 325 OM_uint32
 326 gssEapWrap(OM_uint32 *minor,
 327            gss_ctx_id_t ctx,
 328            int conf_req_flag,
 329            gss_qop_t qop_req,
 330            gss_buffer_t input_message_buffer,
 331            int *conf_state,
 332            gss_buffer_t output_message_buffer);
 333
 334 unsigned char
 335 rfc4121Flags(gss_ctx_id_t ctx, int receiving);
 336
 337 /* display_status.c */
 338 void
 339 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
 340
 341 OM_uint32
 342 gssEapDisplayStatus(OM_uint32 *minor,
 343                     OM_uint32 status_value,
 344                     gss_buffer_t status_string);
 345
 346 #define IS_WIRE_ERROR(err)              ((err) >= GSSEAP_RESERVED && \
 347                                          (err) <= GSSEAP_RADIUS_PROT_FAILURE)
 348
 349 #ifdef GSSEAP_ENABLE_ACCEPTOR
 350 #define IS_RADIUS_ERROR(err)            ((err) >= ERROR_TABLE_BASE_rse && \
 351                                          (err) <= ERROR_TABLE_BASE_rse + RSE_MAX)
 352 #else
 353 #define IS_RADIUS_ERROR(err)            (0)
 354 #endif
 355
 356 /* exchange_meta_data.c */
 357 OM_uint32 GSSAPI_CALLCONV
 358 gssEapExchangeMetaData(OM_uint32 *minor,
 359                        gss_const_OID mech,
 360                        gss_cred_id_t cred,
 361                        gss_ctx_id_t *ctx,
 362                        const gss_name_t name,
 363                        OM_uint32 req_flags,
 364                        gss_const_buffer_t meta_data);
 365
 366 /* export_sec_context.c */
 367 OM_uint32
 368 gssEapExportSecContext(OM_uint32 *minor,
 369                        gss_ctx_id_t ctx,
 370                        gss_buffer_t token);
 371
 372 /* import_sec_context.c */
 373 OM_uint32
 374 gssEapImportContext(OM_uint32 *minor,
 375                     gss_buffer_t token,
 376                     gss_ctx_id_t ctx);
 377
 378 /* inquire_sec_context_by_oid.c */
 379 #define NEGOEX_INITIATOR_SALT      "gss-eap-negoex-initiator"
 380 #define NEGOEX_INITIATOR_SALT_LEN  (sizeof(NEGOEX_INITIATOR_SALT) - 1)
 381
 382 #define NEGOEX_ACCEPTOR_SALT       "gss-eap-negoex-acceptor"
 383 #define NEGOEX_ACCEPTOR_SALT_LEN   (sizeof(NEGOEX_ACCEPTOR_SALT) - 1)
 384
 385 /* pseudo_random.c */
 386 OM_uint32
 387 gssEapPseudoRandom(OM_uint32 *minor,
 388                    gss_ctx_id_t ctx,
 389                    int prf_key,
 390                    const gss_buffer_t prf_in,
 391                    gss_buffer_t prf_out);
 392
 393 /* query_mechanism_info.c */
 394 OM_uint32
 395 gssQueryMechanismInfo(OM_uint32 *minor,
 396                       gss_const_OID mech_oid,
 397                       unsigned char auth_scheme[16]);
 398
 399 /* query_meta_data.c */
 400 OM_uint32
 401 gssEapQueryMetaData(OM_uint32 *minor,
 402                     gss_const_OID mech GSSEAP_UNUSED,
 403                     gss_cred_id_t cred,
 404                     gss_ctx_id_t *context_handle,
 405                     const gss_name_t name,
 406                     OM_uint32 req_flags GSSEAP_UNUSED,
 407                     gss_buffer_t meta_data);
 408
 409 /* eap_mech.c */
 410 OM_uint32
 411 gssEapInitiatorInit(OM_uint32 *minor);
 412
 413 void
 414 gssEapFinalize(void);
 415
 416   /* Debugging and tracing*/
 417   #define gssEapTrace(_fmt, ...) wpa_printf(MSG_INFO, _fmt, __VA_ARGS__);
 418
 419 static inline void
 420 gssEapTraceStatus(const char *function,
 421                   OM_uint32 major, OM_uint32 minor)
 422 {
 423     gss_buffer_desc  gss_code_buf, mech_buf;
 424     OM_uint32 tmpmaj, tmpmin, ctx = 0;
 425     gss_code_buf.value = NULL;
 426     mech_buf.value = NULL;
 427     tmpmaj = gss_display_status(&tmpmin,  major,
 428                                 GSS_C_GSS_CODE, GSS_C_NO_OID, &ctx,
 429                                 &gss_code_buf);
 430   if (!GSS_ERROR(tmpmaj)) {
 431 if (minor == 0)
 432     tmpmaj = makeStringBuffer(&tmpmin, "no minor", &mech_buf);
 433 else tmpmaj = gssEapDisplayStatus(&tmpmin, minor, &mech_buf);
 434 }
 435     if (!GSS_ERROR(tmpmaj))
 436         wpa_printf(MSG_INFO, "%s: %.*s/%.*s",
 437                    function, (int) gss_code_buf.length, (char *) gss_code_buf.value,
 438                    (int) mech_buf.length, (char *) mech_buf.value);
 439     else wpa_printf(MSG_INFO, "%s: %u/%u",
 440                     function, major, minor);
 441     tmpmaj = gss_release_buffer(&tmpmin, &gss_code_buf);
 442     tmpmaj = gss_release_buffer(&tmpmin, &mech_buf);
 443  }
 444
 445
 446   /*If built as a library on Linux, don't respect environment when set*uid*/
 447 #ifdef HAVE_SECURE_GETENV
 448 #define getenv secure_getenv
 449 #endif
 450
 451 #ifdef __cplusplus
 452 }
 453 #endif
 454
 455 #endif /* _GSSAPIP_EAP_H_ */