www.project-moonshot.org Git - mech_eap.orig/blob - util.h

   1 /*
   2  * Copyright (c) 2010, 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 #ifndef _UTIL_H_
  58 #define _UTIL_H_ 1
  59
  60 #include <krb5.h>
  61
  62 #include "util_saml.h"
  63 #include "util_radius.h"
  64
  65 #define KRB_KEYTYPE(key)        ((key)->enctype)
  66
  67 enum gss_eap_token_type {
  68     TOK_TYPE_NONE                    = 0x0000,  /* no token */
  69     TOK_TYPE_MIC                     = 0x0404,  /* RFC 4121 MIC token */
  70     TOK_TYPE_WRAP                    = 0x0504,  /* RFC 4121 wrap token */
  71     TOK_TYPE_EXPORT_NAME             = 0x0401,  /* RFC 2743 exported name */
  72     TOK_TYPE_EXPORT_NAME_COMPOSITE   = 0x0402,  /* draft-ietf-kitten-gss-naming */
  73     TOK_TYPE_DELETE_CONTEXT          = 0x0405,  /* RFC 2743 delete context */
  74     TOK_TYPE_EAP_RESP                = 0x0601,  /* draft-howlett-eap-gss */
  75     TOK_TYPE_EAP_REQ                 = 0x0602,  /* draft-howlett-eap-gss */
  76     TOK_TYPE_GSS_CHANNEL_BINDINGS    = 0x0603,  /* draft-howlett-eap-gss */
  77 };
  78
  79 /* util_buffer.c */
  80 OM_uint32
  81 makeStringBuffer(OM_uint32 *minor,
  82                  const char *string,
  83                  gss_buffer_t buffer);
  84
  85 OM_uint32
  86 bufferToString(OM_uint32 *minor,
  87                const gss_buffer_t buffer,
  88                char **pString);
  89
  90 OM_uint32
  91 duplicateBuffer(OM_uint32 *minor,
  92                 const gss_buffer_t src,
  93                 gss_buffer_t dst);
  94
  95 /* util_cksum.c */
  96 int
  97 gssEapSign(krb5_context context,
  98            krb5_cksumtype type,
  99            size_t rrc,
 100            krb5_keyblock *key,
 101            krb5_keyusage sign_usage,
 102            gss_iov_buffer_desc *iov,
 103            int iov_count);
 104
 105 int
 106 gssEapVerify(krb5_context context,
 107              krb5_cksumtype type,
 108              size_t rrc,
 109              krb5_keyblock *key,
 110              krb5_keyusage sign_usage,
 111              gss_iov_buffer_desc *iov,
 112              int iov_count,
 113              int *valid);
 114
 115 /* util_context.c */
 116 OM_uint32 gssEapAllocContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
 117 OM_uint32 gssEapReleaseContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
 118
 119 OM_uint32
 120 gssEapMakeToken(OM_uint32 *minor,
 121                 gss_ctx_id_t ctx,
 122                 const gss_buffer_t innerToken,
 123                 enum gss_eap_token_type tokenType,
 124                 gss_buffer_t outputToken);
 125
 126 OM_uint32
 127 gssEapVerifyToken(OM_uint32 *minor,
 128                   gss_ctx_id_t ctx,
 129                   const gss_buffer_t inputToken,
 130                   enum gss_eap_token_type tokenType,
 131                   gss_buffer_t innerInputToken);
 132
 133 /* util_cred.c */
 134 OM_uint32 gssEapAllocCred(OM_uint32 *minor, gss_cred_id_t *pCred);
 135 OM_uint32 gssEapReleaseCred(OM_uint32 *minor, gss_cred_id_t *pCred);
 136
 137 OM_uint32
 138 gssEapAcquireCred(OM_uint32 *minor,
 139                   const gss_name_t desiredName,
 140                   const gss_buffer_t password,
 141                   OM_uint32 timeReq,
 142                   const gss_OID_set desiredMechs,
 143                   int cred_usage,
 144                   gss_cred_id_t *pCred,
 145                   gss_OID_set *pActualMechs,
 146                   OM_uint32 *timeRec);
 147
 148 /* util_crypt.c */
 149 int
 150 gssEapEncrypt(krb5_context context, int dce_style, size_t ec,
 151               size_t rrc, krb5_keyblock *key, int usage, krb5_pointer iv,
 152               gss_iov_buffer_desc *iov, int iov_count);
 153
 154 int
 155 gssEapDecrypt(krb5_context context, int dce_style, size_t ec,
 156               size_t rrc, krb5_keyblock *key, int usage, krb5_pointer iv,
 157               gss_iov_buffer_desc *iov, int iov_count);
 158
 159 krb5_cryptotype
 160 gssEapMapCryptoFlag(OM_uint32 type);
 161
 162 gss_iov_buffer_t
 163 gssEapLocateIov(gss_iov_buffer_desc *iov,
 164                 int iov_count,
 165                 OM_uint32 type);
 166
 167 void
 168 gssEapIovMessageLength(gss_iov_buffer_desc *iov,
 169                        int iov_count,
 170                        size_t *data_length,
 171                        size_t *assoc_data_length);
 172
 173 void
 174 gssEapReleaseIov(gss_iov_buffer_desc *iov, int iov_count);
 175
 176 int
 177 gssEapIsIntegrityOnly(gss_iov_buffer_desc *iov, int iov_count);
 178
 179 int
 180 gssEapAllocIov(gss_iov_buffer_t iov, size_t size);
 181
 182 OM_uint32
 183 gssEapDeriveRFC3961Key(OM_uint32 *minor,
 184                        gss_buffer_t msk,
 185                        krb5_enctype enctype,
 186                        krb5_keyblock *pKey);
 187
 188 /* util_krb.c */
 189 OM_uint32
 190 gssEapKerberosInit(OM_uint32 *minor, krb5_context *context);
 191
 192 #define GSSEAP_KRB_INIT(ctx) do {                   \
 193         OM_uint32 tmpMajor;                         \
 194         tmpMajor  = gssEapKerberosInit(minor, ctx); \
 195         if (GSS_ERROR(tmpMajor)) {                  \
 196             return tmpMajor;                        \
 197         }                                           \
 198     } while (0)
 199
 200 /* util_mech.c */
 201 int
 202 gssEapInternalizeOid(const gss_OID oid,
 203                      gss_OID *const pInternalizedOid);
 204
 205 OM_uint32
 206 gssEapDefaultMech(OM_uint32 *minor,
 207                   gss_OID *oid);
 208
 209 OM_uint32
 210 gssEapIndicateMechs(OM_uint32 *minor,
 211                     gss_OID_set *mechs);
 212
 213 OM_uint32
 214 gssEapEnctypeToOid(OM_uint32 *minor,
 215                    krb5_enctype enctype,
 216                    gss_OID *pOid);
 217
 218 OM_uint32
 219 gssEapOidToEnctype(OM_uint32 *minor,
 220                    const gss_OID oid,
 221                    krb5_enctype *enctype);
 222
 223 int
 224 gssEapIsMechanismOid(const gss_OID oid);
 225
 226 int
 227 gssEapIsConcreteMechanismOid(const gss_OID oid);
 228
 229 OM_uint32
 230 gssEapValidateMechs(OM_uint32 *minor,
 231                    const gss_OID_set mechs);
 232
 233 /* util_name.c */
 234 enum gss_eap_attribute_type {
 235     ATTR_TYPE_NONE                  = 0,
 236     ATTR_TYPE_SAML_AAA_ASSERTION    = 1,
 237     ATTR_TYPE_SAML_ATTR             = 2,
 238     ATTR_TYPE_RADIUS_AVP            = 3
 239 };
 240
 241 OM_uint32 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName);
 242 OM_uint32 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName);
 243 OM_uint32 gssEapExportName(OM_uint32 *minor,
 244                            const gss_name_t name,
 245                            gss_buffer_t exportedName,
 246                            int composite);
 247 OM_uint32 gssEapImportName(OM_uint32 *minor,
 248                            const gss_buffer_t input_name_buffer,
 249                            gss_OID input_name_type,
 250                            gss_name_t *output_name);
 251
 252 enum gss_eap_attribute_type
 253 gssEapAttributePrefixToType(const gss_buffer_t prefix);
 254 gss_buffer_t
 255 gssEapAttributeTypeToPrefix(enum gss_eap_attribute_type type);
 256 OM_uint32
 257 decomposeAttributeName(OM_uint32 *minor,
 258                        const gss_buffer_t attribute,
 259                        gss_buffer_t prefix,
 260                        gss_buffer_t suffix);
 261 OM_uint32
 262 composeAttributeName(OM_uint32 *minor,
 263                      const gss_buffer_t prefix,
 264                      const gss_buffer_t suffix,
 265                      gss_buffer_t attribute);
 266
 267 /* util_oid.c */
 268 OM_uint32
 269 composeOid(OM_uint32 *minor_status,
 270            const char *prefix,
 271            size_t prefix_len,
 272            int suffix,
 273            gss_OID_desc *oid);
 274
 275 OM_uint32
 276 decomposeOid(OM_uint32 *minor_status,
 277              const char *prefix,
 278              size_t prefix_len,
 279              gss_OID_desc *oid,
 280              int *suffix) ;
 281
 282 OM_uint32
 283 duplicateOid(OM_uint32 *minor_status,
 284              const gss_OID_desc * const oid,
 285              gss_OID *new_oid);
 286
 287 OM_uint32
 288 duplicateOidSet(OM_uint32 *minor,
 289                 const gss_OID_set src,
 290                 gss_OID_set *dst);
 291
 292 static inline int
 293 oidEqual(const gss_OID_desc *o1, const gss_OID_desc *o2)
 294 {
 295     if (o1 == GSS_C_NO_OID)
 296         return (o2 == GSS_C_NO_OID);
 297     else if (o2 == GSS_C_NO_OID)
 298         return (o1 == GSS_C_NO_OID);
 299     else
 300         return (o1->length == o2->length &&
 301                 memcmp(o1->elements, o2->elements, o1->length) == 0);
 302 }
 303
 304 /* util_ordering.c */
 305 int
 306 sequenceInternalize(void **vqueue, unsigned char **buf, size_t *lenremain);
 307
 308 int
 309 sequenceExternalize(void *vqueue, unsigned char **buf, size_t *lenremain);
 310
 311 int
 312 sequenceSize(void *vqueue, size_t *sizep);
 313
 314 void
 315 sequenceFree(void **vqueue);
 316
 317 int
 318 sequenceCheck(void **vqueue, uint64_t seqnum);
 319
 320 int
 321 sequenceInit(void **vqueue, uint64_t seqnum,
 322              int do_replay, int do_sequence, int wide_nums);
 323
 324 /* util_token.c */
 325 size_t
 326 tokenSize(const gss_OID_desc *mech, size_t body_size);
 327
 328 void
 329 makeTokenHeader(const gss_OID_desc *mech,
 330                 size_t body_size,
 331                 unsigned char **buf,
 332                 enum gss_eap_token_type tok_type);
 333
 334 int
 335 verifyTokenHeader(gss_OID mech,
 336                   size_t *body_size,
 337                   unsigned char **buf_in,
 338                   size_t toksize_in,
 339                   enum gss_eap_token_type tok_type);
 340
 341 /* Helper macros */
 342 #define GSSEAP_CALLOC(count, size)      (calloc((count), (size)))
 343 #define GSSEAP_FREE(ptr)                (free((ptr)))
 344 #define GSSEAP_MALLOC(size)             (malloc((size)))
 345 #define GSSEAP_REALLOC(ptr, size)       (realloc((ptr), (size)))
 346
 347 #define GSSEAP_NOT_IMPLEMENTED          do {            \
 348         assert(0 && "not implemented");                 \
 349         *minor = ENOSYS;                                \
 350         return GSS_S_FAILURE;                           \
 351     } while (0)
 352
 353 #include <pthread.h>
 354
 355 #define GSSEAP_MUTEX                    pthread_mutex_t
 356 #define GSSEAP_MUTEX_INITIALIZER        PTHREAD_MUTEX_INITIALIZER
 357
 358 #define GSSEAP_MUTEX_INIT(m)            pthread_mutex_init((m), NULL)
 359 #define GSSEAP_MUTEX_DESTROY(m)         pthread_mutex_destroy((m))
 360 #define GSSEAP_MUTEX_LOCK(m)            pthread_mutex_lock((m))
 361 #define GSSEAP_MUTEX_UNLOCK(m)          pthread_mutex_unlock((m))
 362
 363 #define GSSEAP_THREAD_KEY               pthread_key_t
 364 #define GSSEAP_KEY_CREATE(k, d)         pthread_key_create((k), (d))
 365 #define GSSEAP_GETSPECIFIC(k)           pthread_getspecific((k))
 366 #define GSSEAP_SETSPECIFIC(k, d)        pthread_setspecific((k), (d))
 367
 368 #define GSSEAP_THREAD_ONCE              pthread_once_t
 369 #define GSSEAP_ONCE(o, i)               pthread_once((o), (i))
 370 #define GSSEAP_ONCE_INITIALIZER         PTHREAD_ONCE_INIT
 371
 372 /* Helper functions */
 373 static inline void
 374 store_uint16_be(uint16_t val, void *vp)
 375 {
 376     unsigned char *p = (unsigned char *)vp;
 377
 378     p[0] = (val >>  8) & 0xff;
 379     p[1] = (val      ) & 0xff;
 380 }
 381
 382 static inline uint16_t
 383 load_uint16_be(const void *cvp)
 384 {
 385     const unsigned char *p = (const unsigned char *)cvp;
 386
 387     return (p[1] | (p[0] << 8));
 388 }
 389
 390 static inline void
 391 store_uint32_be(uint32_t val, void *vp)
 392 {
 393     unsigned char *p = (unsigned char *)vp;
 394
 395     p[0] = (val >> 24) & 0xff;
 396     p[1] = (val >> 16) & 0xff;
 397     p[2] = (val >>  8) & 0xff;
 398     p[3] = (val      ) & 0xff;
 399 }
 400
 401 static inline uint32_t
 402 load_uint32_be(const void *cvp)
 403 {
 404     const unsigned char *p = (const unsigned char *)cvp;
 405
 406     return (p[3] | (p[2] << 8)
 407             | ((uint32_t) p[1] << 16)
 408             | ((uint32_t) p[0] << 24));
 409 }
 410
 411 static inline void
 412 store_uint64_be(uint64_t val, void *vp)
 413 {
 414     unsigned char *p = (unsigned char *)vp;
 415
 416     p[0] = (unsigned char)((val >> 56) & 0xff);
 417     p[1] = (unsigned char)((val >> 48) & 0xff);
 418     p[2] = (unsigned char)((val >> 40) & 0xff);
 419     p[3] = (unsigned char)((val >> 32) & 0xff);
 420     p[4] = (unsigned char)((val >> 24) & 0xff);
 421     p[5] = (unsigned char)((val >> 16) & 0xff);
 422     p[6] = (unsigned char)((val >>  8) & 0xff);
 423     p[7] = (unsigned char)((val      ) & 0xff);
 424 }
 425
 426 static inline uint64_t
 427 load_uint64_be(const void *cvp)
 428 {
 429     const unsigned char *p = (const unsigned char *)cvp;
 430
 431     return ((uint64_t)load_uint32_be(p) << 32) | load_uint32_be(p + 4);
 432 }
 433
 434 #endif /* _UTIL_H_ */