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