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 /* Helper APIs */
  61 OM_uint32 gssEapAllocContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
  62 OM_uint32 gssEapReleaseContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
  63
  64 OM_uint32 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName);
  65 OM_uint32 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName);
  66
  67 OM_uint32 gssEapAllocCred(OM_uint32 *minor, gss_cred_id_t *pCred);
  68 OM_uint32 gssEapReleaseCred(OM_uint32 *minor, gss_cred_id_t *pCred);
  69
  70 /* Kerberos token services */
  71 #define KRB_KEYTYPE(key)        ((key)->enctype)
  72
  73 /* util_crypt.c */
  74 int
  75 gssEapEncrypt(krb5_context context, int dce_style, size_t ec,
  76               size_t rrc, krb5_keyblock *key, int usage, krb5_pointer iv,
  77               gss_iov_buffer_desc *iov, int iov_count);
  78
  79 int
  80 gssEapDecrypt(krb5_context context, int dce_style, size_t ec,
  81               size_t rrc, krb5_keyblock *key, int usage, krb5_pointer iv,
  82               gss_iov_buffer_desc *iov, int iov_count);
  83
  84 krb5_cryptotype
  85 gssEapMapCryptoFlag(OM_uint32 type);
  86
  87 gss_iov_buffer_t
  88 gssEapLocateIov(gss_iov_buffer_desc *iov,
  89                 int iov_count,
  90                 OM_uint32 type);
  91
  92 void
  93 gssEapIovMessageLength(gss_iov_buffer_desc *iov,
  94                        int iov_count,
  95                        size_t *data_length,
  96                        size_t *assoc_data_length);
  97
  98 void
  99 gssEapReleaseIov(gss_iov_buffer_desc *iov, int iov_count);
 100
 101 int
 102 gssEapIsIntegrityOnly(gss_iov_buffer_desc *iov, int iov_count);
 103
 104 int
 105 gssEapAllocIov(gss_iov_buffer_t iov, size_t size);
 106
 107 /* util_cksum.c */
 108 int
 109 gssEapSign(krb5_context context,
 110            krb5_cksumtype type,
 111            size_t rrc,
 112            krb5_keyblock *key,
 113            krb5_keyusage sign_usage,
 114            gss_iov_buffer_desc *iov,
 115            int iov_count);
 116
 117 int
 118 gssEapVerify(krb5_context context,
 119              krb5_cksumtype type,
 120              size_t rrc,
 121              krb5_keyblock *key,
 122              krb5_keyusage sign_usage,
 123              gss_iov_buffer_desc *iov,
 124              int iov_count,
 125              int *valid);
 126
 127 /* util_ordering.c */
 128 int
 129 sequenceInternalize(void **vqueue, unsigned char **buf, size_t *lenremain);
 130
 131 int
 132 sequenceExternalize(void *vqueue, unsigned char **buf, size_t *lenremain);
 133
 134 int
 135 sequenceSize(void *vqueue, size_t *sizep);
 136
 137 void
 138 sequenceFree(void **vqueue);
 139
 140 int
 141 sequenceCheck(void **vqueue, uint64_t seqnum);
 142
 143 int
 144 sequenceInit(void **vqueue, uint64_t seqnum,
 145              int do_replay, int do_sequence, int wide_nums);
 146
 147 /* util_token.c */
 148 size_t
 149 tokenSize(const gss_OID_desc *mech, size_t body_size);
 150
 151 /* Helper macros */
 152 #define GSSEAP_CALLOC(count, size)      (calloc((count), (size)))
 153 #define GSSEAP_FREE(ptr)                (free((ptr)))
 154 #define GSSEAP_MALLOC(size)             (malloc((size)))
 155 #define GSSEAP_REALLOC(ptr, size)       (realloc((ptr), (size)))
 156
 157 #define GSSEAP_NOT_IMPLEMENTED          do {            \
 158         assert(0 && "not implemented");                 \
 159         *minor = ENOSYS;                                \
 160         return GSS_S_FAILURE;                           \
 161     } while (0)
 162
 163 /* Helper functions */
 164 static inline void
 165 store_uint16_be(uint16_t val, void *vp)
 166 {
 167     unsigned char *p = (unsigned char *)vp;
 168
 169     p[0] = (val >>  8) & 0xff;
 170     p[1] = (val      ) & 0xff;
 171 }
 172
 173 static inline uint16_t
 174 load_uint16_be(const void *cvp)
 175 {
 176     const unsigned char *p = (const unsigned char *)cvp;
 177
 178     return (p[1] | (p[0] << 8));
 179 }
 180
 181 static inline void
 182 store_uint32_be(uint32_t val, void *vp)
 183 {
 184     unsigned char *p = (unsigned char *)vp;
 185
 186     p[0] = (val >> 24) & 0xff;
 187     p[1] = (val >> 16) & 0xff;
 188     p[2] = (val >>  8) & 0xff;
 189     p[3] = (val      ) & 0xff;
 190 }
 191
 192 static inline uint32_t
 193 load_uint32_be(const void *cvp)
 194 {
 195     const unsigned char *p = (const unsigned char *)cvp;
 196
 197     return (p[3] | (p[2] << 8)
 198             | ((uint32_t) p[1] << 16)
 199             | ((uint32_t) p[0] << 24));
 200 }
 201
 202 static inline void
 203 store_uint64_be(uint64_t val, void *vp)
 204 {
 205     unsigned char *p = (unsigned char *)vp;
 206
 207     p[0] = (unsigned char)((val >> 56) & 0xff);
 208     p[1] = (unsigned char)((val >> 48) & 0xff);
 209     p[2] = (unsigned char)((val >> 40) & 0xff);
 210     p[3] = (unsigned char)((val >> 32) & 0xff);
 211     p[4] = (unsigned char)((val >> 24) & 0xff);
 212     p[5] = (unsigned char)((val >> 16) & 0xff);
 213     p[6] = (unsigned char)((val >>  8) & 0xff);
 214     p[7] = (unsigned char)((val      ) & 0xff);
 215 }
 216
 217 static inline uint64_t
 218 load_uint64_be(const void *cvp)
 219 {
 220     const unsigned char *p = (const unsigned char *)cvp;
 221
 222     return ((uint64_t)load_uint32_be(p) << 32) | load_uint32_be(p + 4);
 223 }
 224
 225 static inline int
 226 oidEqual(const gss_OID_desc *o1, const gss_OID_desc  *o2)
 227 {
 228     return (o1->length == o2->length &&
 229             memcmp(o1->elements, o2->elements, o1->length) == 0);
 230 }
 231
 232 #endif /* _UTIL_H_ */