moonshot/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
 395 #define KRB_KT_ENT_KEYBLOCK(e)  (&(e)->key)
 396 #define KRB_KT_ENT_FREE(c, e)   krb5_free_keytab_entry_contents((c), (e))
 397
 398 #define KRB_CRYPTO_CONTEXT(ctx) (&(ctx)->rfc3961Key)
 399
 400 #define KRB_DATA_INIT(d)        do {        \
 401         (d)->magic = KV5M_DATA;             \
 402         (d)->length = 0;                    \
 403         (d)->data = NULL;                   \
 404     } while (0)
 405
 406 #endif /* HAVE_HEIMDAL_VERSION */
 407
 408 #define KRB_KEY_INIT(key)       do {        \
 409         KRB_KEY_TYPE(key) = ENCTYPE_NULL;   \
 410         KRB_KEY_DATA(key) = NULL;           \
 411         KRB_KEY_LENGTH(key) = 0;            \
 412     } while (0)
 413
 414 #define GSSEAP_KRB_INIT(ctx) do {                   \
 415         OM_uint32 tmpMajor;                         \
 416                                                     \
 417         tmpMajor  = gssEapKerberosInit(minor, ctx); \
 418         if (GSS_ERROR(tmpMajor)) {                  \
 419             return tmpMajor;                        \
 420         }                                           \
 421     } while (0)
 422
 423 OM_uint32
 424 gssEapKerberosInit(OM_uint32 *minor, krb5_context *context);
 425
 426 OM_uint32
 427 rfc3961ChecksumTypeForKey(OM_uint32 *minor,
 428                           krb5_keyblock *key,
 429                           krb5_cksumtype *cksumtype);
 430
 431 krb5_error_code
 432 krbCryptoLength(krb5_context krbContext,
 433 #ifdef HAVE_HEIMDAL_VERSION
 434                 krb5_crypto krbCrypto,
 435 #else
 436                 krb5_keyblock *key,
 437 #endif
 438                 int type,
 439                 size_t *length);
 440
 441 krb5_error_code
 442 krbPaddingLength(krb5_context krbContext,
 443 #ifdef HAVE_HEIMDAL_VERSION
 444                  krb5_crypto krbCrypto,
 445 #else
 446                  krb5_keyblock *key,
 447 #endif
 448                  size_t dataLength,
 449                  size_t *padLength);
 450
 451 krb5_error_code
 452 krbBlockSize(krb5_context krbContext,
 453 #ifdef HAVE_HEIMDAL_VERSION
 454                  krb5_crypto krbCrypto,
 455 #else
 456                  krb5_keyblock *key,
 457 #endif
 458                  size_t *blockSize);
 459
 460 krb5_error_code
 461 krbEnctypeToString(krb5_context krbContext,
 462                    krb5_enctype enctype,
 463                    const char *prefix,
 464                    gss_buffer_t string);
 465
 466 krb5_error_code
 467 krbMakeAuthDataKdcIssued(krb5_context context,
 468                          const krb5_keyblock *key,
 469                          krb5_const_principal issuer,
 470 #ifdef HAVE_HEIMDAL_VERSION
 471                          const AuthorizationData *authdata,
 472                          AuthorizationData *adKdcIssued
 473 #else
 474                          krb5_authdata *const *authdata,
 475                          krb5_authdata ***adKdcIssued
 476 #endif
 477                          );
 478
 479 krb5_error_code
 480 krbMakeCred(krb5_context context,
 481             krb5_auth_context authcontext,
 482             krb5_creds *creds,
 483             krb5_data *data);
 484
 485 /* util_lucid.c */
 486 OM_uint32
 487 gssEapExportLucidSecContext(OM_uint32 *minor,
 488                             gss_ctx_id_t ctx,
 489                             const gss_OID desiredObject,
 490                             gss_buffer_set_t *data_set);
 491
 492 /* util_mech.c */
 493 extern gss_OID GSS_EAP_MECHANISM;
 494
 495 #define OID_FLAG_NULL_VALID                 0x00000001
 496 #define OID_FLAG_FAMILY_MECH_VALID          0x00000002
 497 #define OID_FLAG_MAP_NULL_TO_DEFAULT_MECH   0x00000004
 498 #define OID_FLAG_MAP_FAMILY_MECH_TO_NULL    0x00000008
 499
 500 OM_uint32
 501 gssEapCanonicalizeOid(OM_uint32 *minor,
 502                       const gss_OID oid,
 503                       OM_uint32 flags,
 504                       gss_OID *pOid);
 505
 506 OM_uint32
 507 gssEapReleaseOid(OM_uint32 *minor, gss_OID *oid);
 508
 509 OM_uint32
 510 gssEapDefaultMech(OM_uint32 *minor,
 511                   gss_OID *oid);
 512
 513 OM_uint32
 514 gssEapIndicateMechs(OM_uint32 *minor,
 515                     gss_OID_set *mechs);
 516
 517 OM_uint32
 518 gssEapEnctypeToOid(OM_uint32 *minor,
 519                    krb5_enctype enctype,
 520                    gss_OID *pOid);
 521
 522 OM_uint32
 523 gssEapOidToEnctype(OM_uint32 *minor,
 524                    const gss_OID oid,
 525                    krb5_enctype *enctype);
 526
 527 int
 528 gssEapIsMechanismOid(const gss_OID oid);
 529
 530 int
 531 gssEapIsConcreteMechanismOid(const gss_OID oid);
 532
 533 OM_uint32
 534 gssEapValidateMechs(OM_uint32 *minor,
 535                    const gss_OID_set mechs);
 536
 537 gss_buffer_t
 538 gssEapOidToSaslName(const gss_OID oid);
 539
 540 gss_OID
 541 gssEapSaslNameToOid(const gss_buffer_t name);
 542
 543 /* util_moonshot.c */
 544 OM_uint32
 545 libMoonshotResolveDefaultIdentity(OM_uint32 *minor,
 546                                   const gss_cred_id_t cred,
 547                                   gss_name_t *pName);
 548
 549 OM_uint32
 550 libMoonshotResolveInitiatorCred(OM_uint32 *minor,
 551                                 gss_cred_id_t cred,
 552                                 const gss_name_t targetName);
 553
 554 /* util_name.c */
 555 #define EXPORT_NAME_FLAG_OID                    0x1
 556 #define EXPORT_NAME_FLAG_COMPOSITE              0x2
 557 #define EXPORT_NAME_FLAG_ALLOW_COMPOSITE        0x4
 558
 559 OM_uint32 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName);
 560 OM_uint32 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName);
 561 OM_uint32 gssEapExportName(OM_uint32 *minor,
 562                            const gss_name_t name,
 563                            gss_buffer_t exportedName);
 564 OM_uint32 gssEapExportNameInternal(OM_uint32 *minor,
 565                                    const gss_name_t name,
 566                                    gss_buffer_t exportedName,
 567                                    OM_uint32 flags);
 568 OM_uint32 gssEapImportName(OM_uint32 *minor,
 569                            const gss_buffer_t input_name_buffer,
 570                            const gss_OID input_name_type,
 571                            const gss_OID input_mech_type,
 572                            gss_name_t *output_name);
 573 OM_uint32 gssEapImportNameInternal(OM_uint32 *minor,
 574                                    const gss_buffer_t input_name_buffer,
 575                                    gss_name_t *output_name,
 576                                    OM_uint32 flags);
 577 OM_uint32
 578 gssEapDuplicateName(OM_uint32 *minor,
 579                     const gss_name_t input_name,
 580                     gss_name_t *dest_name);
 581
 582 OM_uint32
 583 gssEapCanonicalizeName(OM_uint32 *minor,
 584                        const gss_name_t input_name,
 585                        const gss_OID mech_type,
 586                        gss_name_t *dest_name);
 587
 588 OM_uint32
 589 gssEapDisplayName(OM_uint32 *minor,
 590                   gss_name_t name,
 591                   gss_buffer_t output_name_buffer,
 592                   gss_OID *output_name_type);
 593
 594 OM_uint32
 595 gssEapCompareName(OM_uint32 *minor,
 596                   gss_name_t name1,
 597                   gss_name_t name2,
 598                   int *name_equal);
 599
 600 /* util_oid.c */
 601 OM_uint32
 602 composeOid(OM_uint32 *minor_status,
 603            const char *prefix,
 604            size_t prefix_len,
 605            int suffix,
 606            gss_OID_desc *oid);
 607
 608 OM_uint32
 609 decomposeOid(OM_uint32 *minor_status,
 610              const char *prefix,
 611              size_t prefix_len,
 612              gss_OID_desc *oid,
 613              int *suffix) ;
 614
 615 OM_uint32
 616 duplicateOid(OM_uint32 *minor_status,
 617              const gss_OID_desc * const oid,
 618              gss_OID *new_oid);
 619
 620 OM_uint32
 621 duplicateOidSet(OM_uint32 *minor,
 622                 const gss_OID_set src,
 623                 gss_OID_set *dst);
 624
 625 static inline int
 626 oidEqual(const gss_OID_desc *o1, const gss_OID_desc *o2)
 627 {
 628     if (o1 == GSS_C_NO_OID)
 629         return (o2 == GSS_C_NO_OID);
 630     else if (o2 == GSS_C_NO_OID)
 631         return (o1 == GSS_C_NO_OID);
 632     else
 633         return (o1->length == o2->length &&
 634                 memcmp(o1->elements, o2->elements, o1->length) == 0);
 635 }
 636
 637 /* util_ordering.c */
 638 OM_uint32
 639 sequenceInternalize(OM_uint32 *minor,
 640                     void **vqueue,
 641                     unsigned char **buf,
 642                     size_t *lenremain);
 643
 644 OM_uint32
 645 sequenceExternalize(OM_uint32 *minor,
 646                     void *vqueue,
 647                     unsigned char **buf,
 648                     size_t *lenremain);
 649
 650 size_t
 651 sequenceSize(void *vqueue);
 652
 653 OM_uint32
 654 sequenceFree(OM_uint32 *minor, void **vqueue);
 655
 656 OM_uint32
 657 sequenceCheck(OM_uint32 *minor, void **vqueue, uint64_t seqnum);
 658
 659 OM_uint32
 660 sequenceInit(OM_uint32 *minor, void **vqueue, uint64_t seqnum,
 661              int do_replay, int do_sequence, int wide_nums);
 662
 663 /* util_sm.c */
 664 enum gss_eap_state {
 665     GSSEAP_STATE_INITIAL        = 0x01,     /* initial state */
 666     GSSEAP_STATE_AUTHENTICATE   = 0x02,     /* exchange EAP messages */
 667     GSSEAP_STATE_INITIATOR_EXTS = 0x04,     /* initiator extensions */
 668     GSSEAP_STATE_ACCEPTOR_EXTS  = 0x08,     /* acceptor extensions */
 669 #ifdef GSSEAP_ENABLE_REAUTH
 670     GSSEAP_STATE_REAUTHENTICATE = 0x10,     /* GSS reauthentication messages */
 671 #endif
 672     GSSEAP_STATE_ESTABLISHED    = 0x20,     /* context established */
 673     GSSEAP_STATE_ALL            = 0x3F
 674 };
 675
 676 #define GSSEAP_STATE_NEXT(s)    ((s) << 1)
 677
 678 #define GSSEAP_SM_STATE(ctx)                ((ctx)->state)
 679
 680 #ifdef GSSEAP_DEBUG
 681 void gssEapSmTransition(gss_ctx_id_t ctx, enum gss_eap_state state);
 682 #define GSSEAP_SM_TRANSITION(ctx, state)    gssEapSmTransition((ctx), (state))
 683 #else
 684 #define GSSEAP_SM_TRANSITION(ctx, newstate)    do { (ctx)->state = (newstate); } while (0)
 685 #endif
 686
 687 #define GSSEAP_SM_TRANSITION_NEXT(ctx)      GSSEAP_SM_TRANSITION((ctx), GSSEAP_STATE_NEXT(GSSEAP_SM_STATE((ctx))))
 688
 689 /* state machine entry */
 690 struct gss_eap_sm {
 691     OM_uint32 inputTokenType;
 692     OM_uint32 outputTokenType;
 693     enum gss_eap_state validStates;
 694     OM_uint32 itokFlags;
 695     OM_uint32 (*processToken)(OM_uint32 *,
 696                               gss_cred_id_t,
 697                               gss_ctx_id_t,
 698                               gss_name_t,
 699                               gss_OID,
 700                               OM_uint32,
 701                               OM_uint32,
 702                               gss_channel_bindings_t,
 703                               gss_buffer_t,
 704                               gss_buffer_t,
 705                               OM_uint32 *);
 706 };
 707
 708 /* state machine flags, set by handler */
 709 #define SM_FLAG_FORCE_SEND_TOKEN            0x00000001  /* send token even if no inner tokens */
 710 #define SM_FLAG_OUTPUT_TOKEN_CRITICAL       0x00000002  /* output token is critical */
 711
 712 /* state machine flags, set by state machine */
 713 #define SM_FLAG_INPUT_TOKEN_CRITICAL        0x10000000  /* input token was critical */
 714
 715 #define SM_ITOK_FLAG_REQUIRED               0x00000001  /* received tokens must be present */
 716
 717 OM_uint32
 718 gssEapSmStep(OM_uint32 *minor,
 719              gss_cred_id_t cred,
 720              gss_ctx_id_t ctx,
 721              gss_name_t target,
 722              gss_OID mech,
 723              OM_uint32 reqFlags,
 724              OM_uint32 timeReq,
 725              gss_channel_bindings_t chanBindings,
 726              gss_buffer_t inputToken,
 727              gss_buffer_t outputToken,
 728              struct gss_eap_sm *sm,
 729              size_t smCount);
 730
 731 void
 732 gssEapSmTransition(gss_ctx_id_t ctx, enum gss_eap_state state);
 733
 734 /* util_token.c */
 735 struct gss_eap_token_buffer_set {
 736     gss_buffer_set_desc buffers; /* pointers only */
 737     OM_uint32 *types;
 738 };
 739
 740 OM_uint32
 741 gssEapEncodeInnerTokens(OM_uint32 *minor,
 742                         struct gss_eap_token_buffer_set *tokens,
 743                         gss_buffer_t buffer);
 744 OM_uint32
 745 gssEapDecodeInnerTokens(OM_uint32 *minor,
 746                         const gss_buffer_t buffer,
 747                         struct gss_eap_token_buffer_set *tokens);
 748
 749 OM_uint32
 750 gssEapReleaseInnerTokens(OM_uint32 *minor,
 751                          struct gss_eap_token_buffer_set *tokens,
 752                          int freeBuffers);
 753
 754 OM_uint32
 755 gssEapAllocInnerTokens(OM_uint32 *minor,
 756                        size_t count,
 757                        struct gss_eap_token_buffer_set *tokens);
 758
 759 size_t
 760 tokenSize(const gss_OID_desc *mech, size_t body_size);
 761
 762 void
 763 makeTokenHeader(const gss_OID_desc *mech,
 764                 size_t body_size,
 765                 unsigned char **buf,
 766                 enum gss_eap_token_type tok_type);
 767
 768 OM_uint32
 769 verifyTokenHeader(OM_uint32 *minor,
 770                   gss_OID mech,
 771                   size_t *body_size,
 772                   unsigned char **buf_in,
 773                   size_t toksize_in,
 774                   enum gss_eap_token_type *ret_tok_type);
 775
 776 /* Helper macros */
 777
 778 #ifndef GSSEAP_MALLOC
 779 #define GSSEAP_CALLOC                   calloc
 780 #define GSSEAP_MALLOC                   malloc
 781 #define GSSEAP_FREE                     free
 782 #define GSSEAP_REALLOC                  realloc
 783 #endif
 784
 785 #ifndef GSSAPI_CALLCONV
 786 #define GSSAPI_CALLCONV                 KRB5_CALLCONV
 787 #endif
 788
 789 #ifndef GSSEAP_ASSERT
 790 #include <assert.h>
 791 #define GSSEAP_ASSERT(x)                assert((x))
 792 #endif /* !GSSEAP_ASSERT */
 793
 794 #ifdef WIN32
 795 #define GSSEAP_CONSTRUCTOR
 796 #define GSSEAP_DESTRUCTOR
 797 #else
 798 #define GSSEAP_CONSTRUCTOR              __attribute__((constructor))
 799 #define GSSEAP_DESTRUCTOR               __attribute__((destructor))
 800 #endif
 801
 802 #define GSSEAP_NOT_IMPLEMENTED          do {            \
 803         GSSEAP_ASSERT(0 && "not implemented");          \
 804         *minor = ENOSYS;                                \
 805         return GSS_S_FAILURE;                           \
 806     } while (0)
 807
 808 #ifdef WIN32
 809
 810 #include <winbase.h>
 811
 812 #define GSSEAP_GET_LAST_ERROR()         (GetLastError()) /* XXX FIXME */
 813
 814 #define GSSEAP_MUTEX                    CRITICAL_SECTION
 815 #define GSSEAP_MUTEX_INIT(m)            (InitializeCriticalSection((m)), 0)
 816 #define GSSEAP_MUTEX_DESTROY(m)         DeleteCriticalSection((m))
 817 #define GSSEAP_MUTEX_LOCK(m)            EnterCriticalSection((m))
 818 #define GSSEAP_MUTEX_UNLOCK(m)          LeaveCriticalSection((m))
 819
 820 /* Thread-local is handled separately */
 821
 822 /* Once is handled separately because INIT_ONCE is only on Vista and above */
 823 #define GSSEAP_ONCE_LEAVE
 824 #define GSSEAP_ONCE_CALLBACK(cb)        void CALLBACK cb(void)
 825
 826 #else
 827
 828 #include <pthread.h>
 829
 830 #define GSSEAP_GET_LAST_ERROR()         (errno)
 831
 832 #define GSSEAP_MUTEX                    pthread_mutex_t
 833 #define GSSEAP_MUTEX_INIT(m)            pthread_mutex_init((m), NULL)
 834 #define GSSEAP_MUTEX_DESTROY(m)         pthread_mutex_destroy((m))
 835 #define GSSEAP_MUTEX_LOCK(m)            pthread_mutex_lock((m))
 836 #define GSSEAP_MUTEX_UNLOCK(m)          pthread_mutex_unlock((m))
 837
 838 #define GSSEAP_THREAD_KEY               pthread_key_t
 839 #define GSSEAP_KEY_CREATE(k, d)         pthread_key_create((k), (d))
 840 #define GSSEAP_GETSPECIFIC(k)           pthread_getspecific((k))
 841 #define GSSEAP_SETSPECIFIC(k, d)        pthread_setspecific((k), (d))
 842
 843 #define GSSEAP_THREAD_ONCE              pthread_once_t
 844 #define GSSEAP_ONCE_CALLBACK(cb)        void cb(void)
 845 #define GSSEAP_ONCE(o, i)               pthread_once((o), (i))
 846 #define GSSEAP_ONCE_INITIALIZER         PTHREAD_ONCE_INIT
 847 #define GSSEAP_ONCE_LEAVE               do { } while (0)
 848
 849 #endif /* WIN32 */
 850
 851 /* Helper functions */
 852 static inline void
 853 store_uint16_be(uint16_t val, void *vp)
 854 {
 855     unsigned char *p = (unsigned char *)vp;
 856
 857     p[0] = (val >>  8) & 0xff;
 858     p[1] = (val      ) & 0xff;
 859 }
 860
 861 static inline uint16_t
 862 load_uint16_be(const void *cvp)
 863 {
 864     const unsigned char *p = (const unsigned char *)cvp;
 865
 866     return (p[1] | (p[0] << 8));
 867 }
 868
 869 static inline void
 870 store_uint32_be(uint32_t val, void *vp)
 871 {
 872     unsigned char *p = (unsigned char *)vp;
 873
 874     p[0] = (val >> 24) & 0xff;
 875     p[1] = (val >> 16) & 0xff;
 876     p[2] = (val >>  8) & 0xff;
 877     p[3] = (val      ) & 0xff;
 878 }
 879
 880 static inline uint32_t
 881 load_uint32_be(const void *cvp)
 882 {
 883     const unsigned char *p = (const unsigned char *)cvp;
 884
 885     return (p[3] | (p[2] << 8)
 886             | ((uint32_t) p[1] << 16)
 887             | ((uint32_t) p[0] << 24));
 888 }
 889
 890 static inline void
 891 store_uint64_be(uint64_t val, void *vp)
 892 {
 893     unsigned char *p = (unsigned char *)vp;
 894
 895     p[0] = (unsigned char)((val >> 56) & 0xff);
 896     p[1] = (unsigned char)((val >> 48) & 0xff);
 897     p[2] = (unsigned char)((val >> 40) & 0xff);
 898     p[3] = (unsigned char)((val >> 32) & 0xff);
 899     p[4] = (unsigned char)((val >> 24) & 0xff);
 900     p[5] = (unsigned char)((val >> 16) & 0xff);
 901     p[6] = (unsigned char)((val >>  8) & 0xff);
 902     p[7] = (unsigned char)((val      ) & 0xff);
 903 }
 904
 905 static inline uint64_t
 906 load_uint64_be(const void *cvp)
 907 {
 908     const unsigned char *p = (const unsigned char *)cvp;
 909
 910     return ((uint64_t)load_uint32_be(p) << 32) | load_uint32_be(p + 4);
 911 }
 912
 913 static inline unsigned char *
 914 store_buffer(gss_buffer_t buffer, void *vp, int wide_nums)
 915 {
 916     unsigned char *p = (unsigned char *)vp;
 917
 918     if (wide_nums) {
 919         store_uint64_be(buffer->length, p);
 920         p += 8;
 921     } else {
 922         store_uint32_be(buffer->length, p);
 923         p += 4;
 924     }
 925
 926     if (buffer->value != NULL) {
 927         memcpy(p, buffer->value, buffer->length);
 928         p += buffer->length;
 929     }
 930
 931     return p;
 932 }
 933
 934 static inline unsigned char *
 935 load_buffer(const void *cvp, size_t length, gss_buffer_t buffer)
 936 {
 937     buffer->length = 0;
 938     buffer->value = GSSEAP_MALLOC(length);
 939     if (buffer->value == NULL)
 940         return NULL;
 941     buffer->length = length;
 942     memcpy(buffer->value, cvp, length);
 943     return (unsigned char *)cvp + length;
 944 }
 945
 946 static inline unsigned char *
 947 store_oid(gss_OID oid, void *vp)
 948 {
 949     gss_buffer_desc buf;
 950
 951     if (oid != GSS_C_NO_OID) {
 952         buf.length = oid->length;
 953         buf.value = oid->elements;
 954     } else {
 955         buf.length = 0;
 956         buf.value = NULL;
 957     }
 958
 959     return store_buffer(&buf, vp, FALSE);
 960 }
 961
 962 static inline void
 963 krbDataToGssBuffer(krb5_data *data, gss_buffer_t buffer)
 964 {
 965     buffer->value = (void *)data->data;
 966     buffer->length = data->length;
 967 }
 968
 969 static inline void
 970 krbPrincComponentToGssBuffer(krb5_principal krbPrinc,
 971                              int index, gss_buffer_t buffer)
 972 {
 973 #ifdef HAVE_HEIMDAL_VERSION
 974     buffer->value = (void *)KRB_PRINC_NAME(krbPrinc)[index];
 975     buffer->length = strlen((char *)buffer->value);
 976 #else
 977     buffer->value = (void *)krb5_princ_component(NULL, krbPrinc, index)->data;
 978     buffer->length = krb5_princ_component(NULL, krbPrinc, index)->length;
 979 #endif /* HAVE_HEIMDAL_VERSION */
 980 }
 981
 982 static inline void
 983 krbPrincRealmToGssBuffer(krb5_principal krbPrinc, gss_buffer_t buffer)
 984 {
 985 #ifdef HAVE_HEIMDAL_VERSION
 986     buffer->value = (void *)KRB_PRINC_REALM(krbPrinc);
 987     buffer->length = strlen((char *)buffer->value);
 988 #else
 989     krbDataToGssBuffer(KRB_PRINC_REALM(krbPrinc), buffer);
 990 #endif
 991 }
 992
 993 static inline void
 994 gssBufferToKrbData(gss_buffer_t buffer, krb5_data *data)
 995 {
 996     data->data = (char *)buffer->value;
 997     data->length = buffer->length;
 998 }
 999
1000 /* util_tld.c */
1001 struct gss_eap_status_info;
1002
1003 struct gss_eap_thread_local_data {
1004     krb5_context krbContext;
1005     struct gss_eap_status_info *statusInfo;
1006 };
1007
1008 struct gss_eap_thread_local_data *
1009 gssEapGetThreadLocalData(void);
1010
1011 void
1012 gssEapDestroyStatusInfo(struct gss_eap_status_info *status);
1013
1014 void
1015 gssEapDestroyKrbContext(krb5_context context);
1016
1017 #ifdef __cplusplus
1018 }
1019 #endif
1020
1021 #ifdef GSSEAP_ENABLE_ACCEPTOR
1022 #include "util_json.h"
1023 #include "util_attr.h"
1024 #include "util_base64.h"
1025 #endif /* GSSEAP_ENABLE_ACCEPTOR */
1026 #ifdef GSSEAP_ENABLE_REAUTH
1027 #include "util_reauth.h"
1028 #endif
1029
1030 #endif /* _UTIL_H_ */