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