some preliminary RADIUS attribute serialisation
[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 VALUE_PAIR *
36 gss_eap_radius_attr_provider::copyAvps(const VALUE_PAIR *src)
37 {
38     const VALUE_PAIR *vp;
39     VALUE_PAIR *dst = NULL, **pDst = &dst;
40
41     for (vp = src; vp != NULL; vp = vp->next) {
42         VALUE_PAIR *vp2;
43
44         vp2 = (VALUE_PAIR *)GSSEAP_CALLOC(1, sizeof(*vp2));
45         if (vp2 == NULL) {
46             rc_avpair_free(dst);
47             return NULL;
48         }
49         memcpy(vp2, vp, sizeof(*vp));
50         vp2->next = NULL;
51         *pDst = vp2;
52         pDst = &vp2->next;
53     }
54
55     return dst;
56 }
57
58 gss_eap_radius_attr_provider::gss_eap_radius_attr_provider(void)
59 {
60     m_rh = NULL;
61     m_avps = NULL;
62     m_authenticated = false;
63 }
64
65 gss_eap_radius_attr_provider::~gss_eap_radius_attr_provider(void)
66 {
67     if (m_rh != NULL)
68         rc_config_free(m_rh);
69     if (m_avps != NULL)
70         rc_avpair_free(m_avps);
71 }
72
73 bool
74 gss_eap_radius_attr_provider::initFromGssCred(const gss_cred_id_t cred)
75 {
76     OM_uint32 minor;
77
78     return !GSS_ERROR(gssEapRadiusAllocHandle(&minor, cred, &m_rh));
79 }
80
81 bool
82 gss_eap_radius_attr_provider::initFromExistingContext(const gss_eap_attr_ctx *manager,
83                                                       const gss_eap_attr_provider *ctx)
84 {
85     const gss_eap_radius_attr_provider *radius;
86
87     if (!gss_eap_attr_provider::initFromExistingContext(manager, ctx))
88         return false;
89
90     if (!initFromGssCred(GSS_C_NO_CREDENTIAL))
91         return false;
92
93     radius = static_cast<const gss_eap_radius_attr_provider *>(ctx);
94     if (radius->m_avps != NULL) {
95         m_avps = copyAvps(radius->getAvps());
96     }
97
98     return true;
99 }
100
101 bool
102 gss_eap_radius_attr_provider::initFromGssContext(const gss_eap_attr_ctx *manager,
103                                                  const gss_cred_id_t gssCred,
104                                                  const gss_ctx_id_t gssCtx)
105 {
106     if (!gss_eap_attr_provider::initFromGssContext(manager, gssCred, gssCtx))
107         return false;
108
109     if (!initFromGssCred(gssCred))
110         return false;
111
112     if (gssCtx != GSS_C_NO_CONTEXT) {
113         if (gssCtx->acceptorCtx.avps != NULL) {
114             m_avps = copyAvps(gssCtx->acceptorCtx.avps);
115             if (m_avps == NULL)
116                 return false;
117         }
118     }
119
120     return true;
121 }
122
123 static bool
124 alreadyAddedAttributeP(std::vector <std::string> &attrs, VALUE_PAIR *vp)
125 {
126     for (std::vector<std::string>::const_iterator a = attrs.begin();
127          a != attrs.end();
128          ++a) {
129         if (strcmp(vp->name, (*a).c_str()) == 0)
130             return true;
131     }
132
133     return false;
134 }
135
136 static bool
137 isSecretAttributeP(int attrid, int vendor)
138 {
139     bool ret = false;
140
141     switch (vendor) {
142     case RADIUS_VENDOR_ID_MICROSOFT:
143         switch (attrid) {
144         case RADIUS_VENDOR_ATTR_MS_MPPE_SEND_KEY:
145         case RADIUS_VENDOR_ATTR_MS_MPPE_RECV_KEY:
146             ret = true;
147             break;
148         default:
149             break;
150         }
151     default:
152         break;
153     }
154
155     return ret;
156 }
157
158 bool
159 gss_eap_radius_attr_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute, void *data) const
160 {
161     VALUE_PAIR *vp;
162     std::vector <std::string> seen;
163
164     for (vp = m_avps; vp != NULL; vp = vp->next) {
165         gss_buffer_desc attribute;
166
167         if (isSecretAttributeP(ATTRID(vp->attribute), VENDOR(vp->attribute)))
168             continue;
169
170         if (alreadyAddedAttributeP(seen, vp))
171             continue;
172
173         attribute.value = (void *)vp->name;
174         attribute.length = strlen(vp->name);
175
176         if (!addAttribute(this, &attribute, data))
177             return false;
178
179         seen.push_back(std::string(vp->name));
180     }
181
182     return true;
183 }
184
185 void
186 gss_eap_radius_attr_provider::setAttribute(int complete,
187                                            const gss_buffer_t attr,
188                                            const gss_buffer_t value)
189 {
190 }
191
192 void
193 gss_eap_radius_attr_provider::deleteAttribute(const gss_buffer_t value)
194 {
195 }
196
197 bool
198 gss_eap_radius_attr_provider::getAttribute(const gss_buffer_t attr,
199                                            int *authenticated,
200                                            int *complete,
201                                            gss_buffer_t value,
202                                            gss_buffer_t display_value,
203                                            int *more) const
204 {
205     OM_uint32 tmpMinor;
206     gss_buffer_desc strAttr = GSS_C_EMPTY_BUFFER;
207     DICT_ATTR *d;
208     int attrid;
209     char *s;
210
211     /* XXX vendor */
212
213     duplicateBuffer(*attr, &strAttr);
214     s = (char *)strAttr.value;
215
216     if (isdigit(((char *)strAttr.value)[0])) {
217         attrid = strtoul(s, NULL, 10);
218     } else {
219         d = rc_dict_findattr(m_rh, (char *)s);
220         if (d == NULL) {
221             gss_release_buffer(&tmpMinor, &strAttr);
222             return false;
223         }
224         attrid = d->value;
225     }
226
227     gss_release_buffer(&tmpMinor, &strAttr);
228
229     return getAttribute(attrid, authenticated, complete,
230                         value, display_value, more);
231 }
232
233 static bool
234 isPrintableAttributeP(VALUE_PAIR *vp)
235 {
236     size_t i;
237
238     for (i = 0; i < sizeof(vp->strvalue); i++) {
239         if (!isprint(vp->strvalue[i]))
240             return false;
241     }
242
243     return true;
244 }
245
246 bool
247 gss_eap_radius_attr_provider::getAttribute(int attrid,
248                                            int vendor,
249                                            int *authenticated,
250                                            int *complete,
251                                            gss_buffer_t value,
252                                            gss_buffer_t display_value,
253                                            int *more) const
254 {
255     OM_uint32 tmpMinor;
256     VALUE_PAIR *vp;
257     int i = *more;
258     int max = 0;
259     char name[NAME_LENGTH + 1];
260     char displayString[AUTH_STRING_LEN + 1];
261     gss_buffer_desc valueBuf = GSS_C_EMPTY_BUFFER;
262     gss_buffer_desc displayBuf = GSS_C_EMPTY_BUFFER;
263
264     *more = 0;
265
266     if (isSecretAttributeP(attrid, vendor))
267         return false;
268
269     vp = rc_avpair_get(m_avps, attrid, vendor);
270     if (vp == NULL)
271         return false;
272
273     if (i == -1)
274         i = 0;
275
276     do {
277         if (i == max)
278             break;
279
280         max++;
281     } while ((vp = rc_avpair_get(vp->next, attrid, vendor)) != NULL);
282
283     if (i > max)
284         return false;
285
286     if (vp->type == PW_TYPE_STRING) {
287         valueBuf.value = (void *)vp->strvalue;
288         valueBuf.length = vp->lvalue;
289     } else {
290         valueBuf.value = (void *)&vp->lvalue;
291         valueBuf.length = 4;
292     }
293
294     if (value != GSS_C_NO_BUFFER)
295         duplicateBuffer(valueBuf, value);
296
297     if (display_value != GSS_C_NO_BUFFER &&
298         isPrintableAttributeP(vp)) {
299         if (rc_avpair_tostr(m_rh, vp, name, NAME_LENGTH,
300                             displayString, AUTH_STRING_LEN) != 0) {
301             gss_release_buffer(&tmpMinor, value);
302             return false;
303         }
304
305         displayBuf.value = (void *)displayString;
306         displayBuf.length = strlen(displayString);
307
308         duplicateBuffer(displayBuf, display_value);
309     }
310
311     if (authenticated != NULL)
312         *authenticated = m_authenticated;
313     if (complete != NULL)
314         *complete = true;
315
316     if (max > i)
317         *more = i;
318
319     return true;
320 }
321
322 bool
323 gss_eap_radius_attr_provider::getAttribute(int attrid,
324                                            int *authenticated,
325                                            int *complete,
326                                            gss_buffer_t value,
327                                            gss_buffer_t display_value,
328                                            int *more) const
329 {
330
331     return getAttribute(ATTRID(attrid), VENDOR(attrid),
332                         authenticated, complete,
333                         value, display_value, more);
334 }
335
336 gss_any_t
337 gss_eap_radius_attr_provider::mapToAny(int authenticated,
338                                        gss_buffer_t type_id) const
339 {
340     if (authenticated && !m_authenticated)
341         return (gss_any_t)NULL;
342
343     return (gss_any_t)copyAvps(m_avps);
344 }
345
346 void
347 gss_eap_radius_attr_provider::releaseAnyNameMapping(gss_buffer_t type_id,
348                                                     gss_any_t input) const
349 {
350     rc_avpair_free((VALUE_PAIR *)input);
351 }
352
353 bool
354 gss_eap_radius_attr_provider::init(void)
355 {
356     gss_eap_attr_ctx::registerProvider(ATTR_TYPE_RADIUS,
357                                        "urn:ietf:params:gss-eap:radius-avp",
358                                        gss_eap_radius_attr_provider::createAttrContext);
359     return true;
360 }
361
362 void
363 gss_eap_radius_attr_provider::finalize(void)
364 {
365     gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_RADIUS);
366 }
367
368 gss_eap_attr_provider *
369 gss_eap_radius_attr_provider::createAttrContext(void)
370 {
371     return new gss_eap_radius_attr_provider;
372 }
373
374 OM_uint32
375 addAvpFromBuffer(OM_uint32 *minor,
376                  rc_handle *rh,
377                  VALUE_PAIR **vp,
378                  int type,
379                  gss_buffer_t buffer)
380 {
381     if (rc_avpair_add(rh, vp, type, buffer->value, buffer->length, 0) == NULL) {
382         return GSS_S_FAILURE;
383     }
384
385     return GSS_S_COMPLETE;
386 }
387
388 OM_uint32
389 getBufferFromAvps(OM_uint32 *minor,
390                   VALUE_PAIR *vps,
391                   int type,
392                   gss_buffer_t buffer,
393                   int concat)
394 {
395     VALUE_PAIR *vp;
396     unsigned char *p;
397
398     buffer->length = 0;
399     buffer->value = NULL;
400
401     vp = rc_avpair_get(vps, type, 0);
402     if (vp == NULL)
403         return GSS_S_UNAVAILABLE;
404
405     do {
406         buffer->length += vp->lvalue;
407     } while (concat && (vp = rc_avpair_get(vp->next, type, 0)) != NULL);
408
409     buffer->value = GSSEAP_MALLOC(buffer->length);
410     if (buffer->value == NULL) {
411         *minor = ENOMEM;
412         return GSS_S_FAILURE;
413     }
414
415     p = (unsigned char *)buffer->value;
416
417     for (vp = rc_avpair_get(vps, type, 0);
418          concat && vp != NULL;
419          vp = rc_avpair_get(vp->next, type, 0)) {
420         memcpy(p, vp->strvalue, vp->lvalue);
421         p += vp->lvalue;
422     }
423
424     *minor = 0;
425     return GSS_S_COMPLETE;
426 }
427
428 OM_uint32
429 gssEapRadiusAttrProviderInit(OM_uint32 *minor)
430 {
431     return gss_eap_radius_attr_provider::init()
432         ? GSS_S_COMPLETE : GSS_S_FAILURE;
433 }
434
435 OM_uint32
436 gssEapRadiusAttrProviderFinalize(OM_uint32 *minor)
437 {
438     gss_eap_radius_attr_provider::finalize();
439     return GSS_S_COMPLETE;
440 }
441
442 OM_uint32
443 gssEapRadiusAllocHandle(OM_uint32 *minor,
444                         const gss_cred_id_t cred,
445                         rc_handle **pHandle)
446 {
447     rc_handle *rh;
448     const char *config = RC_CONFIG_FILE;
449
450     *pHandle = NULL;
451
452     if (cred != GSS_C_NO_CREDENTIAL && cred->radiusConfigFile != NULL)
453         config = cred->radiusConfigFile;
454
455     rh = rc_read_config((char *)config);
456     if (rh == NULL) {
457         *minor = errno;
458         rc_config_free(rh);
459         return GSS_S_FAILURE;
460     }
461
462     if (rc_read_dictionary(rh, rc_conf_str(rh, (char *)"dictionary")) != 0) {
463         *minor = errno;
464         return GSS_S_FAILURE;
465     }
466
467     *pHandle = rh;
468     return GSS_S_COMPLETE;
469 }
470
471 /*
472  * This is a super-inefficient coding but the API is going to change
473  * as are the data structures, so not putting a lot of work in now.
474  */
475 static size_t
476 avpSize(const VALUE_PAIR *vp)
477 {
478     return NAME_LENGTH + 1 + 12 + AUTH_STRING_LEN + 1;
479 }
480
481 static bool
482 avpExport(const VALUE_PAIR *vp,
483           unsigned char **pBuffer,
484           size_t *pRemain)
485 {
486     unsigned char *p = *pBuffer;
487     size_t remain = *pRemain;
488
489     assert(remain >= avpSize(vp));
490
491     memcpy(p, vp->name, NAME_LENGTH + 1);
492     p += NAME_LENGTH + 1;
493     remain -= NAME_LENGTH + 1;
494
495     store_uint32_be(vp->attribute, &p[0]);
496     store_uint32_be(vp->type,      &p[4]);
497     store_uint32_be(vp->lvalue,    &p[8]);
498
499     p += 12;
500     remain -= 12;
501
502     memcpy(p, vp->strvalue, AUTH_STRING_LEN + 1);
503     p += AUTH_STRING_LEN + 1;
504     remain -= AUTH_STRING_LEN + 1;
505
506     *pBuffer = p;
507     *pRemain = remain;
508
509     return true;
510
511 }
512
513 static bool
514 avpImport(VALUE_PAIR **pVp,
515           unsigned char **pBuffer,
516           size_t *pRemain)
517 {
518     unsigned char *p = *pBuffer;
519     size_t remain = *pRemain;
520     VALUE_PAIR *vp;
521
522     if (remain < avpSize(NULL)) {
523         return false;
524     }
525
526     vp = (VALUE_PAIR *)GSSEAP_CALLOC(1, sizeof(*vp));
527     if (vp == NULL) {
528         throw new std::bad_alloc;
529         return false;
530     }
531     vp->next = NULL;
532
533     memcpy(vp->name, p, NAME_LENGTH + 1);
534     p += NAME_LENGTH + 1;
535     remain -= NAME_LENGTH + 1;
536
537     vp->attribute = load_uint32_be(&p[0]);
538     vp->type      = load_uint32_be(&p[4]);
539     vp->lvalue    = load_uint32_be(&p[8]);
540
541     p += 12;
542     remain -= 12;
543
544     memcpy(vp->strvalue, p, AUTH_STRING_LEN + 1);
545     p += AUTH_STRING_LEN + 1;
546     remain -= AUTH_STRING_LEN + 1;
547
548     *pVp = vp;
549     *pBuffer = p;
550     *pRemain = remain;
551
552     return true;
553 }
554
555 bool
556 gss_eap_radius_attr_provider::initFromBuffer(const gss_eap_attr_ctx *ctx,
557                                              const gss_buffer_t buffer)
558 {
559     unsigned char *p = (unsigned char *)buffer->value;
560     size_t remain = buffer->length;
561     OM_uint32 count;
562     VALUE_PAIR **pNext = &m_avps;
563
564     if (!gss_eap_attr_provider::initFromBuffer(ctx, buffer))
565         return false;
566
567     if (!initFromGssCred(GSS_C_NO_CREDENTIAL))
568         return false;
569
570     if (remain < 4)
571         return false;
572
573     count = load_uint32_be(p);
574     p += 4;
575     remain -= 4;
576
577     do {
578         VALUE_PAIR *attr;
579
580         if (!avpImport(&attr, &p, &remain))
581             return false;
582
583         *pNext = attr;
584         pNext = &attr->next;
585
586         count--;
587     } while (remain != 0);
588
589     if (count != 0)
590         return false;
591
592     return true;
593 }
594
595 void
596 gss_eap_radius_attr_provider::exportToBuffer(gss_buffer_t buffer) const
597 {
598     OM_uint32 count = 0;
599     VALUE_PAIR *vp;
600     unsigned char *p;
601     size_t remain = 4;
602
603     for (vp = m_avps; vp != NULL; vp = vp->next) {
604         remain += avpSize(vp);
605         count++;
606     }
607
608     buffer->value = GSSEAP_MALLOC(remain);
609     if (buffer->value == NULL) {
610         throw new std::bad_alloc;
611         return;
612     }
613     buffer->length = remain;
614
615     p = (unsigned char *)buffer->value;
616
617     store_uint32_be(count, p);
618     p += 4;
619     remain -= 4;
620
621     for (vp = m_avps; vp != NULL; vp = vp->next) {
622         avpExport(vp, &p, &remain);
623     }
624
625     assert(remain == 0);
626 }