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