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_EXT_REQ                 = 0x0603,  /* draft-howlett-eap-gss */
  92     TOK_TYPE_EXT_RESP                = 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_lucid.c */
 264 OM_uint32
 265 gssEapExportLucidSecContext(OM_uint32 *minor,
 266                             gss_ctx_id_t ctx,
 267                             const gss_OID desiredObject,
 268                             gss_buffer_set_t *data_set);
 269
 270 /* util_mech.c */
 271 int
 272 gssEapInternalizeOid(const gss_OID oid,
 273                      gss_OID *const pInternalizedOid);
 274
 275 OM_uint32
 276 gssEapDefaultMech(OM_uint32 *minor,
 277                   gss_OID *oid);
 278
 279 OM_uint32
 280 gssEapIndicateMechs(OM_uint32 *minor,
 281                     gss_OID_set *mechs);
 282
 283 OM_uint32
 284 gssEapEnctypeToOid(OM_uint32 *minor,
 285                    krb5_enctype enctype,
 286                    gss_OID *pOid);
 287
 288 OM_uint32
 289 gssEapOidToEnctype(OM_uint32 *minor,
 290                    const gss_OID oid,
 291                    krb5_enctype *enctype);
 292
 293 int
 294 gssEapIsMechanismOid(const gss_OID oid);
 295
 296 int
 297 gssEapIsConcreteMechanismOid(const gss_OID oid);
 298
 299 OM_uint32
 300 gssEapValidateMechs(OM_uint32 *minor,
 301                    const gss_OID_set mechs);
 302
 303 gss_buffer_t
 304 gssEapOidToSaslName(const gss_OID oid);
 305
 306 gss_OID
 307 gssEapSaslNameToOid(const gss_buffer_t name);
 308
 309 /* util_name.c */
 310 #define EXPORT_NAME_FLAG_OID        0x1
 311 #define EXPORT_NAME_FLAG_COMPOSITE  0x2
 312
 313 OM_uint32 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName);
 314 OM_uint32 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName);
 315 OM_uint32 gssEapExportName(OM_uint32 *minor,
 316                            const gss_name_t name,
 317                            gss_buffer_t exportedName);
 318 OM_uint32 gssEapExportNameInternal(OM_uint32 *minor,
 319                                    const gss_name_t name,
 320                                    gss_buffer_t exportedName,
 321                                    unsigned int flags);
 322 OM_uint32 gssEapImportName(OM_uint32 *minor,
 323                            const gss_buffer_t input_name_buffer,
 324                            gss_OID input_name_type,
 325                            gss_name_t *output_name);
 326 OM_uint32 gssEapImportNameInternal(OM_uint32 *minor,
 327                                    const gss_buffer_t input_name_buffer,
 328                                    gss_name_t *output_name,
 329                                    unsigned int flags);
 330 OM_uint32
 331 gssEapDuplicateName(OM_uint32 *minor,
 332                     const gss_name_t input_name,
 333                     gss_name_t *dest_name);
 334
 335 /* util_oid.c */
 336 OM_uint32
 337 composeOid(OM_uint32 *minor_status,
 338            const char *prefix,
 339            size_t prefix_len,
 340            int suffix,
 341            gss_OID_desc *oid);
 342
 343 OM_uint32
 344 decomposeOid(OM_uint32 *minor_status,
 345              const char *prefix,
 346              size_t prefix_len,
 347              gss_OID_desc *oid,
 348              int *suffix) ;
 349
 350 OM_uint32
 351 duplicateOid(OM_uint32 *minor_status,
 352              const gss_OID_desc * const oid,
 353              gss_OID *new_oid);
 354
 355 OM_uint32
 356 duplicateOidSet(OM_uint32 *minor,
 357                 const gss_OID_set src,
 358                 gss_OID_set *dst);
 359
 360 static inline int
 361 oidEqual(const gss_OID_desc *o1, const gss_OID_desc *o2)
 362 {
 363     if (o1 == GSS_C_NO_OID)
 364         return (o2 == GSS_C_NO_OID);
 365     else if (o2 == GSS_C_NO_OID)
 366         return (o1 == GSS_C_NO_OID);
 367     else
 368         return (o1->length == o2->length &&
 369                 memcmp(o1->elements, o2->elements, o1->length) == 0);
 370 }
 371
 372 /* util_ordering.c */
 373 OM_uint32
 374 sequenceInternalize(OM_uint32 *minor,
 375                     void **vqueue,
 376                     unsigned char **buf,
 377                     size_t *lenremain);
 378
 379 OM_uint32
 380 sequenceExternalize(OM_uint32 *minor,
 381                     void *vqueue,
 382                     unsigned char **buf,
 383                     size_t *lenremain);
 384
 385 size_t
 386 sequenceSize(void *vqueue);
 387
 388 OM_uint32
 389 sequenceFree(OM_uint32 *minor, void **vqueue);
 390
 391 OM_uint32
 392 sequenceCheck(OM_uint32 *minor, void **vqueue, uint64_t seqnum);
 393
 394 OM_uint32
 395 sequenceInit(OM_uint32 *minor, void **vqueue, uint64_t seqnum,
 396              int do_replay, int do_sequence, int wide_nums);
 397
 398 /* util_token.c */
 399 size_t
 400 tokenSize(const gss_OID_desc *mech, size_t body_size);
 401
 402 void
 403 makeTokenHeader(const gss_OID_desc *mech,
 404                 size_t body_size,
 405                 unsigned char **buf,
 406                 enum gss_eap_token_type tok_type);
 407
 408 OM_uint32
 409 verifyTokenHeader(OM_uint32 *minor,
 410                   gss_OID mech,
 411                   size_t *body_size,
 412                   unsigned char **buf_in,
 413                   size_t toksize_in,
 414                   enum gss_eap_token_type *ret_tok_type);
 415
 416 /* Helper macros */
 417 #define GSSEAP_CALLOC(count, size)      (calloc((count), (size)))
 418 #define GSSEAP_FREE(ptr)                (free((ptr)))
 419 #define GSSEAP_MALLOC(size)             (malloc((size)))
 420 #define GSSEAP_REALLOC(ptr, size)       (realloc((ptr), (size)))
 421
 422 #define GSSEAP_NOT_IMPLEMENTED          do {            \
 423         assert(0 && "not implemented");                 \
 424         *minor = ENOSYS;                                \
 425         return GSS_S_FAILURE;                           \
 426     } while (0)
 427
 428 #include <pthread.h>
 429
 430 #define GSSEAP_MUTEX                    pthread_mutex_t
 431 #define GSSEAP_MUTEX_INITIALIZER        PTHREAD_MUTEX_INITIALIZER
 432
 433 #define GSSEAP_MUTEX_INIT(m)            pthread_mutex_init((m), NULL)
 434 #define GSSEAP_MUTEX_DESTROY(m)         pthread_mutex_destroy((m))
 435 #define GSSEAP_MUTEX_LOCK(m)            pthread_mutex_lock((m))
 436 #define GSSEAP_MUTEX_UNLOCK(m)          pthread_mutex_unlock((m))
 437
 438 #define GSSEAP_THREAD_KEY               pthread_key_t
 439 #define GSSEAP_KEY_CREATE(k, d)         pthread_key_create((k), (d))
 440 #define GSSEAP_GETSPECIFIC(k)           pthread_getspecific((k))
 441 #define GSSEAP_SETSPECIFIC(k, d)        pthread_setspecific((k), (d))
 442
 443 #define GSSEAP_THREAD_ONCE              pthread_once_t
 444 #define GSSEAP_ONCE(o, i)               pthread_once((o), (i))
 445 #define GSSEAP_ONCE_INITIALIZER         PTHREAD_ONCE_INIT
 446
 447 /* Helper functions */
 448 static inline void
 449 store_uint16_be(uint16_t val, void *vp)
 450 {
 451     unsigned char *p = (unsigned char *)vp;
 452
 453     p[0] = (val >>  8) & 0xff;
 454     p[1] = (val      ) & 0xff;
 455 }
 456
 457 static inline uint16_t
 458 load_uint16_be(const void *cvp)
 459 {
 460     const unsigned char *p = (const unsigned char *)cvp;
 461
 462     return (p[1] | (p[0] << 8));
 463 }
 464
 465 static inline void
 466 store_uint32_be(uint32_t val, void *vp)
 467 {
 468     unsigned char *p = (unsigned char *)vp;
 469
 470     p[0] = (val >> 24) & 0xff;
 471     p[1] = (val >> 16) & 0xff;
 472     p[2] = (val >>  8) & 0xff;
 473     p[3] = (val      ) & 0xff;
 474 }
 475
 476 static inline uint32_t
 477 load_uint32_be(const void *cvp)
 478 {
 479     const unsigned char *p = (const unsigned char *)cvp;
 480
 481     return (p[3] | (p[2] << 8)
 482             | ((uint32_t) p[1] << 16)
 483             | ((uint32_t) p[0] << 24));
 484 }
 485
 486 static inline void
 487 store_uint64_be(uint64_t val, void *vp)
 488 {
 489     unsigned char *p = (unsigned char *)vp;
 490
 491     p[0] = (unsigned char)((val >> 56) & 0xff);
 492     p[1] = (unsigned char)((val >> 48) & 0xff);
 493     p[2] = (unsigned char)((val >> 40) & 0xff);
 494     p[3] = (unsigned char)((val >> 32) & 0xff);
 495     p[4] = (unsigned char)((val >> 24) & 0xff);
 496     p[5] = (unsigned char)((val >> 16) & 0xff);
 497     p[6] = (unsigned char)((val >>  8) & 0xff);
 498     p[7] = (unsigned char)((val      ) & 0xff);
 499 }
 500
 501 static inline uint64_t
 502 load_uint64_be(const void *cvp)
 503 {
 504     const unsigned char *p = (const unsigned char *)cvp;
 505
 506     return ((uint64_t)load_uint32_be(p) << 32) | load_uint32_be(p + 4);
 507 }
 508
 509 static inline unsigned char *
 510 store_buffer(gss_buffer_t buffer, void *vp, int wide_nums)
 511 {
 512     unsigned char *p = (unsigned char *)vp;
 513
 514     if (wide_nums) {
 515         store_uint64_be(buffer->length, p);
 516         p += 8;
 517     } else {
 518         store_uint32_be(buffer->length, p);
 519         p += 4;
 520     }
 521
 522     if (buffer->value != NULL) {
 523         memcpy(p, buffer->value, buffer->length);
 524         p += buffer->length;
 525     }
 526
 527     return p;
 528 }
 529
 530 static inline unsigned char *
 531 load_buffer(const void *cvp, size_t length, gss_buffer_t buffer)
 532 {
 533     buffer->length = 0;
 534     buffer->value = GSSEAP_MALLOC(length);
 535     if (buffer->value == NULL)
 536         return NULL;
 537     buffer->length = length;
 538     memcpy(buffer->value, cvp, length);
 539     return (unsigned char *)cvp + length;
 540 }
 541
 542 static inline unsigned char *
 543 store_oid(gss_OID oid, void *vp)
 544 {
 545     gss_buffer_desc buf;
 546
 547     if (oid != GSS_C_NO_OID) {
 548         buf.length = oid->length;
 549         buf.value = oid->elements;
 550     } else {
 551         buf.length = 0;
 552         buf.value = NULL;
 553     }
 554
 555     return store_buffer(&buf, vp, FALSE);
 556 }
 557
 558 static inline void
 559 krbDataToGssBuffer(krb5_data *data, gss_buffer_t buffer)
 560 {
 561     buffer->value = (void *)data->data;
 562     buffer->length = data->length;
 563 }
 564
 565 static inline void
 566 gssBufferToKrbData(gss_buffer_t buffer, krb5_data *data)
 567 {
 568     data->data = (char *)buffer->value;
 569     data->length = buffer->length;
 570 }
 571
 572 #ifdef __cplusplus
 573 }
 574 #endif
 575
 576 #include "util_attr.h"
 577 #ifdef GSSEAP_ENABLE_REAUTH
 578 #include "util_reauth.h"
 579 #endif
 580
 581 #endif /* _UTIL_H_ */