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