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