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.
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_EAP_RESP = 0x0601, /* EAP response */
158 TOK_TYPE_EAP_REQ = 0x0602, /* EAP request */
159 TOK_TYPE_EXT_REQ = 0x0603, /* GSS EAP extensions request */
160 TOK_TYPE_EXT_RESP = 0x0604, /* GSS EAP extensions response */
161 TOK_TYPE_GSS_REAUTH = 0x0605, /* GSS EAP fast reauthentication token */
162 TOK_TYPE_CONTEXT_ERR = 0x0606, /* context error */
165 OM_uint32 gssEapAllocContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
166 OM_uint32 gssEapReleaseContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
169 gssEapMakeToken(OM_uint32 *minor,
171 const gss_buffer_t innerToken,
172 enum gss_eap_token_type tokenType,
173 gss_buffer_t outputToken);
176 gssEapVerifyToken(OM_uint32 *minor,
178 const gss_buffer_t inputToken,
179 enum gss_eap_token_type *tokenType,
180 gss_buffer_t innerInputToken);
183 gssEapContextTime(OM_uint32 *minor,
184 gss_ctx_id_t context_handle,
185 OM_uint32 *time_rec);
188 gssEapDisplayName(OM_uint32 *minor,
190 gss_buffer_t output_name_buffer,
191 gss_OID *output_name_type);
194 OM_uint32 gssEapAllocCred(OM_uint32 *minor, gss_cred_id_t *pCred);
195 OM_uint32 gssEapReleaseCred(OM_uint32 *minor, gss_cred_id_t *pCred);
198 gssEapAcquireCred(OM_uint32 *minor,
199 const gss_name_t desiredName,
200 const gss_buffer_t password,
202 const gss_OID_set desiredMechs,
204 gss_cred_id_t *pCred,
205 gss_OID_set *pActualMechs,
208 int gssEapCredAvailable(gss_cred_id_t cred, gss_OID mech);
212 gssEapEncrypt(krb5_context context, int dce_style, size_t ec,
214 #ifdef HAVE_HEIMDAL_VERSION
220 gss_iov_buffer_desc *iov, int iov_count);
223 gssEapDecrypt(krb5_context context, int dce_style, size_t ec,
225 #ifdef HAVE_HEIMDAL_VERSION
231 gss_iov_buffer_desc *iov, int iov_count);
234 gssEapMapCryptoFlag(OM_uint32 type);
237 gssEapLocateIov(gss_iov_buffer_desc *iov,
242 gssEapIovMessageLength(gss_iov_buffer_desc *iov,
245 size_t *assoc_data_length);
248 gssEapReleaseIov(gss_iov_buffer_desc *iov, int iov_count);
251 gssEapIsIntegrityOnly(gss_iov_buffer_desc *iov, int iov_count);
254 gssEapAllocIov(gss_iov_buffer_t iov, size_t size);
257 gssEapDeriveRfc3961Key(OM_uint32 *minor,
258 const unsigned char *key,
260 krb5_enctype enctype,
261 krb5_keyblock *pKey);
264 #define EXT_FLAG_CRITICAL 0x80000000 /* critical, wire flag */
265 #define EXT_FLAG_VERIFIED 0x40000000 /* verified, API flag */
267 #define EXT_TYPE_GSS_CHANNEL_BINDINGS 0x00000000
268 #define EXT_TYPE_REAUTH_CREDS 0x00000001
269 #define EXT_TYPE_MASK (~(EXT_FLAG_CRITICAL | EXT_FLAG_VERIFIED))
271 struct gss_eap_extension_provider {
273 int critical; /* client */
274 int required; /* server */
275 OM_uint32 (*make)(OM_uint32 *,
278 gss_channel_bindings_t,
280 OM_uint32 (*verify)(OM_uint32 *,
283 gss_channel_bindings_t,
288 gssEapMakeExtensions(OM_uint32 *minor,
291 gss_channel_bindings_t chanBindings,
292 gss_buffer_t buffer);
295 gssEapVerifyExtensions(OM_uint32 *minor,
298 gss_channel_bindings_t chanBindings,
299 const gss_buffer_t buffer);
302 #ifdef HAVE_HEIMDAL_VERSION
303 #define KRB_KEY_TYPE(key) ((key)->keytype)
304 #define KRB_KEY_DATA(key) ((key)->keyvalue.data)
305 #define KRB_KEY_LENGTH(key) ((key)->keyvalue.length)
307 #define KRB_KEY_TYPE(key) ((key)->enctype)
308 #define KRB_KEY_DATA(key) ((key)->contents)
309 #define KRB_KEY_LENGTH(key) ((key)->length)
310 #endif /* HAVE_HEIMDAL_VERSION */
312 #define KRB_KEY_INIT(key) do { \
313 KRB_KEY_TYPE(key) = ENCTYPE_NULL; \
314 KRB_KEY_DATA(key) = NULL; \
315 KRB_KEY_LENGTH(key) = 0; \
318 #ifdef HAVE_HEIMDAL_VERSION
319 #define KRB_PRINC_LENGTH(princ) ((princ)->name.name_string.len)
320 #define KRB_PRINC_TYPE(princ) ((princ)->name.name_type)
321 #define KRB_PRINC_NAME(princ) ((princ)->name.name_string.val)
322 #define KRB_CRYPTO_CONTEXT(ctx) (krbCrypto)
324 #define KRB_PRINC_LENGTH(princ) (krb5_princ_size(NULL, (princ)))
325 #define KRB_PRINC_TYPE(princ) (krb5_princ_type(NULL, (princ)))
326 #define KRB_PRINC_NAME(princ) (krb5_princ_name(NULL, (princ)))
327 #define KRB_CRYPTO_CONTEXT(ctx) (&(ctx)->rfc3961Key)
328 #endif /* HAVE_HEIMDAL_VERSION */
330 #ifdef HAVE_HEIMDAL_VERSION
331 #define GSS_IOV_BUFFER_FLAG_ALLOCATE GSS_IOV_BUFFER_TYPE_FLAG_ALLOCATE
332 #define GSS_IOV_BUFFER_FLAG_ALLOCATED GSS_IOV_BUFFER_TYPE_FLAG_ALLOCATED
334 #define GSS_S_CRED_UNAVAIL GSS_S_FAILURE
337 #define GSSEAP_KRB_INIT(ctx) do { \
338 OM_uint32 tmpMajor; \
340 tmpMajor = gssEapKerberosInit(minor, ctx); \
341 if (GSS_ERROR(tmpMajor)) { \
347 gssEapKerberosInit(OM_uint32 *minor, krb5_context *context);
350 rfc3961ChecksumTypeForKey(OM_uint32 *minor,
352 krb5_cksumtype *cksumtype);
355 krbAnonymousPrincipal(void);
358 krbCryptoLength(krb5_context krbContext,
359 #ifdef HAVE_HEIMDAL_VERSION
360 krb5_crypto krbCrypto,
368 krbPaddingLength(krb5_context krbContext,
369 #ifdef HAVE_HEIMDAL_VERSION
370 krb5_crypto krbCrypto,
378 krbBlockSize(krb5_context krbContext,
379 #ifdef HAVE_HEIMDAL_VERSION
380 krb5_crypto krbCrypto,
387 krbEnctypeToString(krb5_context krbContext,
388 krb5_enctype enctype,
390 gss_buffer_t string);
394 gssEapExportLucidSecContext(OM_uint32 *minor,
396 const gss_OID desiredObject,
397 gss_buffer_set_t *data_set);
400 extern gss_OID GSS_EAP_MECHANISM;
403 gssEapInternalizeOid(const gss_OID oid,
404 gss_OID *const pInternalizedOid);
407 gssEapDefaultMech(OM_uint32 *minor,
411 gssEapIndicateMechs(OM_uint32 *minor,
415 gssEapEnctypeToOid(OM_uint32 *minor,
416 krb5_enctype enctype,
420 gssEapOidToEnctype(OM_uint32 *minor,
422 krb5_enctype *enctype);
425 gssEapIsMechanismOid(const gss_OID oid);
428 gssEapIsConcreteMechanismOid(const gss_OID oid);
431 gssEapValidateMechs(OM_uint32 *minor,
432 const gss_OID_set mechs);
435 gssEapOidToSaslName(const gss_OID oid);
438 gssEapSaslNameToOid(const gss_buffer_t name);
441 #define EXPORT_NAME_FLAG_OID 0x1
442 #define EXPORT_NAME_FLAG_COMPOSITE 0x2
444 OM_uint32 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName);
445 OM_uint32 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName);
446 OM_uint32 gssEapExportName(OM_uint32 *minor,
447 const gss_name_t name,
448 gss_buffer_t exportedName);
449 OM_uint32 gssEapExportNameInternal(OM_uint32 *minor,
450 const gss_name_t name,
451 gss_buffer_t exportedName,
453 OM_uint32 gssEapImportName(OM_uint32 *minor,
454 const gss_buffer_t input_name_buffer,
455 gss_OID input_name_type,
456 gss_name_t *output_name);
457 OM_uint32 gssEapImportNameInternal(OM_uint32 *minor,
458 const gss_buffer_t input_name_buffer,
459 gss_name_t *output_name,
462 gssEapDuplicateName(OM_uint32 *minor,
463 const gss_name_t input_name,
464 gss_name_t *dest_name);
468 composeOid(OM_uint32 *minor_status,
475 decomposeOid(OM_uint32 *minor_status,
482 duplicateOid(OM_uint32 *minor_status,
483 const gss_OID_desc * const oid,
487 duplicateOidSet(OM_uint32 *minor,
488 const gss_OID_set src,
492 oidEqual(const gss_OID_desc *o1, const gss_OID_desc *o2)
494 if (o1 == GSS_C_NO_OID)
495 return (o2 == GSS_C_NO_OID);
496 else if (o2 == GSS_C_NO_OID)
497 return (o1 == GSS_C_NO_OID);
499 return (o1->length == o2->length &&
500 memcmp(o1->elements, o2->elements, o1->length) == 0);
503 /* util_ordering.c */
505 sequenceInternalize(OM_uint32 *minor,
511 sequenceExternalize(OM_uint32 *minor,
517 sequenceSize(void *vqueue);
520 sequenceFree(OM_uint32 *minor, void **vqueue);
523 sequenceCheck(OM_uint32 *minor, void **vqueue, uint64_t seqnum);
526 sequenceInit(OM_uint32 *minor, void **vqueue, uint64_t seqnum,
527 int do_replay, int do_sequence, int wide_nums);
531 tokenSize(const gss_OID_desc *mech, size_t body_size);
534 makeTokenHeader(const gss_OID_desc *mech,
537 enum gss_eap_token_type tok_type);
540 verifyTokenHeader(OM_uint32 *minor,
543 unsigned char **buf_in,
545 enum gss_eap_token_type *ret_tok_type);
549 #define GSSEAP_CALLOC calloc
550 #define GSSEAP_MALLOC malloc
551 #define GSSEAP_FREE free
552 #define GSSEAP_REALLOC realloc
554 #define GSSEAP_NOT_IMPLEMENTED do { \
555 assert(0 && "not implemented"); \
557 return GSS_S_FAILURE; \
562 #define GSSEAP_MUTEX pthread_mutex_t
563 #define GSSEAP_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
565 #define GSSEAP_MUTEX_INIT(m) pthread_mutex_init((m), NULL)
566 #define GSSEAP_MUTEX_DESTROY(m) pthread_mutex_destroy((m))
567 #define GSSEAP_MUTEX_LOCK(m) pthread_mutex_lock((m))
568 #define GSSEAP_MUTEX_UNLOCK(m) pthread_mutex_unlock((m))
570 #define GSSEAP_THREAD_KEY pthread_key_t
571 #define GSSEAP_KEY_CREATE(k, d) pthread_key_create((k), (d))
572 #define GSSEAP_GETSPECIFIC(k) pthread_getspecific((k))
573 #define GSSEAP_SETSPECIFIC(k, d) pthread_setspecific((k), (d))
575 #define GSSEAP_THREAD_ONCE pthread_once_t
576 #define GSSEAP_ONCE(o, i) pthread_once((o), (i))
577 #define GSSEAP_ONCE_INITIALIZER PTHREAD_ONCE_INIT
579 /* Helper functions */
581 store_uint16_be(uint16_t val, void *vp)
583 unsigned char *p = (unsigned char *)vp;
585 p[0] = (val >> 8) & 0xff;
586 p[1] = (val ) & 0xff;
589 static inline uint16_t
590 load_uint16_be(const void *cvp)
592 const unsigned char *p = (const unsigned char *)cvp;
594 return (p[1] | (p[0] << 8));
598 store_uint32_be(uint32_t val, void *vp)
600 unsigned char *p = (unsigned char *)vp;
602 p[0] = (val >> 24) & 0xff;
603 p[1] = (val >> 16) & 0xff;
604 p[2] = (val >> 8) & 0xff;
605 p[3] = (val ) & 0xff;
608 static inline uint32_t
609 load_uint32_be(const void *cvp)
611 const unsigned char *p = (const unsigned char *)cvp;
613 return (p[3] | (p[2] << 8)
614 | ((uint32_t) p[1] << 16)
615 | ((uint32_t) p[0] << 24));
619 store_uint64_be(uint64_t val, void *vp)
621 unsigned char *p = (unsigned char *)vp;
623 p[0] = (unsigned char)((val >> 56) & 0xff);
624 p[1] = (unsigned char)((val >> 48) & 0xff);
625 p[2] = (unsigned char)((val >> 40) & 0xff);
626 p[3] = (unsigned char)((val >> 32) & 0xff);
627 p[4] = (unsigned char)((val >> 24) & 0xff);
628 p[5] = (unsigned char)((val >> 16) & 0xff);
629 p[6] = (unsigned char)((val >> 8) & 0xff);
630 p[7] = (unsigned char)((val ) & 0xff);
633 static inline uint64_t
634 load_uint64_be(const void *cvp)
636 const unsigned char *p = (const unsigned char *)cvp;
638 return ((uint64_t)load_uint32_be(p) << 32) | load_uint32_be(p + 4);
641 static inline unsigned char *
642 store_buffer(gss_buffer_t buffer, void *vp, int wide_nums)
644 unsigned char *p = (unsigned char *)vp;
647 store_uint64_be(buffer->length, p);
650 store_uint32_be(buffer->length, p);
654 if (buffer->value != NULL) {
655 memcpy(p, buffer->value, buffer->length);
662 static inline unsigned char *
663 load_buffer(const void *cvp, size_t length, gss_buffer_t buffer)
666 buffer->value = GSSEAP_MALLOC(length);
667 if (buffer->value == NULL)
669 buffer->length = length;
670 memcpy(buffer->value, cvp, length);
671 return (unsigned char *)cvp + length;
674 static inline unsigned char *
675 store_oid(gss_OID oid, void *vp)
679 if (oid != GSS_C_NO_OID) {
680 buf.length = oid->length;
681 buf.value = oid->elements;
687 return store_buffer(&buf, vp, FALSE);
691 krbDataToGssBuffer(krb5_data *data, gss_buffer_t buffer)
693 buffer->value = (void *)data->data;
694 buffer->length = data->length;
698 krbPrincComponentToGssBuffer(krb5_principal krbPrinc,
699 int index, gss_buffer_t buffer)
701 #ifdef HAVE_HEIMDAL_VERSION
702 buffer->value = (void *)krbPrinc->name.name_string.val[index];
703 buffer->length = strlen((char *)buffer->value);
705 buffer->value = (void *)krb5_princ_component(NULL, krbPrinc, index)->data;
706 buffer->length = krb5_princ_component(NULL, krbPrinc, index)->length;
707 #endif /* HAVE_HEIMDAL_VERSION */
711 krbPrincRealmToGssBuffer(krb5_principal krbPrinc, gss_buffer_t buffer)
713 #ifdef HAVE_HEIMDAL_VERSION
714 buffer->value = (void *)krbPrinc->realm;
715 buffer->length = strlen(krbPrinc->realm);
717 krbDataToGssBuffer(krb5_princ_realm(NULL, krbPrinc), buffer);
722 gssBufferToKrbData(gss_buffer_t buffer, krb5_data *data)
724 data->data = (char *)buffer->value;
725 data->length = buffer->length;
732 #include "util_attr.h"
733 #ifdef GSSEAP_ENABLE_REAUTH
734 #include "util_reauth.h"
737 #endif /* _UTIL_H_ */