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 /* GSS headers */
  60 #include <gssapi/gssapi.h>
  61 #include <gssapi/gssapi_krb5.h>
  62 #ifdef HAVE_HEIMDAL_VERSION
  63 typedef struct gss_any *gss_any_t;
  64 #else
  65 #include <gssapi/gssapi_ext.h>
  66 #endif
  67 #include "gssapi_eap.h"
  68
  69 #ifndef HAVE_GSS_INQUIRE_ATTRS_FOR_MECH
  70 typedef const gss_OID_desc *gss_const_OID;
  71 #endif
  72
  73 /* Kerberos headers */
  74 #include <krb5.h>
  75
  76 /* EAP headers */
  77 #include <includes.h>
  78 #include <common.h>
  79 #include <eap_peer/eap.h>
  80 #include <eap_peer/eap_config.h>
  81 #include <eap_peer/eap_methods.h>
  82 #include <eap_common/eap_common.h>
  83 #include <wpabuf.h>
  84
  85 /* FreeRADIUS headers */
  86 #ifdef __cplusplus
  87 extern "C" {
  88 #define operator fr_operator
  89 #endif
  90 #include <freeradius/libradius.h>
  91 #include <freeradius/radius.h>
  92 #include <radsec/radsec.h>
  93 #include <radsec/request.h>
  94 #ifdef __cplusplus
  95 #undef operator
  96 }
  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     struct gss_eap_attr_ctx *attrCtx;
 126 };
 127
 128 #define CRED_FLAG_INITIATE                  0x00010000
 129 #define CRED_FLAG_ACCEPT                    0x00020000
 130 #define CRED_FLAG_PASSWORD                  0x00040000
 131 #define CRED_FLAG_DEFAULT_CCACHE            0x00080000
 132 #define CRED_FLAG_RESOLVED                  0x00100000
 133 #define CRED_FLAG_PUBLIC_MASK               0x0000FFFF
 134
 135 #ifdef HAVE_HEIMDAL_VERSION
 136 struct gss_cred_id_t_desc_struct
 137 #else
 138 struct gss_cred_id_struct
 139 #endif
 140 {
 141     GSSEAP_MUTEX mutex;
 142     OM_uint32 flags;
 143     gss_name_t name;
 144     gss_name_t target; /* for initiator */
 145     gss_buffer_desc password;
 146     gss_OID_set mechanisms;
 147     time_t expiryTime;
 148     gss_buffer_desc radiusConfigFile;
 149     gss_buffer_desc radiusConfigStanza;
 150     gss_buffer_desc caCertificate;
 151     gss_buffer_desc subjectNameConstraint;
 152     gss_buffer_desc subjectAltNameConstraint;
 153 #ifdef GSSEAP_ENABLE_REAUTH
 154     krb5_ccache krbCredCache;
 155     gss_cred_id_t reauthCred;
 156 #endif
 157 };
 158
 159 #define CTX_FLAG_INITIATOR                  0x00000001
 160 #define CTX_FLAG_KRB_REAUTH                 0x00000002
 161
 162 #define CTX_IS_INITIATOR(ctx)               (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
 163
 164 #define CTX_IS_ESTABLISHED(ctx)             ((ctx)->state == GSSEAP_STATE_ESTABLISHED)
 165
 166 /* Initiator context flags */
 167 #define CTX_FLAG_EAP_SUCCESS                0x00010000
 168 #define CTX_FLAG_EAP_RESTART                0x00020000
 169 #define CTX_FLAG_EAP_FAIL                   0x00040000
 170 #define CTX_FLAG_EAP_RESP                   0x00080000
 171 #define CTX_FLAG_EAP_NO_RESP                0x00100000
 172 #define CTX_FLAG_EAP_REQ                    0x00200000
 173 #define CTX_FLAG_EAP_PORT_ENABLED           0x00400000
 174 #define CTX_FLAG_EAP_ALT_ACCEPT             0x00800000
 175 #define CTX_FLAG_EAP_ALT_REJECT             0x01000000
 176 #define CTX_FLAG_EAP_MASK                   0xFFFF0000
 177
 178 struct gss_eap_initiator_ctx {
 179     unsigned int idleWhile;
 180     struct eap_peer_config eapPeerConfig;
 181     struct eap_sm *eap;
 182     struct wpabuf reqData;
 183 };
 184
 185 struct gss_eap_acceptor_ctx {
 186     struct rs_context *radContext;
 187     struct rs_connection *radConn;
 188     char *radServer;
 189     gss_buffer_desc state;
 190     VALUE_PAIR *vps;
 191 };
 192
 193 #ifdef HAVE_HEIMDAL_VERSION
 194 struct gss_ctx_id_t_desc_struct
 195 #else
 196 struct gss_ctx_id_struct
 197 #endif
 198 {
 199     GSSEAP_MUTEX mutex;
 200     enum gss_eap_state state;
 201     OM_uint32 flags;
 202     OM_uint32 gssFlags;
 203     gss_OID mechanismUsed;
 204     krb5_cksumtype checksumType;
 205     krb5_enctype encryptionType;
 206     krb5_keyblock rfc3961Key;
 207     gss_name_t initiatorName;
 208     gss_name_t acceptorName;
 209     time_t expiryTime;
 210     uint64_t sendSeq, recvSeq;
 211     void *seqState;
 212     gss_cred_id_t cred;
 213     union {
 214         struct gss_eap_initiator_ctx initiator;
 215         #define initiatorCtx         ctxU.initiator
 216         struct gss_eap_acceptor_ctx  acceptor;
 217         #define acceptorCtx          ctxU.acceptor
 218 #ifdef GSSEAP_ENABLE_REAUTH
 219         gss_ctx_id_t                 reauth;
 220         #define reauthCtx            ctxU.reauth
 221 #endif
 222     } ctxU;
 223     const struct gss_eap_token_buffer_set *inputTokens;
 224     const struct gss_eap_token_buffer_set *outputTokens;
 225 };
 226
 227 #define TOK_FLAG_SENDER_IS_ACCEPTOR         0x01
 228 #define TOK_FLAG_WRAP_CONFIDENTIAL          0x02
 229 #define TOK_FLAG_ACCEPTOR_SUBKEY            0x04
 230
 231 #define KEY_USAGE_ACCEPTOR_SEAL             22
 232 #define KEY_USAGE_ACCEPTOR_SIGN             23
 233 #define KEY_USAGE_INITIATOR_SEAL            24
 234 #define KEY_USAGE_INITIATOR_SIGN            25
 235
 236 /* accept_sec_context.c */
 237 OM_uint32
 238 gssEapAcceptSecContext(OM_uint32 *minor,
 239                        gss_ctx_id_t ctx,
 240                        gss_cred_id_t cred,
 241                        gss_buffer_t input_token,
 242                        gss_channel_bindings_t input_chan_bindings,
 243                        gss_name_t *src_name,
 244                        gss_OID *mech_type,
 245                        gss_buffer_t output_token,
 246                        OM_uint32 *ret_flags,
 247                        OM_uint32 *time_rec,
 248                        gss_cred_id_t *delegated_cred_handle);
 249
 250 /* init_sec_context.c */
 251 OM_uint32
 252 gssEapInitSecContext(OM_uint32 *minor,
 253                      gss_cred_id_t cred,
 254                      gss_ctx_id_t ctx,
 255                      gss_name_t target_name,
 256                      gss_OID mech_type,
 257                      OM_uint32 req_flags,
 258                      OM_uint32 time_req,
 259                      gss_channel_bindings_t input_chan_bindings,
 260                      gss_buffer_t input_token,
 261                      gss_OID *actual_mech_type,
 262                      gss_buffer_t output_token,
 263                      OM_uint32 *ret_flags,
 264                      OM_uint32 *time_rec);
 265
 266 /* wrap_iov.c */
 267 OM_uint32
 268 gssEapWrapOrGetMIC(OM_uint32 *minor,
 269                    gss_ctx_id_t ctx,
 270                    int conf_req_flag,
 271                    int *conf_state,
 272                    gss_iov_buffer_desc *iov,
 273                    int iov_count,
 274                    enum gss_eap_token_type toktype);
 275
 276 OM_uint32
 277 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
 278                         gss_ctx_id_t ctx,
 279                         int *conf_state,
 280                         gss_qop_t *qop_state,
 281                         gss_iov_buffer_desc *iov,
 282                         int iov_count,
 283                         enum gss_eap_token_type toktype);
 284
 285 OM_uint32
 286 gssEapWrapIovLength(OM_uint32 *minor,
 287                     gss_ctx_id_t ctx,
 288                     int conf_req_flag,
 289                     gss_qop_t qop_req,
 290                     int *conf_state,
 291                     gss_iov_buffer_desc *iov,
 292                     int iov_count);
 293 OM_uint32
 294 gssEapWrap(OM_uint32 *minor,
 295            gss_ctx_id_t ctx,
 296            int conf_req_flag,
 297            gss_qop_t qop_req,
 298            gss_buffer_t input_message_buffer,
 299            int *conf_state,
 300            gss_buffer_t output_message_buffer);
 301
 302 unsigned char
 303 rfc4121Flags(gss_ctx_id_t ctx, int receiving);
 304
 305 /* display_status.c */
 306 void
 307 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
 308
 309 #define IS_WIRE_ERROR(err)              ((err) > GSSEAP_RESERVED && \
 310                                          (err) <= GSSEAP_RADIUS_PROT_FAILURE)
 311
 312 /* export_sec_context.c */
 313 OM_uint32
 314 gssEapExportSecContext(OM_uint32 *minor,
 315                        gss_ctx_id_t ctx,
 316                        gss_buffer_t token);
 317
 318
 319 #ifdef __cplusplus
 320 }
 321 #endif
 322
 323 #endif /* _GSSAPIP_EAP_H_ */