2 * Copyright (c) 2010, JANET(UK)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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.
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.
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
33 * Portions Copyright 2003-2010 Massachusetts Institute of Technology.
34 * All Rights Reserved.
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.
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.
69 #ifndef MIN /* Usually found in <sys/param.h>. */
70 #define MIN(_a,_b) ((_a)<(_b)?(_a):(_b))
73 #define KRB_KEY_TYPE(key) ((key)->enctype)
74 #define KRB_KEY_DATA(key) ((key)->contents)
75 #define KRB_KEY_LENGTH(key) ((key)->length)
76 #define KRB_KEY_INIT(key) do { \
77 KRB_KEY_TYPE(key) = ENCTYPE_NULL; \
78 KRB_KEY_DATA(key) = NULL; \
79 KRB_KEY_LENGTH(key) = 0; \
82 enum gss_eap_token_type {
83 TOK_TYPE_NONE = 0x0000, /* no token */
84 TOK_TYPE_MIC = 0x0404, /* RFC 4121 MIC token */
85 TOK_TYPE_WRAP = 0x0504, /* RFC 4121 wrap token */
86 TOK_TYPE_EXPORT_NAME = 0x0401, /* RFC 2743 exported name */
87 TOK_TYPE_EXPORT_NAME_COMPOSITE = 0x0402, /* draft-ietf-kitten-gss-naming */
88 TOK_TYPE_DELETE_CONTEXT = 0x0405, /* RFC 2743 delete context */
89 TOK_TYPE_EAP_RESP = 0x0601, /* draft-howlett-eap-gss */
90 TOK_TYPE_EAP_REQ = 0x0602, /* draft-howlett-eap-gss */
91 TOK_TYPE_EXT_REQ = 0x0603, /* draft-howlett-eap-gss */
92 TOK_TYPE_EXT_RESP = 0x0604, /* to be specified */
93 TOK_TYPE_GSS_REAUTH = 0x0605, /* to be specified */
96 #define EAP_EXPORT_CONTEXT_V1 1
100 makeStringBuffer(OM_uint32 *minor,
102 gss_buffer_t buffer);
105 bufferToString(OM_uint32 *minor,
106 const gss_buffer_t buffer,
110 duplicateBuffer(OM_uint32 *minor,
111 const gss_buffer_t src,
115 bufferEqual(const gss_buffer_t b1, const gss_buffer_t b2)
117 return (b1->length == b2->length &&
118 memcmp(b1->value, b2->value, b2->length) == 0);
122 bufferEqualString(const gss_buffer_t b1, const char *s)
126 b2.length = strlen(s);
127 b2.value = (char *)s;
129 return bufferEqual(b1, &b2);
134 gssEapSign(krb5_context context,
138 krb5_keyusage sign_usage,
139 gss_iov_buffer_desc *iov,
143 gssEapVerify(krb5_context context,
147 krb5_keyusage sign_usage,
148 gss_iov_buffer_desc *iov,
154 gssEapEncodeGssChannelBindings(OM_uint32 *minor,
155 gss_channel_bindings_t chanBindings,
156 gss_buffer_t encodedBindings);
160 OM_uint32 gssEapAllocContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
161 OM_uint32 gssEapReleaseContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
164 gssEapMakeToken(OM_uint32 *minor,
166 const gss_buffer_t innerToken,
167 enum gss_eap_token_type tokenType,
168 gss_buffer_t outputToken);
171 gssEapVerifyToken(OM_uint32 *minor,
173 const gss_buffer_t inputToken,
174 enum gss_eap_token_type *tokenType,
175 gss_buffer_t innerInputToken);
178 gssEapContextTime(OM_uint32 *minor,
179 gss_ctx_id_t context_handle,
180 OM_uint32 *time_rec);
183 gssEapDisplayName(OM_uint32 *minor,
185 gss_buffer_t output_name_buffer,
186 gss_OID *output_name_type);
189 OM_uint32 gssEapAllocCred(OM_uint32 *minor, gss_cred_id_t *pCred);
190 OM_uint32 gssEapReleaseCred(OM_uint32 *minor, gss_cred_id_t *pCred);
193 gssEapAcquireCred(OM_uint32 *minor,
194 const gss_name_t desiredName,
195 const gss_buffer_t password,
197 const gss_OID_set desiredMechs,
199 gss_cred_id_t *pCred,
200 gss_OID_set *pActualMechs,
203 int gssEapCredAvailable(gss_cred_id_t cred, gss_OID mech);
207 gssEapEncrypt(krb5_context context, int dce_style, size_t ec,
208 size_t rrc, krb5_keyblock *key, int usage, krb5_pointer iv,
209 gss_iov_buffer_desc *iov, int iov_count);
212 gssEapDecrypt(krb5_context context, int dce_style, size_t ec,
213 size_t rrc, krb5_keyblock *key, int usage, krb5_pointer iv,
214 gss_iov_buffer_desc *iov, int iov_count);
217 gssEapMapCryptoFlag(OM_uint32 type);
220 gssEapLocateIov(gss_iov_buffer_desc *iov,
225 gssEapIovMessageLength(gss_iov_buffer_desc *iov,
228 size_t *assoc_data_length);
231 gssEapReleaseIov(gss_iov_buffer_desc *iov, int iov_count);
234 gssEapIsIntegrityOnly(gss_iov_buffer_desc *iov, int iov_count);
237 gssEapAllocIov(gss_iov_buffer_t iov, size_t size);
240 gssEapDeriveRfc3961Key(OM_uint32 *minor,
241 const unsigned char *key,
243 krb5_enctype enctype,
244 krb5_keyblock *pKey);
247 #define EXT_FLAG_CRITICAL 0x80000000
248 #define EXT_FLAG_VERIFIED 0x40000000
250 #define EXT_TYPE_GSS_CHANNEL_BINDINGS 0x00000000
251 #define EXT_TYPE_REAUTH_CREDS 0x00000001
252 #define EXT_TYPE_MASK (~(EXT_FLAG_CRITICAL | EXT_FLAG_VERIFIED))
254 struct gss_eap_extension_provider {
257 OM_uint32 (*callback)(OM_uint32 *,
260 gss_channel_bindings_t,
265 gssEapMakeExtensions(OM_uint32 *minor,
268 const struct gss_eap_extension_provider *exts,
270 gss_channel_bindings_t chanBindings,
271 gss_buffer_t buffer);
274 gssEapVerifyExtensions(OM_uint32 *minor,
277 const struct gss_eap_extension_provider *exts,
279 gss_channel_bindings_t chanBindings,
280 const gss_buffer_t buffer);
284 gssEapKerberosInit(OM_uint32 *minor, krb5_context *context);
287 rfc3961ChecksumTypeForKey(OM_uint32 *minor,
289 krb5_cksumtype *cksumtype);
291 #define GSSEAP_KRB_INIT(ctx) do { \
292 OM_uint32 tmpMajor; \
293 tmpMajor = gssEapKerberosInit(minor, ctx); \
294 if (GSS_ERROR(tmpMajor)) { \
301 gssEapExportLucidSecContext(OM_uint32 *minor,
303 const gss_OID desiredObject,
304 gss_buffer_set_t *data_set);
307 extern gss_OID GSS_EAP_MECHANISM;
310 gssEapInternalizeOid(const gss_OID oid,
311 gss_OID *const pInternalizedOid);
314 gssEapDefaultMech(OM_uint32 *minor,
318 gssEapIndicateMechs(OM_uint32 *minor,
322 gssEapEnctypeToOid(OM_uint32 *minor,
323 krb5_enctype enctype,
327 gssEapOidToEnctype(OM_uint32 *minor,
329 krb5_enctype *enctype);
332 gssEapIsMechanismOid(const gss_OID oid);
335 gssEapIsConcreteMechanismOid(const gss_OID oid);
338 gssEapValidateMechs(OM_uint32 *minor,
339 const gss_OID_set mechs);
342 gssEapOidToSaslName(const gss_OID oid);
345 gssEapSaslNameToOid(const gss_buffer_t name);
348 #define EXPORT_NAME_FLAG_OID 0x1
349 #define EXPORT_NAME_FLAG_COMPOSITE 0x2
351 OM_uint32 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName);
352 OM_uint32 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName);
353 OM_uint32 gssEapExportName(OM_uint32 *minor,
354 const gss_name_t name,
355 gss_buffer_t exportedName);
356 OM_uint32 gssEapExportNameInternal(OM_uint32 *minor,
357 const gss_name_t name,
358 gss_buffer_t exportedName,
360 OM_uint32 gssEapImportName(OM_uint32 *minor,
361 const gss_buffer_t input_name_buffer,
362 gss_OID input_name_type,
363 gss_name_t *output_name);
364 OM_uint32 gssEapImportNameInternal(OM_uint32 *minor,
365 const gss_buffer_t input_name_buffer,
366 gss_name_t *output_name,
369 gssEapDuplicateName(OM_uint32 *minor,
370 const gss_name_t input_name,
371 gss_name_t *dest_name);
375 composeOid(OM_uint32 *minor_status,
382 decomposeOid(OM_uint32 *minor_status,
389 duplicateOid(OM_uint32 *minor_status,
390 const gss_OID_desc * const oid,
394 duplicateOidSet(OM_uint32 *minor,
395 const gss_OID_set src,
399 oidEqual(const gss_OID_desc *o1, const gss_OID_desc *o2)
401 if (o1 == GSS_C_NO_OID)
402 return (o2 == GSS_C_NO_OID);
403 else if (o2 == GSS_C_NO_OID)
404 return (o1 == GSS_C_NO_OID);
406 return (o1->length == o2->length &&
407 memcmp(o1->elements, o2->elements, o1->length) == 0);
410 /* util_ordering.c */
412 sequenceInternalize(OM_uint32 *minor,
418 sequenceExternalize(OM_uint32 *minor,
424 sequenceSize(void *vqueue);
427 sequenceFree(OM_uint32 *minor, void **vqueue);
430 sequenceCheck(OM_uint32 *minor, void **vqueue, uint64_t seqnum);
433 sequenceInit(OM_uint32 *minor, void **vqueue, uint64_t seqnum,
434 int do_replay, int do_sequence, int wide_nums);
438 tokenSize(const gss_OID_desc *mech, size_t body_size);
441 makeTokenHeader(const gss_OID_desc *mech,
444 enum gss_eap_token_type tok_type);
447 verifyTokenHeader(OM_uint32 *minor,
450 unsigned char **buf_in,
452 enum gss_eap_token_type *ret_tok_type);
456 #define GSSEAP_CALLOC calloc
457 #define GSSEAP_MALLOC malloc
458 #define GSSEAP_FREE free
459 #define GSSEAP_REALLOC realloc
461 #define GSSEAP_NOT_IMPLEMENTED do { \
462 assert(0 && "not implemented"); \
464 return GSS_S_FAILURE; \
469 #define GSSEAP_MUTEX pthread_mutex_t
470 #define GSSEAP_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
472 #define GSSEAP_MUTEX_INIT(m) pthread_mutex_init((m), NULL)
473 #define GSSEAP_MUTEX_DESTROY(m) pthread_mutex_destroy((m))
474 #define GSSEAP_MUTEX_LOCK(m) pthread_mutex_lock((m))
475 #define GSSEAP_MUTEX_UNLOCK(m) pthread_mutex_unlock((m))
477 #define GSSEAP_THREAD_KEY pthread_key_t
478 #define GSSEAP_KEY_CREATE(k, d) pthread_key_create((k), (d))
479 #define GSSEAP_GETSPECIFIC(k) pthread_getspecific((k))
480 #define GSSEAP_SETSPECIFIC(k, d) pthread_setspecific((k), (d))
482 #define GSSEAP_THREAD_ONCE pthread_once_t
483 #define GSSEAP_ONCE(o, i) pthread_once((o), (i))
484 #define GSSEAP_ONCE_INITIALIZER PTHREAD_ONCE_INIT
486 /* Helper functions */
488 store_uint16_be(uint16_t val, void *vp)
490 unsigned char *p = (unsigned char *)vp;
492 p[0] = (val >> 8) & 0xff;
493 p[1] = (val ) & 0xff;
496 static inline uint16_t
497 load_uint16_be(const void *cvp)
499 const unsigned char *p = (const unsigned char *)cvp;
501 return (p[1] | (p[0] << 8));
505 store_uint32_be(uint32_t val, void *vp)
507 unsigned char *p = (unsigned char *)vp;
509 p[0] = (val >> 24) & 0xff;
510 p[1] = (val >> 16) & 0xff;
511 p[2] = (val >> 8) & 0xff;
512 p[3] = (val ) & 0xff;
515 static inline uint32_t
516 load_uint32_be(const void *cvp)
518 const unsigned char *p = (const unsigned char *)cvp;
520 return (p[3] | (p[2] << 8)
521 | ((uint32_t) p[1] << 16)
522 | ((uint32_t) p[0] << 24));
526 store_uint64_be(uint64_t val, void *vp)
528 unsigned char *p = (unsigned char *)vp;
530 p[0] = (unsigned char)((val >> 56) & 0xff);
531 p[1] = (unsigned char)((val >> 48) & 0xff);
532 p[2] = (unsigned char)((val >> 40) & 0xff);
533 p[3] = (unsigned char)((val >> 32) & 0xff);
534 p[4] = (unsigned char)((val >> 24) & 0xff);
535 p[5] = (unsigned char)((val >> 16) & 0xff);
536 p[6] = (unsigned char)((val >> 8) & 0xff);
537 p[7] = (unsigned char)((val ) & 0xff);
540 static inline uint64_t
541 load_uint64_be(const void *cvp)
543 const unsigned char *p = (const unsigned char *)cvp;
545 return ((uint64_t)load_uint32_be(p) << 32) | load_uint32_be(p + 4);
548 static inline unsigned char *
549 store_buffer(gss_buffer_t buffer, void *vp, int wide_nums)
551 unsigned char *p = (unsigned char *)vp;
554 store_uint64_be(buffer->length, p);
557 store_uint32_be(buffer->length, p);
561 if (buffer->value != NULL) {
562 memcpy(p, buffer->value, buffer->length);
569 static inline unsigned char *
570 load_buffer(const void *cvp, size_t length, gss_buffer_t buffer)
573 buffer->value = GSSEAP_MALLOC(length);
574 if (buffer->value == NULL)
576 buffer->length = length;
577 memcpy(buffer->value, cvp, length);
578 return (unsigned char *)cvp + length;
581 static inline unsigned char *
582 store_oid(gss_OID oid, void *vp)
586 if (oid != GSS_C_NO_OID) {
587 buf.length = oid->length;
588 buf.value = oid->elements;
594 return store_buffer(&buf, vp, FALSE);
598 krbDataToGssBuffer(krb5_data *data, gss_buffer_t buffer)
600 buffer->value = (void *)data->data;
601 buffer->length = data->length;
605 gssBufferToKrbData(gss_buffer_t buffer, krb5_data *data)
607 data->data = (char *)buffer->value;
608 data->length = buffer->length;
615 #include "util_attr.h"
616 #ifdef GSSEAP_ENABLE_REAUTH
617 #include "util_reauth.h"
620 #endif /* _UTIL_H_ */