2 * Copyright (c) 2011, JANET(UK)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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.
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.
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
34 * RADIUS attribute provider implementation.
37 #include "gssapiP_eap.h"
39 /* stuff that should be provided by libradsec/libfreeradius-radius */
40 #define VENDORATTR(vendor, attr) (((vendor) << 16) | (attr))
43 #define ATTRID(attr) ((attr) & 0xFFFF)
46 static gss_buffer_desc radiusUrnPrefix = {
47 sizeof("urn:x-radius:") - 1,
48 (void *)"urn:x-radius:"
51 static VALUE_PAIR *copyAvps(const VALUE_PAIR *src);
53 gss_eap_radius_attr_provider::gss_eap_radius_attr_provider(void)
56 m_authenticated = false;
59 gss_eap_radius_attr_provider::~gss_eap_radius_attr_provider(void)
66 gss_eap_radius_attr_provider::initFromExistingContext(const gss_eap_attr_ctx *manager,
67 const gss_eap_attr_provider *ctx)
69 const gss_eap_radius_attr_provider *radius;
71 if (!gss_eap_attr_provider::initFromExistingContext(manager, ctx))
74 radius = static_cast<const gss_eap_radius_attr_provider *>(ctx);
76 if (radius->m_vps != NULL)
77 m_vps = copyAvps(const_cast<VALUE_PAIR *>(radius->getAvps()));
79 m_authenticated = radius->m_authenticated;
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)
89 if (!gss_eap_attr_provider::initFromGssContext(manager, gssCred, gssCtx))
92 if (gssCtx != GSS_C_NO_CONTEXT) {
93 if (gssCtx->acceptorCtx.vps != NULL) {
94 m_vps = copyAvps(gssCtx->acceptorCtx.vps);
98 /* We assume libradsec validated this for us */
99 assert(pairfind(m_vps, PW_MESSAGE_AUTHENTICATOR) != NULL);
100 m_authenticated = true;
108 alreadyAddedAttributeP(std::vector <std::string> &attrs, VALUE_PAIR *vp)
110 for (std::vector<std::string>::const_iterator a = attrs.begin();
113 if (strcmp(vp->name, (*a).c_str()) == 0)
121 isSecretAttributeP(uint16_t attrid, uint16_t vendor)
123 bool bSecretAttribute = false;
128 case PW_MS_MPPE_SEND_KEY:
129 case PW_MS_MPPE_RECV_KEY:
130 bSecretAttribute = true;
139 return bSecretAttribute;
143 isSecretAttributeP(uint32_t attribute)
145 return isSecretAttributeP(ATTRID(attribute), VENDOR(attribute));
149 isInternalAttributeP(uint16_t attrid, uint16_t vendor)
151 bool bInternalAttribute = false;
153 /* should have been filtered */
154 assert(!isSecretAttributeP(attrid, vendor));
157 case VENDORPEC_UKERNA:
158 bInternalAttribute = true;
164 return bInternalAttribute;
168 isInternalAttributeP(uint32_t attribute)
170 return isInternalAttributeP(ATTRID(attribute), VENDOR(attribute));
174 * Copy AVP list, same as paircopy except it filters out attributes
178 copyAvps(const VALUE_PAIR *src)
180 const VALUE_PAIR *vp;
181 VALUE_PAIR *dst = NULL, **pDst = &dst;
183 for (vp = src; vp != NULL; vp = vp->next) {
186 if (isSecretAttributeP(vp->attribute))
189 vpcopy = paircopyvp(vp);
190 if (vpcopy == NULL) {
192 throw new std::bad_alloc;
196 pDst = &vpcopy->next;
203 gss_eap_radius_attr_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute,
207 std::vector <std::string> seen;
209 for (vp = m_vps; vp != NULL; vp = vp->next) {
210 gss_buffer_desc attribute;
213 /* Don't advertise attributes that are internal to the GSS-EAP mechanism */
214 if (isInternalAttributeP(vp->attribute))
217 if (alreadyAddedAttributeP(seen, vp))
220 snprintf(attrid, sizeof(attrid), "%s%d",
221 (char *)radiusUrnPrefix.value, vp->attribute);
223 attribute.value = attrid;
224 attribute.length = strlen(attrid);
226 if (!addAttribute(m_manager, this, &attribute, data))
229 seen.push_back(std::string(vp->name));
236 getAttributeId(const gss_buffer_t attr)
239 gss_buffer_desc strAttr = GSS_C_EMPTY_BUFFER;
244 if (attr->length < radiusUrnPrefix.length ||
245 memcmp(attr->value, radiusUrnPrefix.value, radiusUrnPrefix.length) != 0)
248 /* need to duplicate because attr may not be NUL terminated */
249 duplicateBuffer(*attr, &strAttr);
250 s = (char *)strAttr.value + radiusUrnPrefix.length;
253 attrid = strtoul(s, NULL, 10);
255 da = dict_attrbyname(s);
260 gss_release_buffer(&tmpMinor, &strAttr);
266 gss_eap_radius_attr_provider::setAttribute(int complete GSSEAP_UNUSED,
268 const gss_buffer_t value)
270 OM_uint32 major = GSS_S_UNAVAILABLE, minor;
272 if (!isSecretAttributeP(attrid) &&
273 !isInternalAttributeP(attrid)) {
274 deleteAttribute(attrid);
276 major = gssEapRadiusAddAvp(&minor, &m_vps,
277 ATTRID(attrid), VENDOR(attrid),
281 return !GSS_ERROR(major);
285 gss_eap_radius_attr_provider::setAttribute(int complete,
286 const gss_buffer_t attr,
287 const gss_buffer_t value)
289 uint32_t attrid = getAttributeId(attr);
294 return setAttribute(complete, attrid, value);
298 gss_eap_radius_attr_provider::deleteAttribute(uint32_t attrid)
300 if (isSecretAttributeP(attrid) || isInternalAttributeP(attrid) ||
301 pairfind(m_vps, attrid) == NULL)
304 pairdelete(&m_vps, attrid);
310 gss_eap_radius_attr_provider::deleteAttribute(const gss_buffer_t attr)
312 uint32_t attrid = getAttributeId(attr);
317 return deleteAttribute(attrid);
321 gss_eap_radius_attr_provider::getAttribute(const gss_buffer_t attr,
325 gss_buffer_t display_value,
330 attrid = getAttributeId(attr);
334 return getAttribute(attrid, authenticated, complete,
335 value, display_value, more);
339 gss_eap_radius_attr_provider::getAttribute(uint32_t attrid,
343 gss_buffer_t display_value,
347 int i = *more, count = 0;
354 for (vp = pairfind(m_vps, attrid);
356 vp = pairfind(vp->next, attrid)) {
358 if (pairfind(vp->next, attrid) != NULL)
364 if (vp == NULL && *more == 0)
367 if (value != GSS_C_NO_BUFFER) {
368 gss_buffer_desc valueBuf;
370 valueBuf.value = (void *)vp->vp_octets;
371 valueBuf.length = vp->length;
373 duplicateBuffer(valueBuf, value);
376 if (display_value != GSS_C_NO_BUFFER) {
377 char displayString[MAX_STRING_LEN];
378 gss_buffer_desc displayBuf;
380 displayBuf.length = vp_prints_value(displayString,
381 sizeof(displayString), vp, 0);
382 displayBuf.value = (void *)displayString;
384 duplicateBuffer(displayBuf, display_value);
387 if (authenticated != NULL)
388 *authenticated = m_authenticated;
389 if (complete != NULL)
396 gss_eap_radius_attr_provider::getFragmentedAttribute(uint16_t attribute,
400 gss_buffer_t value) const
402 OM_uint32 major, minor;
404 major = gssEapRadiusGetAvp(&minor, m_vps, attribute, vendor, value, TRUE);
406 if (authenticated != NULL)
407 *authenticated = m_authenticated;
408 if (complete != NULL)
411 return !GSS_ERROR(major);
415 gss_eap_radius_attr_provider::getAttribute(uint16_t attribute,
420 gss_buffer_t display_value,
424 return getAttribute(VENDORATTR(attribute, vendor),
425 authenticated, complete,
426 value, display_value, more);
430 gss_eap_radius_attr_provider::mapToAny(int authenticated,
431 gss_buffer_t type_id GSSEAP_UNUSED) const
433 if (authenticated && !m_authenticated)
434 return (gss_any_t)NULL;
436 return (gss_any_t)copyAvps(m_vps);
440 gss_eap_radius_attr_provider::releaseAnyNameMapping(gss_buffer_t type_id GSSEAP_UNUSED,
441 gss_any_t input) const
443 VALUE_PAIR *vp = (VALUE_PAIR *)input;
448 gss_eap_radius_attr_provider::init(void)
450 struct rs_context *radContext;
452 gss_eap_attr_ctx::registerProvider(ATTR_TYPE_RADIUS, createAttrContext);
456 * This hack is necessary in order to force the loading of the global
457 * dictionary, otherwise accepting reauthentication tokens fails unless
458 * the acceptor has already accepted a normal authentication token.
460 if (rs_context_create(&radContext) != 0)
463 if (rs_context_read_config(radContext, RS_CONFIG_FILE) != 0) {
464 rs_context_destroy(radContext);
468 if (rs_context_init_freeradius_dict(radContext, NULL)) {
469 rs_context_destroy(radContext);
473 rs_context_destroy(radContext);
480 gss_eap_radius_attr_provider::finalize(void)
482 gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_RADIUS);
485 gss_eap_attr_provider *
486 gss_eap_radius_attr_provider::createAttrContext(void)
488 return new gss_eap_radius_attr_provider;
492 gssEapRadiusAddAvp(OM_uint32 *minor,
496 const gss_buffer_t buffer)
498 uint32_t attrid = VENDORATTR(vendor, attribute);
499 unsigned char *p = (unsigned char *)buffer->value;
500 size_t remain = buffer->length;
507 * There's an extra byte of padding; RADIUS AVPs can only
510 if (n >= MAX_STRING_LEN)
511 n = MAX_STRING_LEN - 1;
513 vp = paircreate(attrid, PW_TYPE_OCTETS);
516 return GSS_S_FAILURE;
519 memcpy(vp->vp_octets, p, n);
526 } while (remain != 0);
528 return GSS_S_COMPLETE;
532 gssEapRadiusGetRawAvp(OM_uint32 *minor,
538 uint32_t attr = VENDORATTR(vendor, attribute);
540 *vp = pairfind(vps, attr);
542 *minor = GSSEAP_NO_SUCH_ATTR;
543 return GSS_S_UNAVAILABLE;
546 return GSS_S_COMPLETE;
550 gssEapRadiusGetAvp(OM_uint32 *minor,
559 uint32_t attr = VENDORATTR(vendor, attribute);
562 buffer->value = NULL;
564 vp = pairfind(vps, attr);
566 *minor = GSSEAP_NO_SUCH_ATTR;
567 return GSS_S_UNAVAILABLE;
571 buffer->length += vp->length;
572 } while (concat && (vp = pairfind(vp->next, attr)) != NULL);
574 buffer->value = GSSEAP_MALLOC(buffer->length);
575 if (buffer->value == NULL) {
577 return GSS_S_FAILURE;
580 p = (unsigned char *)buffer->value;
582 for (vp = pairfind(vps, attr);
583 concat && vp != NULL;
584 vp = pairfind(vp->next, attr)) {
585 memcpy(p, vp->vp_octets, vp->length);
590 return GSS_S_COMPLETE;
594 gssEapRadiusFreeAvps(OM_uint32 *minor,
599 return GSS_S_COMPLETE;
603 gssEapRadiusAttrProviderInit(OM_uint32 *minor)
605 if (!gss_eap_radius_attr_provider::init()) {
606 *minor = GSSEAP_RADSEC_INIT_FAILURE;
607 return GSS_S_FAILURE;
610 return GSS_S_COMPLETE;
614 gssEapRadiusAttrProviderFinalize(OM_uint32 *minor)
616 gss_eap_radius_attr_provider::finalize();
619 return GSS_S_COMPLETE;
623 avpToJson(const VALUE_PAIR *vp)
627 assert(vp->length <= MAX_STRING_LEN);
630 case PW_TYPE_INTEGER:
633 obj.set("value", vp->lvalue);
636 obj.set("value", vp->vp_strvalue);
641 if (base64Encode(vp->vp_octets, vp->length, &b64) < 0)
642 throw new std::bad_alloc;
644 obj.set("value", b64);
650 obj.set("type", vp->attribute);
656 jsonToAvp(VALUE_PAIR **pVp, JSONObject &obj)
658 VALUE_PAIR *vp = NULL;
662 JSONObject type = obj["type"];
663 JSONObject value = obj["value"];
664 if (type.isnull() || value.isnull())
667 attrid = type.integer();
668 da = dict_attrbyvalue(attrid);
672 vp = paircreate(attrid, PW_TYPE_STRING);
675 throw new std::bad_alloc;
680 case PW_TYPE_INTEGER:
684 vp->lvalue = value.integer();
686 case PW_TYPE_STRING: {
687 const char *str = value.string();
690 if (str == NULL || (len = strlen(str)) >= MAX_STRING_LEN)
694 memcpy(vp->vp_strvalue, str, len + 1);
699 const char *str = value.string();
702 /* this optimization requires base64Decode only understand packed encoding */
704 strlen(str) >= BASE64_EXPAND(MAX_STRING_LEN))
707 len = base64Decode(str, vp->vp_octets);
712 vp->vp_octets[len] = '\0';
729 gss_eap_radius_attr_provider::name(void) const
735 gss_eap_radius_attr_provider::initWithJsonObject(const gss_eap_attr_ctx *ctx,
738 VALUE_PAIR **pNext = &m_vps;
740 if (!gss_eap_attr_provider::initWithJsonObject(ctx, obj))
743 JSONObject attrs = obj["attributes"];
744 size_t nelems = attrs.size();
746 for (size_t i = 0; i < nelems; i++) {
747 JSONObject attr = attrs[i];
750 if (!jsonToAvp(&vp, attr))
761 gss_eap_radius_attr_provider::prefix(void) const
763 return "urn:ietf:params:gss-eap:radius-avp";
767 gss_eap_radius_attr_provider::jsonRepresentation(void) const
769 JSONObject obj, attrs = JSONObject::array();
771 for (VALUE_PAIR *vp = m_vps; vp != NULL; vp = vp->next) {
772 JSONObject attr = avpToJson(vp);
776 obj.set("attributes", attrs);
782 gss_eap_radius_attr_provider::getExpiryTime(void) const
786 vp = pairfind(m_vps, PW_SESSION_TIMEOUT);
787 if (vp == NULL || vp->lvalue == 0)
790 return time(NULL) + vp->lvalue;
794 gssEapRadiusMapError(OM_uint32 *minor,
795 struct rs_error *err)
801 code = rs_err_code(err, 0);
803 if (code == RSE_OK) {
805 return GSS_S_COMPLETE;
808 *minor = ERROR_TABLE_BASE_rse + code;
810 gssEapSaveStatusInfo(*minor, "%s", rs_err_msg(err));
813 return GSS_S_FAILURE;