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::initWithExistingContext(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::initWithExistingContext(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::initWithGssContext(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::initWithGssContext(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 std::bad_alloc();
195 pDst = &vpcopy->next;
202 gss_eap_radius_attr_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute,
206 std::vector <std::string> seen;
208 for (vp = m_vps; vp != NULL; vp = vp->next) {
209 gss_buffer_desc attribute;
212 /* Don't advertise attributes that are internal to the GSS-EAP mechanism */
213 if (isInternalAttributeP(vp->attribute))
216 if (alreadyAddedAttributeP(seen, vp))
219 snprintf(attrid, sizeof(attrid), "%s%d",
220 (char *)radiusUrnPrefix.value, vp->attribute);
222 attribute.value = attrid;
223 attribute.length = strlen(attrid);
225 if (!addAttribute(m_manager, this, &attribute, data))
228 seen.push_back(std::string(vp->name));
235 getAttributeId(const gss_buffer_t attr)
238 gss_buffer_desc strAttr = GSS_C_EMPTY_BUFFER;
243 if (attr->length < radiusUrnPrefix.length ||
244 memcmp(attr->value, radiusUrnPrefix.value, radiusUrnPrefix.length) != 0)
247 /* need to duplicate because attr may not be NUL terminated */
248 duplicateBuffer(*attr, &strAttr);
249 s = (char *)strAttr.value + radiusUrnPrefix.length;
252 attrid = strtoul(s, NULL, 10);
254 da = dict_attrbyname(s);
259 gss_release_buffer(&tmpMinor, &strAttr);
265 gss_eap_radius_attr_provider::setAttribute(int complete GSSEAP_UNUSED,
267 const gss_buffer_t value)
269 OM_uint32 major = GSS_S_UNAVAILABLE, minor;
271 if (!isSecretAttributeP(attrid) &&
272 !isInternalAttributeP(attrid)) {
273 deleteAttribute(attrid);
275 major = gssEapRadiusAddAvp(&minor, &m_vps,
276 ATTRID(attrid), VENDOR(attrid),
280 return !GSS_ERROR(major);
284 gss_eap_radius_attr_provider::setAttribute(int complete,
285 const gss_buffer_t attr,
286 const gss_buffer_t value)
288 uint32_t attrid = getAttributeId(attr);
293 return setAttribute(complete, attrid, value);
297 gss_eap_radius_attr_provider::deleteAttribute(uint32_t attrid)
299 if (isSecretAttributeP(attrid) || isInternalAttributeP(attrid) ||
300 pairfind(m_vps, attrid) == NULL)
303 pairdelete(&m_vps, attrid);
309 gss_eap_radius_attr_provider::deleteAttribute(const gss_buffer_t attr)
311 uint32_t attrid = getAttributeId(attr);
316 return deleteAttribute(attrid);
320 gss_eap_radius_attr_provider::getAttribute(const gss_buffer_t attr,
324 gss_buffer_t display_value,
329 attrid = getAttributeId(attr);
333 return getAttribute(attrid, authenticated, complete,
334 value, display_value, more);
338 gss_eap_radius_attr_provider::getAttribute(uint32_t attrid,
342 gss_buffer_t display_value,
346 int i = *more, count = 0;
353 for (vp = pairfind(m_vps, attrid);
355 vp = pairfind(vp->next, attrid)) {
357 if (pairfind(vp->next, attrid) != NULL)
363 if (vp == NULL && *more == 0)
366 if (value != GSS_C_NO_BUFFER) {
367 gss_buffer_desc valueBuf;
369 valueBuf.value = (void *)vp->vp_octets;
370 valueBuf.length = vp->length;
372 duplicateBuffer(valueBuf, value);
375 if (display_value != GSS_C_NO_BUFFER) {
376 char displayString[MAX_STRING_LEN];
377 gss_buffer_desc displayBuf;
379 displayBuf.length = vp_prints_value(displayString,
380 sizeof(displayString), vp, 0);
381 displayBuf.value = (void *)displayString;
383 duplicateBuffer(displayBuf, display_value);
386 if (authenticated != NULL)
387 *authenticated = m_authenticated;
388 if (complete != NULL)
395 gss_eap_radius_attr_provider::getFragmentedAttribute(uint16_t attribute,
399 gss_buffer_t value) const
401 OM_uint32 major, minor;
403 major = gssEapRadiusGetAvp(&minor, m_vps, attribute, vendor, value, TRUE);
405 if (authenticated != NULL)
406 *authenticated = m_authenticated;
407 if (complete != NULL)
410 return !GSS_ERROR(major);
414 gss_eap_radius_attr_provider::getAttribute(uint16_t attribute,
419 gss_buffer_t display_value,
423 return getAttribute(VENDORATTR(attribute, vendor),
424 authenticated, complete,
425 value, display_value, more);
429 gss_eap_radius_attr_provider::mapToAny(int authenticated,
430 gss_buffer_t type_id GSSEAP_UNUSED) const
432 if (authenticated && !m_authenticated)
433 return (gss_any_t)NULL;
435 return (gss_any_t)copyAvps(m_vps);
439 gss_eap_radius_attr_provider::releaseAnyNameMapping(gss_buffer_t type_id GSSEAP_UNUSED,
440 gss_any_t input) const
442 VALUE_PAIR *vp = (VALUE_PAIR *)input;
447 gss_eap_radius_attr_provider::init(void)
449 struct rs_context *radContext;
451 gss_eap_attr_ctx::registerProvider(ATTR_TYPE_RADIUS, createAttrContext);
455 * This hack is necessary in order to force the loading of the global
456 * dictionary, otherwise accepting reauthentication tokens fails unless
457 * the acceptor has already accepted a normal authentication token.
459 if (rs_context_create(&radContext) != 0)
462 if (rs_context_read_config(radContext, RS_CONFIG_FILE) != 0) {
463 rs_context_destroy(radContext);
467 if (rs_context_init_freeradius_dict(radContext, NULL)) {
468 rs_context_destroy(radContext);
472 rs_context_destroy(radContext);
479 gss_eap_radius_attr_provider::finalize(void)
481 gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_RADIUS);
484 gss_eap_attr_provider *
485 gss_eap_radius_attr_provider::createAttrContext(void)
487 return new gss_eap_radius_attr_provider;
491 gssEapRadiusAddAvp(OM_uint32 *minor,
495 const gss_buffer_t buffer)
497 uint32_t attrid = VENDORATTR(vendor, attribute);
498 unsigned char *p = (unsigned char *)buffer->value;
499 size_t remain = buffer->length;
506 * There's an extra byte of padding; RADIUS AVPs can only
509 if (n >= MAX_STRING_LEN)
510 n = MAX_STRING_LEN - 1;
512 vp = paircreate(attrid, PW_TYPE_OCTETS);
515 return GSS_S_FAILURE;
518 memcpy(vp->vp_octets, p, n);
525 } while (remain != 0);
527 return GSS_S_COMPLETE;
531 gssEapRadiusGetRawAvp(OM_uint32 *minor,
537 uint32_t attr = VENDORATTR(vendor, attribute);
539 *vp = pairfind(vps, attr);
541 *minor = GSSEAP_NO_SUCH_ATTR;
542 return GSS_S_UNAVAILABLE;
545 return GSS_S_COMPLETE;
549 gssEapRadiusGetAvp(OM_uint32 *minor,
558 uint32_t attr = VENDORATTR(vendor, attribute);
561 buffer->value = NULL;
563 vp = pairfind(vps, attr);
565 *minor = GSSEAP_NO_SUCH_ATTR;
566 return GSS_S_UNAVAILABLE;
570 buffer->length += vp->length;
571 } while (concat && (vp = pairfind(vp->next, attr)) != NULL);
573 buffer->value = GSSEAP_MALLOC(buffer->length);
574 if (buffer->value == NULL) {
576 return GSS_S_FAILURE;
579 p = (unsigned char *)buffer->value;
581 for (vp = pairfind(vps, attr);
582 concat && vp != NULL;
583 vp = pairfind(vp->next, attr)) {
584 memcpy(p, vp->vp_octets, vp->length);
589 return GSS_S_COMPLETE;
593 gssEapRadiusFreeAvps(OM_uint32 *minor,
598 return GSS_S_COMPLETE;
602 gssEapRadiusAttrProviderInit(OM_uint32 *minor)
604 if (!gss_eap_radius_attr_provider::init()) {
605 *minor = GSSEAP_RADSEC_INIT_FAILURE;
606 return GSS_S_FAILURE;
609 return GSS_S_COMPLETE;
613 gssEapRadiusAttrProviderFinalize(OM_uint32 *minor)
615 gss_eap_radius_attr_provider::finalize();
618 return GSS_S_COMPLETE;
622 avpToJson(const VALUE_PAIR *vp)
626 assert(vp->length <= MAX_STRING_LEN);
629 case PW_TYPE_INTEGER:
632 obj.set("value", vp->lvalue);
635 obj.set("value", vp->vp_strvalue);
640 if (base64Encode(vp->vp_octets, vp->length, &b64) < 0)
641 throw std::bad_alloc();
643 obj.set("value", b64);
649 obj.set("type", vp->attribute);
655 jsonToAvp(VALUE_PAIR **pVp, JSONObject &obj)
657 VALUE_PAIR *vp = NULL;
661 JSONObject type = obj["type"];
662 JSONObject value = obj["value"];
664 if (!type.isInteger())
667 attrid = type.integer();
668 da = dict_attrbyvalue(attrid);
672 int type = base64Valid(value.string()) ?
673 PW_TYPE_OCTETS : PW_TYPE_STRING;
674 vp = paircreate(attrid, type);
677 throw std::bad_alloc();
680 case PW_TYPE_INTEGER:
683 if (!value.isInteger())
687 vp->lvalue = value.integer();
689 case PW_TYPE_STRING: {
690 if (!value.isString())
693 const char *str = value.string();
694 size_t len = strlen(str);
696 if (len >= MAX_STRING_LEN)
700 memcpy(vp->vp_strvalue, str, len + 1);
705 if (!value.isString())
708 const char *str = value.string();
709 ssize_t len = strlen(str);
711 /* this optimization requires base64Decode only understand packed encoding */
712 if (len >= BASE64_EXPAND(MAX_STRING_LEN))
715 len = base64Decode(str, vp->vp_octets);
736 gss_eap_radius_attr_provider::name(void) const
742 gss_eap_radius_attr_provider::initWithJsonObject(const gss_eap_attr_ctx *ctx,
745 VALUE_PAIR **pNext = &m_vps;
747 if (!gss_eap_attr_provider::initWithJsonObject(ctx, obj))
750 JSONObject attrs = obj["attributes"];
751 size_t nelems = attrs.size();
753 for (size_t i = 0; i < nelems; i++) {
754 JSONObject attr = attrs[i];
757 if (!jsonToAvp(&vp, attr))
764 m_authenticated = obj["authenticated"].integer();
770 gss_eap_radius_attr_provider::prefix(void) const
772 return "urn:ietf:params:gss-eap:radius-avp";
776 gss_eap_radius_attr_provider::jsonRepresentation(void) const
778 JSONObject obj, attrs = JSONObject::array();
780 for (VALUE_PAIR *vp = m_vps; vp != NULL; vp = vp->next) {
781 JSONObject attr = avpToJson(vp);
785 obj.set("attributes", attrs);
787 obj.set("authenticated", m_authenticated);
793 gss_eap_radius_attr_provider::getExpiryTime(void) const
797 vp = pairfind(m_vps, PW_SESSION_TIMEOUT);
798 if (vp == NULL || vp->lvalue == 0)
801 return time(NULL) + vp->lvalue;
805 gssEapRadiusMapError(OM_uint32 *minor,
806 struct rs_error *err)
812 code = rs_err_code(err, 0);
814 if (code == RSE_OK) {
816 return GSS_S_COMPLETE;
819 *minor = ERROR_TABLE_BASE_rse + code;
821 gssEapSaveStatusInfo(*minor, "%s", rs_err_msg(err));
824 return GSS_S_FAILURE;