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 #include <sys/param.h>
  65 #include <string.h>
  66 #include <errno.h>
  67
  68 #include <krb5.h>
  69
  70 #ifdef __cplusplus
  71 extern "C" {
  72 #endif
  73
  74 #ifndef MIN
  75 #define MIN(_a,_b)  ((_a)<(_b)?(_a):(_b))
  76 #endif
  77
  78 /* util_buffer.c */
  79 OM_uint32
  80 makeStringBuffer(OM_uint32 *minor,
  81                  const char *string,
  82                  gss_buffer_t buffer);
  83
  84 OM_uint32
  85 bufferToString(OM_uint32 *minor,
  86                const gss_buffer_t buffer,
  87                char **pString);
  88
  89 OM_uint32
  90 duplicateBuffer(OM_uint32 *minor,
  91                 const gss_buffer_t src,
  92                 gss_buffer_t dst);
  93
  94 static inline int
  95 bufferEqual(const gss_buffer_t b1, const gss_buffer_t b2)
  96 {
  97     return (b1->length == b2->length &&
  98             memcmp(b1->value, b2->value, b2->length) == 0);
  99 }
 100
 101 static inline int
 102 bufferEqualString(const gss_buffer_t b1, const char *s)
 103 {
 104     gss_buffer_desc b2;
 105
 106     b2.length = strlen(s);
 107     b2.value = (char *)s;
 108
 109     return bufferEqual(b1, &b2);
 110 }
 111
 112 /* util_cksum.c */
 113 int
 114 gssEapSign(krb5_context context,
 115            krb5_cksumtype type,
 116            size_t rrc,
 117 #ifdef HAVE_HEIMDAL_VERSION
 118            krb5_crypto crypto,
 119 #else
 120            krb5_keyblock *key,
 121 #endif
 122            krb5_keyusage sign_usage,
 123            gss_iov_buffer_desc *iov,
 124            int iov_count);
 125
 126 int
 127 gssEapVerify(krb5_context context,
 128              krb5_cksumtype type,
 129              size_t rrc,
 130 #ifdef HAVE_HEIMDAL_VERSION
 131              krb5_crypto crypto,
 132 #else
 133              krb5_keyblock *key,
 134 #endif
 135              krb5_keyusage sign_usage,
 136              gss_iov_buffer_desc *iov,
 137              int iov_count,
 138              int *valid);
 139
 140 #if 0
 141 OM_uint32
 142 gssEapEncodeGssChannelBindings(OM_uint32 *minor,
 143                                gss_channel_bindings_t chanBindings,
 144                                gss_buffer_t encodedBindings);
 145 #endif
 146
 147 /* util_context.c */
 148 #define EAP_EXPORT_CONTEXT_V1           1
 149
 150 enum gss_eap_token_type {
 151     TOK_TYPE_NONE                    = 0x0000,  /* no token */
 152     TOK_TYPE_MIC                     = 0x0404,  /* RFC 4121 MIC token */
 153     TOK_TYPE_WRAP                    = 0x0504,  /* RFC 4121 wrap token */
 154     TOK_TYPE_EXPORT_NAME             = 0x0401,  /* RFC 2743 exported name */
 155     TOK_TYPE_EXPORT_NAME_COMPOSITE   = 0x0402,  /* exported composite name */
 156     TOK_TYPE_DELETE_CONTEXT          = 0x0405,  /* RFC 2743 delete context */
 157     TOK_TYPE_INITIATOR_CONTEXT       = 0x0601,  /* initiator-sent context token */
 158     TOK_TYPE_ACCEPTOR_CONTEXT        = 0x0602,  /* acceptor-sent context token */
 159 };
 160
 161 /* inner token types and flags */
 162 #define ITOK_TYPE_NONE                  0x00000000
 163 #define ITOK_TYPE_CONTEXT_ERR           0x00000001 /* critical */
 164 #define ITOK_TYPE_ACCEPTOR_NAME_REQ     0x00000002 /* TBD */
 165 #define ITOK_TYPE_ACCEPTOR_NAME_RESP    0x00000003 /* TBD */
 166 #define ITOK_TYPE_EAP_RESP              0x00000004 /* critical, required, if not reauth */
 167 #define ITOK_TYPE_EAP_REQ               0x00000005 /* critical, required, if not reauth */
 168 #define ITOK_TYPE_GSS_CHANNEL_BINDINGS  0x00000006 /* critical, required, if not reauth */
 169 #define ITOK_TYPE_REAUTH_CREDS          0x00000007 /* optional */
 170 #define ITOK_TYPE_REAUTH_REQ            0x00000008 /* optional */
 171 #define ITOK_TYPE_REAUTH_RESP           0x00000009 /* optional */
 172 #define ITOK_TYPE_INITIATOR_MIC         0x0000000A /* required */
 173 #define ITOK_TYPE_ACCEPTOR_MIC          0x0000000B /* required */
 174 #define ITOK_TYPE_ACCEPTOR_EXTS         0x0000000C /* optional, acceptor exts supported */
 175 #define ITOK_TYPE_INITIATOR_EXTS        0x0000000D /* optional, initiator exts supported */
 176 #define ITOK_TYPE_VERSION_INFO          0x0000000E /* optional */
 177 #define ITOK_TYPE_VENDOR_INFO           0x0000000F /* optional */
 178
 179 #define ITOK_FLAG_CRITICAL              0x80000000  /* critical, wire flag */
 180 #define ITOK_FLAG_VERIFIED              0x40000000  /* verified, API flag */
 181
 182 #define ITOK_TYPE_MASK                  (~(ITOK_FLAG_CRITICAL | ITOK_FLAG_VERIFIED))
 183
 184 OM_uint32 gssEapAllocContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
 185 OM_uint32 gssEapReleaseContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
 186
 187 OM_uint32
 188 gssEapRecordContextTokenHeader(OM_uint32 *minor,
 189                                gss_ctx_id_t ctx,
 190                                enum gss_eap_token_type tokType);
 191
 192 OM_uint32
 193 gssEapRecordInnerContextToken(OM_uint32 *minor,
 194                               gss_ctx_id_t ctx,
 195                               gss_buffer_t innerToken,
 196                               OM_uint32 type);
 197
 198 OM_uint32
 199 gssEapVerifyContextToken(OM_uint32 *minor,
 200                          gss_ctx_id_t ctx,
 201                          const gss_buffer_t inputToken,
 202                          enum gss_eap_token_type tokenType,
 203                          gss_buffer_t innerInputToken);
 204
 205 OM_uint32
 206 gssEapContextTime(OM_uint32 *minor,
 207                   gss_ctx_id_t context_handle,
 208                   OM_uint32 *time_rec);
 209
 210 OM_uint32
 211 gssEapDisplayName(OM_uint32 *minor,
 212                   gss_name_t name,
 213                   gss_buffer_t output_name_buffer,
 214                   gss_OID *output_name_type);
 215
 216 /* util_cred.c */
 217 OM_uint32 gssEapAllocCred(OM_uint32 *minor, gss_cred_id_t *pCred);
 218 OM_uint32 gssEapReleaseCred(OM_uint32 *minor, gss_cred_id_t *pCred);
 219
 220 OM_uint32
 221 gssEapAcquireCred(OM_uint32 *minor,
 222                   const gss_name_t desiredName,
 223                   const gss_buffer_t password,
 224                   OM_uint32 timeReq,
 225                   const gss_OID_set desiredMechs,
 226                   int cred_usage,
 227                   gss_cred_id_t *pCred,
 228                   gss_OID_set *pActualMechs,
 229                   OM_uint32 *timeRec);
 230
 231 int gssEapCredAvailable(gss_cred_id_t cred, gss_OID mech);
 232
 233 /* util_crypt.c */
 234 int
 235 gssEapEncrypt(krb5_context context, int dce_style, size_t ec,
 236               size_t rrc,
 237 #ifdef HAVE_HEIMDAL_VERSION
 238               krb5_crypto crypto,
 239 #else
 240               krb5_keyblock *key,
 241 #endif
 242               int usage,
 243               gss_iov_buffer_desc *iov, int iov_count);
 244
 245 int
 246 gssEapDecrypt(krb5_context context, int dce_style, size_t ec,
 247               size_t rrc,
 248 #ifdef HAVE_HEIMDAL_VERSION
 249               krb5_crypto crypto,
 250 #else
 251               krb5_keyblock *key,
 252 #endif
 253               int usage,
 254               gss_iov_buffer_desc *iov, int iov_count);
 255
 256 int
 257 gssEapMapCryptoFlag(OM_uint32 type);
 258
 259 gss_iov_buffer_t
 260 gssEapLocateIov(gss_iov_buffer_desc *iov,
 261                 int iov_count,
 262                 OM_uint32 type);
 263
 264 void
 265 gssEapIovMessageLength(gss_iov_buffer_desc *iov,
 266                        int iov_count,
 267                        size_t *data_length,
 268                        size_t *assoc_data_length);
 269
 270 void
 271 gssEapReleaseIov(gss_iov_buffer_desc *iov, int iov_count);
 272
 273 int
 274 gssEapIsIntegrityOnly(gss_iov_buffer_desc *iov, int iov_count);
 275
 276 int
 277 gssEapAllocIov(gss_iov_buffer_t iov, size_t size);
 278
 279 OM_uint32
 280 gssEapDeriveRfc3961Key(OM_uint32 *minor,
 281                        const unsigned char *key,
 282                        size_t keyLength,
 283                        krb5_enctype enctype,
 284                        krb5_keyblock *pKey);
 285
 286 /* util_krb.c */
 287 #ifdef HAVE_HEIMDAL_VERSION
 288
 289 #define KRB_TIME_FOREVER        ((time_t)~0L)
 290
 291 #define KRB_KEY_TYPE(key)       ((key)->keytype)
 292 #define KRB_KEY_DATA(key)       ((key)->keyvalue.data)
 293 #define KRB_KEY_LENGTH(key)     ((key)->keyvalue.length)
 294
 295 #define KRB_PRINC_LENGTH(princ) ((princ)->name.name_string.len)
 296 #define KRB_PRINC_TYPE(princ)   ((princ)->name.name_type)
 297 #define KRB_PRINC_NAME(princ)   ((princ)->name.name_string.val)
 298 #define KRB_PRINC_REALM(princ)  ((princ)->realm)
 299
 300 #define KRB_KT_ENT_KEYBLOCK(e)  (&(e)->keyblock)
 301 #define KRB_KT_ENT_FREE(c, e)   krb5_kt_free_entry((c), (e))
 302
 303 #define KRB_CRYPTO_CONTEXT(ctx) (krbCrypto)
 304
 305 #else
 306
 307 #define KRB_TIME_FOREVER        KRB5_INT32_MAX
 308
 309 #define KRB_KEY_TYPE(key)       ((key)->enctype)
 310 #define KRB_KEY_DATA(key)       ((key)->contents)
 311 #define KRB_KEY_LENGTH(key)     ((key)->length)
 312
 313 #define KRB_PRINC_LENGTH(princ) (krb5_princ_size(NULL, (princ)))
 314 #define KRB_PRINC_TYPE(princ)   (krb5_princ_type(NULL, (princ)))
 315 #define KRB_PRINC_NAME(princ)   (krb5_princ_name(NULL, (princ)))
 316 #define KRB_PRINC_REALM(princ)  (krb5_princ_realm(NULL, (princ)))
 317
 318 #define KRB_KT_ENT_KEYBLOCK(e)  (&(e)->key)
 319 #define KRB_KT_ENT_FREE(c, e)   krb5_free_keytab_entry_contents((c), (e))
 320
 321 #define KRB_CRYPTO_CONTEXT(ctx) (&(ctx)->rfc3961Key)
 322
 323 #endif /* HAVE_HEIMDAL_VERSION */
 324
 325 #define KRB_KEY_INIT(key)       do {        \
 326         KRB_KEY_TYPE(key) = ENCTYPE_NULL;   \
 327         KRB_KEY_DATA(key) = NULL;           \
 328         KRB_KEY_LENGTH(key) = 0;            \
 329     } while (0)
 330
 331 #define GSSEAP_KRB_INIT(ctx) do {                   \
 332         OM_uint32 tmpMajor;                         \
 333                                                     \
 334         tmpMajor  = gssEapKerberosInit(minor, ctx); \
 335         if (GSS_ERROR(tmpMajor)) {                  \
 336             return tmpMajor;                        \
 337         }                                           \
 338     } while (0)
 339
 340 OM_uint32
 341 gssEapKerberosInit(OM_uint32 *minor, krb5_context *context);
 342
 343 OM_uint32
 344 rfc3961ChecksumTypeForKey(OM_uint32 *minor,
 345                           krb5_keyblock *key,
 346                           krb5_cksumtype *cksumtype);
 347
 348 krb5_const_principal
 349 krbAnonymousPrincipal(void);
 350
 351 krb5_error_code
 352 krbCryptoLength(krb5_context krbContext,
 353 #ifdef HAVE_HEIMDAL_VERSION
 354                 krb5_crypto krbCrypto,
 355 #else
 356                 krb5_keyblock *key,
 357 #endif
 358                 int type,
 359                 size_t *length);
 360
 361 krb5_error_code
 362 krbPaddingLength(krb5_context krbContext,
 363 #ifdef HAVE_HEIMDAL_VERSION
 364                  krb5_crypto krbCrypto,
 365 #else
 366                  krb5_keyblock *key,
 367 #endif
 368                  size_t dataLength,
 369                  size_t *padLength);
 370
 371 krb5_error_code
 372 krbBlockSize(krb5_context krbContext,
 373 #ifdef HAVE_HEIMDAL_VERSION
 374                  krb5_crypto krbCrypto,
 375 #else
 376                  krb5_keyblock *key,
 377 #endif
 378                  size_t *blockSize);
 379
 380 krb5_error_code
 381 krbEnctypeToString(krb5_context krbContext,
 382                    krb5_enctype enctype,
 383                    const char *prefix,
 384                    gss_buffer_t string);
 385
 386 krb5_error_code
 387 krbMakeAuthDataKdcIssued(krb5_context context,
 388                          const krb5_keyblock *key,
 389                          krb5_const_principal issuer,
 390 #ifdef HAVE_HEIMDAL_VERSION
 391                          const AuthorizationData *authdata,
 392                          AuthorizationData *adKdcIssued
 393 #else
 394                          krb5_authdata *const *authdata,
 395                          krb5_authdata ***adKdcIssued
 396 #endif
 397                          );
 398
 399 krb5_error_code
 400 krbMakeCred(krb5_context context,
 401             krb5_auth_context authcontext,
 402             krb5_creds *creds,
 403             krb5_data *data);
 404
 405 /* util_lucid.c */
 406 OM_uint32
 407 gssEapExportLucidSecContext(OM_uint32 *minor,
 408                             gss_ctx_id_t ctx,
 409                             const gss_OID desiredObject,
 410                             gss_buffer_set_t *data_set);
 411
 412 /* util_mech.c */
 413 extern gss_OID GSS_EAP_MECHANISM;
 414
 415 int
 416 gssEapInternalizeOid(const gss_OID oid,
 417                      gss_OID *const pInternalizedOid);
 418
 419 OM_uint32
 420 gssEapReleaseOid(OM_uint32 *minor, gss_OID *oid);
 421
 422 OM_uint32
 423 gssEapDefaultMech(OM_uint32 *minor,
 424                   gss_OID *oid);
 425
 426 OM_uint32
 427 gssEapIndicateMechs(OM_uint32 *minor,
 428                     gss_OID_set *mechs);
 429
 430 OM_uint32
 431 gssEapEnctypeToOid(OM_uint32 *minor,
 432                    krb5_enctype enctype,
 433                    gss_OID *pOid);
 434
 435 OM_uint32
 436 gssEapOidToEnctype(OM_uint32 *minor,
 437                    const gss_OID oid,
 438                    krb5_enctype *enctype);
 439
 440 int
 441 gssEapIsMechanismOid(const gss_OID oid);
 442
 443 int
 444 gssEapIsConcreteMechanismOid(const gss_OID oid);
 445
 446 OM_uint32
 447 gssEapValidateMechs(OM_uint32 *minor,
 448                    const gss_OID_set mechs);
 449
 450 gss_buffer_t
 451 gssEapOidToSaslName(const gss_OID oid);
 452
 453 gss_OID
 454 gssEapSaslNameToOid(const gss_buffer_t name);
 455
 456 /* util_name.c */
 457 #define EXPORT_NAME_FLAG_OID        0x1
 458 #define EXPORT_NAME_FLAG_COMPOSITE  0x2
 459
 460 OM_uint32 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName);
 461 OM_uint32 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName);
 462 OM_uint32 gssEapExportName(OM_uint32 *minor,
 463                            const gss_name_t name,
 464                            gss_buffer_t exportedName);
 465 OM_uint32 gssEapExportNameInternal(OM_uint32 *minor,
 466                                    const gss_name_t name,
 467                                    gss_buffer_t exportedName,
 468                                    unsigned int flags);
 469 OM_uint32 gssEapImportName(OM_uint32 *minor,
 470                            const gss_buffer_t input_name_buffer,
 471                            gss_OID input_name_type,
 472                            gss_name_t *output_name);
 473 OM_uint32 gssEapImportNameInternal(OM_uint32 *minor,
 474                                    const gss_buffer_t input_name_buffer,
 475                                    gss_name_t *output_name,
 476                                    unsigned int flags);
 477 OM_uint32
 478 gssEapDuplicateName(OM_uint32 *minor,
 479                     const gss_name_t input_name,
 480                     gss_name_t *dest_name);
 481
 482 /* util_oid.c */
 483 OM_uint32
 484 composeOid(OM_uint32 *minor_status,
 485            const char *prefix,
 486            size_t prefix_len,
 487            int suffix,
 488            gss_OID_desc *oid);
 489
 490 OM_uint32
 491 decomposeOid(OM_uint32 *minor_status,
 492              const char *prefix,
 493              size_t prefix_len,
 494              gss_OID_desc *oid,
 495              int *suffix) ;
 496
 497 OM_uint32
 498 duplicateOid(OM_uint32 *minor_status,
 499              const gss_OID_desc * const oid,
 500              gss_OID *new_oid);
 501
 502 OM_uint32
 503 duplicateOidSet(OM_uint32 *minor,
 504                 const gss_OID_set src,
 505                 gss_OID_set *dst);
 506
 507 static inline int
 508 oidEqual(const gss_OID_desc *o1, const gss_OID_desc *o2)
 509 {
 510     if (o1 == GSS_C_NO_OID)
 511         return (o2 == GSS_C_NO_OID);
 512     else if (o2 == GSS_C_NO_OID)
 513         return (o1 == GSS_C_NO_OID);
 514     else
 515         return (o1->length == o2->length &&
 516                 memcmp(o1->elements, o2->elements, o1->length) == 0);
 517 }
 518
 519 /* util_ordering.c */
 520 OM_uint32
 521 sequenceInternalize(OM_uint32 *minor,
 522                     void **vqueue,
 523                     unsigned char **buf,
 524                     size_t *lenremain);
 525
 526 OM_uint32
 527 sequenceExternalize(OM_uint32 *minor,
 528                     void *vqueue,
 529                     unsigned char **buf,
 530                     size_t *lenremain);
 531
 532 size_t
 533 sequenceSize(void *vqueue);
 534
 535 OM_uint32
 536 sequenceFree(OM_uint32 *minor, void **vqueue);
 537
 538 OM_uint32
 539 sequenceCheck(OM_uint32 *minor, void **vqueue, uint64_t seqnum);
 540
 541 OM_uint32
 542 sequenceInit(OM_uint32 *minor, void **vqueue, uint64_t seqnum,
 543              int do_replay, int do_sequence, int wide_nums);
 544
 545 /* util_sm.c */
 546 enum gss_eap_state {
 547     GSSEAP_STATE_INITIAL        = 0x01,     /* initial state */
 548     GSSEAP_STATE_AUTHENTICATE   = 0x02,     /* exchange EAP messages */
 549     GSSEAP_STATE_INITIATOR_EXTS = 0x04,     /* initiator extensions */
 550     GSSEAP_STATE_ACCEPTOR_EXTS  = 0x08,     /* acceptor extensions */
 551 #ifdef GSSEAP_ENABLE_REAUTH
 552     GSSEAP_STATE_REAUTHENTICATE = 0x10,     /* GSS reauthentication messages */
 553 #endif
 554     GSSEAP_STATE_ESTABLISHED    = 0x20,     /* context established */
 555     GSSEAP_STATE_ALL            = 0x3F
 556 };
 557
 558 #define GSSEAP_STATE_NEXT(s)    ((s) << 1)
 559
 560 #define GSSEAP_SM_STATE(ctx)                ((ctx)->state)
 561
 562 #ifdef GSSEAP_DEBUG
 563 void gssEapSmTransition(gss_ctx_id_t ctx, enum gss_eap_state state);
 564 #define GSSEAP_SM_TRANSITION(ctx, state)    gssEapSmTransition((ctx), (state))
 565 #else
 566 #define GSSEAP_SM_TRANSITION(ctx, newstate)    do { (ctx)->state = (newstate); } while (0)
 567 #endif
 568
 569 #define GSSEAP_SM_TRANSITION_NEXT(ctx)      GSSEAP_SM_TRANSITION((ctx), GSSEAP_STATE_NEXT(GSSEAP_SM_STATE((ctx))))
 570
 571 /* state machine entry */
 572 struct gss_eap_sm {
 573     OM_uint32 inputTokenType;
 574     OM_uint32 outputTokenType;
 575     enum gss_eap_state validStates;
 576     OM_uint32 itokFlags;
 577     OM_uint32 (*processToken)(OM_uint32 *,
 578                               gss_cred_id_t,
 579                               gss_ctx_id_t,
 580                               gss_name_t,
 581                               gss_OID,
 582                               OM_uint32,
 583                               OM_uint32,
 584                               gss_channel_bindings_t,
 585                               gss_buffer_t,
 586                               gss_buffer_t,
 587                               OM_uint32 *);
 588 };
 589
 590 /* state machine flags, set by handler */
 591 #define SM_FLAG_FORCE_SEND_TOKEN            0x00000001  /* send token even if no inner tokens */
 592 #define SM_FLAG_OUTPUT_TOKEN_CRITICAL       0x00000002  /* output token is critical */
 593
 594 /* state machine flags, set by state machine */
 595 #define SM_FLAG_INPUT_TOKEN_CRITICAL        0x10000000  /* input token was critical */
 596
 597 #define SM_ITOK_FLAG_REQUIRED               0x00000001  /* received tokens must be present */
 598
 599 OM_uint32
 600 gssEapSmStep(OM_uint32 *minor,
 601              gss_cred_id_t cred,
 602              gss_ctx_id_t ctx,
 603              gss_name_t target,
 604              gss_OID mech,
 605              OM_uint32 reqFlags,
 606              OM_uint32 timeReq,
 607              gss_channel_bindings_t chanBindings,
 608              gss_buffer_t inputToken,
 609              gss_buffer_t outputToken,
 610              struct gss_eap_sm *sm,
 611              size_t smCount);
 612
 613 void
 614 gssEapSmTransition(gss_ctx_id_t ctx, enum gss_eap_state state);
 615
 616 /* util_token.c */
 617 OM_uint32
 618 gssEapEncodeInnerTokens(OM_uint32 *minor,
 619                         gss_buffer_set_t extensions,
 620                         OM_uint32 *types,
 621                         gss_buffer_t buffer);
 622 OM_uint32
 623 gssEapDecodeInnerTokens(OM_uint32 *minor,
 624                         const gss_buffer_t buffer,
 625                         gss_buffer_set_t *pExtensions,
 626                         OM_uint32 **pTypes);
 627
 628 size_t
 629 tokenSize(size_t bodySize);
 630
 631 void
 632 makeTokenHeader(size_t body_size,
 633                 unsigned char **buf);
 634
 635 OM_uint32
 636 verifyTokenHeader(OM_uint32 *minor,
 637                   gss_OID mech,
 638                   size_t *body_size,
 639                   unsigned char **buf_in,
 640                   size_t toksize_in,
 641                   enum gss_eap_token_type *ret_tok_type);
 642
 643 /* Helper macros */
 644
 645 #define GSSEAP_CALLOC                   calloc
 646 #define GSSEAP_MALLOC                   malloc
 647 #define GSSEAP_FREE                     free
 648 #define GSSEAP_REALLOC                  realloc
 649
 650 #define GSSEAP_NOT_IMPLEMENTED          do {            \
 651         assert(0 && "not implemented");                 \
 652         *minor = ENOSYS;                                \
 653         return GSS_S_FAILURE;                           \
 654     } while (0)
 655
 656 #include <pthread.h>
 657
 658 #define GSSEAP_MUTEX                    pthread_mutex_t
 659 #define GSSEAP_MUTEX_INITIALIZER        PTHREAD_MUTEX_INITIALIZER
 660
 661 #define GSSEAP_MUTEX_INIT(m)            pthread_mutex_init((m), NULL)
 662 #define GSSEAP_MUTEX_DESTROY(m)         pthread_mutex_destroy((m))
 663 #define GSSEAP_MUTEX_LOCK(m)            pthread_mutex_lock((m))
 664 #define GSSEAP_MUTEX_UNLOCK(m)          pthread_mutex_unlock((m))
 665
 666 #define GSSEAP_THREAD_KEY               pthread_key_t
 667 #define GSSEAP_KEY_CREATE(k, d)         pthread_key_create((k), (d))
 668 #define GSSEAP_GETSPECIFIC(k)           pthread_getspecific((k))
 669 #define GSSEAP_SETSPECIFIC(k, d)        pthread_setspecific((k), (d))
 670
 671 #define GSSEAP_THREAD_ONCE              pthread_once_t
 672 #define GSSEAP_ONCE(o, i)               pthread_once((o), (i))
 673 #define GSSEAP_ONCE_INITIALIZER         PTHREAD_ONCE_INIT
 674
 675 /* Helper functions */
 676 static inline void
 677 store_uint16_be(uint16_t val, void *vp)
 678 {
 679     unsigned char *p = (unsigned char *)vp;
 680
 681     p[0] = (val >>  8) & 0xff;
 682     p[1] = (val      ) & 0xff;
 683 }
 684
 685 static inline uint16_t
 686 load_uint16_be(const void *cvp)
 687 {
 688     const unsigned char *p = (const unsigned char *)cvp;
 689
 690     return (p[1] | (p[0] << 8));
 691 }
 692
 693 static inline void
 694 store_uint32_be(uint32_t val, void *vp)
 695 {
 696     unsigned char *p = (unsigned char *)vp;
 697
 698     p[0] = (val >> 24) & 0xff;
 699     p[1] = (val >> 16) & 0xff;
 700     p[2] = (val >>  8) & 0xff;
 701     p[3] = (val      ) & 0xff;
 702 }
 703
 704 static inline uint32_t
 705 load_uint32_be(const void *cvp)
 706 {
 707     const unsigned char *p = (const unsigned char *)cvp;
 708
 709     return (p[3] | (p[2] << 8)
 710             | ((uint32_t) p[1] << 16)
 711             | ((uint32_t) p[0] << 24));
 712 }
 713
 714 static inline void
 715 store_uint64_be(uint64_t val, void *vp)
 716 {
 717     unsigned char *p = (unsigned char *)vp;
 718
 719     p[0] = (unsigned char)((val >> 56) & 0xff);
 720     p[1] = (unsigned char)((val >> 48) & 0xff);
 721     p[2] = (unsigned char)((val >> 40) & 0xff);
 722     p[3] = (unsigned char)((val >> 32) & 0xff);
 723     p[4] = (unsigned char)((val >> 24) & 0xff);
 724     p[5] = (unsigned char)((val >> 16) & 0xff);
 725     p[6] = (unsigned char)((val >>  8) & 0xff);
 726     p[7] = (unsigned char)((val      ) & 0xff);
 727 }
 728
 729 static inline uint64_t
 730 load_uint64_be(const void *cvp)
 731 {
 732     const unsigned char *p = (const unsigned char *)cvp;
 733
 734     return ((uint64_t)load_uint32_be(p) << 32) | load_uint32_be(p + 4);
 735 }
 736
 737 static inline unsigned char *
 738 store_buffer(gss_buffer_t buffer, void *vp, int wide_nums)
 739 {
 740     unsigned char *p = (unsigned char *)vp;
 741
 742     if (wide_nums) {
 743         store_uint64_be(buffer->length, p);
 744         p += 8;
 745     } else {
 746         store_uint32_be(buffer->length, p);
 747         p += 4;
 748     }
 749
 750     if (buffer->value != NULL) {
 751         memcpy(p, buffer->value, buffer->length);
 752         p += buffer->length;
 753     }
 754
 755     return p;
 756 }
 757
 758 static inline unsigned char *
 759 load_buffer(const void *cvp, size_t length, gss_buffer_t buffer)
 760 {
 761     buffer->length = 0;
 762     buffer->value = GSSEAP_MALLOC(length);
 763     if (buffer->value == NULL)
 764         return NULL;
 765     buffer->length = length;
 766     memcpy(buffer->value, cvp, length);
 767     return (unsigned char *)cvp + length;
 768 }
 769
 770 static inline unsigned char *
 771 store_oid(gss_OID oid, void *vp)
 772 {
 773     gss_buffer_desc buf;
 774
 775     if (oid != GSS_C_NO_OID) {
 776         buf.length = oid->length;
 777         buf.value = oid->elements;
 778     } else {
 779         buf.length = 0;
 780         buf.value = NULL;
 781     }
 782
 783     return store_buffer(&buf, vp, FALSE);
 784 }
 785
 786 static inline void
 787 krbDataToGssBuffer(krb5_data *data, gss_buffer_t buffer)
 788 {
 789     buffer->value = (void *)data->data;
 790     buffer->length = data->length;
 791 }
 792
 793 static inline void
 794 krbPrincComponentToGssBuffer(krb5_principal krbPrinc,
 795                              int index, gss_buffer_t buffer)
 796 {
 797 #ifdef HAVE_HEIMDAL_VERSION
 798     buffer->value = (void *)KRB_PRINC_NAME(krbPrinc)[index];
 799     buffer->length = strlen((char *)buffer->value);
 800 #else
 801     buffer->value = (void *)krb5_princ_component(NULL, krbPrinc, index)->data;
 802     buffer->length = krb5_princ_component(NULL, krbPrinc, index)->length;
 803 #endif /* HAVE_HEIMDAL_VERSION */
 804 }
 805
 806 static inline void
 807 krbPrincRealmToGssBuffer(krb5_principal krbPrinc, gss_buffer_t buffer)
 808 {
 809 #ifdef HAVE_HEIMDAL_VERSION
 810     buffer->value = (void *)KRB_PRINC_REALM(krbPrinc);
 811     buffer->length = strlen((char *)buffer->value);
 812 #else
 813     krbDataToGssBuffer(KRB_PRINC_REALM(krbPrinc), buffer);
 814 #endif
 815 }
 816
 817 static inline void
 818 gssBufferToKrbData(gss_buffer_t buffer, krb5_data *data)
 819 {
 820     data->data = (char *)buffer->value;
 821     data->length = buffer->length;
 822 }
 823
 824 #ifdef __cplusplus
 825 }
 826 #endif
 827
 828 #include "util_attr.h"
 829 #ifdef GSSEAP_ENABLE_REAUTH
 830 #include "util_reauth.h"
 831 #endif
 832
 833 #endif /* _UTIL_H_ */