make extension tokens extensible
[mech_eap.orig] / 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 #include <string.h>
61 #include <errno.h>
62
63 #include <krb5.h>
64
65 #ifdef __cplusplus
66 extern "C" {
67 #endif
68
69 #ifndef MIN             /* Usually found in <sys/param.h>. */
70 #define MIN(_a,_b)  ((_a)<(_b)?(_a):(_b))
71 #endif
72
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;            \
80     } while (0)
81
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 */
94 };
95
96 #define EAP_EXPORT_CONTEXT_V1           1
97
98 /* util_buffer.c */
99 OM_uint32
100 makeStringBuffer(OM_uint32 *minor,
101                  const char *string,
102                  gss_buffer_t buffer);
103
104 OM_uint32
105 bufferToString(OM_uint32 *minor,
106                const gss_buffer_t buffer,
107                char **pString);
108
109 OM_uint32
110 duplicateBuffer(OM_uint32 *minor,
111                 const gss_buffer_t src,
112                 gss_buffer_t dst);
113
114 static inline int
115 bufferEqual(const gss_buffer_t b1, const gss_buffer_t b2)
116 {
117     return (b1->length == b2->length &&
118             memcmp(b1->value, b2->value, b2->length) == 0);
119 }
120
121 static inline int
122 bufferEqualString(const gss_buffer_t b1, const char *s)
123 {
124     gss_buffer_desc b2;
125
126     b2.length = strlen(s);
127     b2.value = (char *)s;
128
129     return bufferEqual(b1, &b2);
130 }
131
132 /* util_cksum.c */
133 int
134 gssEapSign(krb5_context context,
135            krb5_cksumtype type,
136            size_t rrc,
137            krb5_keyblock *key,
138            krb5_keyusage sign_usage,
139            gss_iov_buffer_desc *iov,
140            int iov_count);
141
142 int
143 gssEapVerify(krb5_context context,
144              krb5_cksumtype type,
145              size_t rrc,
146              krb5_keyblock *key,
147              krb5_keyusage sign_usage,
148              gss_iov_buffer_desc *iov,
149              int iov_count,
150              int *valid);
151
152 #if 0
153 OM_uint32
154 gssEapEncodeGssChannelBindings(OM_uint32 *minor,
155                                gss_channel_bindings_t chanBindings,
156                                gss_buffer_t encodedBindings);
157 #endif
158
159 /* util_context.c */
160 OM_uint32 gssEapAllocContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
161 OM_uint32 gssEapReleaseContext(OM_uint32 *minor, gss_ctx_id_t *pCtx);
162
163 OM_uint32
164 gssEapMakeToken(OM_uint32 *minor,
165                 gss_ctx_id_t ctx,
166                 const gss_buffer_t innerToken,
167                 enum gss_eap_token_type tokenType,
168                 gss_buffer_t outputToken);
169
170 OM_uint32
171 gssEapVerifyToken(OM_uint32 *minor,
172                   gss_ctx_id_t ctx,
173                   const gss_buffer_t inputToken,
174                   enum gss_eap_token_type *tokenType,
175                   gss_buffer_t innerInputToken);
176
177 OM_uint32
178 gssEapContextTime(OM_uint32 *minor,
179                   gss_ctx_id_t context_handle,
180                   OM_uint32 *time_rec);
181
182 OM_uint32
183 gssEapDisplayName(OM_uint32 *minor,
184                   gss_name_t name,
185                   gss_buffer_t output_name_buffer,
186                   gss_OID *output_name_type);
187
188 /* util_cred.c */
189 OM_uint32 gssEapAllocCred(OM_uint32 *minor, gss_cred_id_t *pCred);
190 OM_uint32 gssEapReleaseCred(OM_uint32 *minor, gss_cred_id_t *pCred);
191
192 OM_uint32
193 gssEapAcquireCred(OM_uint32 *minor,
194                   const gss_name_t desiredName,
195                   const gss_buffer_t password,
196                   OM_uint32 timeReq,
197                   const gss_OID_set desiredMechs,
198                   int cred_usage,
199                   gss_cred_id_t *pCred,
200                   gss_OID_set *pActualMechs,
201                   OM_uint32 *timeRec);
202
203 int gssEapCredAvailable(gss_cred_id_t cred, gss_OID mech);
204
205 /* util_crypt.c */
206 int
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);
210
211 int
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);
215
216 krb5_cryptotype
217 gssEapMapCryptoFlag(OM_uint32 type);
218
219 gss_iov_buffer_t
220 gssEapLocateIov(gss_iov_buffer_desc *iov,
221                 int iov_count,
222                 OM_uint32 type);
223
224 void
225 gssEapIovMessageLength(gss_iov_buffer_desc *iov,
226                        int iov_count,
227                        size_t *data_length,
228                        size_t *assoc_data_length);
229
230 void
231 gssEapReleaseIov(gss_iov_buffer_desc *iov, int iov_count);
232
233 int
234 gssEapIsIntegrityOnly(gss_iov_buffer_desc *iov, int iov_count);
235
236 int
237 gssEapAllocIov(gss_iov_buffer_t iov, size_t size);
238
239 OM_uint32
240 gssEapDeriveRfc3961Key(OM_uint32 *minor,
241                        const unsigned char *key,
242                        size_t keyLength,
243                        krb5_enctype enctype,
244                        krb5_keyblock *pKey);
245
246 /* util_exts.c */
247 #define EXT_FLAG_CRITICAL               0x80000000
248 #define EXT_FLAG_VERIFIED               0x40000000
249
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))
253
254 struct gss_eap_extension_provider {
255     OM_uint32 type;
256     int critical;
257     OM_uint32 (*callback)(OM_uint32 *,
258                           gss_cred_id_t,
259                           gss_ctx_id_t,
260                           gss_channel_bindings_t,
261                           gss_buffer_t);
262 };
263
264 OM_uint32
265 gssEapMakeExtensions(OM_uint32 *minor,
266                      gss_cred_id_t cred,
267                      gss_ctx_id_t ctx,
268                      const struct gss_eap_extension_provider *exts,
269                      size_t count,
270                      gss_channel_bindings_t chanBindings,
271                      gss_buffer_t buffer);
272
273 OM_uint32
274 gssEapVerifyExtensions(OM_uint32 *minor,
275                        gss_cred_id_t cred,
276                        gss_ctx_id_t ctx,
277                        const struct gss_eap_extension_provider *exts,
278                        size_t count,
279                        gss_channel_bindings_t chanBindings,
280                        const gss_buffer_t buffer);
281
282 /* util_krb.c */
283 OM_uint32
284 gssEapKerberosInit(OM_uint32 *minor, krb5_context *context);
285
286 OM_uint32
287 rfc3961ChecksumTypeForKey(OM_uint32 *minor,
288                           krb5_keyblock *key,
289                           krb5_cksumtype *cksumtype);
290
291 #define GSSEAP_KRB_INIT(ctx) do {                   \
292         OM_uint32 tmpMajor;                         \
293         tmpMajor  = gssEapKerberosInit(minor, ctx); \
294         if (GSS_ERROR(tmpMajor)) {                  \
295             return tmpMajor;                        \
296         }                                           \
297     } while (0)
298
299 /* util_lucid.c */
300 OM_uint32
301 gssEapExportLucidSecContext(OM_uint32 *minor,
302                             gss_ctx_id_t ctx,
303                             const gss_OID desiredObject,
304                             gss_buffer_set_t *data_set);
305
306 /* util_mech.c */
307 extern gss_OID GSS_EAP_MECHANISM;
308
309 int
310 gssEapInternalizeOid(const gss_OID oid,
311                      gss_OID *const pInternalizedOid);
312
313 OM_uint32
314 gssEapDefaultMech(OM_uint32 *minor,
315                   gss_OID *oid);
316
317 OM_uint32
318 gssEapIndicateMechs(OM_uint32 *minor,
319                     gss_OID_set *mechs);
320
321 OM_uint32
322 gssEapEnctypeToOid(OM_uint32 *minor,
323                    krb5_enctype enctype,
324                    gss_OID *pOid);
325
326 OM_uint32
327 gssEapOidToEnctype(OM_uint32 *minor,
328                    const gss_OID oid,
329                    krb5_enctype *enctype);
330
331 int
332 gssEapIsMechanismOid(const gss_OID oid);
333
334 int
335 gssEapIsConcreteMechanismOid(const gss_OID oid);
336
337 OM_uint32
338 gssEapValidateMechs(OM_uint32 *minor,
339                    const gss_OID_set mechs);
340
341 gss_buffer_t
342 gssEapOidToSaslName(const gss_OID oid);
343
344 gss_OID
345 gssEapSaslNameToOid(const gss_buffer_t name);
346
347 /* util_name.c */
348 #define EXPORT_NAME_FLAG_OID        0x1
349 #define EXPORT_NAME_FLAG_COMPOSITE  0x2
350
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,
359                                    unsigned int flags);
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,
367                                    unsigned int flags);
368 OM_uint32
369 gssEapDuplicateName(OM_uint32 *minor,
370                     const gss_name_t input_name,
371                     gss_name_t *dest_name);
372
373 /* util_oid.c */
374 OM_uint32
375 composeOid(OM_uint32 *minor_status,
376            const char *prefix,
377            size_t prefix_len,
378            int suffix,
379            gss_OID_desc *oid);
380
381 OM_uint32
382 decomposeOid(OM_uint32 *minor_status,
383              const char *prefix,
384              size_t prefix_len,
385              gss_OID_desc *oid,
386              int *suffix) ;
387
388 OM_uint32
389 duplicateOid(OM_uint32 *minor_status,
390              const gss_OID_desc * const oid,
391              gss_OID *new_oid);
392
393 OM_uint32
394 duplicateOidSet(OM_uint32 *minor,
395                 const gss_OID_set src,
396                 gss_OID_set *dst);
397
398 static inline int
399 oidEqual(const gss_OID_desc *o1, const gss_OID_desc *o2)
400 {
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);
405     else
406         return (o1->length == o2->length &&
407                 memcmp(o1->elements, o2->elements, o1->length) == 0);
408 }
409
410 /* util_ordering.c */
411 OM_uint32
412 sequenceInternalize(OM_uint32 *minor,
413                     void **vqueue,
414                     unsigned char **buf,
415                     size_t *lenremain);
416
417 OM_uint32
418 sequenceExternalize(OM_uint32 *minor,
419                     void *vqueue,
420                     unsigned char **buf,
421                     size_t *lenremain);
422
423 size_t
424 sequenceSize(void *vqueue);
425
426 OM_uint32
427 sequenceFree(OM_uint32 *minor, void **vqueue);
428
429 OM_uint32
430 sequenceCheck(OM_uint32 *minor, void **vqueue, uint64_t seqnum);
431
432 OM_uint32
433 sequenceInit(OM_uint32 *minor, void **vqueue, uint64_t seqnum,
434              int do_replay, int do_sequence, int wide_nums);
435
436 /* util_token.c */
437 size_t
438 tokenSize(const gss_OID_desc *mech, size_t body_size);
439
440 void
441 makeTokenHeader(const gss_OID_desc *mech,
442                 size_t body_size,
443                 unsigned char **buf,
444                 enum gss_eap_token_type tok_type);
445
446 OM_uint32
447 verifyTokenHeader(OM_uint32 *minor,
448                   gss_OID mech,
449                   size_t *body_size,
450                   unsigned char **buf_in,
451                   size_t toksize_in,
452                   enum gss_eap_token_type *ret_tok_type);
453
454 /* Helper macros */
455
456 #define GSSEAP_CALLOC                   calloc
457 #define GSSEAP_MALLOC                   malloc
458 #define GSSEAP_FREE                     free
459 #define GSSEAP_REALLOC                  realloc
460
461 #define GSSEAP_NOT_IMPLEMENTED          do {            \
462         assert(0 && "not implemented");                 \
463         *minor = ENOSYS;                                \
464         return GSS_S_FAILURE;                           \
465     } while (0)
466
467 #include <pthread.h>
468
469 #define GSSEAP_MUTEX                    pthread_mutex_t
470 #define GSSEAP_MUTEX_INITIALIZER        PTHREAD_MUTEX_INITIALIZER
471
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))
476
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))
481
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
485
486 /* Helper functions */
487 static inline void
488 store_uint16_be(uint16_t val, void *vp)
489 {
490     unsigned char *p = (unsigned char *)vp;
491
492     p[0] = (val >>  8) & 0xff;
493     p[1] = (val      ) & 0xff;
494 }
495
496 static inline uint16_t
497 load_uint16_be(const void *cvp)
498 {
499     const unsigned char *p = (const unsigned char *)cvp;
500
501     return (p[1] | (p[0] << 8));
502 }
503
504 static inline void
505 store_uint32_be(uint32_t val, void *vp)
506 {
507     unsigned char *p = (unsigned char *)vp;
508
509     p[0] = (val >> 24) & 0xff;
510     p[1] = (val >> 16) & 0xff;
511     p[2] = (val >>  8) & 0xff;
512     p[3] = (val      ) & 0xff;
513 }
514
515 static inline uint32_t
516 load_uint32_be(const void *cvp)
517 {
518     const unsigned char *p = (const unsigned char *)cvp;
519
520     return (p[3] | (p[2] << 8)
521             | ((uint32_t) p[1] << 16)
522             | ((uint32_t) p[0] << 24));
523 }
524
525 static inline void
526 store_uint64_be(uint64_t val, void *vp)
527 {
528     unsigned char *p = (unsigned char *)vp;
529
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);
538 }
539
540 static inline uint64_t
541 load_uint64_be(const void *cvp)
542 {
543     const unsigned char *p = (const unsigned char *)cvp;
544
545     return ((uint64_t)load_uint32_be(p) << 32) | load_uint32_be(p + 4);
546 }
547
548 static inline unsigned char *
549 store_buffer(gss_buffer_t buffer, void *vp, int wide_nums)
550 {
551     unsigned char *p = (unsigned char *)vp;
552
553     if (wide_nums) {
554         store_uint64_be(buffer->length, p);
555         p += 8;
556     } else {
557         store_uint32_be(buffer->length, p);
558         p += 4;
559     }
560
561     if (buffer->value != NULL) {
562         memcpy(p, buffer->value, buffer->length);
563         p += buffer->length;
564     }
565
566     return p;
567 }
568
569 static inline unsigned char *
570 load_buffer(const void *cvp, size_t length, gss_buffer_t buffer)
571 {
572     buffer->length = 0;
573     buffer->value = GSSEAP_MALLOC(length);
574     if (buffer->value == NULL)
575         return NULL;
576     buffer->length = length;
577     memcpy(buffer->value, cvp, length);
578     return (unsigned char *)cvp + length;
579 }
580
581 static inline unsigned char *
582 store_oid(gss_OID oid, void *vp)
583 {
584     gss_buffer_desc buf;
585
586     if (oid != GSS_C_NO_OID) {
587         buf.length = oid->length;
588         buf.value = oid->elements;
589     } else {
590         buf.length = 0;
591         buf.value = NULL;
592     }
593
594     return store_buffer(&buf, vp, FALSE);
595 }
596
597 static inline void
598 krbDataToGssBuffer(krb5_data *data, gss_buffer_t buffer)
599 {
600     buffer->value = (void *)data->data;
601     buffer->length = data->length;
602 }
603
604 static inline void
605 gssBufferToKrbData(gss_buffer_t buffer, krb5_data *data)
606 {
607     data->data = (char *)buffer->value;
608     data->length = buffer->length;
609 }
610
611 #ifdef __cplusplus
612 }
613 #endif
614
615 #include "util_attr.h"
616 #ifdef GSSEAP_ENABLE_REAUTH
617 #include "util_reauth.h"
618 #endif
619
620 #endif /* _UTIL_H_ */