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