don't free RADIUS context before packet
[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     gss_eap_attr_ctx::registerProvider(ATTR_TYPE_RADIUS,
450                                        "urn:ietf:params:gss-eap:radius-avp",
451                                        createAttrContext);
452     return true;
453 }
454
455 void
456 gss_eap_radius_attr_provider::finalize(void)
457 {
458     gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_RADIUS);
459 }
460
461 gss_eap_attr_provider *
462 gss_eap_radius_attr_provider::createAttrContext(void)
463 {
464     return new gss_eap_radius_attr_provider;
465 }
466
467 OM_uint32
468 gssEapRadiusAddAvp(OM_uint32 *minor,
469                    VALUE_PAIR **vps,
470                    uint16_t attribute,
471                    uint16_t vendor,
472                    const gss_buffer_t buffer)
473 {
474     uint32_t attrid = VENDORATTR(vendor, attribute);
475     unsigned char *p = (unsigned char *)buffer->value;
476     size_t remain = buffer->length;
477
478     do {
479         VALUE_PAIR *vp;
480         size_t n = remain;
481
482         /*
483          * There's an extra byte of padding; RADIUS AVPs can only
484          * be 253 octets.
485          */
486         if (n >= MAX_STRING_LEN)
487             n = MAX_STRING_LEN - 1;
488
489         vp = paircreate(attrid, PW_TYPE_OCTETS);
490         if (vp == NULL) {
491             *minor = ENOMEM;
492             return GSS_S_FAILURE;
493         }
494
495         memcpy(vp->vp_octets, p, n);
496         vp->length = n;
497
498         pairadd(vps, vp);
499
500         p += n;
501         remain -= n;
502     } while (remain != 0);
503
504     return GSS_S_COMPLETE;
505 }
506
507 OM_uint32
508 gssEapRadiusGetRawAvp(OM_uint32 *minor,
509                       VALUE_PAIR *vps,
510                       uint16_t attribute,
511                       uint16_t vendor,
512                       VALUE_PAIR **vp)
513 {
514     uint32_t attr = VENDORATTR(vendor, attribute);
515
516     *vp = pairfind(vps, attr);
517     if (*vp == NULL) {
518         *minor = GSSEAP_NO_SUCH_ATTR;
519         return GSS_S_UNAVAILABLE;
520     }
521
522     return GSS_S_COMPLETE;
523 }
524
525 OM_uint32
526 gssEapRadiusGetAvp(OM_uint32 *minor,
527                    VALUE_PAIR *vps,
528                    uint16_t attribute,
529                    uint16_t vendor,
530                    gss_buffer_t buffer,
531                    int concat)
532 {
533     VALUE_PAIR *vp;
534     unsigned char *p;
535     uint32_t attr = VENDORATTR(vendor, attribute);
536
537     buffer->length = 0;
538     buffer->value = NULL;
539
540     vp = pairfind(vps, attr);
541     if (vp == NULL) {
542         *minor = GSSEAP_NO_SUCH_ATTR;
543         return GSS_S_UNAVAILABLE;
544     }
545
546     do {
547         buffer->length += vp->length;
548     } while (concat && (vp = pairfind(vp->next, attr)) != NULL);
549
550     buffer->value = GSSEAP_MALLOC(buffer->length);
551     if (buffer->value == NULL) {
552         *minor = ENOMEM;
553         return GSS_S_FAILURE;
554     }
555
556     p = (unsigned char *)buffer->value;
557
558     for (vp = pairfind(vps, attr);
559          concat && vp != NULL;
560          vp = pairfind(vp->next, attr)) {
561         memcpy(p, vp->vp_octets, vp->length);
562         p += vp->length;
563     }
564
565     *minor = 0;
566     return GSS_S_COMPLETE;
567 }
568
569 OM_uint32
570 gssEapRadiusFreeAvps(OM_uint32 *minor,
571                      VALUE_PAIR **vps)
572 {
573     pairfree(vps);
574     *minor = 0;
575     return GSS_S_COMPLETE;
576 }
577
578 OM_uint32
579 gssEapRadiusAttrProviderInit(OM_uint32 *minor)
580 {
581     if (!gss_eap_radius_attr_provider::init()) {
582         *minor = GSSEAP_RADSEC_INIT_FAILURE;
583         return GSS_S_FAILURE;
584     }
585
586     return GSS_S_COMPLETE;
587 }
588
589 OM_uint32
590 gssEapRadiusAttrProviderFinalize(OM_uint32 *minor)
591 {
592     gss_eap_radius_attr_provider::finalize();
593     return GSS_S_COMPLETE;
594 }
595
596 /*
597  * Encoding is:
598  * 4 octet NBO attribute ID | 4 octet attribute length | attribute data
599  */
600 static size_t
601 avpSize(const VALUE_PAIR *vp)
602 {
603     size_t size = 4 + 1;
604
605     if (vp != NULL)
606         size += vp->length;
607
608     return size;
609 }
610
611 static bool
612 avpExport(const VALUE_PAIR *vp,
613           unsigned char **pBuffer,
614           size_t *pRemain)
615 {
616     unsigned char *p = *pBuffer;
617     size_t remain = *pRemain;
618
619     assert(remain >= avpSize(vp));
620
621     store_uint32_be(vp->attribute, p);
622
623     switch (vp->type) {
624     case PW_TYPE_INTEGER:
625     case PW_TYPE_IPADDR:
626     case PW_TYPE_DATE:
627         p[4] = 4;
628         store_uint32_be(vp->lvalue, p + 5);
629         break;
630     default:
631         assert(vp->length <= MAX_STRING_LEN);
632         p[4] = (uint8_t)vp->length;
633         memcpy(p + 5, vp->vp_octets, vp->length);
634         break;
635     }
636
637     *pBuffer += 5 + p[4];
638     *pRemain -= 5 + p[4];
639
640     return true;
641
642 }
643
644 static bool
645 avpImport(VALUE_PAIR **pVp,
646           unsigned char **pBuffer,
647           size_t *pRemain)
648 {
649     unsigned char *p = *pBuffer;
650     size_t remain = *pRemain;
651     VALUE_PAIR *vp = NULL;
652     DICT_ATTR *da;
653     uint32_t attrid;
654
655     if (remain < avpSize(NULL))
656         goto fail;
657
658     attrid = load_uint32_be(p);
659     p += 4;
660     remain -= 4;
661
662     da = dict_attrbyvalue(attrid);
663     if (da == NULL)
664         goto fail;
665
666     vp = pairalloc(da);
667     if (vp == NULL) {
668         throw new std::bad_alloc;
669         goto fail;
670     }
671
672     if (remain < p[0])
673         goto fail;
674
675     switch (vp->type) {
676     case PW_TYPE_INTEGER:
677     case PW_TYPE_IPADDR:
678     case PW_TYPE_DATE:
679         if (p[0] != 4)
680             goto fail;
681
682         vp->length = 4;
683         vp->lvalue = load_uint32_be(p + 1);
684         p += 5;
685         remain -= 5;
686         break;
687     case PW_TYPE_STRING:
688     default:
689         if (p[0] >= MAX_STRING_LEN)
690             goto fail;
691
692         vp->length = (uint32_t)p[0];
693         memcpy(vp->vp_octets, p + 1, vp->length);
694
695         if (vp->type == PW_TYPE_STRING)
696             vp->vp_strvalue[vp->length] = '\0';
697
698         p += 1 + vp->length;
699         remain -= 1 + vp->length;
700         break;
701     }
702
703     *pVp = vp;
704     *pBuffer = p;
705     *pRemain = remain;
706
707     return true;
708
709 fail:
710     pairbasicfree(vp);
711     return false;
712 }
713
714 bool
715 gss_eap_radius_attr_provider::initFromBuffer(const gss_eap_attr_ctx *ctx,
716                                              const gss_buffer_t buffer)
717 {
718     unsigned char *p = (unsigned char *)buffer->value;
719     size_t remain = buffer->length;
720     VALUE_PAIR **pNext = &m_vps;
721
722     if (!gss_eap_attr_provider::initFromBuffer(ctx, buffer))
723         return false;
724
725     do {
726         VALUE_PAIR *attr;
727
728         if (!avpImport(&attr, &p, &remain))
729             return false;
730
731         *pNext = attr;
732         pNext = &attr->next;
733     } while (remain != 0);
734
735     return true;
736 }
737
738 void
739 gss_eap_radius_attr_provider::exportToBuffer(gss_buffer_t buffer) const
740 {
741     VALUE_PAIR *vp;
742     unsigned char *p;
743     size_t remain = 0;
744
745     for (vp = m_vps; vp != NULL; vp = vp->next) {
746         remain += avpSize(vp);
747     }
748
749     buffer->value = GSSEAP_MALLOC(remain);
750     if (buffer->value == NULL) {
751         throw new std::bad_alloc;
752         return;
753     }
754     buffer->length = remain;
755
756     p = (unsigned char *)buffer->value;
757
758     for (vp = m_vps; vp != NULL; vp = vp->next) {
759         avpExport(vp, &p, &remain);
760     }
761
762     assert(remain == 0);
763 }
764
765 time_t
766 gss_eap_radius_attr_provider::getExpiryTime(void) const
767 {
768     VALUE_PAIR *vp;
769
770     vp = pairfind(m_vps, PW_SESSION_TIMEOUT);
771     if (vp == NULL || vp->lvalue == 0)
772         return 0;
773
774     return time(NULL) + vp->lvalue;
775 }
776
777 OM_uint32
778 gssEapRadiusMapError(OM_uint32 *minor,
779                      struct rs_error *err)
780 {
781     int code;
782
783     assert(err != NULL);
784
785     code = rs_err_code(err, 0);
786
787     if (code == RSE_OK) {
788         *minor = 0;
789         return GSS_S_COMPLETE;
790     }
791
792     *minor = ERROR_TABLE_BASE_rse + code;
793
794     gssEapSaveStatusInfo(*minor, "%s", rs_err_msg(err));
795     rs_err_free(err);
796
797     return GSS_S_FAILURE;
798 }