2 * Copyright (c) 2011, 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.
64 #include <sys/param.h>
75 #define MIN(_a,_b) ((_a)<(_b)?(_a):(_b))
80 makeStringBuffer(OM_uint32 *minor,
85 bufferToString(OM_uint32 *minor,
86 const gss_buffer_t buffer,
90 duplicateBuffer(OM_uint32 *minor,
91 const gss_buffer_t src,
95 bufferEqual(const gss_buffer_t b1, const gss_buffer_t b2)
97 return (b1->length == b2->length &&
98 memcmp(b1->value, b2->value, b2->length) == 0);
102 bufferEqualString(const gss_buffer_t b1, const char *s)
106 b2.length = strlen(s);
107 b2.value = (char *)s;
109 return bufferEqual(b1, &b2);
114 gssEapSign(krb5_context context,
117 #ifdef HAVE_HEIMDAL_VERSION
122 krb5_keyusage sign_usage,
123 gss_iov_buffer_desc *iov,
127 gssEapVerify(krb5_context context,
130 #ifdef HAVE_HEIMDAL_VERSION
135 krb5_keyusage sign_usage,
136 gss_iov_buffer_desc *iov,
142 gssEapEncodeGssChannelBindings(OM_uint32 *minor,
143 gss_channel_bindings_t chanBindings,
144 gss_buffer_t encodedBindings);
148 #define EAP_EXPORT_CONTEXT_V1 1
150 enum gss_eap_token_type {
151 TOK_TYPE_NONE = 0x0000, /* no token */
152 TOK_TYPE_MIC = 0x0404, /* RFC 4121 MIC token */
153 TOK_TYPE_WRAP = 0x0504, /* RFC 4121 wrap token */
154 TOK_TYPE_EXPORT_NAME = 0x0401, /* RFC 2743 exported name */
155 TOK_TYPE_EXPORT_NAME_COMPOSITE = 0x0402, /* exported composite name */
156 TOK_TYPE_DELETE_CONTEXT = 0x0405, /* RFC 2743 delete context */
157 TOK_TYPE_ESTABLISH_CONTEXT = 0x0601, /* establish context */
160 /* inner token types and flags */
161 #define ITOK_TYPE_NONE 0x00000000
162 #define ITOK_TYPE_CONTEXT_ERR 0x00000001
163 #define ITOK_TYPE_ACCEPTOR_NAME_REQ 0x00000002
164 #define ITOK_TYPE_ACCEPTOR_NAME_RESP 0x00000003
165 #define ITOK_TYPE_EAP_RESP 0x00000004
166 #define ITOK_TYPE_EAP_REQ 0x00000005
167 #define ITOK_TYPE_GSS_CHANNEL_BINDINGS 0x00000006
168 #define ITOK_TYPE_REAUTH_CREDS 0x00000007
169 #define ITOK_TYPE_REAUTH_REQ 0x00000008
170 #define ITOK_TYPE_REAUTH_RESP 0x00000009
172 #define ITOK_FLAG_CRITICAL 0x80000000 /* critical, wire flag */
173 #define ITOK_FLAG_VERIFIED 0x40000000 /* verified, API flag */
175 #define ITOK_TYPE_MASK (~(EXT_FLAG_CRITICAL | EXT_FLAG_VERIFIED))
177 OM_uint32 gssEapAllocContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
178 OM_uint32 gssEapReleaseContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
181 gssEapMakeToken(OM_uint32 *minor,
183 const gss_buffer_t innerToken,
184 enum gss_eap_token_type tokenType,
185 gss_buffer_t outputToken);
188 gssEapVerifyToken(OM_uint32 *minor,
190 const gss_buffer_t inputToken,
191 enum gss_eap_token_type *tokenType,
192 gss_buffer_t innerInputToken);
195 gssEapContextTime(OM_uint32 *minor,
196 gss_ctx_id_t context_handle,
197 OM_uint32 *time_rec);
200 gssEapDisplayName(OM_uint32 *minor,
202 gss_buffer_t output_name_buffer,
203 gss_OID *output_name_type);
206 OM_uint32 gssEapAllocCred(OM_uint32 *minor, gss_cred_id_t *pCred);
207 OM_uint32 gssEapReleaseCred(OM_uint32 *minor, gss_cred_id_t *pCred);
210 gssEapAcquireCred(OM_uint32 *minor,
211 const gss_name_t desiredName,
212 const gss_buffer_t password,
214 const gss_OID_set desiredMechs,
216 gss_cred_id_t *pCred,
217 gss_OID_set *pActualMechs,
220 int gssEapCredAvailable(gss_cred_id_t cred, gss_OID mech);
224 gssEapEncrypt(krb5_context context, int dce_style, size_t ec,
226 #ifdef HAVE_HEIMDAL_VERSION
232 gss_iov_buffer_desc *iov, int iov_count);
235 gssEapDecrypt(krb5_context context, int dce_style, size_t ec,
237 #ifdef HAVE_HEIMDAL_VERSION
243 gss_iov_buffer_desc *iov, int iov_count);
246 gssEapMapCryptoFlag(OM_uint32 type);
249 gssEapLocateIov(gss_iov_buffer_desc *iov,
254 gssEapIovMessageLength(gss_iov_buffer_desc *iov,
257 size_t *assoc_data_length);
260 gssEapReleaseIov(gss_iov_buffer_desc *iov, int iov_count);
263 gssEapIsIntegrityOnly(gss_iov_buffer_desc *iov, int iov_count);
266 gssEapAllocIov(gss_iov_buffer_t iov, size_t size);
269 gssEapDeriveRfc3961Key(OM_uint32 *minor,
270 const unsigned char *key,
272 krb5_enctype enctype,
273 krb5_keyblock *pKey);
276 #ifdef HAVE_HEIMDAL_VERSION
278 #define KRB_TIME_FOREVER ((time_t)~0L)
280 #define KRB_KEY_TYPE(key) ((key)->keytype)
281 #define KRB_KEY_DATA(key) ((key)->keyvalue.data)
282 #define KRB_KEY_LENGTH(key) ((key)->keyvalue.length)
284 #define KRB_PRINC_LENGTH(princ) ((princ)->name.name_string.len)
285 #define KRB_PRINC_TYPE(princ) ((princ)->name.name_type)
286 #define KRB_PRINC_NAME(princ) ((princ)->name.name_string.val)
287 #define KRB_PRINC_REALM(princ) ((princ)->realm)
289 #define KRB_KT_ENT_KEYBLOCK(e) (&(e)->keyblock)
290 #define KRB_KT_ENT_FREE(c, e) krb5_kt_free_entry((c), (e))
292 #define KRB_CRYPTO_CONTEXT(ctx) (krbCrypto)
296 #define KRB_TIME_FOREVER KRB5_INT32_MAX
298 #define KRB_KEY_TYPE(key) ((key)->enctype)
299 #define KRB_KEY_DATA(key) ((key)->contents)
300 #define KRB_KEY_LENGTH(key) ((key)->length)
302 #define KRB_PRINC_LENGTH(princ) (krb5_princ_size(NULL, (princ)))
303 #define KRB_PRINC_TYPE(princ) (krb5_princ_type(NULL, (princ)))
304 #define KRB_PRINC_NAME(princ) (krb5_princ_name(NULL, (princ)))
305 #define KRB_PRINC_REALM(princ) (krb5_princ_realm(NULL, (princ)))
307 #define KRB_KT_ENT_KEYBLOCK(e) (&(e)->key)
308 #define KRB_KT_ENT_FREE(c, e) krb5_free_keytab_entry_contents((c), (e))
310 #define KRB_CRYPTO_CONTEXT(ctx) (&(ctx)->rfc3961Key)
312 #endif /* HAVE_HEIMDAL_VERSION */
314 #define KRB_KEY_INIT(key) do { \
315 KRB_KEY_TYPE(key) = ENCTYPE_NULL; \
316 KRB_KEY_DATA(key) = NULL; \
317 KRB_KEY_LENGTH(key) = 0; \
320 #define GSSEAP_KRB_INIT(ctx) do { \
321 OM_uint32 tmpMajor; \
323 tmpMajor = gssEapKerberosInit(minor, ctx); \
324 if (GSS_ERROR(tmpMajor)) { \
330 gssEapKerberosInit(OM_uint32 *minor, krb5_context *context);
333 rfc3961ChecksumTypeForKey(OM_uint32 *minor,
335 krb5_cksumtype *cksumtype);
338 krbAnonymousPrincipal(void);
341 krbCryptoLength(krb5_context krbContext,
342 #ifdef HAVE_HEIMDAL_VERSION
343 krb5_crypto krbCrypto,
351 krbPaddingLength(krb5_context krbContext,
352 #ifdef HAVE_HEIMDAL_VERSION
353 krb5_crypto krbCrypto,
361 krbBlockSize(krb5_context krbContext,
362 #ifdef HAVE_HEIMDAL_VERSION
363 krb5_crypto krbCrypto,
370 krbEnctypeToString(krb5_context krbContext,
371 krb5_enctype enctype,
373 gss_buffer_t string);
376 krbMakeAuthDataKdcIssued(krb5_context context,
377 const krb5_keyblock *key,
378 krb5_const_principal issuer,
379 #ifdef HAVE_HEIMDAL_VERSION
380 const AuthorizationData *authdata,
381 AuthorizationData *adKdcIssued
383 krb5_authdata *const *authdata,
384 krb5_authdata ***adKdcIssued
389 krbMakeCred(krb5_context context,
390 krb5_auth_context authcontext,
396 gssEapExportLucidSecContext(OM_uint32 *minor,
398 const gss_OID desiredObject,
399 gss_buffer_set_t *data_set);
402 extern gss_OID GSS_EAP_MECHANISM;
405 gssEapInternalizeOid(const gss_OID oid,
406 gss_OID *const pInternalizedOid);
409 gssEapReleaseOid(OM_uint32 *minor, gss_OID *oid);
412 gssEapDefaultMech(OM_uint32 *minor,
416 gssEapIndicateMechs(OM_uint32 *minor,
420 gssEapEnctypeToOid(OM_uint32 *minor,
421 krb5_enctype enctype,
425 gssEapOidToEnctype(OM_uint32 *minor,
427 krb5_enctype *enctype);
430 gssEapIsMechanismOid(const gss_OID oid);
433 gssEapIsConcreteMechanismOid(const gss_OID oid);
436 gssEapValidateMechs(OM_uint32 *minor,
437 const gss_OID_set mechs);
440 gssEapOidToSaslName(const gss_OID oid);
443 gssEapSaslNameToOid(const gss_buffer_t name);
446 #define EXPORT_NAME_FLAG_OID 0x1
447 #define EXPORT_NAME_FLAG_COMPOSITE 0x2
449 OM_uint32 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName);
450 OM_uint32 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName);
451 OM_uint32 gssEapExportName(OM_uint32 *minor,
452 const gss_name_t name,
453 gss_buffer_t exportedName);
454 OM_uint32 gssEapExportNameInternal(OM_uint32 *minor,
455 const gss_name_t name,
456 gss_buffer_t exportedName,
458 OM_uint32 gssEapImportName(OM_uint32 *minor,
459 const gss_buffer_t input_name_buffer,
460 gss_OID input_name_type,
461 gss_name_t *output_name);
462 OM_uint32 gssEapImportNameInternal(OM_uint32 *minor,
463 const gss_buffer_t input_name_buffer,
464 gss_name_t *output_name,
467 gssEapDuplicateName(OM_uint32 *minor,
468 const gss_name_t input_name,
469 gss_name_t *dest_name);
473 composeOid(OM_uint32 *minor_status,
480 decomposeOid(OM_uint32 *minor_status,
487 duplicateOid(OM_uint32 *minor_status,
488 const gss_OID_desc * const oid,
492 duplicateOidSet(OM_uint32 *minor,
493 const gss_OID_set src,
497 oidEqual(const gss_OID_desc *o1, const gss_OID_desc *o2)
499 if (o1 == GSS_C_NO_OID)
500 return (o2 == GSS_C_NO_OID);
501 else if (o2 == GSS_C_NO_OID)
502 return (o1 == GSS_C_NO_OID);
504 return (o1->length == o2->length &&
505 memcmp(o1->elements, o2->elements, o1->length) == 0);
508 /* util_ordering.c */
510 sequenceInternalize(OM_uint32 *minor,
516 sequenceExternalize(OM_uint32 *minor,
522 sequenceSize(void *vqueue);
525 sequenceFree(OM_uint32 *minor, void **vqueue);
528 sequenceCheck(OM_uint32 *minor, void **vqueue, uint64_t seqnum);
531 sequenceInit(OM_uint32 *minor, void **vqueue, uint64_t seqnum,
532 int do_replay, int do_sequence, int wide_nums);
538 gssEapSmStep(OM_uint32 *minor,
545 gss_channel_bindings_t chanBindings,
546 gss_buffer_t inputToken,
547 gss_buffer_t outputToken,
548 struct gss_eap_sm *sm,
553 gssEapEncodeInnerTokens(OM_uint32 *minor,
554 gss_buffer_set_t extensions,
556 gss_buffer_t buffer);
558 gssEapDecodeInnerTokens(OM_uint32 *minor,
559 const gss_buffer_t buffer,
560 gss_buffer_set_t *pExtensions,
564 tokenSize(const gss_OID_desc *mech, size_t body_size);
567 makeTokenHeader(const gss_OID_desc *mech,
570 enum gss_eap_token_type tok_type);
573 verifyTokenHeader(OM_uint32 *minor,
576 unsigned char **buf_in,
578 enum gss_eap_token_type *ret_tok_type);
582 #define GSSEAP_CALLOC calloc
583 #define GSSEAP_MALLOC malloc
584 #define GSSEAP_FREE free
585 #define GSSEAP_REALLOC realloc
587 #define GSSEAP_NOT_IMPLEMENTED do { \
588 assert(0 && "not implemented"); \
590 return GSS_S_FAILURE; \
595 #define GSSEAP_MUTEX pthread_mutex_t
596 #define GSSEAP_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
598 #define GSSEAP_MUTEX_INIT(m) pthread_mutex_init((m), NULL)
599 #define GSSEAP_MUTEX_DESTROY(m) pthread_mutex_destroy((m))
600 #define GSSEAP_MUTEX_LOCK(m) pthread_mutex_lock((m))
601 #define GSSEAP_MUTEX_UNLOCK(m) pthread_mutex_unlock((m))
603 #define GSSEAP_THREAD_KEY pthread_key_t
604 #define GSSEAP_KEY_CREATE(k, d) pthread_key_create((k), (d))
605 #define GSSEAP_GETSPECIFIC(k) pthread_getspecific((k))
606 #define GSSEAP_SETSPECIFIC(k, d) pthread_setspecific((k), (d))
608 #define GSSEAP_THREAD_ONCE pthread_once_t
609 #define GSSEAP_ONCE(o, i) pthread_once((o), (i))
610 #define GSSEAP_ONCE_INITIALIZER PTHREAD_ONCE_INIT
612 /* Helper functions */
614 store_uint16_be(uint16_t val, void *vp)
616 unsigned char *p = (unsigned char *)vp;
618 p[0] = (val >> 8) & 0xff;
619 p[1] = (val ) & 0xff;
622 static inline uint16_t
623 load_uint16_be(const void *cvp)
625 const unsigned char *p = (const unsigned char *)cvp;
627 return (p[1] | (p[0] << 8));
631 store_uint32_be(uint32_t val, void *vp)
633 unsigned char *p = (unsigned char *)vp;
635 p[0] = (val >> 24) & 0xff;
636 p[1] = (val >> 16) & 0xff;
637 p[2] = (val >> 8) & 0xff;
638 p[3] = (val ) & 0xff;
641 static inline uint32_t
642 load_uint32_be(const void *cvp)
644 const unsigned char *p = (const unsigned char *)cvp;
646 return (p[3] | (p[2] << 8)
647 | ((uint32_t) p[1] << 16)
648 | ((uint32_t) p[0] << 24));
652 store_uint64_be(uint64_t val, void *vp)
654 unsigned char *p = (unsigned char *)vp;
656 p[0] = (unsigned char)((val >> 56) & 0xff);
657 p[1] = (unsigned char)((val >> 48) & 0xff);
658 p[2] = (unsigned char)((val >> 40) & 0xff);
659 p[3] = (unsigned char)((val >> 32) & 0xff);
660 p[4] = (unsigned char)((val >> 24) & 0xff);
661 p[5] = (unsigned char)((val >> 16) & 0xff);
662 p[6] = (unsigned char)((val >> 8) & 0xff);
663 p[7] = (unsigned char)((val ) & 0xff);
666 static inline uint64_t
667 load_uint64_be(const void *cvp)
669 const unsigned char *p = (const unsigned char *)cvp;
671 return ((uint64_t)load_uint32_be(p) << 32) | load_uint32_be(p + 4);
674 static inline unsigned char *
675 store_buffer(gss_buffer_t buffer, void *vp, int wide_nums)
677 unsigned char *p = (unsigned char *)vp;
680 store_uint64_be(buffer->length, p);
683 store_uint32_be(buffer->length, p);
687 if (buffer->value != NULL) {
688 memcpy(p, buffer->value, buffer->length);
695 static inline unsigned char *
696 load_buffer(const void *cvp, size_t length, gss_buffer_t buffer)
699 buffer->value = GSSEAP_MALLOC(length);
700 if (buffer->value == NULL)
702 buffer->length = length;
703 memcpy(buffer->value, cvp, length);
704 return (unsigned char *)cvp + length;
707 static inline unsigned char *
708 store_oid(gss_OID oid, void *vp)
712 if (oid != GSS_C_NO_OID) {
713 buf.length = oid->length;
714 buf.value = oid->elements;
720 return store_buffer(&buf, vp, FALSE);
724 krbDataToGssBuffer(krb5_data *data, gss_buffer_t buffer)
726 buffer->value = (void *)data->data;
727 buffer->length = data->length;
731 krbPrincComponentToGssBuffer(krb5_principal krbPrinc,
732 int index, gss_buffer_t buffer)
734 #ifdef HAVE_HEIMDAL_VERSION
735 buffer->value = (void *)KRB_PRINC_NAME(krbPrinc)[index];
736 buffer->length = strlen((char *)buffer->value);
738 buffer->value = (void *)krb5_princ_component(NULL, krbPrinc, index)->data;
739 buffer->length = krb5_princ_component(NULL, krbPrinc, index)->length;
740 #endif /* HAVE_HEIMDAL_VERSION */
744 krbPrincRealmToGssBuffer(krb5_principal krbPrinc, gss_buffer_t buffer)
746 #ifdef HAVE_HEIMDAL_VERSION
747 buffer->value = (void *)KRB_PRINC_REALM(krbPrinc);
748 buffer->length = strlen((char *)buffer->value);
750 krbDataToGssBuffer(KRB_PRINC_REALM(krbPrinc), buffer);
755 gssBufferToKrbData(gss_buffer_t buffer, krb5_data *data)
757 data->data = (char *)buffer->value;
758 data->length = buffer->length;
765 #include "util_attr.h"
766 #ifdef GSSEAP_ENABLE_REAUTH
767 #include "util_reauth.h"
770 #endif /* _UTIL_H_ */