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