Merge branch 'master' into tlv
[mech_eap.git] / util_radius.cpp
1 /*
2  * Copyright (c) 2011, 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 /*
34  * RADIUS attribute provider implementation.
35  */
36
37 #include "gssapiP_eap.h"
38
39 /* stuff that should be provided by libradsec/libfreeradius-radius */
40 #define VENDORATTR(vendor, attr)            (((vendor) << 16) | (attr))
41
42 #ifndef ATTRID
43 #define ATTRID(attr)                        ((attr) & 0xFFFF)
44 #endif
45
46 static gss_buffer_desc radiusUrnPrefix = {
47     sizeof("urn:x-radius:") - 1,
48     (void *)"urn:x-radius:"
49 };
50
51 static VALUE_PAIR *copyAvps(const VALUE_PAIR *src);
52
53 gss_eap_radius_attr_provider::gss_eap_radius_attr_provider(void)
54 {
55     m_vps = NULL;
56     m_authenticated = false;
57 }
58
59 gss_eap_radius_attr_provider::~gss_eap_radius_attr_provider(void)
60 {
61     if (m_vps != NULL)
62         pairfree(&m_vps);
63 }
64
65 bool
66 gss_eap_radius_attr_provider::initFromExistingContext(const gss_eap_attr_ctx *manager,
67                                                       const gss_eap_attr_provider *ctx)
68 {
69     const gss_eap_radius_attr_provider *radius;
70
71     if (!gss_eap_attr_provider::initFromExistingContext(manager, ctx))
72         return false;
73
74     radius = static_cast<const gss_eap_radius_attr_provider *>(ctx);
75
76     if (radius->m_vps != NULL)
77         m_vps = copyAvps(const_cast<VALUE_PAIR *>(radius->getAvps()));
78
79     m_authenticated = radius->m_authenticated;
80
81     return true;
82 }
83
84 bool
85 gss_eap_radius_attr_provider::initFromGssContext(const gss_eap_attr_ctx *manager,
86                                                  const gss_cred_id_t gssCred,
87                                                  const gss_ctx_id_t gssCtx)
88 {
89     if (!gss_eap_attr_provider::initFromGssContext(manager, gssCred, gssCtx))
90         return false;
91
92     if (gssCtx != GSS_C_NO_CONTEXT) {
93         if (gssCtx->acceptorCtx.vps != NULL) {
94             m_vps = copyAvps(gssCtx->acceptorCtx.vps);
95             if (m_vps == NULL)
96                 return false;
97
98             /* We assume libradsec validated this for us */
99             assert(pairfind(m_vps, PW_MESSAGE_AUTHENTICATOR) != NULL);
100             m_authenticated = true;
101         }
102     }
103
104     return true;
105 }
106
107 static bool
108 alreadyAddedAttributeP(std::vector <std::string> &attrs, VALUE_PAIR *vp)
109 {
110     for (std::vector<std::string>::const_iterator a = attrs.begin();
111          a != attrs.end();
112          ++a) {
113         if (strcmp(vp->name, (*a).c_str()) == 0)
114             return true;
115     }
116
117     return false;
118 }
119
120 static bool
121 isSecretAttributeP(uint16_t attrid, uint16_t vendor)
122 {
123     bool bSecretAttribute = false;
124
125     switch (vendor) {
126     case VENDORPEC_MS:
127         switch (attrid) {
128         case PW_MS_MPPE_SEND_KEY:
129         case PW_MS_MPPE_RECV_KEY:
130             bSecretAttribute = true;
131             break;
132         default:
133             break;
134         }
135     default:
136         break;
137     }
138
139     return bSecretAttribute;
140 }
141
142 static bool
143 isSecretAttributeP(uint32_t attribute)
144 {
145     return isSecretAttributeP(ATTRID(attribute), VENDOR(attribute));
146 }
147
148 static bool
149 isInternalAttributeP(uint16_t attrid, uint16_t vendor)
150 {
151     bool bInternalAttribute = false;
152
153     /* should have been filtered */
154     assert(!isSecretAttributeP(attrid, vendor));
155
156     switch (vendor) {
157     case VENDORPEC_UKERNA:
158         bInternalAttribute = true;
159         break;
160     default:
161         break;
162     }
163
164     return bInternalAttribute;
165 }
166
167 static bool
168 isInternalAttributeP(uint32_t attribute)
169 {
170     return isInternalAttributeP(ATTRID(attribute), VENDOR(attribute));
171 }
172
173 /*
174  * Copy AVP list, same as paircopy except it filters out attributes
175  * containing keys.
176  */
177 static VALUE_PAIR *
178 copyAvps(const VALUE_PAIR *src)
179 {
180     const VALUE_PAIR *vp;
181     VALUE_PAIR *dst = NULL, **pDst = &dst;
182
183     for (vp = src; vp != NULL; vp = vp->next) {
184         VALUE_PAIR *vpcopy;
185
186         if (isSecretAttributeP(vp->attribute))
187             continue;
188
189         vpcopy = paircopyvp(vp);
190         if (vpcopy == NULL) {
191             pairfree(&dst);
192             throw new std::bad_alloc;
193             return NULL;
194         }
195         *pDst = vpcopy;
196         pDst = &vpcopy->next;
197      }
198
199     return dst;
200 }
201
202 bool
203 gss_eap_radius_attr_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute,
204                                                 void *data) const
205 {
206     VALUE_PAIR *vp;
207     std::vector <std::string> seen;
208
209     for (vp = m_vps; vp != NULL; vp = vp->next) {
210         gss_buffer_desc attribute;
211         char attrid[64];
212
213         /* Don't advertise attributes that are internal to the GSS-EAP mechanism */
214         if (isInternalAttributeP(vp->attribute))
215             continue;
216
217         if (alreadyAddedAttributeP(seen, vp))
218             continue;
219
220         snprintf(attrid, sizeof(attrid), "%s%d",
221             (char *)radiusUrnPrefix.value, vp->attribute);
222
223         attribute.value = attrid;
224         attribute.length = strlen(attrid);
225
226         if (!addAttribute(this, &attribute, data))
227             return false;
228
229         seen.push_back(std::string(vp->name));
230     }
231
232     return true;
233 }
234
235 uint32_t
236 getAttributeId(const gss_buffer_t attr)
237 {
238     OM_uint32 tmpMinor;
239     gss_buffer_desc strAttr = GSS_C_EMPTY_BUFFER;
240     DICT_ATTR *da;
241     char *s;
242     uint32_t attrid = 0;
243
244     if (attr->length < radiusUrnPrefix.length ||
245         memcmp(attr->value, radiusUrnPrefix.value, radiusUrnPrefix.length) != 0)
246         return 0;
247
248     /* need to duplicate because attr may not be NUL terminated */
249     duplicateBuffer(*attr, &strAttr);
250     s = (char *)strAttr.value + radiusUrnPrefix.length;
251
252     if (isdigit(*s)) {
253         attrid = strtoul(s, NULL, 10);
254     } else {
255         da = dict_attrbyname(s);
256         if (da != NULL)
257             attrid = da->attr;
258     }
259
260     gss_release_buffer(&tmpMinor, &strAttr);
261
262     return attrid;
263 }
264
265 bool
266 gss_eap_radius_attr_provider::setAttribute(int complete,
267                                            uint32_t attrid,
268                                            const gss_buffer_t value)
269 {
270     OM_uint32 major = GSS_S_UNAVAILABLE, minor;
271
272     if (!isSecretAttributeP(attrid) &&
273         !isInternalAttributeP(attrid)) {
274         deleteAttribute(attrid);
275
276         major = gssEapRadiusAddAvp(&minor, &m_vps,
277                                    ATTRID(attrid), VENDOR(attrid), 
278                                    value);
279     }
280
281     return !GSS_ERROR(major);
282 }
283
284 bool
285 gss_eap_radius_attr_provider::setAttribute(int complete,
286                                            const gss_buffer_t attr,
287                                            const gss_buffer_t value)
288 {
289     uint32_t attrid = getAttributeId(attr);
290
291     if (!attrid)
292         return false;
293
294     return setAttribute(complete, attrid, value);
295 }
296
297 bool
298 gss_eap_radius_attr_provider::deleteAttribute(uint32_t attrid)
299 {
300     if (isSecretAttributeP(attrid) || isInternalAttributeP(attrid) ||
301         pairfind(m_vps, attrid) == NULL)
302         return false;
303
304     pairdelete(&m_vps, attrid);
305
306     return true;
307 }
308
309 bool
310 gss_eap_radius_attr_provider::deleteAttribute(const gss_buffer_t attr)
311 {
312     uint32_t attrid = getAttributeId(attr);
313
314     if (!attrid)
315         return false;
316
317     return deleteAttribute(attrid);
318 }
319
320 bool
321 gss_eap_radius_attr_provider::getAttribute(const gss_buffer_t attr,
322                                            int *authenticated,
323                                            int *complete,
324                                            gss_buffer_t value,
325                                            gss_buffer_t display_value,
326                                            int *more) const
327 {
328     uint32_t attrid;
329
330     attrid = getAttributeId(attr);
331     if (!attrid)
332         return false;
333
334     return getAttribute(attrid, authenticated, complete,
335                         value, display_value, more);
336 }
337
338 bool
339 gss_eap_radius_attr_provider::getAttribute(uint32_t attrid,
340                                            int *authenticated,
341                                            int *complete,
342                                            gss_buffer_t value,
343                                            gss_buffer_t display_value,
344                                            int *more) const
345 {
346     VALUE_PAIR *vp;
347     int i = *more, count = 0;
348
349     *more = 0;
350
351     if (i == -1)
352         i = 0;
353
354     for (vp = pairfind(m_vps, attrid);
355          vp != NULL;
356          vp = pairfind(vp->next, attrid)) {
357         if (count++ == i) {
358             if (pairfind(vp->next, attrid) != NULL)
359                 *more = count;
360             break;
361         }
362     }
363
364     if (vp == NULL && *more == 0)
365         return false;
366
367     if (value != GSS_C_NO_BUFFER) {
368         gss_buffer_desc valueBuf;
369
370         valueBuf.value = (void *)vp->vp_octets;
371         valueBuf.length = vp->length;
372
373         duplicateBuffer(valueBuf, value);
374     }
375
376     if (display_value != GSS_C_NO_BUFFER) {
377         char displayString[MAX_STRING_LEN];
378         gss_buffer_desc displayBuf;
379
380         displayBuf.length = vp_prints_value(displayString,
381                                             sizeof(displayString), vp, 0);
382         displayBuf.value = (void *)displayString;
383
384         duplicateBuffer(displayBuf, display_value);
385     }
386
387     if (authenticated != NULL)
388         *authenticated = m_authenticated;
389     if (complete != NULL)
390         *complete = true;
391
392     return true;
393 }
394
395 bool
396 gss_eap_radius_attr_provider::getFragmentedAttribute(uint16_t attribute,
397                                                      uint16_t vendor,
398                                                      int *authenticated,
399                                                      int *complete,
400                                                      gss_buffer_t value) const
401 {
402     OM_uint32 major, minor;
403
404     major = gssEapRadiusGetAvp(&minor, m_vps, attribute, vendor, value, TRUE);
405
406     if (authenticated != NULL)
407         *authenticated = m_authenticated;
408     if (complete != NULL)
409         *complete = true;
410
411     return !GSS_ERROR(major);
412 }
413
414 bool
415 gss_eap_radius_attr_provider::getAttribute(uint16_t attribute,
416                                            uint16_t vendor,
417                                            int *authenticated,
418                                            int *complete,
419                                            gss_buffer_t value,
420                                            gss_buffer_t display_value,
421                                            int *more) const
422 {
423
424     return getAttribute(VENDORATTR(attribute, vendor),
425                         authenticated, complete,
426                         value, display_value, more);
427 }
428
429 gss_any_t
430 gss_eap_radius_attr_provider::mapToAny(int authenticated,
431                                        gss_buffer_t type_id) const
432 {
433     if (authenticated && !m_authenticated)
434         return (gss_any_t)NULL;
435
436     return (gss_any_t)copyAvps(m_vps);
437 }
438
439 void
440 gss_eap_radius_attr_provider::releaseAnyNameMapping(gss_buffer_t type_id,
441                                                     gss_any_t input) const
442 {
443     pairfree((VALUE_PAIR **)&input);
444 }
445
446 bool
447 gss_eap_radius_attr_provider::init(void)
448 {
449     struct rs_context *radContext;
450
451     gss_eap_attr_ctx::registerProvider(ATTR_TYPE_RADIUS,
452                                        "urn:ietf:params:gss-eap:radius-avp",
453                                        createAttrContext);
454
455 #if 1
456     /*
457      * This hack is necessary in order to force the loading of the global
458      * dictionary, otherwise accepting reauthentication tokens fails unless
459      * the acceptor has already accepted a normal authentication token.
460      */
461     if (rs_context_create(&radContext, RS_DICT_FILE) != 0) {
462         return false;
463     }
464
465     rs_context_destroy(radContext);
466 #endif
467
468     return true;
469 }
470
471 void
472 gss_eap_radius_attr_provider::finalize(void)
473 {
474     gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_RADIUS);
475 }
476
477 gss_eap_attr_provider *
478 gss_eap_radius_attr_provider::createAttrContext(void)
479 {
480     return new gss_eap_radius_attr_provider;
481 }
482
483 OM_uint32
484 gssEapRadiusAddAvp(OM_uint32 *minor,
485                    VALUE_PAIR **vps,
486                    uint16_t attribute,
487                    uint16_t vendor,
488                    const gss_buffer_t buffer)
489 {
490     uint32_t attrid = VENDORATTR(vendor, attribute);
491     unsigned char *p = (unsigned char *)buffer->value;
492     size_t remain = buffer->length;
493
494     do {
495         VALUE_PAIR *vp;
496         size_t n = remain;
497
498         /*
499          * There's an extra byte of padding; RADIUS AVPs can only
500          * be 253 octets.
501          */
502         if (n >= MAX_STRING_LEN)
503             n = MAX_STRING_LEN - 1;
504
505         vp = paircreate(attrid, PW_TYPE_OCTETS);
506         if (vp == NULL) {
507             *minor = ENOMEM;
508             return GSS_S_FAILURE;
509         }
510
511         memcpy(vp->vp_octets, p, n);
512         vp->length = n;
513
514         pairadd(vps, vp);
515
516         p += n;
517         remain -= n;
518     } while (remain != 0);
519
520     return GSS_S_COMPLETE;
521 }
522
523 OM_uint32
524 gssEapRadiusGetRawAvp(OM_uint32 *minor,
525                       VALUE_PAIR *vps,
526                       uint16_t attribute,
527                       uint16_t vendor,
528                       VALUE_PAIR **vp)
529 {
530     uint32_t attr = VENDORATTR(vendor, attribute);
531
532     *vp = pairfind(vps, attr);
533     if (*vp == NULL) {
534         *minor = GSSEAP_NO_SUCH_ATTR;
535         return GSS_S_UNAVAILABLE;
536     }
537
538     return GSS_S_COMPLETE;
539 }
540
541 OM_uint32
542 gssEapRadiusGetAvp(OM_uint32 *minor,
543                    VALUE_PAIR *vps,
544                    uint16_t attribute,
545                    uint16_t vendor,
546                    gss_buffer_t buffer,
547                    int concat)
548 {
549     VALUE_PAIR *vp;
550     unsigned char *p;
551     uint32_t attr = VENDORATTR(vendor, attribute);
552
553     buffer->length = 0;
554     buffer->value = NULL;
555
556     vp = pairfind(vps, attr);
557     if (vp == NULL) {
558         *minor = GSSEAP_NO_SUCH_ATTR;
559         return GSS_S_UNAVAILABLE;
560     }
561
562     do {
563         buffer->length += vp->length;
564     } while (concat && (vp = pairfind(vp->next, attr)) != NULL);
565
566     buffer->value = GSSEAP_MALLOC(buffer->length);
567     if (buffer->value == NULL) {
568         *minor = ENOMEM;
569         return GSS_S_FAILURE;
570     }
571
572     p = (unsigned char *)buffer->value;
573
574     for (vp = pairfind(vps, attr);
575          concat && vp != NULL;
576          vp = pairfind(vp->next, attr)) {
577         memcpy(p, vp->vp_octets, vp->length);
578         p += vp->length;
579     }
580
581     *minor = 0;
582     return GSS_S_COMPLETE;
583 }
584
585 OM_uint32
586 gssEapRadiusFreeAvps(OM_uint32 *minor,
587                      VALUE_PAIR **vps)
588 {
589     pairfree(vps);
590     *minor = 0;
591     return GSS_S_COMPLETE;
592 }
593
594 OM_uint32
595 gssEapRadiusAttrProviderInit(OM_uint32 *minor)
596 {
597     if (!gss_eap_radius_attr_provider::init()) {
598         *minor = GSSEAP_RADSEC_INIT_FAILURE;
599         return GSS_S_FAILURE;
600     }
601
602     return GSS_S_COMPLETE;
603 }
604
605 OM_uint32
606 gssEapRadiusAttrProviderFinalize(OM_uint32 *minor)
607 {
608     gss_eap_radius_attr_provider::finalize();
609     return GSS_S_COMPLETE;
610 }
611
612 /*
613  * Encoding is:
614  * 4 octet NBO attribute ID | 4 octet attribute length | attribute data
615  */
616 static size_t
617 avpSize(const VALUE_PAIR *vp)
618 {
619     size_t size = 4 + 1;
620
621     if (vp != NULL)
622         size += vp->length;
623
624     return size;
625 }
626
627 static bool
628 avpExport(const VALUE_PAIR *vp,
629           unsigned char **pBuffer,
630           size_t *pRemain)
631 {
632     unsigned char *p = *pBuffer;
633     size_t remain = *pRemain;
634
635     assert(remain >= avpSize(vp));
636
637     store_uint32_be(vp->attribute, p);
638
639     switch (vp->type) {
640     case PW_TYPE_INTEGER:
641     case PW_TYPE_IPADDR:
642     case PW_TYPE_DATE:
643         p[4] = 4;
644         store_uint32_be(vp->lvalue, p + 5);
645         break;
646     default:
647         assert(vp->length <= MAX_STRING_LEN);
648         p[4] = (uint8_t)vp->length;
649         memcpy(p + 5, vp->vp_octets, vp->length);
650         break;
651     }
652
653     *pBuffer += 5 + p[4];
654     *pRemain -= 5 + p[4];
655
656     return true;
657
658 }
659
660 static bool
661 avpImport(VALUE_PAIR **pVp,
662           unsigned char **pBuffer,
663           size_t *pRemain)
664 {
665     unsigned char *p = *pBuffer;
666     size_t remain = *pRemain;
667     VALUE_PAIR *vp = NULL;
668     DICT_ATTR *da;
669     uint32_t attrid;
670
671     if (remain < avpSize(NULL))
672         goto fail;
673
674     attrid = load_uint32_be(p);
675     p += 4;
676     remain -= 4;
677
678     da = dict_attrbyvalue(attrid);
679     if (da != NULL) {
680         vp = pairalloc(da);
681     } else {
682         vp = paircreate(attrid, PW_TYPE_STRING);
683     }
684     if (vp == NULL) {
685         throw new std::bad_alloc;
686         goto fail;
687     }
688
689     if (remain < p[0])
690         goto fail;
691
692     switch (vp->type) {
693     case PW_TYPE_INTEGER:
694     case PW_TYPE_IPADDR:
695     case PW_TYPE_DATE:
696         if (p[0] != 4)
697             goto fail;
698
699         vp->length = 4;
700         vp->lvalue = load_uint32_be(p + 1);
701         p += 5;
702         remain -= 5;
703         break;
704     case PW_TYPE_STRING:
705     default:
706         if (p[0] >= MAX_STRING_LEN)
707             goto fail;
708
709         vp->length = (uint32_t)p[0];
710         memcpy(vp->vp_octets, p + 1, vp->length);
711
712         if (vp->type == PW_TYPE_STRING)
713             vp->vp_strvalue[vp->length] = '\0';
714
715         p += 1 + vp->length;
716         remain -= 1 + vp->length;
717         break;
718     }
719
720     *pVp = vp;
721     *pBuffer = p;
722     *pRemain = remain;
723
724     return true;
725
726 fail:
727     if (vp != NULL)
728         pairbasicfree(vp);
729     *pVp = NULL;
730     return false;
731 }
732
733 bool
734 gss_eap_radius_attr_provider::initFromBuffer(const gss_eap_attr_ctx *ctx,
735                                              const gss_buffer_t buffer)
736 {
737     unsigned char *p = (unsigned char *)buffer->value;
738     size_t remain = buffer->length;
739     VALUE_PAIR **pNext = &m_vps;
740
741     if (!gss_eap_attr_provider::initFromBuffer(ctx, buffer))
742         return false;
743
744     do {
745         VALUE_PAIR *attr;
746
747         if (!avpImport(&attr, &p, &remain))
748             return false;
749
750         *pNext = attr;
751         pNext = &attr->next;
752     } while (remain != 0);
753
754     return true;
755 }
756
757 void
758 gss_eap_radius_attr_provider::exportToBuffer(gss_buffer_t buffer) const
759 {
760     VALUE_PAIR *vp;
761     unsigned char *p;
762     size_t remain = 0;
763
764     for (vp = m_vps; vp != NULL; vp = vp->next) {
765         remain += avpSize(vp);
766     }
767
768     buffer->value = GSSEAP_MALLOC(remain);
769     if (buffer->value == NULL) {
770         throw new std::bad_alloc;
771         return;
772     }
773     buffer->length = remain;
774
775     p = (unsigned char *)buffer->value;
776
777     for (vp = m_vps; vp != NULL; vp = vp->next) {
778         avpExport(vp, &p, &remain);
779     }
780
781     assert(remain == 0);
782 }
783
784 time_t
785 gss_eap_radius_attr_provider::getExpiryTime(void) const
786 {
787     VALUE_PAIR *vp;
788
789     vp = pairfind(m_vps, PW_SESSION_TIMEOUT);
790     if (vp == NULL || vp->lvalue == 0)
791         return 0;
792
793     return time(NULL) + vp->lvalue;
794 }
795
796 OM_uint32
797 gssEapRadiusMapError(OM_uint32 *minor,
798                      struct rs_error *err)
799 {
800     int code;
801
802     assert(err != NULL);
803
804     code = rs_err_code(err, 0);
805
806     if (code == RSE_OK) {
807         *minor = 0;
808         return GSS_S_COMPLETE;
809     }
810
811     *minor = ERROR_TABLE_BASE_rse + code;
812
813     gssEapSaveStatusInfo(*minor, "%s", rs_err_msg(err, 0));
814     rs_err_free(err);
815
816     return GSS_S_FAILURE;
817 }