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 int
  68 gssEapSign(krb5_context context,
  69            krb5_cksumtype type,
  70            size_t rrc,
  71            krb5_keyblock *key,
  72            krb5_keyusage sign_usage,
  73            gss_iov_buffer_desc *iov,
  74            int iov_count);
  75
  76 int
  77 gssEapVerify(krb5_context context,
  78              krb5_cksumtype type,
  79              size_t rrc,
  80              krb5_keyblock *key,
  81              krb5_keyusage sign_usage,
  82              gss_iov_buffer_desc *iov,
  83              int iov_count,
  84              int *valid);
  85
  86 /* util_context.c */
  87 OM_uint32 gssEapAllocContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
  88 OM_uint32 gssEapReleaseContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
  89
  90 /* util_cred.c */
  91 OM_uint32 gssEapAllocCred(OM_uint32 *minor, gss_cred_id_t *pCred);
  92 OM_uint32 gssEapReleaseCred(OM_uint32 *minor, gss_cred_id_t *pCred);
  93
  94 /* util_crypt.c */
  95 int
  96 gssEapEncrypt(krb5_context context, int dce_style, size_t ec,
  97               size_t rrc, krb5_keyblock *key, int usage, krb5_pointer iv,
  98               gss_iov_buffer_desc *iov, int iov_count);
  99
 100 int
 101 gssEapDecrypt(krb5_context context, int dce_style, size_t ec,
 102               size_t rrc, krb5_keyblock *key, int usage, krb5_pointer iv,
 103               gss_iov_buffer_desc *iov, int iov_count);
 104
 105 krb5_cryptotype
 106 gssEapMapCryptoFlag(OM_uint32 type);
 107
 108 gss_iov_buffer_t
 109 gssEapLocateIov(gss_iov_buffer_desc *iov,
 110                 int iov_count,
 111                 OM_uint32 type);
 112
 113 void
 114 gssEapIovMessageLength(gss_iov_buffer_desc *iov,
 115                        int iov_count,
 116                        size_t *data_length,
 117                        size_t *assoc_data_length);
 118
 119 void
 120 gssEapReleaseIov(gss_iov_buffer_desc *iov, int iov_count);
 121
 122 int
 123 gssEapIsIntegrityOnly(gss_iov_buffer_desc *iov, int iov_count);
 124
 125 int
 126 gssEapAllocIov(gss_iov_buffer_t iov, size_t size);
 127
 128 OM_uint32
 129 gssEapDeriveRFC3961Key(OM_uint32 *minor,
 130                        gss_buffer_t msk,
 131                        krb5_enctype enctype,
 132                        krb5_keyblock *pKey);
 133
 134 /* util_krb.c */
 135 OM_uint32
 136 gssEapKerberosInit(OM_uint32 *minor, krb5_context *context);
 137
 138 #define GSSEAP_KRB_INIT(ctx) do {                   \
 139         OM_uint32 tmpMajor;                         \
 140         tmpMajor  = gssEapKerberosInit(minor, ctx); \
 141         if (GSS_ERROR(tmpMajor)) {                  \
 142             return tmpMajor;                        \
 143         }                                           \
 144     } while (0)
 145
 146 /* util_mech.c */
 147 void
 148 gssEapInternalizeOid(const gss_OID oid,
 149                      gss_OID *const pInternalizedOid);
 150
 151 OM_uint32
 152 gssEapDefaultMech(OM_uint32 *minor,
 153                   gss_OID *oid);
 154
 155 OM_uint32
 156 gssEapIndicateMechs(OM_uint32 *minor,
 157                     gss_OID_set *mechs);
 158
 159 OM_uint32
 160 gssEapEnctypeToOid(OM_uint32 *minor,
 161                    krb5_enctype enctype,
 162                    gss_OID *pOid);
 163
 164 OM_uint32
 165 gssEapOidToEnctype(OM_uint32 *minor,
 166                    const gss_OID oid,
 167                    krb5_enctype *enctype);
 168
 169 int
 170 gssEapIsMechanismOid(const gss_OID oid);
 171
 172 /* util_name.c */
 173 OM_uint32 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName);
 174 OM_uint32 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName);
 175 OM_uint32 gssEapExportName(OM_uint32 *minor,
 176                            const gss_name_t name,
 177                            gss_buffer_t exportedName,
 178                            int composite);
 179
 180 /* util_oid.c */
 181 OM_uint32
 182 composeOid(OM_uint32 *minor_status,
 183            const char *prefix,
 184            size_t prefix_len,
 185            int suffix,
 186            gss_OID_desc *oid);
 187
 188 OM_uint32
 189 decomposeOid(OM_uint32 *minor_status,
 190              const char *prefix,
 191              size_t prefix_len,
 192              gss_OID_desc *oid,
 193              int *suffix) ;
 194
 195 static inline int
 196 oidEqual(const gss_OID_desc *o1, const gss_OID_desc  *o2)
 197 {
 198     return (o1->length == o2->length &&
 199             memcmp(o1->elements, o2->elements, o1->length) == 0);
 200 }
 201
 202 /* util_ordering.c */
 203 int
 204 sequenceInternalize(void **vqueue, unsigned char **buf, size_t *lenremain);
 205
 206 int
 207 sequenceExternalize(void *vqueue, unsigned char **buf, size_t *lenremain);
 208
 209 int
 210 sequenceSize(void *vqueue, size_t *sizep);
 211
 212 void
 213 sequenceFree(void **vqueue);
 214
 215 int
 216 sequenceCheck(void **vqueue, uint64_t seqnum);
 217
 218 int
 219 sequenceInit(void **vqueue, uint64_t seqnum,
 220              int do_replay, int do_sequence, int wide_nums);
 221
 222 /* util_token.c */
 223 enum gss_eap_token_type {
 224     TOK_TYPE_EAP_RESP  = 0x0601,
 225     TOK_TYPE_EAP_REQ   = 0x0602,
 226     TOK_TYPE_GSS_CB    = 0x0603,
 227     TOK_TYPE_MIC       = 0x0404,
 228     TOK_TYPE_WRAP      = 0x0504,
 229     TOK_TYPE_DELETE    = 0x0405,
 230     TOK_TYPE_NONE      = 0xFFFF
 231 };
 232
 233 size_t
 234 tokenSize(const gss_OID_desc *mech, size_t body_size);
 235
 236 void
 237 makeTokenHeader(const gss_OID_desc *mech,
 238                 size_t body_size,
 239                 unsigned char **buf,
 240                 enum gss_eap_token_type tok_type);
 241
 242 int
 243 verifyTokenHeader(const gss_OID_desc * mech,
 244                   size_t *body_size,
 245                   unsigned char **buf_in,
 246                   size_t toksize_in,
 247                   enum gss_eap_token_type tok_type);
 248
 249 /* Helper macros */
 250 #define GSSEAP_CALLOC(count, size)      (calloc((count), (size)))
 251 #define GSSEAP_FREE(ptr)                (free((ptr)))
 252 #define GSSEAP_MALLOC(size)             (malloc((size)))
 253 #define GSSEAP_REALLOC(ptr, size)       (realloc((ptr), (size)))
 254
 255 #define GSSEAP_NOT_IMPLEMENTED          do {            \
 256         assert(0 && "not implemented");                 \
 257         *minor = ENOSYS;                                \
 258         return GSS_S_FAILURE;                           \
 259     } while (0)
 260
 261 #include <pthread.h>
 262
 263 #define GSSEAP_MUTEX                    pthread_mutex_t
 264 #define GSSEAP_MUTEX_INITIALIZER        PTHREAD_MUTEX_INITIALIZER
 265
 266 #define GSSEAP_MUTEX_INIT(m)            pthread_mutex_init((m), NULL)
 267 #define GSSEAP_MUTEX_DESTROY(m)         pthread_mutex_destroy((m))
 268 #define GSSEAP_MUTEX_LOCK(m)            pthread_mutex_lock((m))
 269 #define GSSEAP_MUTEX_UNLOCK(m)          pthread_mutex_unlock((m))
 270
 271 #define GSSEAP_THREAD_KEY               pthread_key_t
 272 #define GSSEAP_KEY_CREATE(k, d)         pthread_key_create((k), (d))
 273 #define GSSEAP_GETSPECIFIC(k)           pthread_getspecific((k))
 274 #define GSSEAP_SETSPECIFIC(k, d)        pthread_setspecific((k), (d))
 275
 276 #define GSSEAP_THREAD_ONCE              pthread_once_t
 277 #define GSSEAP_ONCE(o, i)               pthread_once((o), (i))
 278 #define GSSEAP_ONCE_INITIALIZER         PTHREAD_ONCE_INIT
 279
 280 /* Helper functions */
 281 static inline void
 282 store_uint16_be(uint16_t val, void *vp)
 283 {
 284     unsigned char *p = (unsigned char *)vp;
 285
 286     p[0] = (val >>  8) & 0xff;
 287     p[1] = (val      ) & 0xff;
 288 }
 289
 290 static inline uint16_t
 291 load_uint16_be(const void *cvp)
 292 {
 293     const unsigned char *p = (const unsigned char *)cvp;
 294
 295     return (p[1] | (p[0] << 8));
 296 }
 297
 298 static inline void
 299 store_uint32_be(uint32_t val, void *vp)
 300 {
 301     unsigned char *p = (unsigned char *)vp;
 302
 303     p[0] = (val >> 24) & 0xff;
 304     p[1] = (val >> 16) & 0xff;
 305     p[2] = (val >>  8) & 0xff;
 306     p[3] = (val      ) & 0xff;
 307 }
 308
 309 static inline uint32_t
 310 load_uint32_be(const void *cvp)
 311 {
 312     const unsigned char *p = (const unsigned char *)cvp;
 313
 314     return (p[3] | (p[2] << 8)
 315             | ((uint32_t) p[1] << 16)
 316             | ((uint32_t) p[0] << 24));
 317 }
 318
 319 static inline void
 320 store_uint64_be(uint64_t val, void *vp)
 321 {
 322     unsigned char *p = (unsigned char *)vp;
 323
 324     p[0] = (unsigned char)((val >> 56) & 0xff);
 325     p[1] = (unsigned char)((val >> 48) & 0xff);
 326     p[2] = (unsigned char)((val >> 40) & 0xff);
 327     p[3] = (unsigned char)((val >> 32) & 0xff);
 328     p[4] = (unsigned char)((val >> 24) & 0xff);
 329     p[5] = (unsigned char)((val >> 16) & 0xff);
 330     p[6] = (unsigned char)((val >>  8) & 0xff);
 331     p[7] = (unsigned char)((val      ) & 0xff);
 332 }
 333
 334 static inline uint64_t
 335 load_uint64_be(const void *cvp)
 336 {
 337     const unsigned char *p = (const unsigned char *)cvp;
 338
 339     return ((uint64_t)load_uint32_be(p) << 32) | load_uint32_be(p + 4);
 340 }
 341
 342 static OM_uint32
 343 makeStringBuffer(OM_uint32 *minor,
 344                  const char *string,
 345                  gss_buffer_t buffer)
 346 {
 347     size_t len = strlen(string);
 348
 349     buffer->value = GSSEAP_MALLOC(len + 1);
 350     if (buffer->value == NULL) {
 351         *minor = ENOMEM;
 352         return GSS_S_FAILURE;
 353     }
 354     memcpy(buffer->value, string, len + 1);
 355     buffer->length = len;
 356
 357     *minor = 0;
 358     return GSS_S_COMPLETE;
 359 }
 360
 361 #endif /* _UTIL_H_ */