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