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