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