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 GSSEAP_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 GSSEAP_ASSERT(!isSecretAttributeP(attrid, vendor));
157 case VENDORPEC_UKERNA:
159 case PW_GSS_ACCEPTOR_SERVICE_NAME:
160 case PW_GSS_ACCEPTOR_HOST_NAME:
161 case PW_GSS_ACCEPTOR_SERVICE_SPECIFIC:
162 case PW_GSS_ACCEPTOR_REALM_NAME:
163 case PW_SAML_AAA_ASSERTION:
164 bInternalAttribute = true;
174 return bInternalAttribute;
178 isInternalAttributeP(uint32_t attribute)
180 return isInternalAttributeP(ATTRID(attribute), VENDOR(attribute));
184 isFragmentedAttributeP(uint16_t attrid, uint16_t vendor)
186 /* A bit of a hack for the PAC for now. Should be configurable. */
187 return (vendor == VENDORPEC_UKERNA) &&
188 !isInternalAttributeP(attrid, vendor);
192 isFragmentedAttributeP(uint32_t attribute)
194 return isFragmentedAttributeP(ATTRID(attribute), VENDOR(attribute));
198 * Copy AVP list, same as paircopy except it filters out attributes
202 copyAvps(const VALUE_PAIR *src)
204 const VALUE_PAIR *vp;
205 VALUE_PAIR *dst = NULL, **pDst = &dst;
207 for (vp = src; vp != NULL; vp = vp->next) {
210 if (isSecretAttributeP(vp->attribute))
213 vpcopy = paircopyvp(vp);
214 if (vpcopy == NULL) {
216 throw std::bad_alloc();
219 pDst = &vpcopy->next;
226 gss_eap_radius_attr_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute,
230 std::vector <std::string> seen;
232 for (vp = m_vps; vp != NULL; vp = vp->next) {
233 gss_buffer_desc attribute;
236 /* Don't advertise attributes that are internal to the GSS-EAP mechanism */
237 if (isInternalAttributeP(vp->attribute))
240 if (alreadyAddedAttributeP(seen, vp))
243 snprintf(attrid, sizeof(attrid), "%s%d",
244 (char *)radiusUrnPrefix.value, vp->attribute);
246 attribute.value = attrid;
247 attribute.length = strlen(attrid);
249 if (!addAttribute(m_manager, this, &attribute, data))
252 seen.push_back(std::string(vp->name));
259 getAttributeId(const gss_buffer_t attr)
262 gss_buffer_desc strAttr = GSS_C_EMPTY_BUFFER;
267 if (attr->length < radiusUrnPrefix.length ||
268 memcmp(attr->value, radiusUrnPrefix.value, radiusUrnPrefix.length) != 0)
271 /* need to duplicate because attr may not be NUL terminated */
272 duplicateBuffer(*attr, &strAttr);
273 s = (char *)strAttr.value + radiusUrnPrefix.length;
276 attrid = strtoul(s, NULL, 10);
278 da = dict_attrbyname(s);
283 gss_release_buffer(&tmpMinor, &strAttr);
289 gss_eap_radius_attr_provider::setAttribute(int complete GSSEAP_UNUSED,
291 const gss_buffer_t value)
293 OM_uint32 major = GSS_S_UNAVAILABLE, minor;
295 if (!isSecretAttributeP(attrid) &&
296 !isInternalAttributeP(attrid)) {
297 deleteAttribute(attrid);
299 major = gssEapRadiusAddAvp(&minor, &m_vps,
300 ATTRID(attrid), VENDOR(attrid),
304 return !GSS_ERROR(major);
308 gss_eap_radius_attr_provider::setAttribute(int complete,
309 const gss_buffer_t attr,
310 const gss_buffer_t value)
312 uint32_t attrid = getAttributeId(attr);
317 return setAttribute(complete, attrid, value);
321 gss_eap_radius_attr_provider::deleteAttribute(uint32_t attrid)
323 if (isSecretAttributeP(attrid) || isInternalAttributeP(attrid) ||
324 pairfind(m_vps, attrid) == NULL)
327 pairdelete(&m_vps, attrid);
333 gss_eap_radius_attr_provider::deleteAttribute(const gss_buffer_t attr)
335 uint32_t attrid = getAttributeId(attr);
340 return deleteAttribute(attrid);
344 gss_eap_radius_attr_provider::getAttribute(const gss_buffer_t attr,
348 gss_buffer_t display_value,
353 attrid = getAttributeId(attr);
357 return getAttribute(attrid, authenticated, complete,
358 value, display_value, more);
362 gss_eap_radius_attr_provider::getAttribute(uint32_t attrid,
366 gss_buffer_t display_value,
370 int i = *more, count = 0;
377 if (isSecretAttributeP(attrid) || isInternalAttributeP(attrid)) {
379 } else if (isFragmentedAttributeP(attrid)) {
380 return getFragmentedAttribute(attrid,
386 for (vp = pairfind(m_vps, attrid);
388 vp = pairfind(vp->next, attrid)) {
390 if (pairfind(vp->next, attrid) != NULL)
396 if (vp == NULL && *more == 0)
399 if (value != GSS_C_NO_BUFFER) {
400 gss_buffer_desc valueBuf;
402 valueBuf.value = (void *)vp->vp_octets;
403 valueBuf.length = vp->length;
405 duplicateBuffer(valueBuf, value);
408 if (display_value != GSS_C_NO_BUFFER &&
409 vp->type != PW_TYPE_OCTETS) {
410 char displayString[MAX_STRING_LEN];
411 gss_buffer_desc displayBuf;
413 displayBuf.length = vp_prints_value(displayString,
414 sizeof(displayString), vp, 0);
415 displayBuf.value = (void *)displayString;
417 duplicateBuffer(displayBuf, display_value);
420 if (authenticated != NULL)
421 *authenticated = m_authenticated;
422 if (complete != NULL)
429 gss_eap_radius_attr_provider::getFragmentedAttribute(uint16_t attribute,
433 gss_buffer_t value) const
435 OM_uint32 major, minor;
437 major = gssEapRadiusGetAvp(&minor, m_vps, attribute, vendor, value, TRUE);
439 if (authenticated != NULL)
440 *authenticated = m_authenticated;
441 if (complete != NULL)
444 return !GSS_ERROR(major);
448 gss_eap_radius_attr_provider::getFragmentedAttribute(uint32_t attrid,
451 gss_buffer_t value) const
453 return getFragmentedAttribute(ATTRID(attrid), VENDOR(attrid),
454 authenticated, complete, value);
458 gss_eap_radius_attr_provider::getAttribute(uint16_t attribute,
463 gss_buffer_t display_value,
467 return getAttribute(VENDORATTR(attribute, vendor),
468 authenticated, complete,
469 value, display_value, more);
473 gss_eap_radius_attr_provider::mapToAny(int authenticated,
474 gss_buffer_t type_id GSSEAP_UNUSED) const
476 if (authenticated && !m_authenticated)
477 return (gss_any_t)NULL;
479 return (gss_any_t)copyAvps(m_vps);
483 gss_eap_radius_attr_provider::releaseAnyNameMapping(gss_buffer_t type_id GSSEAP_UNUSED,
484 gss_any_t input) const
486 VALUE_PAIR *vp = (VALUE_PAIR *)input;
491 gss_eap_radius_attr_provider::init(void)
493 gss_eap_attr_ctx::registerProvider(ATTR_TYPE_RADIUS, createAttrContext);
499 gss_eap_radius_attr_provider::finalize(void)
501 gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_RADIUS);
504 gss_eap_attr_provider *
505 gss_eap_radius_attr_provider::createAttrContext(void)
507 return new gss_eap_radius_attr_provider;
511 gssEapRadiusAddAvp(OM_uint32 *minor,
515 const gss_buffer_t buffer)
517 uint32_t attrid = VENDORATTR(vendor, attribute);
518 unsigned char *p = (unsigned char *)buffer->value;
519 size_t remain = buffer->length;
526 * There's an extra byte of padding; RADIUS AVPs can only
529 if (n >= MAX_STRING_LEN)
530 n = MAX_STRING_LEN - 1;
532 vp = paircreate(attrid, PW_TYPE_OCTETS);
535 return GSS_S_FAILURE;
538 memcpy(vp->vp_octets, p, n);
545 } while (remain != 0);
547 return GSS_S_COMPLETE;
551 gssEapRadiusGetRawAvp(OM_uint32 *minor,
557 uint32_t attr = VENDORATTR(vendor, attribute);
559 *vp = pairfind(vps, attr);
561 *minor = GSSEAP_NO_SUCH_ATTR;
562 return GSS_S_UNAVAILABLE;
565 return GSS_S_COMPLETE;
569 gssEapRadiusGetAvp(OM_uint32 *minor,
578 uint32_t attr = VENDORATTR(vendor, attribute);
580 if (buffer != GSS_C_NO_BUFFER) {
582 buffer->value = NULL;
585 vp = pairfind(vps, attr);
587 *minor = GSSEAP_NO_SUCH_ATTR;
588 return GSS_S_UNAVAILABLE;
591 if (buffer != GSS_C_NO_BUFFER) {
593 buffer->length += vp->length;
594 } while (concat && (vp = pairfind(vp->next, attr)) != NULL);
596 buffer->value = GSSEAP_MALLOC(buffer->length);
597 if (buffer->value == NULL) {
599 return GSS_S_FAILURE;
602 p = (unsigned char *)buffer->value;
604 for (vp = pairfind(vps, attr);
605 concat && vp != NULL;
606 vp = pairfind(vp->next, attr)) {
607 memcpy(p, vp->vp_octets, vp->length);
613 return GSS_S_COMPLETE;
617 gssEapRadiusFreeAvps(OM_uint32 *minor,
622 return GSS_S_COMPLETE;
626 gssEapRadiusAttrProviderInit(OM_uint32 *minor)
628 if (!gss_eap_radius_attr_provider::init()) {
629 *minor = GSSEAP_RADSEC_INIT_FAILURE;
630 return GSS_S_FAILURE;
633 return GSS_S_COMPLETE;
637 gssEapRadiusAttrProviderFinalize(OM_uint32 *minor)
639 gss_eap_radius_attr_provider::finalize();
642 return GSS_S_COMPLETE;
646 avpToJson(const VALUE_PAIR *vp)
650 GSSEAP_ASSERT(vp->length <= MAX_STRING_LEN);
653 case PW_TYPE_INTEGER:
656 obj.set("value", vp->lvalue);
659 obj.set("value", vp->vp_strvalue);
664 if (base64Encode(vp->vp_octets, vp->length, &b64) < 0)
665 throw std::bad_alloc();
667 obj.set("value", b64);
673 obj.set("type", vp->attribute);
679 jsonToAvp(VALUE_PAIR **pVp, JSONObject &obj)
681 VALUE_PAIR *vp = NULL;
685 JSONObject type = obj["type"];
686 JSONObject value = obj["value"];
688 if (!type.isInteger())
691 attrid = type.integer();
692 da = dict_attrbyvalue(attrid);
696 int type = base64Valid(value.string()) ?
697 PW_TYPE_OCTETS : PW_TYPE_STRING;
698 vp = paircreate(attrid, type);
701 throw std::bad_alloc();
704 case PW_TYPE_INTEGER:
707 if (!value.isInteger())
711 vp->lvalue = value.integer();
713 case PW_TYPE_STRING: {
714 if (!value.isString())
717 const char *str = value.string();
718 size_t len = strlen(str);
720 if (len >= MAX_STRING_LEN)
724 memcpy(vp->vp_strvalue, str, len + 1);
729 if (!value.isString())
732 const char *str = value.string();
733 ssize_t len = strlen(str);
735 /* this optimization requires base64Decode only understand packed encoding */
736 if (len >= BASE64_EXPAND(MAX_STRING_LEN))
739 len = base64Decode(str, vp->vp_octets);
760 gss_eap_radius_attr_provider::name(void) const
766 gss_eap_radius_attr_provider::initWithJsonObject(const gss_eap_attr_ctx *ctx,
769 VALUE_PAIR **pNext = &m_vps;
771 if (!gss_eap_attr_provider::initWithJsonObject(ctx, obj))
774 JSONObject attrs = obj["attributes"];
775 size_t nelems = attrs.size();
777 for (size_t i = 0; i < nelems; i++) {
778 JSONObject attr = attrs[i];
781 if (!jsonToAvp(&vp, attr))
788 m_authenticated = obj["authenticated"].integer() ? true : false;
794 gss_eap_radius_attr_provider::prefix(void) const
796 return "urn:ietf:params:gss-eap:radius-avp";
800 gss_eap_radius_attr_provider::jsonRepresentation(void) const
802 JSONObject obj, attrs = JSONObject::array();
804 for (VALUE_PAIR *vp = m_vps; vp != NULL; vp = vp->next) {
805 JSONObject attr = avpToJson(vp);
809 obj.set("attributes", attrs);
811 obj.set("authenticated", m_authenticated);
817 gss_eap_radius_attr_provider::getExpiryTime(void) const
821 vp = pairfind(m_vps, PW_SESSION_TIMEOUT);
822 if (vp == NULL || vp->lvalue == 0)
825 return time(NULL) + vp->lvalue;
829 gssEapRadiusMapError(OM_uint32 *minor,
830 struct rs_error *err)
834 GSSEAP_ASSERT(err != NULL);
836 code = rs_err_code(err, 0);
838 if (code == RSE_OK) {
840 return GSS_S_COMPLETE;
843 *minor = ERROR_TABLE_BASE_rse + code;
845 gssEapSaveStatusInfo(*minor, "%s", rs_err_msg(err));
848 return GSS_S_FAILURE;
852 gssEapCreateRadiusContext(OM_uint32 *minor,
854 struct rs_context **pRadContext)
856 const char *configFile = RS_CONFIG_FILE;
857 struct rs_context *radContext;
858 struct rs_alloc_scheme ralloc;
859 struct rs_error *err;
864 if (rs_context_create(&radContext) != 0) {
865 *minor = GSSEAP_RADSEC_CONTEXT_FAILURE;
866 return GSS_S_FAILURE;
869 if (cred->radiusConfigFile.value != NULL)
870 configFile = (const char *)cred->radiusConfigFile.value;
872 ralloc.calloc = GSSEAP_CALLOC;
873 ralloc.malloc = GSSEAP_MALLOC;
874 ralloc.free = GSSEAP_FREE;
875 ralloc.realloc = GSSEAP_REALLOC;
877 rs_context_set_alloc_scheme(radContext, &ralloc);
879 if (rs_context_read_config(radContext, configFile) != 0) {
880 err = rs_err_ctx_pop(radContext);
884 if (rs_context_init_freeradius_dict(radContext, NULL) != 0) {
885 err = rs_err_ctx_pop(radContext);
889 *pRadContext = radContext;
892 return GSS_S_COMPLETE;
895 major = gssEapRadiusMapError(minor, err);
896 rs_context_destroy(radContext);