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, /* exported composite name */
88 TOK_TYPE_DELETE_CONTEXT = 0x0405, /* RFC 2743 delete context */
89 TOK_TYPE_EAP_RESP = 0x0601, /* EAP response */
90 TOK_TYPE_EAP_REQ = 0x0602, /* EAP request */
91 TOK_TYPE_EXT_REQ = 0x0603, /* GSS EAP extensions request */
92 TOK_TYPE_EXT_RESP = 0x0604, /* GSS EAP extensions response */
93 TOK_TYPE_GSS_REAUTH = 0x0605, /* GSS EAP fast reauthentication token */
94 TOK_TYPE_CONTEXT_ERR = 0x0606, /* context error */
97 #define EAP_EXPORT_CONTEXT_V1 1
101 makeStringBuffer(OM_uint32 *minor,
103 gss_buffer_t buffer);
106 bufferToString(OM_uint32 *minor,
107 const gss_buffer_t buffer,
111 duplicateBuffer(OM_uint32 *minor,
112 const gss_buffer_t src,
116 bufferEqual(const gss_buffer_t b1, const gss_buffer_t b2)
118 return (b1->length == b2->length &&
119 memcmp(b1->value, b2->value, b2->length) == 0);
123 bufferEqualString(const gss_buffer_t b1, const char *s)
127 b2.length = strlen(s);
128 b2.value = (char *)s;
130 return bufferEqual(b1, &b2);
135 gssEapSign(krb5_context context,
139 krb5_keyusage sign_usage,
140 gss_iov_buffer_desc *iov,
144 gssEapVerify(krb5_context context,
148 krb5_keyusage sign_usage,
149 gss_iov_buffer_desc *iov,
155 gssEapEncodeGssChannelBindings(OM_uint32 *minor,
156 gss_channel_bindings_t chanBindings,
157 gss_buffer_t encodedBindings);
161 OM_uint32 gssEapAllocContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
162 OM_uint32 gssEapReleaseContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
165 gssEapMakeToken(OM_uint32 *minor,
167 const gss_buffer_t innerToken,
168 enum gss_eap_token_type tokenType,
169 gss_buffer_t outputToken);
172 gssEapVerifyToken(OM_uint32 *minor,
174 const gss_buffer_t inputToken,
175 enum gss_eap_token_type *tokenType,
176 gss_buffer_t innerInputToken);
179 gssEapContextTime(OM_uint32 *minor,
180 gss_ctx_id_t context_handle,
181 OM_uint32 *time_rec);
184 gssEapDisplayName(OM_uint32 *minor,
186 gss_buffer_t output_name_buffer,
187 gss_OID *output_name_type);
190 OM_uint32 gssEapAllocCred(OM_uint32 *minor, gss_cred_id_t *pCred);
191 OM_uint32 gssEapReleaseCred(OM_uint32 *minor, gss_cred_id_t *pCred);
194 gssEapAcquireCred(OM_uint32 *minor,
195 const gss_name_t desiredName,
196 const gss_buffer_t password,
198 const gss_OID_set desiredMechs,
200 gss_cred_id_t *pCred,
201 gss_OID_set *pActualMechs,
204 int gssEapCredAvailable(gss_cred_id_t cred, gss_OID mech);
208 gssEapEncrypt(krb5_context context, int dce_style, size_t ec,
209 size_t rrc, krb5_keyblock *key, int usage, krb5_pointer iv,
210 gss_iov_buffer_desc *iov, int iov_count);
213 gssEapDecrypt(krb5_context context, int dce_style, size_t ec,
214 size_t rrc, krb5_keyblock *key, int usage, krb5_pointer iv,
215 gss_iov_buffer_desc *iov, int iov_count);
218 gssEapMapCryptoFlag(OM_uint32 type);
221 gssEapLocateIov(gss_iov_buffer_desc *iov,
226 gssEapIovMessageLength(gss_iov_buffer_desc *iov,
229 size_t *assoc_data_length);
232 gssEapReleaseIov(gss_iov_buffer_desc *iov, int iov_count);
235 gssEapIsIntegrityOnly(gss_iov_buffer_desc *iov, int iov_count);
238 gssEapAllocIov(gss_iov_buffer_t iov, size_t size);
241 gssEapDeriveRfc3961Key(OM_uint32 *minor,
242 const unsigned char *key,
244 krb5_enctype enctype,
245 krb5_keyblock *pKey);
248 #define EXT_FLAG_CRITICAL 0x80000000
249 #define EXT_FLAG_VERIFIED 0x40000000
251 #define EXT_TYPE_GSS_CHANNEL_BINDINGS 0x00000000
252 #define EXT_TYPE_REAUTH_CREDS 0x00000001
253 #define EXT_TYPE_MASK (~(EXT_FLAG_CRITICAL | EXT_FLAG_VERIFIED))
255 struct gss_eap_extension_provider {
257 int critical; /* client */
258 int required; /* server */
259 OM_uint32 (*make)(OM_uint32 *,
262 gss_channel_bindings_t,
264 OM_uint32 (*verify)(OM_uint32 *,
267 gss_channel_bindings_t,
272 gssEapMakeExtensions(OM_uint32 *minor,
275 gss_channel_bindings_t chanBindings,
276 gss_buffer_t buffer);
279 gssEapVerifyExtensions(OM_uint32 *minor,
282 gss_channel_bindings_t chanBindings,
283 const gss_buffer_t buffer);
287 gssEapKerberosInit(OM_uint32 *minor, krb5_context *context);
290 rfc3961ChecksumTypeForKey(OM_uint32 *minor,
292 krb5_cksumtype *cksumtype);
294 #define GSSEAP_KRB_INIT(ctx) do { \
295 OM_uint32 tmpMajor; \
296 tmpMajor = gssEapKerberosInit(minor, ctx); \
297 if (GSS_ERROR(tmpMajor)) { \
304 gssEapExportLucidSecContext(OM_uint32 *minor,
306 const gss_OID desiredObject,
307 gss_buffer_set_t *data_set);
310 extern gss_OID GSS_EAP_MECHANISM;
313 gssEapInternalizeOid(const gss_OID oid,
314 gss_OID *const pInternalizedOid);
317 gssEapDefaultMech(OM_uint32 *minor,
321 gssEapIndicateMechs(OM_uint32 *minor,
325 gssEapEnctypeToOid(OM_uint32 *minor,
326 krb5_enctype enctype,
330 gssEapOidToEnctype(OM_uint32 *minor,
332 krb5_enctype *enctype);
335 gssEapIsMechanismOid(const gss_OID oid);
338 gssEapIsConcreteMechanismOid(const gss_OID oid);
341 gssEapValidateMechs(OM_uint32 *minor,
342 const gss_OID_set mechs);
345 gssEapOidToSaslName(const gss_OID oid);
348 gssEapSaslNameToOid(const gss_buffer_t name);
351 #define EXPORT_NAME_FLAG_OID 0x1
352 #define EXPORT_NAME_FLAG_COMPOSITE 0x2
354 OM_uint32 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName);
355 OM_uint32 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName);
356 OM_uint32 gssEapExportName(OM_uint32 *minor,
357 const gss_name_t name,
358 gss_buffer_t exportedName);
359 OM_uint32 gssEapExportNameInternal(OM_uint32 *minor,
360 const gss_name_t name,
361 gss_buffer_t exportedName,
363 OM_uint32 gssEapImportName(OM_uint32 *minor,
364 const gss_buffer_t input_name_buffer,
365 gss_OID input_name_type,
366 gss_name_t *output_name);
367 OM_uint32 gssEapImportNameInternal(OM_uint32 *minor,
368 const gss_buffer_t input_name_buffer,
369 gss_name_t *output_name,
372 gssEapDuplicateName(OM_uint32 *minor,
373 const gss_name_t input_name,
374 gss_name_t *dest_name);
378 composeOid(OM_uint32 *minor_status,
385 decomposeOid(OM_uint32 *minor_status,
392 duplicateOid(OM_uint32 *minor_status,
393 const gss_OID_desc * const oid,
397 duplicateOidSet(OM_uint32 *minor,
398 const gss_OID_set src,
402 oidEqual(const gss_OID_desc *o1, const gss_OID_desc *o2)
404 if (o1 == GSS_C_NO_OID)
405 return (o2 == GSS_C_NO_OID);
406 else if (o2 == GSS_C_NO_OID)
407 return (o1 == GSS_C_NO_OID);
409 return (o1->length == o2->length &&
410 memcmp(o1->elements, o2->elements, o1->length) == 0);
413 /* util_ordering.c */
415 sequenceInternalize(OM_uint32 *minor,
421 sequenceExternalize(OM_uint32 *minor,
427 sequenceSize(void *vqueue);
430 sequenceFree(OM_uint32 *minor, void **vqueue);
433 sequenceCheck(OM_uint32 *minor, void **vqueue, uint64_t seqnum);
436 sequenceInit(OM_uint32 *minor, void **vqueue, uint64_t seqnum,
437 int do_replay, int do_sequence, int wide_nums);
441 tokenSize(const gss_OID_desc *mech, size_t body_size);
444 makeTokenHeader(const gss_OID_desc *mech,
447 enum gss_eap_token_type tok_type);
450 verifyTokenHeader(OM_uint32 *minor,
453 unsigned char **buf_in,
455 enum gss_eap_token_type *ret_tok_type);
459 #define GSSEAP_CALLOC calloc
460 #define GSSEAP_MALLOC malloc
461 #define GSSEAP_FREE free
462 #define GSSEAP_REALLOC realloc
464 #define GSSEAP_NOT_IMPLEMENTED do { \
465 assert(0 && "not implemented"); \
467 return GSS_S_FAILURE; \
472 #define GSSEAP_MUTEX pthread_mutex_t
473 #define GSSEAP_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
475 #define GSSEAP_MUTEX_INIT(m) pthread_mutex_init((m), NULL)
476 #define GSSEAP_MUTEX_DESTROY(m) pthread_mutex_destroy((m))
477 #define GSSEAP_MUTEX_LOCK(m) pthread_mutex_lock((m))
478 #define GSSEAP_MUTEX_UNLOCK(m) pthread_mutex_unlock((m))
480 #define GSSEAP_THREAD_KEY pthread_key_t
481 #define GSSEAP_KEY_CREATE(k, d) pthread_key_create((k), (d))
482 #define GSSEAP_GETSPECIFIC(k) pthread_getspecific((k))
483 #define GSSEAP_SETSPECIFIC(k, d) pthread_setspecific((k), (d))
485 #define GSSEAP_THREAD_ONCE pthread_once_t
486 #define GSSEAP_ONCE(o, i) pthread_once((o), (i))
487 #define GSSEAP_ONCE_INITIALIZER PTHREAD_ONCE_INIT
489 /* Helper functions */
491 store_uint16_be(uint16_t val, void *vp)
493 unsigned char *p = (unsigned char *)vp;
495 p[0] = (val >> 8) & 0xff;
496 p[1] = (val ) & 0xff;
499 static inline uint16_t
500 load_uint16_be(const void *cvp)
502 const unsigned char *p = (const unsigned char *)cvp;
504 return (p[1] | (p[0] << 8));
508 store_uint32_be(uint32_t val, void *vp)
510 unsigned char *p = (unsigned char *)vp;
512 p[0] = (val >> 24) & 0xff;
513 p[1] = (val >> 16) & 0xff;
514 p[2] = (val >> 8) & 0xff;
515 p[3] = (val ) & 0xff;
518 static inline uint32_t
519 load_uint32_be(const void *cvp)
521 const unsigned char *p = (const unsigned char *)cvp;
523 return (p[3] | (p[2] << 8)
524 | ((uint32_t) p[1] << 16)
525 | ((uint32_t) p[0] << 24));
529 store_uint64_be(uint64_t val, void *vp)
531 unsigned char *p = (unsigned char *)vp;
533 p[0] = (unsigned char)((val >> 56) & 0xff);
534 p[1] = (unsigned char)((val >> 48) & 0xff);
535 p[2] = (unsigned char)((val >> 40) & 0xff);
536 p[3] = (unsigned char)((val >> 32) & 0xff);
537 p[4] = (unsigned char)((val >> 24) & 0xff);
538 p[5] = (unsigned char)((val >> 16) & 0xff);
539 p[6] = (unsigned char)((val >> 8) & 0xff);
540 p[7] = (unsigned char)((val ) & 0xff);
543 static inline uint64_t
544 load_uint64_be(const void *cvp)
546 const unsigned char *p = (const unsigned char *)cvp;
548 return ((uint64_t)load_uint32_be(p) << 32) | load_uint32_be(p + 4);
551 static inline unsigned char *
552 store_buffer(gss_buffer_t buffer, void *vp, int wide_nums)
554 unsigned char *p = (unsigned char *)vp;
557 store_uint64_be(buffer->length, p);
560 store_uint32_be(buffer->length, p);
564 if (buffer->value != NULL) {
565 memcpy(p, buffer->value, buffer->length);
572 static inline unsigned char *
573 load_buffer(const void *cvp, size_t length, gss_buffer_t buffer)
576 buffer->value = GSSEAP_MALLOC(length);
577 if (buffer->value == NULL)
579 buffer->length = length;
580 memcpy(buffer->value, cvp, length);
581 return (unsigned char *)cvp + length;
584 static inline unsigned char *
585 store_oid(gss_OID oid, void *vp)
589 if (oid != GSS_C_NO_OID) {
590 buf.length = oid->length;
591 buf.value = oid->elements;
597 return store_buffer(&buf, vp, FALSE);
601 krbDataToGssBuffer(krb5_data *data, gss_buffer_t buffer)
603 buffer->value = (void *)data->data;
604 buffer->length = data->length;
608 gssBufferToKrbData(gss_buffer_t buffer, krb5_data *data)
610 data->data = (char *)buffer->value;
611 data->length = buffer->length;
618 #include "util_attr.h"
619 #ifdef GSSEAP_ENABLE_REAUTH
620 #include "util_reauth.h"
623 #endif /* _UTIL_H_ */