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