mech_eap/gssapiP_eap.h

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