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