mech_eap/util.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  * Portions Copyright 2003-2010 Massachusetts Institute of Technology.
  34  * All Rights Reserved.
  35  *
  36  * Export of this software from the United States of America may
  37  *   require a specific license from the United States Government.
  38  *   It is the responsibility of any person or organization contemplating
  39  *   export to obtain such a license before exporting.
  40  *
  41  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
  42  * distribute this software and its documentation for any purpose and
  43  * without fee is hereby granted, provided that the above copyright
  44  * notice appear in all copies and that both that copyright notice and
  45  * this permission notice appear in supporting documentation, and that
  46  * the name of M.I.T. not be used in advertising or publicity pertaining
  47  * to distribution of the software without specific, written prior
  48  * permission.  Furthermore if you modify this software you must label
  49  * your software as modified software and not distribute it in such a
  50  * fashion that it might be confused with the original M.I.T. software.
  51  * M.I.T. makes no representations about the suitability of
  52  * this software for any purpose.  It is provided "as is" without express
  53  * or implied warranty.
  54  *
  55  */
  56
  57 #ifndef _UTIL_H_
  58 #define _UTIL_H_ 1
  59
  60 #include <krb5.h>
  61
  62 #include "util_saml.h"
  63 #include "util_radius.h"
  64
  65 #define KRB_KEY_TYPE(key)       ((key)->enctype)
  66 #define KRB_KEY_DATA(key)       ((key)->contents)
  67 #define KRB_KEY_LENGTH(key)     ((key)->length)
  68 #define KRB_KEY_INIT(key)       do {        \
  69         KRB_KEY_TYPE(key) = ENCTYPE_NULL;   \
  70         KRB_KEY_DATA(key) = NULL;           \
  71         KRB_KEY_LENGTH(key) = 0;            \
  72     } while (0)
  73
  74 enum gss_eap_token_type {
  75     TOK_TYPE_NONE                    = 0x0000,  /* no token */
  76     TOK_TYPE_MIC                     = 0x0404,  /* RFC 4121 MIC token */
  77     TOK_TYPE_WRAP                    = 0x0504,  /* RFC 4121 wrap token */
  78     TOK_TYPE_EXPORT_NAME             = 0x0401,  /* RFC 2743 exported name */
  79     TOK_TYPE_EXPORT_NAME_COMPOSITE   = 0x0402,  /* draft-ietf-kitten-gss-naming */
  80     TOK_TYPE_DELETE_CONTEXT          = 0x0405,  /* RFC 2743 delete context */
  81     TOK_TYPE_EAP_RESP                = 0x0601,  /* draft-howlett-eap-gss */
  82     TOK_TYPE_EAP_REQ                 = 0x0602,  /* draft-howlett-eap-gss */
  83     TOK_TYPE_GSS_CB                  = 0x0603,  /* draft-howlett-eap-gss */
  84 };
  85
  86 #define EAP_EXPORT_CONTEXT_V1           1
  87
  88 /* util_buffer.c */
  89 OM_uint32
  90 makeStringBuffer(OM_uint32 *minor,
  91                  const char *string,
  92                  gss_buffer_t buffer);
  93
  94 OM_uint32
  95 bufferToString(OM_uint32 *minor,
  96                const gss_buffer_t buffer,
  97                char **pString);
  98
  99 OM_uint32
 100 duplicateBuffer(OM_uint32 *minor,
 101                 const gss_buffer_t src,
 102                 gss_buffer_t dst);
 103
 104 /* util_cksum.c */
 105 int
 106 gssEapSign(krb5_context context,
 107            krb5_cksumtype type,
 108            size_t rrc,
 109            krb5_keyblock *key,
 110            krb5_keyusage sign_usage,
 111            gss_iov_buffer_desc *iov,
 112            int iov_count);
 113
 114 int
 115 gssEapVerify(krb5_context context,
 116              krb5_cksumtype type,
 117              size_t rrc,
 118              krb5_keyblock *key,
 119              krb5_keyusage sign_usage,
 120              gss_iov_buffer_desc *iov,
 121              int iov_count,
 122              int *valid);
 123
 124 #if 0
 125 OM_uint32
 126 gssEapEncodeGssChannelBindings(OM_uint32 *minor,
 127                                gss_channel_bindings_t chanBindings,
 128                                gss_buffer_t encodedBindings);
 129 #endif
 130
 131 /* util_context.c */
 132 OM_uint32 gssEapAllocContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
 133 OM_uint32 gssEapReleaseContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
 134
 135 OM_uint32
 136 gssEapMakeToken(OM_uint32 *minor,
 137                 gss_ctx_id_t ctx,
 138                 const gss_buffer_t innerToken,
 139                 enum gss_eap_token_type tokenType,
 140                 gss_buffer_t outputToken);
 141
 142 OM_uint32
 143 gssEapVerifyToken(OM_uint32 *minor,
 144                   gss_ctx_id_t ctx,
 145                   const gss_buffer_t inputToken,
 146                   enum gss_eap_token_type tokenType,
 147                   gss_buffer_t innerInputToken);
 148
 149 /* util_cred.c */
 150 OM_uint32 gssEapAllocCred(OM_uint32 *minor, gss_cred_id_t *pCred);
 151 OM_uint32 gssEapReleaseCred(OM_uint32 *minor, gss_cred_id_t *pCred);
 152
 153 OM_uint32
 154 gssEapAcquireCred(OM_uint32 *minor,
 155                   const gss_name_t desiredName,
 156                   const gss_buffer_t password,
 157                   OM_uint32 timeReq,
 158                   const gss_OID_set desiredMechs,
 159                   int cred_usage,
 160                   gss_cred_id_t *pCred,
 161                   gss_OID_set *pActualMechs,
 162                   OM_uint32 *timeRec);
 163
 164 int gssEapCredAvailable(gss_cred_id_t cred, gss_OID mech);
 165
 166 /* util_crypt.c */
 167 int
 168 gssEapEncrypt(krb5_context context, int dce_style, size_t ec,
 169               size_t rrc, krb5_keyblock *key, int usage, krb5_pointer iv,
 170               gss_iov_buffer_desc *iov, int iov_count);
 171
 172 int
 173 gssEapDecrypt(krb5_context context, int dce_style, size_t ec,
 174               size_t rrc, krb5_keyblock *key, int usage, krb5_pointer iv,
 175               gss_iov_buffer_desc *iov, int iov_count);
 176
 177 krb5_cryptotype
 178 gssEapMapCryptoFlag(OM_uint32 type);
 179
 180 gss_iov_buffer_t
 181 gssEapLocateIov(gss_iov_buffer_desc *iov,
 182                 int iov_count,
 183                 OM_uint32 type);
 184
 185 void
 186 gssEapIovMessageLength(gss_iov_buffer_desc *iov,
 187                        int iov_count,
 188                        size_t *data_length,
 189                        size_t *assoc_data_length);
 190
 191 void
 192 gssEapReleaseIov(gss_iov_buffer_desc *iov, int iov_count);
 193
 194 int
 195 gssEapIsIntegrityOnly(gss_iov_buffer_desc *iov, int iov_count);
 196
 197 int
 198 gssEapAllocIov(gss_iov_buffer_t iov, size_t size);
 199
 200 OM_uint32
 201 gssEapDeriveRFC3961Key(OM_uint32 *minor,
 202                        const unsigned char *key,
 203                        size_t keyLength,
 204                        krb5_enctype enctype,
 205                        krb5_keyblock *pKey);
 206
 207 /* util_krb.c */
 208 OM_uint32
 209 gssEapKerberosInit(OM_uint32 *minor, krb5_context *context);
 210
 211 #define GSSEAP_KRB_INIT(ctx) do {                   \
 212         OM_uint32 tmpMajor;                         \
 213         tmpMajor  = gssEapKerberosInit(minor, ctx); \
 214         if (GSS_ERROR(tmpMajor)) {                  \
 215             return tmpMajor;                        \
 216         }                                           \
 217     } while (0)
 218
 219 /* util_mech.c */
 220 int
 221 gssEapInternalizeOid(const gss_OID oid,
 222                      gss_OID *const pInternalizedOid);
 223
 224 OM_uint32
 225 gssEapDefaultMech(OM_uint32 *minor,
 226                   gss_OID *oid);
 227
 228 OM_uint32
 229 gssEapIndicateMechs(OM_uint32 *minor,
 230                     gss_OID_set *mechs);
 231
 232 OM_uint32
 233 gssEapEnctypeToOid(OM_uint32 *minor,
 234                    krb5_enctype enctype,
 235                    gss_OID *pOid);
 236
 237 OM_uint32
 238 gssEapOidToEnctype(OM_uint32 *minor,
 239                    const gss_OID oid,
 240                    krb5_enctype *enctype);
 241
 242 int
 243 gssEapIsMechanismOid(const gss_OID oid);
 244
 245 int
 246 gssEapIsConcreteMechanismOid(const gss_OID oid);
 247
 248 OM_uint32
 249 gssEapValidateMechs(OM_uint32 *minor,
 250                    const gss_OID_set mechs);
 251
 252 /* util_name.c */
 253 enum gss_eap_attribute_type {
 254     ATTR_TYPE_NONE                  = 0,
 255     ATTR_TYPE_SAML_AAA_ASSERTION    = 1,
 256     ATTR_TYPE_SAML_ATTR             = 2,
 257     ATTR_TYPE_RADIUS_AVP            = 3
 258 };
 259
 260 OM_uint32 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName);
 261 OM_uint32 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName);
 262 OM_uint32 gssEapExportName(OM_uint32 *minor,
 263                            const gss_name_t name,
 264                            gss_buffer_t exportedName,
 265                            int composite);
 266 OM_uint32 gssEapImportName(OM_uint32 *minor,
 267                            const gss_buffer_t input_name_buffer,
 268                            gss_OID input_name_type,
 269                            gss_name_t *output_name);
 270
 271 enum gss_eap_attribute_type
 272 gssEapAttributePrefixToType(const gss_buffer_t prefix);
 273 gss_buffer_t
 274 gssEapAttributeTypeToPrefix(enum gss_eap_attribute_type type);
 275 OM_uint32
 276 decomposeAttributeName(OM_uint32 *minor,
 277                        const gss_buffer_t attribute,
 278                        gss_buffer_t prefix,
 279                        gss_buffer_t suffix);
 280 OM_uint32
 281 composeAttributeName(OM_uint32 *minor,
 282                      const gss_buffer_t prefix,
 283                      const gss_buffer_t suffix,
 284                      gss_buffer_t attribute);
 285
 286 /* util_oid.c */
 287 OM_uint32
 288 composeOid(OM_uint32 *minor_status,
 289            const char *prefix,
 290            size_t prefix_len,
 291            int suffix,
 292            gss_OID_desc *oid);
 293
 294 OM_uint32
 295 decomposeOid(OM_uint32 *minor_status,
 296              const char *prefix,
 297              size_t prefix_len,
 298              gss_OID_desc *oid,
 299              int *suffix) ;
 300
 301 OM_uint32
 302 duplicateOid(OM_uint32 *minor_status,
 303              const gss_OID_desc * const oid,
 304              gss_OID *new_oid);
 305
 306 OM_uint32
 307 duplicateOidSet(OM_uint32 *minor,
 308                 const gss_OID_set src,
 309                 gss_OID_set *dst);
 310
 311 static inline int
 312 oidEqual(const gss_OID_desc *o1, const gss_OID_desc *o2)
 313 {
 314     if (o1 == GSS_C_NO_OID)
 315         return (o2 == GSS_C_NO_OID);
 316     else if (o2 == GSS_C_NO_OID)
 317         return (o1 == GSS_C_NO_OID);
 318     else
 319         return (o1->length == o2->length &&
 320                 memcmp(o1->elements, o2->elements, o1->length) == 0);
 321 }
 322
 323 /* util_ordering.c */
 324 int
 325 sequenceInternalize(void **vqueue, unsigned char **buf, size_t *lenremain);
 326
 327 int
 328 sequenceExternalize(void *vqueue, unsigned char **buf, size_t *lenremain);
 329
 330 size_t
 331 sequenceSize(void *vqueue);
 332
 333 void
 334 sequenceFree(void **vqueue);
 335
 336 int
 337 sequenceCheck(void **vqueue, uint64_t seqnum);
 338
 339 int
 340 sequenceInit(void **vqueue, uint64_t seqnum,
 341              int do_replay, int do_sequence, int wide_nums);
 342
 343 /* util_token.c */
 344 size_t
 345 tokenSize(const gss_OID_desc *mech, size_t body_size);
 346
 347 void
 348 makeTokenHeader(const gss_OID_desc *mech,
 349                 size_t body_size,
 350                 unsigned char **buf,
 351                 enum gss_eap_token_type tok_type);
 352
 353 OM_uint32
 354 verifyTokenHeader(OM_uint32 *minor,
 355                   gss_OID mech,
 356                   size_t *body_size,
 357                   unsigned char **buf_in,
 358                   size_t toksize_in,
 359                   enum gss_eap_token_type tok_type);
 360
 361 /* Helper macros */
 362 #define GSSEAP_CALLOC(count, size)      (calloc((count), (size)))
 363 #define GSSEAP_FREE(ptr)                (free((ptr)))
 364 #define GSSEAP_MALLOC(size)             (malloc((size)))
 365 #define GSSEAP_REALLOC(ptr, size)       (realloc((ptr), (size)))
 366
 367 #define GSSEAP_NOT_IMPLEMENTED          do {            \
 368         assert(0 && "not implemented");                 \
 369         *minor = ENOSYS;                                \
 370         return GSS_S_FAILURE;                           \
 371     } while (0)
 372
 373 #include <pthread.h>
 374
 375 #define GSSEAP_MUTEX                    pthread_mutex_t
 376 #define GSSEAP_MUTEX_INITIALIZER        PTHREAD_MUTEX_INITIALIZER
 377
 378 #define GSSEAP_MUTEX_INIT(m)            pthread_mutex_init((m), NULL)
 379 #define GSSEAP_MUTEX_DESTROY(m)         pthread_mutex_destroy((m))
 380 #define GSSEAP_MUTEX_LOCK(m)            pthread_mutex_lock((m))
 381 #define GSSEAP_MUTEX_UNLOCK(m)          pthread_mutex_unlock((m))
 382
 383 #define GSSEAP_THREAD_KEY               pthread_key_t
 384 #define GSSEAP_KEY_CREATE(k, d)         pthread_key_create((k), (d))
 385 #define GSSEAP_GETSPECIFIC(k)           pthread_getspecific((k))
 386 #define GSSEAP_SETSPECIFIC(k, d)        pthread_setspecific((k), (d))
 387
 388 #define GSSEAP_THREAD_ONCE              pthread_once_t
 389 #define GSSEAP_ONCE(o, i)               pthread_once((o), (i))
 390 #define GSSEAP_ONCE_INITIALIZER         PTHREAD_ONCE_INIT
 391
 392 /* Helper functions */
 393 static inline void
 394 store_uint16_be(uint16_t val, void *vp)
 395 {
 396     unsigned char *p = (unsigned char *)vp;
 397
 398     p[0] = (val >>  8) & 0xff;
 399     p[1] = (val      ) & 0xff;
 400 }
 401
 402 static inline uint16_t
 403 load_uint16_be(const void *cvp)
 404 {
 405     const unsigned char *p = (const unsigned char *)cvp;
 406
 407     return (p[1] | (p[0] << 8));
 408 }
 409
 410 static inline void
 411 store_uint32_be(uint32_t val, void *vp)
 412 {
 413     unsigned char *p = (unsigned char *)vp;
 414
 415     p[0] = (val >> 24) & 0xff;
 416     p[1] = (val >> 16) & 0xff;
 417     p[2] = (val >>  8) & 0xff;
 418     p[3] = (val      ) & 0xff;
 419 }
 420
 421 static inline uint32_t
 422 load_uint32_be(const void *cvp)
 423 {
 424     const unsigned char *p = (const unsigned char *)cvp;
 425
 426     return (p[3] | (p[2] << 8)
 427             | ((uint32_t) p[1] << 16)
 428             | ((uint32_t) p[0] << 24));
 429 }
 430
 431 static inline void
 432 store_uint64_be(uint64_t val, void *vp)
 433 {
 434     unsigned char *p = (unsigned char *)vp;
 435
 436     p[0] = (unsigned char)((val >> 56) & 0xff);
 437     p[1] = (unsigned char)((val >> 48) & 0xff);
 438     p[2] = (unsigned char)((val >> 40) & 0xff);
 439     p[3] = (unsigned char)((val >> 32) & 0xff);
 440     p[4] = (unsigned char)((val >> 24) & 0xff);
 441     p[5] = (unsigned char)((val >> 16) & 0xff);
 442     p[6] = (unsigned char)((val >>  8) & 0xff);
 443     p[7] = (unsigned char)((val      ) & 0xff);
 444 }
 445
 446 static inline uint64_t
 447 load_uint64_be(const void *cvp)
 448 {
 449     const unsigned char *p = (const unsigned char *)cvp;
 450
 451     return ((uint64_t)load_uint32_be(p) << 32) | load_uint32_be(p + 4);
 452 }
 453
 454 static inline unsigned char *
 455 store_buffer(gss_buffer_t buffer, void *vp, int wide_nums)
 456 {
 457     unsigned char *p = (unsigned char *)vp;
 458
 459     if (wide_nums) {
 460         store_uint64_be(buffer->length, p);
 461         p += 8;
 462     } else {
 463         store_uint32_be(buffer->length, p);
 464         p += 4;
 465     }
 466
 467     if (buffer->value != NULL) {
 468         memcpy(p, buffer->value, buffer->length);
 469         p += buffer->length;
 470     }
 471
 472     return p;
 473 }
 474
 475 static inline unsigned char *
 476 load_buffer(const void *cvp, size_t length, gss_buffer_t buffer)
 477 {
 478     buffer->length = 0;
 479     buffer->value = GSSEAP_MALLOC(length);
 480     if (buffer->value == NULL)
 481         return NULL;
 482     buffer->length = length;
 483     memcpy(buffer->value, cvp, length);
 484     return (unsigned char *)cvp + length;
 485 }
 486
 487 static inline unsigned char *
 488 store_oid(gss_OID oid, void *vp)
 489 {
 490     gss_buffer_desc buf;
 491
 492     if (oid != GSS_C_NO_OID) {
 493         buf.length = oid->length;
 494         buf.value = oid->elements;
 495     } else {
 496         buf.length = 0;
 497         buf.value = NULL;
 498     }
 499
 500     return store_buffer(&buf, vp, FALSE);
 501 }
 502 #endif /* _UTIL_H_ */