mech_eap/util.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  * 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 /*
  58  * Utility functions.
  59  */
  60
  61 #ifndef _UTIL_H_
  62 #define _UTIL_H_ 1
  63
  64 #ifdef HAVE_SYS_PARAM_H
  65 #include <sys/param.h>
  66 #endif
  67 #ifdef HAVE_STDINT_H
  68 #include <stdint.h>
  69 #endif
  70 #include <string.h>
  71 #include <errno.h>
  72
  73 #include <krb5.h>
  74
  75 #ifdef WIN32
  76 #define inline __inline
  77 #define snprintf _snprintf
  78 #endif
  79
  80 #ifdef __cplusplus
  81 extern "C" {
  82 #endif
  83
  84 #ifndef MIN
  85 #define MIN(_a,_b)  ((_a)<(_b)?(_a):(_b))
  86 #endif
  87
  88 #if !defined(WIN32) && !(defined(__cplusplus)) || (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4))
  89 #define GSSEAP_UNUSED __attribute__ ((__unused__))
  90 #else
  91 #define GSSEAP_UNUSED
  92 #endif
  93
  94 /* util_buffer.c */
  95 OM_uint32
  96 makeStringBuffer(OM_uint32 *minor,
  97                  const char *string,
  98                  gss_buffer_t buffer);
  99
 100 #define makeStringBufferOrCleanup(src, dst)             \
 101     do {                                                \
 102         major = makeStringBuffer((minor), (src), (dst));\
 103         if (GSS_ERROR(major))                           \
 104             goto cleanup;                               \
 105     } while (0)
 106
 107 OM_uint32
 108 bufferToString(OM_uint32 *minor,
 109                const gss_buffer_t buffer,
 110                char **pString);
 111
 112 OM_uint32
 113 duplicateBuffer(OM_uint32 *minor,
 114                 const gss_buffer_t src,
 115                 gss_buffer_t dst);
 116
 117 #define duplicateBufferOrCleanup(src, dst)              \
 118     do {                                                \
 119         major = duplicateBuffer((minor), (src), (dst)); \
 120         if (GSS_ERROR(major))                           \
 121             goto cleanup;                               \
 122     } while (0)
 123
 124 static inline int
 125 bufferEqual(const gss_buffer_t b1, const gss_buffer_t b2)
 126 {
 127     return (b1->length == b2->length &&
 128             memcmp(b1->value, b2->value, b2->length) == 0);
 129 }
 130
 131 static inline int
 132 bufferEqualString(const gss_buffer_t b1, const char *s)
 133 {
 134     gss_buffer_desc b2;
 135
 136     b2.length = strlen(s);
 137     b2.value = (char *)s;
 138
 139     return bufferEqual(b1, &b2);
 140 }
 141
 142 /* util_cksum.c */
 143 int
 144 gssEapSign(krb5_context context,
 145            krb5_cksumtype type,
 146            size_t rrc,
 147 #ifdef HAVE_HEIMDAL_VERSION
 148            krb5_crypto crypto,
 149 #else
 150            krb5_keyblock *key,
 151 #endif
 152            krb5_keyusage sign_usage,
 153            gss_iov_buffer_desc *iov,
 154            int iov_count);
 155
 156 int
 157 gssEapVerify(krb5_context context,
 158              krb5_cksumtype type,
 159              size_t rrc,
 160 #ifdef HAVE_HEIMDAL_VERSION
 161              krb5_crypto crypto,
 162 #else
 163              krb5_keyblock *key,
 164 #endif
 165              krb5_keyusage sign_usage,
 166              gss_iov_buffer_desc *iov,
 167              int iov_count,
 168              int *valid);
 169
 170 #if 0
 171 OM_uint32
 172 gssEapEncodeGssChannelBindings(OM_uint32 *minor,
 173                                gss_channel_bindings_t chanBindings,
 174                                gss_buffer_t encodedBindings);
 175 #endif
 176
 177 /* util_context.c */
 178 #define EAP_EXPORT_CONTEXT_V1           1
 179
 180 enum gss_eap_token_type {
 181     TOK_TYPE_NONE                    = 0x0000,  /* no token */
 182     TOK_TYPE_MIC                     = 0x0404,  /* RFC 4121 MIC token */
 183     TOK_TYPE_WRAP                    = 0x0504,  /* RFC 4121 wrap token */
 184     TOK_TYPE_EXPORT_NAME             = 0x0401,  /* RFC 2743 exported name */
 185     TOK_TYPE_EXPORT_NAME_COMPOSITE   = 0x0402,  /* exported composite name */
 186     TOK_TYPE_DELETE_CONTEXT          = 0x0405,  /* RFC 2743 delete context */
 187     TOK_TYPE_INITIATOR_CONTEXT       = 0x0601,  /* initiator-sent context token */
 188     TOK_TYPE_ACCEPTOR_CONTEXT        = 0x0602,  /* acceptor-sent context token */
 189 };
 190
 191 /* inner token types and flags */
 192 #define ITOK_TYPE_NONE                  0x00000000
 193 #define ITOK_TYPE_CONTEXT_ERR           0x00000001 /* critical */
 194 #define ITOK_TYPE_ACCEPTOR_NAME_REQ     0x00000002 /* TBD */
 195 #define ITOK_TYPE_ACCEPTOR_NAME_RESP    0x00000003 /* TBD */
 196 #define ITOK_TYPE_EAP_RESP              0x00000004 /* critical, required, if not reauth */
 197 #define ITOK_TYPE_EAP_REQ               0x00000005 /* critical, required, if not reauth */
 198 #define ITOK_TYPE_GSS_CHANNEL_BINDINGS  0x00000006 /* critical, required, if not reauth */
 199 #define ITOK_TYPE_REAUTH_CREDS          0x00000007 /* optional */
 200 #define ITOK_TYPE_REAUTH_REQ            0x00000008 /* optional */
 201 #define ITOK_TYPE_REAUTH_RESP           0x00000009 /* optional */
 202 #define ITOK_TYPE_VERSION_INFO          0x0000000A /* optional */
 203 #define ITOK_TYPE_VENDOR_INFO           0x0000000B /* optional */
 204 #define ITOK_TYPE_GSS_FLAGS             0x0000000C /* optional */
 205 #define ITOK_TYPE_INITIATOR_MIC         0x0000000D /* critical, required, if not reauth */
 206 #define ITOK_TYPE_ACCEPTOR_MIC          0x0000000E /* TBD */
 207
 208 #define ITOK_FLAG_CRITICAL              0x80000000  /* critical, wire flag */
 209 #define ITOK_FLAG_VERIFIED              0x40000000  /* verified, API flag */
 210
 211 #define ITOK_TYPE_MASK                  (~(ITOK_FLAG_CRITICAL | ITOK_FLAG_VERIFIED))
 212
 213 #define GSSEAP_WIRE_FLAGS_MASK          ( GSS_C_MUTUAL_FLAG             | \
 214                                           GSS_C_DCE_STYLE               | \
 215                                           GSS_C_IDENTIFY_FLAG           | \
 216                                           GSS_C_EXTENDED_ERROR_FLAG       )
 217
 218 OM_uint32 gssEapAllocContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
 219 OM_uint32 gssEapReleaseContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
 220
 221 OM_uint32
 222 gssEapMakeToken(OM_uint32 *minor,
 223                 gss_ctx_id_t ctx,
 224                 const gss_buffer_t innerToken,
 225                 enum gss_eap_token_type tokenType,
 226                 gss_buffer_t outputToken);
 227
 228 OM_uint32
 229 gssEapVerifyToken(OM_uint32 *minor,
 230                   gss_ctx_id_t ctx,
 231                   const gss_buffer_t inputToken,
 232                   enum gss_eap_token_type *tokenType,
 233                   gss_buffer_t innerInputToken);
 234
 235 OM_uint32
 236 gssEapContextTime(OM_uint32 *minor,
 237                   gss_ctx_id_t context_handle,
 238                   OM_uint32 *time_rec);
 239
 240 OM_uint32
 241 gssEapMakeTokenMIC(OM_uint32 *minor,
 242                    gss_ctx_id_t ctx,
 243                    gss_buffer_t tokenMIC);
 244
 245 OM_uint32
 246 gssEapVerifyTokenMIC(OM_uint32 *minor,
 247                      gss_ctx_id_t ctx,
 248                      const gss_buffer_t tokenMIC);
 249
 250 /* util_cred.c */
 251 OM_uint32 gssEapAllocCred(OM_uint32 *minor, gss_cred_id_t *pCred);
 252 OM_uint32 gssEapReleaseCred(OM_uint32 *minor, gss_cred_id_t *pCred);
 253
 254 gss_OID
 255 gssEapPrimaryMechForCred(gss_cred_id_t cred);
 256
 257 OM_uint32
 258 gssEapAcquireCred(OM_uint32 *minor,
 259                   const gss_name_t desiredName,
 260                   OM_uint32 timeReq,
 261                   const gss_OID_set desiredMechs,
 262                   int cred_usage,
 263                   gss_cred_id_t *pCred,
 264                   gss_OID_set *pActualMechs,
 265                   OM_uint32 *timeRec);
 266
 267 OM_uint32
 268 gssEapSetCredPassword(OM_uint32 *minor,
 269                       gss_cred_id_t cred,
 270                       const gss_buffer_t password);
 271
 272 OM_uint32
 273 gssEapSetCredService(OM_uint32 *minor,
 274                      gss_cred_id_t cred,
 275                      const gss_name_t target);
 276
 277 OM_uint32
 278 gssEapResolveInitiatorCred(OM_uint32 *minor,
 279                            const gss_cred_id_t cred,
 280                            const gss_name_t target,
 281                            gss_cred_id_t *resolvedCred);
 282
 283 int gssEapCredAvailable(gss_cred_id_t cred, gss_OID mech);
 284
 285 OM_uint32
 286 gssEapInquireCred(OM_uint32 *minor,
 287                   gss_cred_id_t cred,
 288                   gss_name_t *name,
 289                   OM_uint32 *pLifetime,
 290                   gss_cred_usage_t *cred_usage,
 291                   gss_OID_set *mechanisms);
 292
 293 /* util_crypt.c */
 294 int
 295 gssEapEncrypt(krb5_context context, int dce_style, size_t ec,
 296               size_t rrc,
 297 #ifdef HAVE_HEIMDAL_VERSION
 298               krb5_crypto crypto,
 299 #else
 300               krb5_keyblock *key,
 301 #endif
 302               int usage,
 303               gss_iov_buffer_desc *iov, int iov_count);
 304
 305 int
 306 gssEapDecrypt(krb5_context context, int dce_style, size_t ec,
 307               size_t rrc,
 308 #ifdef HAVE_HEIMDAL_VERSION
 309               krb5_crypto crypto,
 310 #else
 311               krb5_keyblock *key,
 312 #endif
 313               int usage,
 314               gss_iov_buffer_desc *iov, int iov_count);
 315
 316 int
 317 gssEapMapCryptoFlag(OM_uint32 type);
 318
 319 gss_iov_buffer_t
 320 gssEapLocateIov(gss_iov_buffer_desc *iov,
 321                 int iov_count,
 322                 OM_uint32 type);
 323
 324 void
 325 gssEapIovMessageLength(gss_iov_buffer_desc *iov,
 326                        int iov_count,
 327                        size_t *data_length,
 328                        size_t *assoc_data_length);
 329
 330 void
 331 gssEapReleaseIov(gss_iov_buffer_desc *iov, int iov_count);
 332
 333 int
 334 gssEapIsIntegrityOnly(gss_iov_buffer_desc *iov, int iov_count);
 335
 336 int
 337 gssEapAllocIov(gss_iov_buffer_t iov, size_t size);
 338
 339 OM_uint32
 340 gssEapDeriveRfc3961Key(OM_uint32 *minor,
 341                        const unsigned char *key,
 342                        size_t keyLength,
 343                        krb5_enctype enctype,
 344                        krb5_keyblock *pKey);
 345
 346 /* util_krb.c */
 347
 348 #ifndef KRB_MALLOC
 349 /*
 350  * If your Kerberos library uses a different allocator to your
 351  * GSS mechanism glue, then you might wish to define these in
 352  * config.h or elsewhere. This should eventually go away when
 353  * we no longer need to allocate memory that is freed by the
 354  * Kerberos library.
 355  */
 356 #define KRB_CALLOC                      calloc
 357 #define KRB_MALLOC                      malloc
 358 #define KRB_FREE                        free
 359 #define KRB_REALLOC                     realloc
 360 #endif /* KRB_MALLOC */
 361
 362 #ifdef HAVE_HEIMDAL_VERSION
 363
 364 #define KRB_TIME_FOREVER        ((time_t)~0L)
 365
 366 #define KRB_KEY_TYPE(key)       ((key)->keytype)
 367 #define KRB_KEY_DATA(key)       ((key)->keyvalue.data)
 368 #define KRB_KEY_LENGTH(key)     ((key)->keyvalue.length)
 369
 370 #define KRB_PRINC_LENGTH(princ) ((princ)->name.name_string.len)
 371 #define KRB_PRINC_TYPE(princ)   ((princ)->name.name_type)
 372 #define KRB_PRINC_NAME(princ)   ((princ)->name.name_string.val)
 373 #define KRB_PRINC_REALM(princ)  ((princ)->realm)
 374
 375 #define KRB_KT_ENT_KEYBLOCK(e)  (&(e)->keyblock)
 376 #define KRB_KT_ENT_FREE(c, e)   krb5_kt_free_entry((c), (e))
 377
 378 #define KRB_CRYPTO_CONTEXT(ctx) (krbCrypto)
 379
 380 #define KRB_DATA_INIT(d)        krb5_data_zero((d))
 381
 382 #else
 383
 384 #define KRB_TIME_FOREVER        KRB5_INT32_MAX
 385
 386 #define KRB_KEY_TYPE(key)       ((key)->enctype)
 387 #define KRB_KEY_DATA(key)       ((key)->contents)
 388 #define KRB_KEY_LENGTH(key)     ((key)->length)
 389
 390 #define KRB_PRINC_LENGTH(princ) (krb5_princ_size(NULL, (princ)))
 391 #define KRB_PRINC_TYPE(princ)   (krb5_princ_type(NULL, (princ)))
 392 #define KRB_PRINC_NAME(princ)   (krb5_princ_name(NULL, (princ)))
 393 #define KRB_PRINC_REALM(princ)  (krb5_princ_realm(NULL, (princ)))
 394 #define KRB_PRINC_COMPONENT(princ, component) \
 395         (krb5_princ_component(NULL, (princ), (component)))
 396
 397 #define KRB_KT_ENT_KEYBLOCK(e)  (&(e)->key)
 398 #define KRB_KT_ENT_FREE(c, e)   krb5_free_keytab_entry_contents((c), (e))
 399
 400 #define KRB_CRYPTO_CONTEXT(ctx) (&(ctx)->rfc3961Key)
 401
 402 #define KRB_DATA_INIT(d)        do {        \
 403         (d)->magic = KV5M_DATA;             \
 404         (d)->length = 0;                    \
 405         (d)->data = NULL;                   \
 406     } while (0)
 407
 408 #endif /* HAVE_HEIMDAL_VERSION */
 409
 410 #define KRB_KEY_INIT(key)       do {        \
 411         KRB_KEY_TYPE(key) = ENCTYPE_NULL;   \
 412         KRB_KEY_DATA(key) = NULL;           \
 413         KRB_KEY_LENGTH(key) = 0;            \
 414     } while (0)
 415
 416 #define GSSEAP_KRB_INIT(ctx) do {                   \
 417         OM_uint32 tmpMajor;                         \
 418                                                     \
 419         tmpMajor  = gssEapKerberosInit(minor, ctx); \
 420         if (GSS_ERROR(tmpMajor)) {                  \
 421             return tmpMajor;                        \
 422         }                                           \
 423     } while (0)
 424
 425 OM_uint32
 426 gssEapKerberosInit(OM_uint32 *minor, krb5_context *context);
 427
 428 OM_uint32
 429 rfc3961ChecksumTypeForKey(OM_uint32 *minor,
 430                           krb5_keyblock *key,
 431                           krb5_cksumtype *cksumtype);
 432
 433 krb5_error_code
 434 krbCryptoLength(krb5_context krbContext,
 435 #ifdef HAVE_HEIMDAL_VERSION
 436                 krb5_crypto krbCrypto,
 437 #else
 438                 krb5_keyblock *key,
 439 #endif
 440                 int type,
 441                 size_t *length);
 442
 443 krb5_error_code
 444 krbPaddingLength(krb5_context krbContext,
 445 #ifdef HAVE_HEIMDAL_VERSION
 446                  krb5_crypto krbCrypto,
 447 #else
 448                  krb5_keyblock *key,
 449 #endif
 450                  size_t dataLength,
 451                  size_t *padLength);
 452
 453 krb5_error_code
 454 krbBlockSize(krb5_context krbContext,
 455 #ifdef HAVE_HEIMDAL_VERSION
 456                  krb5_crypto krbCrypto,
 457 #else
 458                  krb5_keyblock *key,
 459 #endif
 460                  size_t *blockSize);
 461
 462 krb5_error_code
 463 krbEnctypeToString(krb5_context krbContext,
 464                    krb5_enctype enctype,
 465                    const char *prefix,
 466                    gss_buffer_t string);
 467
 468 krb5_error_code
 469 krbMakeAuthDataKdcIssued(krb5_context context,
 470                          const krb5_keyblock *key,
 471                          krb5_const_principal issuer,
 472 #ifdef HAVE_HEIMDAL_VERSION
 473                          const AuthorizationData *authdata,
 474                          AuthorizationData *adKdcIssued
 475 #else
 476                          krb5_authdata *const *authdata,
 477                          krb5_authdata ***adKdcIssued
 478 #endif
 479                          );
 480
 481 krb5_error_code
 482 krbMakeCred(krb5_context context,
 483             krb5_auth_context authcontext,
 484             krb5_creds *creds,
 485             krb5_data *data);
 486
 487 /* util_lucid.c */
 488 OM_uint32
 489 gssEapExportLucidSecContext(OM_uint32 *minor,
 490                             gss_ctx_id_t ctx,
 491                             const gss_OID desiredObject,
 492                             gss_buffer_set_t *data_set);
 493
 494 /* util_mech.c */
 495 extern gss_OID GSS_EAP_MECHANISM;
 496
 497 #define OID_FLAG_NULL_VALID                 0x00000001
 498 #define OID_FLAG_FAMILY_MECH_VALID          0x00000002
 499 #define OID_FLAG_MAP_NULL_TO_DEFAULT_MECH   0x00000004
 500 #define OID_FLAG_MAP_FAMILY_MECH_TO_NULL    0x00000008
 501
 502 OM_uint32
 503 gssEapCanonicalizeOid(OM_uint32 *minor,
 504                       const gss_OID oid,
 505                       OM_uint32 flags,
 506                       gss_OID *pOid);
 507
 508 OM_uint32
 509 gssEapReleaseOid(OM_uint32 *minor, gss_OID *oid);
 510
 511 OM_uint32
 512 gssEapDefaultMech(OM_uint32 *minor,
 513                   gss_OID *oid);
 514
 515 OM_uint32
 516 gssEapIndicateMechs(OM_uint32 *minor,
 517                     gss_OID_set *mechs);
 518
 519 OM_uint32
 520 gssEapEnctypeToOid(OM_uint32 *minor,
 521                    krb5_enctype enctype,
 522                    gss_OID *pOid);
 523
 524 OM_uint32
 525 gssEapOidToEnctype(OM_uint32 *minor,
 526                    const gss_OID oid,
 527                    krb5_enctype *enctype);
 528
 529 int
 530 gssEapIsMechanismOid(const gss_OID oid);
 531
 532 int
 533 gssEapIsConcreteMechanismOid(const gss_OID oid);
 534
 535 OM_uint32
 536 gssEapValidateMechs(OM_uint32 *minor,
 537                    const gss_OID_set mechs);
 538
 539 gss_buffer_t
 540 gssEapOidToSaslName(const gss_OID oid);
 541
 542 gss_OID
 543 gssEapSaslNameToOid(const gss_buffer_t name);
 544
 545 /* util_moonshot.c */
 546 OM_uint32
 547 libMoonshotResolveDefaultIdentity(OM_uint32 *minor,
 548                                   const gss_cred_id_t cred,
 549                                   gss_name_t *pName);
 550
 551 OM_uint32
 552 libMoonshotResolveInitiatorCred(OM_uint32 *minor,
 553                                 gss_cred_id_t cred,
 554                                 const gss_name_t targetName);
 555
 556 /* util_name.c */
 557 #define EXPORT_NAME_FLAG_OID                    0x1
 558 #define EXPORT_NAME_FLAG_COMPOSITE              0x2
 559 #define EXPORT_NAME_FLAG_ALLOW_COMPOSITE        0x4
 560
 561 OM_uint32 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName);
 562 OM_uint32 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName);
 563 OM_uint32 gssEapExportName(OM_uint32 *minor,
 564                            const gss_name_t name,
 565                            gss_buffer_t exportedName);
 566 OM_uint32 gssEapExportNameInternal(OM_uint32 *minor,
 567                                    const gss_name_t name,
 568                                    gss_buffer_t exportedName,
 569                                    OM_uint32 flags);
 570 OM_uint32 gssEapImportName(OM_uint32 *minor,
 571                            const gss_buffer_t input_name_buffer,
 572                            const gss_OID input_name_type,
 573                            const gss_OID input_mech_type,
 574                            gss_name_t *output_name);
 575 OM_uint32 gssEapImportNameInternal(OM_uint32 *minor,
 576                                    const gss_buffer_t input_name_buffer,
 577                                    gss_name_t *output_name,
 578                                    OM_uint32 flags);
 579 OM_uint32
 580 gssEapDuplicateName(OM_uint32 *minor,
 581                     const gss_name_t input_name,
 582                     gss_name_t *dest_name);
 583
 584 OM_uint32
 585 gssEapCanonicalizeName(OM_uint32 *minor,
 586                        const gss_name_t input_name,
 587                        const gss_OID mech_type,
 588                        gss_name_t *dest_name);
 589
 590 OM_uint32
 591 gssEapDisplayName(OM_uint32 *minor,
 592                   gss_name_t name,
 593                   gss_buffer_t output_name_buffer,
 594                   gss_OID *output_name_type);
 595
 596 OM_uint32
 597 gssEapCompareName(OM_uint32 *minor,
 598                   gss_name_t name1,
 599                   gss_name_t name2,
 600                   int *name_equal);
 601
 602 /* util_oid.c */
 603 OM_uint32
 604 composeOid(OM_uint32 *minor_status,
 605            const char *prefix,
 606            size_t prefix_len,
 607            int suffix,
 608            gss_OID_desc *oid);
 609
 610 OM_uint32
 611 decomposeOid(OM_uint32 *minor_status,
 612              const char *prefix,
 613              size_t prefix_len,
 614              gss_OID_desc *oid,
 615              int *suffix) ;
 616
 617 OM_uint32
 618 duplicateOid(OM_uint32 *minor_status,
 619              const gss_OID_desc * const oid,
 620              gss_OID *new_oid);
 621
 622 OM_uint32
 623 duplicateOidSet(OM_uint32 *minor,
 624                 const gss_OID_set src,
 625                 gss_OID_set *dst);
 626
 627 static inline int
 628 oidEqual(const gss_OID_desc *o1, const gss_OID_desc *o2)
 629 {
 630     if (o1 == GSS_C_NO_OID)
 631         return (o2 == GSS_C_NO_OID);
 632     else if (o2 == GSS_C_NO_OID)
 633         return (o1 == GSS_C_NO_OID);
 634     else
 635         return (o1->length == o2->length &&
 636                 memcmp(o1->elements, o2->elements, o1->length) == 0);
 637 }
 638
 639 /* util_ordering.c */
 640 OM_uint32
 641 sequenceInternalize(OM_uint32 *minor,
 642                     void **vqueue,
 643                     unsigned char **buf,
 644                     size_t *lenremain);
 645
 646 OM_uint32
 647 sequenceExternalize(OM_uint32 *minor,
 648                     void *vqueue,
 649                     unsigned char **buf,
 650                     size_t *lenremain);
 651
 652 size_t
 653 sequenceSize(void *vqueue);
 654
 655 OM_uint32
 656 sequenceFree(OM_uint32 *minor, void **vqueue);
 657
 658 OM_uint32
 659 sequenceCheck(OM_uint32 *minor, void **vqueue, uint64_t seqnum);
 660
 661 OM_uint32
 662 sequenceInit(OM_uint32 *minor, void **vqueue, uint64_t seqnum,
 663              int do_replay, int do_sequence, int wide_nums);
 664
 665 /* util_sm.c */
 666 enum gss_eap_state {
 667     GSSEAP_STATE_INITIAL        = 0x01,     /* initial state */
 668     GSSEAP_STATE_AUTHENTICATE   = 0x02,     /* exchange EAP messages */
 669     GSSEAP_STATE_INITIATOR_EXTS = 0x04,     /* initiator extensions */
 670     GSSEAP_STATE_ACCEPTOR_EXTS  = 0x08,     /* acceptor extensions */
 671 #ifdef GSSEAP_ENABLE_REAUTH
 672     GSSEAP_STATE_REAUTHENTICATE = 0x10,     /* GSS reauthentication messages */
 673 #endif
 674     GSSEAP_STATE_ESTABLISHED    = 0x20,     /* context established */
 675     GSSEAP_STATE_ALL            = 0x3F
 676 };
 677
 678 #define GSSEAP_STATE_NEXT(s)    ((s) << 1)
 679
 680 #define GSSEAP_SM_STATE(ctx)                ((ctx)->state)
 681
 682 #ifdef GSSEAP_DEBUG
 683 void gssEapSmTransition(gss_ctx_id_t ctx, enum gss_eap_state state);
 684 #define GSSEAP_SM_TRANSITION(ctx, state)    gssEapSmTransition((ctx), (state))
 685 #else
 686 #define GSSEAP_SM_TRANSITION(ctx, newstate)    do { (ctx)->state = (newstate); } while (0)
 687 #endif
 688
 689 #define GSSEAP_SM_TRANSITION_NEXT(ctx)      GSSEAP_SM_TRANSITION((ctx), GSSEAP_STATE_NEXT(GSSEAP_SM_STATE((ctx))))
 690
 691 /* state machine entry */
 692 struct gss_eap_sm {
 693     OM_uint32 inputTokenType;
 694     OM_uint32 outputTokenType;
 695     enum gss_eap_state validStates;
 696     OM_uint32 itokFlags;
 697     OM_uint32 (*processToken)(OM_uint32 *,
 698                               gss_cred_id_t,
 699                               gss_ctx_id_t,
 700                               gss_name_t,
 701                               gss_OID,
 702                               OM_uint32,
 703                               OM_uint32,
 704                               gss_channel_bindings_t,
 705                               gss_buffer_t,
 706                               gss_buffer_t,
 707                               OM_uint32 *);
 708 };
 709
 710 /* state machine flags, set by handler */
 711 #define SM_FLAG_FORCE_SEND_TOKEN            0x00000001  /* send token even if no inner tokens */
 712 #define SM_FLAG_OUTPUT_TOKEN_CRITICAL       0x00000002  /* output token is critical */
 713
 714 /* state machine flags, set by state machine */
 715 #define SM_FLAG_INPUT_TOKEN_CRITICAL        0x10000000  /* input token was critical */
 716
 717 #define SM_ITOK_FLAG_REQUIRED               0x00000001  /* received tokens must be present */
 718
 719 OM_uint32
 720 gssEapSmStep(OM_uint32 *minor,
 721              gss_cred_id_t cred,
 722              gss_ctx_id_t ctx,
 723              gss_name_t target,
 724              gss_OID mech,
 725              OM_uint32 reqFlags,
 726              OM_uint32 timeReq,
 727              gss_channel_bindings_t chanBindings,
 728              gss_buffer_t inputToken,
 729              gss_buffer_t outputToken,
 730              struct gss_eap_sm *sm,
 731              size_t smCount);
 732
 733 void
 734 gssEapSmTransition(gss_ctx_id_t ctx, enum gss_eap_state state);
 735
 736 /* util_token.c */
 737 struct gss_eap_token_buffer_set {
 738     gss_buffer_set_desc buffers; /* pointers only */
 739     OM_uint32 *types;
 740 };
 741
 742 OM_uint32
 743 gssEapEncodeInnerTokens(OM_uint32 *minor,
 744                         struct gss_eap_token_buffer_set *tokens,
 745                         gss_buffer_t buffer);
 746 OM_uint32
 747 gssEapDecodeInnerTokens(OM_uint32 *minor,
 748                         const gss_buffer_t buffer,
 749                         struct gss_eap_token_buffer_set *tokens);
 750
 751 OM_uint32
 752 gssEapReleaseInnerTokens(OM_uint32 *minor,
 753                          struct gss_eap_token_buffer_set *tokens,
 754                          int freeBuffers);
 755
 756 OM_uint32
 757 gssEapAllocInnerTokens(OM_uint32 *minor,
 758                        size_t count,
 759                        struct gss_eap_token_buffer_set *tokens);
 760
 761 size_t
 762 tokenSize(const gss_OID_desc *mech, size_t body_size);
 763
 764 void
 765 makeTokenHeader(const gss_OID_desc *mech,
 766                 size_t body_size,
 767                 unsigned char **buf,
 768                 enum gss_eap_token_type tok_type);
 769
 770 OM_uint32
 771 verifyTokenHeader(OM_uint32 *minor,
 772                   gss_OID mech,
 773                   size_t *body_size,
 774                   unsigned char **buf_in,
 775                   size_t toksize_in,
 776                   enum gss_eap_token_type *ret_tok_type);
 777
 778 /* Helper macros */
 779 #if _WIN32
 780 #include <gssapi/gssapi_alloc.h>
 781 #define GSSEAP_MALLOC gssalloc_malloc
 782 #define GSSEAP_CALLOC gssalloc_calloc
 783 #define GSSEAP_FREE gssalloc_free
 784 #define GSSEAP_REALLOC gssalloc_realloc
 785 #endif
 786
 787 #ifndef GSSEAP_MALLOC
 788 #define GSSEAP_CALLOC                   calloc
 789 #define GSSEAP_MALLOC                   malloc
 790 #define GSSEAP_FREE                     free
 791 #define GSSEAP_REALLOC                  realloc
 792 #endif
 793
 794 #ifndef GSSAPI_CALLCONV
 795 #define GSSAPI_CALLCONV                 KRB5_CALLCONV
 796 #endif
 797
 798 #ifndef GSSEAP_ASSERT
 799 #include <assert.h>
 800 #define GSSEAP_ASSERT(x)                assert((x))
 801 #endif /* !GSSEAP_ASSERT */
 802
 803 #ifdef WIN32
 804 #define GSSEAP_CONSTRUCTOR
 805 #define GSSEAP_DESTRUCTOR
 806 #else
 807 #define GSSEAP_CONSTRUCTOR              __attribute__((constructor))
 808 #define GSSEAP_DESTRUCTOR               __attribute__((destructor))
 809 #endif
 810
 811 #define GSSEAP_NOT_IMPLEMENTED          do {            \
 812         GSSEAP_ASSERT(0 && "not implemented");          \
 813         *minor = ENOSYS;                                \
 814         return GSS_S_FAILURE;                           \
 815     } while (0)
 816
 817 #ifdef WIN32
 818
 819 #include <winbase.h>
 820
 821 #define GSSEAP_GET_LAST_ERROR()         (GetLastError()) /* XXX FIXME */
 822
 823 #define GSSEAP_MUTEX                    CRITICAL_SECTION
 824 #define GSSEAP_MUTEX_INIT(m)            (InitializeCriticalSection((m)), 0)
 825 #define GSSEAP_MUTEX_DESTROY(m)         DeleteCriticalSection((m))
 826 #define GSSEAP_MUTEX_LOCK(m)            EnterCriticalSection((m))
 827 #define GSSEAP_MUTEX_UNLOCK(m)          LeaveCriticalSection((m))
 828 #define GSSEAP_ONCE_LEAVE               do { return TRUE; } while (0)
 829
 830 /* Thread-local is handled separately */
 831
 832 #define GSSEAP_THREAD_ONCE              INIT_ONCE
 833 #define GSSEAP_ONCE_CALLBACK(cb)        BOOL CALLBACK cb(PINIT_ONCE InitOnce, PVOID Parameter, PVOID *Context)
 834 #define GSSEAP_ONCE(o, i)               InitOnceExecuteOnce((o), (i), NULL, NULL)
 835 #define GSSEAP_ONCE_INITIALIZER         INIT_ONCE_STATIC_INIT
 836
 837 #else
 838
 839 #include <pthread.h>
 840
 841 #define GSSEAP_GET_LAST_ERROR()         (errno)
 842
 843 #define GSSEAP_MUTEX                    pthread_mutex_t
 844 #define GSSEAP_MUTEX_INIT(m)            pthread_mutex_init((m), NULL)
 845 #define GSSEAP_MUTEX_DESTROY(m)         pthread_mutex_destroy((m))
 846 #define GSSEAP_MUTEX_LOCK(m)            pthread_mutex_lock((m))
 847 #define GSSEAP_MUTEX_UNLOCK(m)          pthread_mutex_unlock((m))
 848
 849 #define GSSEAP_THREAD_KEY               pthread_key_t
 850 #define GSSEAP_KEY_CREATE(k, d)         pthread_key_create((k), (d))
 851 #define GSSEAP_GETSPECIFIC(k)           pthread_getspecific((k))
 852 #define GSSEAP_SETSPECIFIC(k, d)        pthread_setspecific((k), (d))
 853
 854 #define GSSEAP_THREAD_ONCE              pthread_once_t
 855 #define GSSEAP_ONCE_CALLBACK(cb)        void cb(void)
 856 #define GSSEAP_ONCE(o, i)               pthread_once((o), (i))
 857 #define GSSEAP_ONCE_INITIALIZER         PTHREAD_ONCE_INIT
 858 #define GSSEAP_ONCE_LEAVE               do { } while (0)
 859
 860 #endif /* WIN32 */
 861
 862 /* Helper functions */
 863 static inline void
 864 store_uint16_be(uint16_t val, void *vp)
 865 {
 866     unsigned char *p = (unsigned char *)vp;
 867
 868     p[0] = (val >>  8) & 0xff;
 869     p[1] = (val      ) & 0xff;
 870 }
 871
 872 static inline uint16_t
 873 load_uint16_be(const void *cvp)
 874 {
 875     const unsigned char *p = (const unsigned char *)cvp;
 876
 877     return (p[1] | (p[0] << 8));
 878 }
 879
 880 static inline void
 881 store_uint32_be(uint32_t val, void *vp)
 882 {
 883     unsigned char *p = (unsigned char *)vp;
 884
 885     p[0] = (val >> 24) & 0xff;
 886     p[1] = (val >> 16) & 0xff;
 887     p[2] = (val >>  8) & 0xff;
 888     p[3] = (val      ) & 0xff;
 889 }
 890
 891 static inline uint32_t
 892 load_uint32_be(const void *cvp)
 893 {
 894     const unsigned char *p = (const unsigned char *)cvp;
 895
 896     return (p[3] | (p[2] << 8)
 897             | ((uint32_t) p[1] << 16)
 898             | ((uint32_t) p[0] << 24));
 899 }
 900
 901 static inline void
 902 store_uint64_be(uint64_t val, void *vp)
 903 {
 904     unsigned char *p = (unsigned char *)vp;
 905
 906     p[0] = (unsigned char)((val >> 56) & 0xff);
 907     p[1] = (unsigned char)((val >> 48) & 0xff);
 908     p[2] = (unsigned char)((val >> 40) & 0xff);
 909     p[3] = (unsigned char)((val >> 32) & 0xff);
 910     p[4] = (unsigned char)((val >> 24) & 0xff);
 911     p[5] = (unsigned char)((val >> 16) & 0xff);
 912     p[6] = (unsigned char)((val >>  8) & 0xff);
 913     p[7] = (unsigned char)((val      ) & 0xff);
 914 }
 915
 916 static inline uint64_t
 917 load_uint64_be(const void *cvp)
 918 {
 919     const unsigned char *p = (const unsigned char *)cvp;
 920
 921     return ((uint64_t)load_uint32_be(p) << 32) | load_uint32_be(p + 4);
 922 }
 923
 924 static inline unsigned char *
 925 store_buffer(gss_buffer_t buffer, void *vp, int wide_nums)
 926 {
 927     unsigned char *p = (unsigned char *)vp;
 928
 929     if (wide_nums) {
 930         store_uint64_be(buffer->length, p);
 931         p += 8;
 932     } else {
 933         store_uint32_be(buffer->length, p);
 934         p += 4;
 935     }
 936
 937     if (buffer->value != NULL) {
 938         memcpy(p, buffer->value, buffer->length);
 939         p += buffer->length;
 940     }
 941
 942     return p;
 943 }
 944
 945 static inline unsigned char *
 946 load_buffer(const void *cvp, size_t length, gss_buffer_t buffer)
 947 {
 948     buffer->length = 0;
 949     buffer->value = GSSEAP_MALLOC(length);
 950     if (buffer->value == NULL)
 951         return NULL;
 952     buffer->length = length;
 953     memcpy(buffer->value, cvp, length);
 954     return (unsigned char *)cvp + length;
 955 }
 956
 957 static inline unsigned char *
 958 store_oid(gss_OID oid, void *vp)
 959 {
 960     gss_buffer_desc buf;
 961
 962     if (oid != GSS_C_NO_OID) {
 963         buf.length = oid->length;
 964         buf.value = oid->elements;
 965     } else {
 966         buf.length = 0;
 967         buf.value = NULL;
 968     }
 969
 970     return store_buffer(&buf, vp, FALSE);
 971 }
 972
 973 static inline void
 974 krbDataToGssBuffer(krb5_data *data, gss_buffer_t buffer)
 975 {
 976     buffer->value = (void *)data->data;
 977     buffer->length = data->length;
 978 }
 979
 980 static inline void
 981 krbPrincComponentToGssBuffer(krb5_principal krbPrinc,
 982                              int index, gss_buffer_t buffer)
 983 {
 984 #ifdef HAVE_HEIMDAL_VERSION
 985     buffer->value = (void *)KRB_PRINC_NAME(krbPrinc)[index];
 986     buffer->length = strlen((char *)buffer->value);
 987 #else
 988     buffer->value = (void *)krb5_princ_component(NULL, krbPrinc, index)->data;
 989     buffer->length = krb5_princ_component(NULL, krbPrinc, index)->length;
 990 #endif /* HAVE_HEIMDAL_VERSION */
 991 }
 992
 993 static inline void
 994 krbPrincRealmToGssBuffer(krb5_principal krbPrinc, gss_buffer_t buffer)
 995 {
 996 #ifdef HAVE_HEIMDAL_VERSION
 997     buffer->value = (void *)KRB_PRINC_REALM(krbPrinc);
 998     buffer->length = strlen((char *)buffer->value);
 999 #else
1000     krbDataToGssBuffer(KRB_PRINC_REALM(krbPrinc), buffer);
1001 #endif
1002 }
1003
1004 static inline void
1005 gssBufferToKrbData(gss_buffer_t buffer, krb5_data *data)
1006 {
1007     data->data = (char *)buffer->value;
1008     data->length = buffer->length;
1009 }
1010
1011 /* util_tld.c */
1012 struct gss_eap_status_info;
1013
1014 struct gss_eap_thread_local_data {
1015     krb5_context krbContext;
1016     struct gss_eap_status_info *statusInfo;
1017 };
1018
1019 struct gss_eap_thread_local_data *
1020 gssEapGetThreadLocalData(void);
1021
1022 void
1023 gssEapDestroyStatusInfo(struct gss_eap_status_info *status);
1024
1025 void
1026 gssEapDestroyKrbContext(krb5_context context);
1027
1028 #ifdef __cplusplus
1029 }
1030 #endif
1031
1032 #ifdef GSSEAP_ENABLE_ACCEPTOR
1033 #include "util_json.h"
1034 #include "util_attr.h"
1035 #include "util_base64.h"
1036 #endif /* GSSEAP_ENABLE_ACCEPTOR */
1037 #ifdef GSSEAP_ENABLE_REAUTH
1038 #include "util_reauth.h"
1039 #endif
1040
1041 #endif /* _UTIL_H_ */