www.project-moonshot.org Git - mech_eap.orig/blob - 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 #include <unistd.h>
  46 #include <stdlib.h>
  47 #include <stdarg.h>
  48 #include <time.h>
  49 #include <sys/param.h>
  50
  51 /* GSS headers */
  52 #include <gssapi/gssapi.h>
  53 #include <gssapi/gssapi_krb5.h>
  54 #ifdef HAVE_HEIMDAL_VERSION
  55 typedef struct gss_any *gss_any_t;
  56 #else
  57 #include <gssapi/gssapi_ext.h>
  58 #endif
  59 #include "gssapi_eap.h"
  60
  61 #ifndef HAVE_GSS_INQUIRE_ATTRS_FOR_MECH
  62 typedef const gss_OID_desc *gss_const_OID;
  63 #endif
  64
  65 /* Kerberos headers */
  66 #include <krb5.h>
  67
  68 /* EAP headers */
  69 #include <common.h>
  70 #include <eap_peer/eap.h>
  71 #include <eap_peer/eap_config.h>
  72 #include <eap_peer/eap_methods.h>
  73 #include <eap_common/eap_common.h>
  74 #include <wpabuf.h>
  75
  76 /* FreeRADIUS headers */
  77 #ifdef __cplusplus
  78 extern "C" {
  79 #define operator fr_operator
  80 #endif
  81 #include <freeradius/libradius.h>
  82 #include <freeradius/radius.h>
  83 #include <radsec/radsec.h>
  84 #include <radsec/request.h>
  85 #ifdef __cplusplus
  86 #undef operator
  87 }
  88 #endif
  89
  90 #include "gsseap_err.h"
  91 #include "radsec_err.h"
  92 #include "util.h"
  93
  94 #ifdef __cplusplus
  95 extern "C" {
  96 #endif
  97
  98 /* These name flags are informative and not actually used by anything yet */
  99 #define NAME_FLAG_NAI                       0x00000001
 100 #define NAME_FLAG_SERVICE                   0x00000002
 101 #define NAME_FLAG_COMPOSITE                 0x00000004
 102
 103 struct gss_eap_saml_attr_ctx;
 104 struct gss_eap_attr_ctx;
 105
 106 #ifdef HAVE_HEIMDAL_VERSION
 107 struct gss_name_t_desc_struct
 108 #else
 109 struct gss_name_struct
 110 #endif
 111 {
 112     GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
 113     OM_uint32 flags;
 114     gss_OID mechanismUsed; /* this is immutable */
 115     krb5_principal krbPrincipal; /* this is immutable */
 116     struct gss_eap_attr_ctx *attrCtx;
 117 };
 118
 119 #define CRED_FLAG_INITIATE                  0x00010000
 120 #define CRED_FLAG_ACCEPT                    0x00020000
 121 #define CRED_FLAG_DEFAULT_IDENTITY          0x00040000
 122 #define CRED_FLAG_PASSWORD                  0x00080000
 123 #define CRED_FLAG_DEFAULT_CCACHE            0x00100000
 124 #define CRED_FLAG_PUBLIC_MASK               0x0000FFFF
 125
 126 #ifdef HAVE_HEIMDAL_VERSION
 127 struct gss_cred_id_t_desc_struct
 128 #else
 129 struct gss_cred_id_struct
 130 #endif
 131 {
 132     GSSEAP_MUTEX mutex;
 133     OM_uint32 flags;
 134     gss_name_t name;
 135     gss_buffer_desc password;
 136     gss_OID_set mechanisms;
 137     time_t expiryTime;
 138     char *radiusConfigFile;
 139     char *radiusConfigStanza;
 140 #ifdef GSSEAP_ENABLE_REAUTH
 141     krb5_ccache krbCredCache;
 142     gss_cred_id_t reauthCred;
 143 #endif
 144 };
 145
 146 #define CTX_FLAG_INITIATOR                  0x00000001
 147 #define CTX_FLAG_KRB_REAUTH                 0x00000002
 148
 149 #define CTX_IS_INITIATOR(ctx)               (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
 150
 151 #define CTX_IS_ESTABLISHED(ctx)             ((ctx)->state == GSSEAP_STATE_ESTABLISHED)
 152
 153 /* Initiator context flags */
 154 #define CTX_FLAG_EAP_SUCCESS                0x00010000
 155 #define CTX_FLAG_EAP_RESTART                0x00020000
 156 #define CTX_FLAG_EAP_FAIL                   0x00040000
 157 #define CTX_FLAG_EAP_RESP                   0x00080000
 158 #define CTX_FLAG_EAP_NO_RESP                0x00100000
 159 #define CTX_FLAG_EAP_REQ                    0x00200000
 160 #define CTX_FLAG_EAP_PORT_ENABLED           0x00400000
 161 #define CTX_FLAG_EAP_ALT_ACCEPT             0x00800000
 162 #define CTX_FLAG_EAP_ALT_REJECT             0x01000000
 163 #define CTX_FLAG_EAP_MASK                   0xFFFF0000
 164
 165 struct gss_eap_initiator_ctx {
 166     unsigned int idleWhile;
 167     struct eap_peer_config eapPeerConfig;
 168     struct eap_sm *eap;
 169     struct wpabuf reqData;
 170 };
 171
 172 struct gss_eap_acceptor_ctx {
 173     struct rs_context *radContext;
 174     struct rs_connection *radConn;
 175     char *radServer;
 176     gss_buffer_desc state;
 177     VALUE_PAIR *vps;
 178 };
 179
 180 #ifdef HAVE_HEIMDAL_VERSION
 181 struct gss_ctx_id_t_desc_struct
 182 #else
 183 struct gss_ctx_id_struct
 184 #endif
 185 {
 186     GSSEAP_MUTEX mutex;
 187     enum gss_eap_state state;
 188     OM_uint32 flags;
 189     OM_uint32 gssFlags;
 190     gss_OID mechanismUsed;
 191     krb5_cksumtype checksumType;
 192     krb5_enctype encryptionType;
 193     krb5_keyblock rfc3961Key;
 194     gss_name_t initiatorName;
 195     gss_name_t acceptorName;
 196     time_t expiryTime;
 197     uint64_t sendSeq, recvSeq;
 198     void *seqState;
 199     gss_cred_id_t defaultCred;
 200     union {
 201         struct gss_eap_initiator_ctx initiator;
 202         #define initiatorCtx         ctxU.initiator
 203         struct gss_eap_acceptor_ctx  acceptor;
 204         #define acceptorCtx          ctxU.acceptor
 205 #ifdef GSSEAP_ENABLE_REAUTH
 206         gss_ctx_id_t                 reauth;
 207         #define reauthCtx            ctxU.reauth
 208 #endif
 209     } ctxU;
 210     const struct gss_eap_token_buffer_set *inputTokens;
 211     const struct gss_eap_token_buffer_set *outputTokens;
 212 };
 213
 214 #define TOK_FLAG_SENDER_IS_ACCEPTOR         0x01
 215 #define TOK_FLAG_WRAP_CONFIDENTIAL          0x02
 216 #define TOK_FLAG_ACCEPTOR_SUBKEY            0x04
 217
 218 #define KEY_USAGE_ACCEPTOR_SEAL             22
 219 #define KEY_USAGE_ACCEPTOR_SIGN             23
 220 #define KEY_USAGE_INITIATOR_SEAL            24
 221 #define KEY_USAGE_INITIATOR_SIGN            25
 222
 223 /* wrap_iov.c */
 224 OM_uint32
 225 gssEapWrapOrGetMIC(OM_uint32 *minor,
 226                    gss_ctx_id_t ctx,
 227                    int conf_req_flag,
 228                    int *conf_state,
 229                    gss_iov_buffer_desc *iov,
 230                    int iov_count,
 231                    enum gss_eap_token_type toktype);
 232
 233 OM_uint32
 234 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
 235                         gss_ctx_id_t ctx,
 236                         int *conf_state,
 237                         gss_qop_t *qop_state,
 238                         gss_iov_buffer_desc *iov,
 239                         int iov_count,
 240                         enum gss_eap_token_type toktype);
 241
 242 OM_uint32
 243 gssEapWrapIovLength(OM_uint32 *minor,
 244                     gss_ctx_id_t ctx,
 245                     int conf_req_flag,
 246                     gss_qop_t qop_req,
 247                     int *conf_state,
 248                     gss_iov_buffer_desc *iov,
 249                     int iov_count);
 250 OM_uint32
 251 gssEapWrap(OM_uint32 *minor,
 252            gss_ctx_id_t ctx,
 253            int conf_req_flag,
 254            gss_qop_t qop_req,
 255            gss_buffer_t input_message_buffer,
 256            int *conf_state,
 257            gss_buffer_t output_message_buffer);
 258
 259 unsigned char
 260 rfc4121Flags(gss_ctx_id_t ctx, int receiving);
 261
 262 /* display_status.c */
 263 void
 264 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
 265
 266 #define IS_WIRE_ERROR(err)              ((err) > GSSEAP_RESERVED && \
 267                                          (err) <= GSSEAP_RADIUS_PROT_FAILURE)
 268
 269 /* export_sec_context.c */
 270 OM_uint32
 271 gssEapExportSecContext(OM_uint32 *minor,
 272                        gss_ctx_id_t ctx,
 273                        gss_buffer_t token);
 274
 275
 276 #ifdef __cplusplus
 277 }
 278 #endif
 279
 280 #endif /* _GSSAPIP_EAP_H_ */