www.project-moonshot.org Git - mech_eap.orig/blob - 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 <string.h>
  61 #include <errno.h>
  62
  63 #include <krb5.h>
  64
  65 #ifdef __cplusplus
  66 extern "C" {
  67 #endif
  68
  69 #ifndef MIN             /* Usually found in <sys/param.h>. */
  70 #define MIN(_a,_b)  ((_a)<(_b)?(_a):(_b))
  71 #endif
  72
  73 #define KRB_KEY_TYPE(key)       ((key)->enctype)
  74 #define KRB_KEY_DATA(key)       ((key)->contents)
  75 #define KRB_KEY_LENGTH(key)     ((key)->length)
  76 #define KRB_KEY_INIT(key)       do {        \
  77         KRB_KEY_TYPE(key) = ENCTYPE_NULL;   \
  78         KRB_KEY_DATA(key) = NULL;           \
  79         KRB_KEY_LENGTH(key) = 0;            \
  80     } while (0)
  81
  82 enum gss_eap_token_type {
  83     TOK_TYPE_NONE                    = 0x0000,  /* no token */
  84     TOK_TYPE_MIC                     = 0x0404,  /* RFC 4121 MIC token */
  85     TOK_TYPE_WRAP                    = 0x0504,  /* RFC 4121 wrap token */
  86     TOK_TYPE_EXPORT_NAME             = 0x0401,  /* RFC 2743 exported name */
  87     TOK_TYPE_EXPORT_NAME_COMPOSITE   = 0x0402,  /* draft-ietf-kitten-gss-naming */
  88     TOK_TYPE_DELETE_CONTEXT          = 0x0405,  /* RFC 2743 delete context */
  89     TOK_TYPE_EAP_RESP                = 0x0601,  /* draft-howlett-eap-gss */
  90     TOK_TYPE_EAP_REQ                 = 0x0602,  /* draft-howlett-eap-gss */
  91     TOK_TYPE_GSS_CB                  = 0x0603,  /* draft-howlett-eap-gss */
  92 };
  93
  94 #define EAP_EXPORT_CONTEXT_V1           1
  95
  96 /* util_buffer.c */
  97 OM_uint32
  98 makeStringBuffer(OM_uint32 *minor,
  99                  const char *string,
 100                  gss_buffer_t buffer);
 101
 102 OM_uint32
 103 bufferToString(OM_uint32 *minor,
 104                const gss_buffer_t buffer,
 105                char **pString);
 106
 107 OM_uint32
 108 duplicateBuffer(OM_uint32 *minor,
 109                 const gss_buffer_t src,
 110                 gss_buffer_t dst);
 111
 112 static inline int
 113 bufferEqual(const gss_buffer_t b1, const gss_buffer_t b2)
 114 {
 115     return (b1->length == b2->length &&
 116             memcmp(b1->value, b2->value, b2->length) == 0);
 117 }
 118
 119 static inline int
 120 bufferEqualString(const gss_buffer_t b1, const char *s)
 121 {
 122     gss_buffer_desc b2;
 123
 124     b2.length = strlen(s);
 125     b2.value = (char *)s;
 126
 127     return bufferEqual(b1, &b2);
 128 }
 129
 130 /* util_cksum.c */
 131 int
 132 gssEapSign(krb5_context context,
 133            krb5_cksumtype type,
 134            size_t rrc,
 135            krb5_keyblock *key,
 136            krb5_keyusage sign_usage,
 137            gss_iov_buffer_desc *iov,
 138            int iov_count);
 139
 140 int
 141 gssEapVerify(krb5_context context,
 142              krb5_cksumtype type,
 143              size_t rrc,
 144              krb5_keyblock *key,
 145              krb5_keyusage sign_usage,
 146              gss_iov_buffer_desc *iov,
 147              int iov_count,
 148              int *valid);
 149
 150 #if 0
 151 OM_uint32
 152 gssEapEncodeGssChannelBindings(OM_uint32 *minor,
 153                                gss_channel_bindings_t chanBindings,
 154                                gss_buffer_t encodedBindings);
 155 #endif
 156
 157 /* util_context.c */
 158 OM_uint32 gssEapAllocContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
 159 OM_uint32 gssEapReleaseContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
 160
 161 OM_uint32
 162 gssEapMakeToken(OM_uint32 *minor,
 163                 gss_ctx_id_t ctx,
 164                 const gss_buffer_t innerToken,
 165                 enum gss_eap_token_type tokenType,
 166                 gss_buffer_t outputToken);
 167
 168 OM_uint32
 169 gssEapVerifyToken(OM_uint32 *minor,
 170                   gss_ctx_id_t ctx,
 171                   const gss_buffer_t inputToken,
 172                   enum gss_eap_token_type tokenType,
 173                   gss_buffer_t innerInputToken);
 174
 175 /* util_cred.c */
 176 OM_uint32 gssEapAllocCred(OM_uint32 *minor, gss_cred_id_t *pCred);
 177 OM_uint32 gssEapReleaseCred(OM_uint32 *minor, gss_cred_id_t *pCred);
 178
 179 OM_uint32
 180 gssEapAcquireCred(OM_uint32 *minor,
 181                   const gss_name_t desiredName,
 182                   const gss_buffer_t password,
 183                   OM_uint32 timeReq,
 184                   const gss_OID_set desiredMechs,
 185                   int cred_usage,
 186                   gss_cred_id_t *pCred,
 187                   gss_OID_set *pActualMechs,
 188                   OM_uint32 *timeRec);
 189
 190 int gssEapCredAvailable(gss_cred_id_t cred, gss_OID mech);
 191
 192 /* util_crypt.c */
 193 int
 194 gssEapEncrypt(krb5_context context, int dce_style, size_t ec,
 195               size_t rrc, krb5_keyblock *key, int usage, krb5_pointer iv,
 196               gss_iov_buffer_desc *iov, int iov_count);
 197
 198 int
 199 gssEapDecrypt(krb5_context context, int dce_style, size_t ec,
 200               size_t rrc, krb5_keyblock *key, int usage, krb5_pointer iv,
 201               gss_iov_buffer_desc *iov, int iov_count);
 202
 203 krb5_cryptotype
 204 gssEapMapCryptoFlag(OM_uint32 type);
 205
 206 gss_iov_buffer_t
 207 gssEapLocateIov(gss_iov_buffer_desc *iov,
 208                 int iov_count,
 209                 OM_uint32 type);
 210
 211 void
 212 gssEapIovMessageLength(gss_iov_buffer_desc *iov,
 213                        int iov_count,
 214                        size_t *data_length,
 215                        size_t *assoc_data_length);
 216
 217 void
 218 gssEapReleaseIov(gss_iov_buffer_desc *iov, int iov_count);
 219
 220 int
 221 gssEapIsIntegrityOnly(gss_iov_buffer_desc *iov, int iov_count);
 222
 223 int
 224 gssEapAllocIov(gss_iov_buffer_t iov, size_t size);
 225
 226 OM_uint32
 227 gssEapDeriveRfc3961Key(OM_uint32 *minor,
 228                        const unsigned char *key,
 229                        size_t keyLength,
 230                        krb5_enctype enctype,
 231                        krb5_keyblock *pKey);
 232
 233 /* util_krb.c */
 234 OM_uint32
 235 gssEapKerberosInit(OM_uint32 *minor, krb5_context *context);
 236
 237 OM_uint32
 238 rfc3961ChecksumTypeForKey(OM_uint32 *minor,
 239                           krb5_keyblock *key,
 240                           krb5_cksumtype *cksumtype);
 241
 242 #define GSSEAP_KRB_INIT(ctx) do {                   \
 243         OM_uint32 tmpMajor;                         \
 244         tmpMajor  = gssEapKerberosInit(minor, ctx); \
 245         if (GSS_ERROR(tmpMajor)) {                  \
 246             return tmpMajor;                        \
 247         }                                           \
 248     } while (0)
 249
 250 /* util_mech.c */
 251 int
 252 gssEapInternalizeOid(const gss_OID oid,
 253                      gss_OID *const pInternalizedOid);
 254
 255 OM_uint32
 256 gssEapDefaultMech(OM_uint32 *minor,
 257                   gss_OID *oid);
 258
 259 OM_uint32
 260 gssEapIndicateMechs(OM_uint32 *minor,
 261                     gss_OID_set *mechs);
 262
 263 OM_uint32
 264 gssEapEnctypeToOid(OM_uint32 *minor,
 265                    krb5_enctype enctype,
 266                    gss_OID *pOid);
 267
 268 OM_uint32
 269 gssEapOidToEnctype(OM_uint32 *minor,
 270                    const gss_OID oid,
 271                    krb5_enctype *enctype);
 272
 273 int
 274 gssEapIsMechanismOid(const gss_OID oid);
 275
 276 int
 277 gssEapIsConcreteMechanismOid(const gss_OID oid);
 278
 279 OM_uint32
 280 gssEapValidateMechs(OM_uint32 *minor,
 281                    const gss_OID_set mechs);
 282
 283 /* util_name.c */
 284 #define EXPORT_NAME_FLAG_OID        0x1
 285 #define EXPORT_NAME_FLAG_COMPOSITE  0x2
 286
 287 OM_uint32 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName);
 288 OM_uint32 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName);
 289 OM_uint32 gssEapExportName(OM_uint32 *minor,
 290                            const gss_name_t name,
 291                            gss_buffer_t exportedName);
 292 OM_uint32 gssEapExportNameInternal(OM_uint32 *minor,
 293                                    const gss_name_t name,
 294                                    gss_buffer_t exportedName,
 295                                    unsigned int flags);
 296 OM_uint32 gssEapImportName(OM_uint32 *minor,
 297                            const gss_buffer_t input_name_buffer,
 298                            gss_OID input_name_type,
 299                            gss_name_t *output_name);
 300 OM_uint32 gssEapImportNameInternal(OM_uint32 *minor,
 301                                    const gss_buffer_t input_name_buffer,
 302                                    gss_name_t *output_name,
 303                                    unsigned int flags);
 304
 305 /* util_oid.c */
 306 OM_uint32
 307 composeOid(OM_uint32 *minor_status,
 308            const char *prefix,
 309            size_t prefix_len,
 310            int suffix,
 311            gss_OID_desc *oid);
 312
 313 OM_uint32
 314 decomposeOid(OM_uint32 *minor_status,
 315              const char *prefix,
 316              size_t prefix_len,
 317              gss_OID_desc *oid,
 318              int *suffix) ;
 319
 320 OM_uint32
 321 duplicateOid(OM_uint32 *minor_status,
 322              const gss_OID_desc * const oid,
 323              gss_OID *new_oid);
 324
 325 OM_uint32
 326 duplicateOidSet(OM_uint32 *minor,
 327                 const gss_OID_set src,
 328                 gss_OID_set *dst);
 329
 330 static inline int
 331 oidEqual(const gss_OID_desc *o1, const gss_OID_desc *o2)
 332 {
 333     if (o1 == GSS_C_NO_OID)
 334         return (o2 == GSS_C_NO_OID);
 335     else if (o2 == GSS_C_NO_OID)
 336         return (o1 == GSS_C_NO_OID);
 337     else
 338         return (o1->length == o2->length &&
 339                 memcmp(o1->elements, o2->elements, o1->length) == 0);
 340 }
 341
 342 /* util_ordering.c */
 343 OM_uint32
 344 sequenceInternalize(OM_uint32 *minor,
 345                     void **vqueue,
 346                     unsigned char **buf,
 347                     size_t *lenremain);
 348
 349 OM_uint32
 350 sequenceExternalize(OM_uint32 *minor,
 351                     void *vqueue,
 352                     unsigned char **buf,
 353                     size_t *lenremain);
 354
 355 size_t
 356 sequenceSize(void *vqueue);
 357
 358 OM_uint32
 359 sequenceFree(OM_uint32 *minor, void **vqueue);
 360
 361 OM_uint32
 362 sequenceCheck(OM_uint32 *minor, void **vqueue, uint64_t seqnum);
 363
 364 OM_uint32
 365 sequenceInit(OM_uint32 *minor, void **vqueue, uint64_t seqnum,
 366              int do_replay, int do_sequence, int wide_nums);
 367
 368 /* util_token.c */
 369 size_t
 370 tokenSize(const gss_OID_desc *mech, size_t body_size);
 371
 372 void
 373 makeTokenHeader(const gss_OID_desc *mech,
 374                 size_t body_size,
 375                 unsigned char **buf,
 376                 enum gss_eap_token_type tok_type);
 377
 378 OM_uint32
 379 verifyTokenHeader(OM_uint32 *minor,
 380                   gss_OID mech,
 381                   size_t *body_size,
 382                   unsigned char **buf_in,
 383                   size_t toksize_in,
 384                   enum gss_eap_token_type tok_type);
 385
 386 /* Helper macros */
 387 #define GSSEAP_CALLOC(count, size)      (calloc((count), (size)))
 388 #define GSSEAP_FREE(ptr)                (free((ptr)))
 389 #define GSSEAP_MALLOC(size)             (malloc((size)))
 390 #define GSSEAP_REALLOC(ptr, size)       (realloc((ptr), (size)))
 391
 392 #define GSSEAP_NOT_IMPLEMENTED          do {            \
 393         assert(0 && "not implemented");                 \
 394         *minor = ENOSYS;                                \
 395         return GSS_S_FAILURE;                           \
 396     } while (0)
 397
 398 #include <pthread.h>
 399
 400 #define GSSEAP_MUTEX                    pthread_mutex_t
 401 #define GSSEAP_MUTEX_INITIALIZER        PTHREAD_MUTEX_INITIALIZER
 402
 403 #define GSSEAP_MUTEX_INIT(m)            pthread_mutex_init((m), NULL)
 404 #define GSSEAP_MUTEX_DESTROY(m)         pthread_mutex_destroy((m))
 405 #define GSSEAP_MUTEX_LOCK(m)            pthread_mutex_lock((m))
 406 #define GSSEAP_MUTEX_UNLOCK(m)          pthread_mutex_unlock((m))
 407
 408 #define GSSEAP_THREAD_KEY               pthread_key_t
 409 #define GSSEAP_KEY_CREATE(k, d)         pthread_key_create((k), (d))
 410 #define GSSEAP_GETSPECIFIC(k)           pthread_getspecific((k))
 411 #define GSSEAP_SETSPECIFIC(k, d)        pthread_setspecific((k), (d))
 412
 413 #define GSSEAP_THREAD_ONCE              pthread_once_t
 414 #define GSSEAP_ONCE(o, i)               pthread_once((o), (i))
 415 #define GSSEAP_ONCE_INITIALIZER         PTHREAD_ONCE_INIT
 416
 417 /* Helper functions */
 418 static inline void
 419 store_uint16_be(uint16_t val, void *vp)
 420 {
 421     unsigned char *p = (unsigned char *)vp;
 422
 423     p[0] = (val >>  8) & 0xff;
 424     p[1] = (val      ) & 0xff;
 425 }
 426
 427 static inline uint16_t
 428 load_uint16_be(const void *cvp)
 429 {
 430     const unsigned char *p = (const unsigned char *)cvp;
 431
 432     return (p[1] | (p[0] << 8));
 433 }
 434
 435 static inline void
 436 store_uint32_be(uint32_t val, void *vp)
 437 {
 438     unsigned char *p = (unsigned char *)vp;
 439
 440     p[0] = (val >> 24) & 0xff;
 441     p[1] = (val >> 16) & 0xff;
 442     p[2] = (val >>  8) & 0xff;
 443     p[3] = (val      ) & 0xff;
 444 }
 445
 446 static inline uint32_t
 447 load_uint32_be(const void *cvp)
 448 {
 449     const unsigned char *p = (const unsigned char *)cvp;
 450
 451     return (p[3] | (p[2] << 8)
 452             | ((uint32_t) p[1] << 16)
 453             | ((uint32_t) p[0] << 24));
 454 }
 455
 456 static inline void
 457 store_uint64_be(uint64_t val, void *vp)
 458 {
 459     unsigned char *p = (unsigned char *)vp;
 460
 461     p[0] = (unsigned char)((val >> 56) & 0xff);
 462     p[1] = (unsigned char)((val >> 48) & 0xff);
 463     p[2] = (unsigned char)((val >> 40) & 0xff);
 464     p[3] = (unsigned char)((val >> 32) & 0xff);
 465     p[4] = (unsigned char)((val >> 24) & 0xff);
 466     p[5] = (unsigned char)((val >> 16) & 0xff);
 467     p[6] = (unsigned char)((val >>  8) & 0xff);
 468     p[7] = (unsigned char)((val      ) & 0xff);
 469 }
 470
 471 static inline uint64_t
 472 load_uint64_be(const void *cvp)
 473 {
 474     const unsigned char *p = (const unsigned char *)cvp;
 475
 476     return ((uint64_t)load_uint32_be(p) << 32) | load_uint32_be(p + 4);
 477 }
 478
 479 static inline unsigned char *
 480 store_buffer(gss_buffer_t buffer, void *vp, int wide_nums)
 481 {
 482     unsigned char *p = (unsigned char *)vp;
 483
 484     if (wide_nums) {
 485         store_uint64_be(buffer->length, p);
 486         p += 8;
 487     } else {
 488         store_uint32_be(buffer->length, p);
 489         p += 4;
 490     }
 491
 492     if (buffer->value != NULL) {
 493         memcpy(p, buffer->value, buffer->length);
 494         p += buffer->length;
 495     }
 496
 497     return p;
 498 }
 499
 500 static inline unsigned char *
 501 load_buffer(const void *cvp, size_t length, gss_buffer_t buffer)
 502 {
 503     buffer->length = 0;
 504     buffer->value = GSSEAP_MALLOC(length);
 505     if (buffer->value == NULL)
 506         return NULL;
 507     buffer->length = length;
 508     memcpy(buffer->value, cvp, length);
 509     return (unsigned char *)cvp + length;
 510 }
 511
 512 static inline unsigned char *
 513 store_oid(gss_OID oid, void *vp)
 514 {
 515     gss_buffer_desc buf;
 516
 517     if (oid != GSS_C_NO_OID) {
 518         buf.length = oid->length;
 519         buf.value = oid->elements;
 520     } else {
 521         buf.length = 0;
 522         buf.value = NULL;
 523     }
 524
 525     return store_buffer(&buf, vp, FALSE);
 526 }
 527
 528 #ifdef __cplusplus
 529 }
 530 #endif
 531
 532 #include "util_attr.h"
 533
 534 #endif /* _UTIL_H_ */