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 #define RS_MAP_ERROR(code) (ERROR_TABLE_BASE_rse + (code))
41 static rs_avp *copyAvps(rs_const_avp *src);
44 gssEapRadiusGetAvp(OM_uint32 *minor,
46 const gss_eap_attrid &attrid,
51 gssEapRadiusAddAvp(OM_uint32 *minor,
53 const gss_eap_attrid &attrid,
54 const gss_buffer_t buffer);
57 avpToAttrId(rs_const_avp *vp)
59 gss_eap_attrid attrid;
61 rs_avp_attrid(vp, &attrid.second, &attrid.first);
66 gss_eap_radius_attr_provider::gss_eap_radius_attr_provider(void)
69 m_authenticated = false;
72 gss_eap_radius_attr_provider::~gss_eap_radius_attr_provider(void)
79 gss_eap_radius_attr_provider::initWithExistingContext(const gss_eap_attr_ctx *manager,
80 const gss_eap_attr_provider *ctx)
82 const gss_eap_radius_attr_provider *radius;
84 if (!gss_eap_attr_provider::initWithExistingContext(manager, ctx))
87 radius = static_cast<const gss_eap_radius_attr_provider *>(ctx);
89 if (radius->m_vps != NULL)
90 m_vps = copyAvps(radius->getAvps());
92 m_authenticated = radius->m_authenticated;
98 gss_eap_radius_attr_provider::initWithGssContext(const gss_eap_attr_ctx *manager,
99 const gss_cred_id_t gssCred,
100 const gss_ctx_id_t gssCtx)
102 if (!gss_eap_attr_provider::initWithGssContext(manager, gssCred, gssCtx))
105 if (gssCtx != GSS_C_NO_CONTEXT) {
106 if (gssCtx->acceptorCtx.vps != NULL) {
107 m_vps = copyAvps(gssCtx->acceptorCtx.vps);
111 /* We assume libradsec validated this for us */
112 GSSEAP_ASSERT(rs_avp_find(m_vps, PW_MESSAGE_AUTHENTICATOR, 0) != NULL);
113 m_authenticated = true;
121 alreadyAddedAttributeP(std::vector <gss_eap_attrid> &attrs,
122 gss_eap_attrid &attrid)
124 for (std::vector<gss_eap_attrid>::const_iterator a = attrs.begin();
127 if (attrid.first == (*a).first &&
128 attrid.second == (*a).second)
136 isSecretAttributeP(const gss_eap_attrid &attrid)
138 bool bSecretAttribute = false;
140 switch (attrid.first) {
141 case VENDORPEC_MICROSOFT:
142 switch (attrid.second) {
143 case PW_MS_MPPE_SEND_KEY:
144 case PW_MS_MPPE_RECV_KEY:
145 bSecretAttribute = true;
154 return bSecretAttribute;
158 isSecretAttributeP(rs_const_avp *vp)
160 return isSecretAttributeP(avpToAttrId(vp));
164 isInternalAttributeP(const gss_eap_attrid &attrid)
166 bool bInternalAttribute = false;
168 /* should have been filtered */
169 GSSEAP_ASSERT(!isSecretAttributeP(attrid));
171 switch (attrid.first) {
172 case VENDORPEC_UKERNA:
173 switch (attrid.second) {
174 case PW_SAML_AAA_ASSERTION:
175 bInternalAttribute = true;
182 switch (attrid.second) {
183 case PW_GSS_ACCEPTOR_SERVICE_NAME:
184 case PW_GSS_ACCEPTOR_HOST_NAME:
185 case PW_GSS_ACCEPTOR_SERVICE_SPECIFICS:
186 case PW_GSS_ACCEPTOR_REALM_NAME:
187 bInternalAttribute = true;
197 return bInternalAttribute;
201 isInternalAttributeP(rs_const_avp *vp)
203 return isInternalAttributeP(avpToAttrId(vp));
207 isFragmentedAttributeP(const gss_eap_attrid &attrid)
209 /* A bit of a hack for the PAC for now. Should be configurable. */
210 return (attrid.first == VENDORPEC_UKERNA) &&
211 !isInternalAttributeP(attrid);
215 * Copy AVP list, same as paircopy except it filters out attributes
219 copyAvps(rs_const_avp *src)
224 for (vp = src; vp != NULL; vp = rs_avp_next_const(vp)) {
227 if (isSecretAttributeP(vp))
230 vpcopy = rs_avp_dup(vp);
231 if (vpcopy == NULL) {
233 throw std::bad_alloc();
236 rs_avp_append(&dst, vpcopy);
243 gss_eap_radius_attr_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute,
247 std::vector <gss_eap_attrid> seen;
249 for (vp = m_vps; vp != NULL; vp = rs_avp_next(vp)) {
250 gss_buffer_desc desc;
251 gss_eap_attrid attrid;
254 /* Don't advertise attributes that are internal to the GSS-EAP mechanism */
255 if (isInternalAttributeP(vp))
258 rs_avp_attrid(vp, &attrid.second, &attrid.first);
260 if (alreadyAddedAttributeP(seen, attrid))
263 if (rs_attr_display_name(attrid.second, attrid.first,
264 buf, sizeof(buf), TRUE) != RSE_OK ||
265 strncmp(buf, "Attr-", 5) != 0)
268 desc.value = &buf[5];
269 desc.length = strlen((char *)desc.value);
271 if (!addAttribute(m_manager, this, &desc, data))
274 seen.push_back(attrid);
281 getAttributeId(const gss_buffer_t desc,
282 gss_eap_attrid *attrid)
287 if (desc->length == 0)
290 canon = isdigit(*(char *)desc->value);
292 /* need to duplicate because attr may not be NUL terminated */
293 strAttr = (char *)GSSEAP_MALLOC((canon ? 5 : 0) + desc->length + 1);
295 throw new std::bad_alloc();
300 memcpy(s, "Attr-", 5);
304 memcpy(s, desc->value, desc->length);
308 code = rs_attr_parse_name(strAttr, &attrid->second, &attrid->first);
310 GSSEAP_FREE(strAttr);
312 return (code == RSE_OK);
316 gss_eap_radius_attr_provider::setAttribute(int complete GSSEAP_UNUSED,
317 const gss_eap_attrid &attrid,
318 const gss_buffer_t value)
320 OM_uint32 major = GSS_S_UNAVAILABLE, minor;
322 if (!isSecretAttributeP(attrid) &&
323 !isInternalAttributeP(attrid)) {
324 deleteAttribute(attrid);
326 major = gssEapRadiusAddAvp(&minor, &m_vps, attrid, value);
329 return !GSS_ERROR(major);
333 gss_eap_radius_attr_provider::setAttribute(int complete,
334 const gss_buffer_t attr,
335 const gss_buffer_t value)
337 gss_eap_attrid attrid;
339 if (!getAttributeId(attr, &attrid))
342 return setAttribute(complete, attrid, value);
346 gss_eap_radius_attr_provider::deleteAttribute(const gss_eap_attrid &attrid)
348 if (isSecretAttributeP(attrid) ||
349 isInternalAttributeP(attrid) ||
350 rs_avp_find(m_vps, attrid.second, attrid.first) == NULL)
353 return (rs_avp_delete(&m_vps, attrid.second, attrid.first) == RSE_OK);
357 gss_eap_radius_attr_provider::deleteAttribute(const gss_buffer_t attr)
359 gss_eap_attrid attrid;
361 if (!getAttributeId(attr, &attrid))
364 return deleteAttribute(attrid);
368 gss_eap_radius_attr_provider::getAttribute(const gss_buffer_t attr,
372 gss_buffer_t display_value,
375 gss_eap_attrid attrid;
377 if (!getAttributeId(attr, &attrid))
380 return getAttribute(attrid,
381 authenticated, complete,
382 value, display_value, more);
386 gss_eap_radius_attr_provider::getAttribute(const gss_eap_attrid &attrid,
390 gss_buffer_t display_value,
394 int i = *more, count = 0;
401 if (isSecretAttributeP(attrid) ||
402 isInternalAttributeP(attrid)) {
404 } else if (isFragmentedAttributeP(attrid)) {
405 return getFragmentedAttribute(attrid,
411 for (vp = rs_avp_find_const(m_vps, attrid.second, attrid.first);
413 vp = rs_avp_find_const(rs_avp_next_const(vp), attrid.second, attrid.first)) {
415 if (rs_avp_find_const(rs_avp_next_const(vp), attrid.second, attrid.first) != NULL)
421 if (vp == NULL && *more == 0)
424 if (value != GSS_C_NO_BUFFER) {
425 gss_buffer_desc valueBuf;
427 rs_avp_octets_value_byref((rs_avp *)vp,
428 (unsigned char **)&valueBuf.value,
431 duplicateBuffer(valueBuf, value);
434 if (display_value != GSS_C_NO_BUFFER &&
435 !rs_avp_is_octets(vp)) {
436 char displayString[RS_MAX_STRING_LEN];
437 gss_buffer_desc displayBuf;
439 displayBuf.length = rs_avp_display_value(vp, displayString,
440 sizeof(displayString));
441 displayBuf.value = (void *)displayString;
443 duplicateBuffer(displayBuf, display_value);
446 if (authenticated != NULL)
447 *authenticated = m_authenticated;
448 if (complete != NULL)
455 gss_eap_radius_attr_provider::getFragmentedAttribute(const gss_eap_attrid &attrid,
458 gss_buffer_t value) const
460 OM_uint32 major, minor;
462 major = gssEapRadiusGetAvp(&minor, m_vps, attrid, value, TRUE);
464 if (authenticated != NULL)
465 *authenticated = m_authenticated;
466 if (complete != NULL)
469 return !GSS_ERROR(major);
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 rs_avp *vp = (rs_avp *)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,
513 const gss_eap_attrid &attrid,
514 const gss_buffer_t buffer)
516 unsigned char *p = (unsigned char *)buffer->value;
517 size_t remain = buffer->length;
524 * There's an extra byte of padding; RADIUS AVPs can only
527 if (n >= RS_MAX_STRING_LEN)
528 n = RS_MAX_STRING_LEN - 1;
530 vp = rs_avp_alloc(attrid.second, attrid.first);
533 return GSS_S_FAILURE;
536 rs_avp_octets_set(vp, p, n);
538 rs_avp_append(vps, vp);
542 } while (remain != 0);
544 return GSS_S_COMPLETE;
548 gssEapRadiusAddAvp(OM_uint32 *minor,
549 struct rs_packet *pkt,
550 unsigned int attribute,
552 const gss_buffer_t buffer)
554 gss_eap_attrid attrid(vendor, attribute);
557 code = rs_packet_append_avp(pkt, attrid.second, attrid.first,
558 buffer->value, buffer->length);
559 if (code != RSE_OK) {
560 *minor = RS_MAP_ERROR(code);
561 return GSS_S_FAILURE;
565 return GSS_S_COMPLETE;
569 gssEapRadiusGetRawAvp(OM_uint32 *minor,
571 unsigned int attribute,
575 *vp = rs_avp_find_const(vps, attribute, vendor);
577 *minor = GSSEAP_NO_SUCH_ATTR;
578 return GSS_S_UNAVAILABLE;
581 return GSS_S_COMPLETE;
585 gssEapRadiusGetAvp(OM_uint32 *minor,
587 const gss_eap_attrid &attrid,
594 if (buffer != GSS_C_NO_BUFFER) {
596 buffer->value = NULL;
599 vp = rs_avp_find_const(vps, attrid.second, attrid.first);
601 *minor = GSSEAP_NO_SUCH_ATTR;
602 return GSS_S_UNAVAILABLE;
605 if (buffer != GSS_C_NO_BUFFER) {
607 rs_avp_fragmented_value(vp, NULL, &buffer->length);
609 buffer->length = rs_avp_length(vp);
611 buffer->value = GSSEAP_MALLOC(buffer->length);
612 if (buffer->value == NULL) {
614 return GSS_S_FAILURE;
618 err = rs_avp_fragmented_value(vp, (unsigned char *)buffer->value, &buffer->length);
620 err = rs_avp_octets_value(vp, (unsigned char *)buffer->value, &buffer->length);
623 *minor = RS_MAP_ERROR(err);
624 return GSS_S_FAILURE;
629 return GSS_S_COMPLETE;
633 gssEapRadiusGetAvp(OM_uint32 *minor,
634 struct rs_packet *pkt,
635 unsigned int attribute,
641 gss_eap_attrid attrid(vendor, attribute);
643 rs_packet_avps(pkt, &vps);
645 return gssEapRadiusGetAvp(minor, *vps, attrid, buffer, concat);
649 gssEapRadiusFreeAvps(OM_uint32 *minor,
654 return GSS_S_COMPLETE;
658 gssEapRadiusAttrProviderInit(OM_uint32 *minor)
660 if (!gss_eap_radius_attr_provider::init()) {
661 *minor = GSSEAP_RADSEC_INIT_FAILURE;
662 return GSS_S_FAILURE;
665 return GSS_S_COMPLETE;
669 gssEapRadiusAttrProviderFinalize(OM_uint32 *minor)
671 gss_eap_radius_attr_provider::finalize();
674 return GSS_S_COMPLETE;
678 avpToJson(rs_const_avp *vp)
681 gss_eap_attrid attrid;
683 GSSEAP_ASSERT(rs_avp_length(vp) <= RS_MAX_STRING_LEN);
685 switch (rs_avp_typeof(vp)) {
686 case RS_TYPE_INTEGER:
687 obj.set("value", rs_avp_integer_value(vp));
690 obj.set("value", rs_avp_date_value(vp));
693 obj.set("value", rs_avp_string_value(vp));
698 if (base64Encode(rs_avp_octets_value_const_ptr(vp),
699 rs_avp_length(vp), &b64) < 0)
700 throw std::bad_alloc();
702 obj.set("value", b64);
708 attrid = avpToAttrId(vp);
710 obj.set("type", attrid.second);
711 if (attrid.first != 0)
712 obj.set("vendor", attrid.first);
718 jsonToAvp(rs_avp **pVp, JSONObject &obj)
721 gss_eap_attrid attrid;
723 JSONObject type = obj["type"];
724 JSONObject vendor = obj["vendor"];
725 JSONObject value = obj["value"];
727 if (!type.isInteger())
729 attrid.second = type.integer();
731 if (!vendor.isNull()) {
732 if (!vendor.isInteger())
734 attrid.first = vendor.integer();
739 vp = rs_avp_alloc(attrid.second, attrid.first);
741 throw std::bad_alloc();
743 switch (rs_avp_typeof(vp)) {
744 case RS_TYPE_INTEGER:
747 if (!value.isInteger())
750 if (rs_avp_integer_set(vp, value.integer()) != RSE_OK)
754 case RS_TYPE_STRING: {
755 if (!value.isString())
758 if (rs_avp_string_set(vp, value.string()) != RSE_OK)
765 unsigned char buf[RS_MAX_STRING_LEN];
767 if (!value.isString())
770 const char *str = value.string();
771 ssize_t len = strlen(str);
773 /* this optimization requires base64Decode only understand packed encoding */
774 if (len >= BASE64_EXPAND(RS_MAX_STRING_LEN))
777 len = base64Decode(str, buf);
781 if (rs_avp_octets_set(vp, buf, len) != RSE_OK)
800 gss_eap_radius_attr_provider::name(void) const
806 gss_eap_radius_attr_provider::initWithJsonObject(const gss_eap_attr_ctx *ctx,
809 if (!gss_eap_attr_provider::initWithJsonObject(ctx, obj))
812 JSONObject attrs = obj["attributes"];
813 size_t nelems = attrs.size();
815 for (size_t i = 0; i < nelems; i++) {
816 JSONObject attr = attrs[i];
819 if (!jsonToAvp(&vp, attr))
822 rs_avp_append(&m_vps, vp);
825 m_authenticated = obj["authenticated"].integer() ? true : false;
831 gss_eap_radius_attr_provider::prefix(void) const
833 return "urn:ietf:params:gss:radius-attribute";
837 gss_eap_radius_attr_provider::jsonRepresentation(void) const
839 JSONObject obj, attrs = JSONObject::array();
841 for (rs_avp *vp = m_vps; vp != NULL; vp = rs_avp_next(vp)) {
842 JSONObject attr = avpToJson(vp);
846 obj.set("attributes", attrs);
848 obj.set("authenticated", m_authenticated);
854 gss_eap_radius_attr_provider::getExpiryTime(void) const
859 vp = rs_avp_find(m_vps, PW_SESSION_TIMEOUT, 0);
863 value = rs_avp_integer_value(vp);
867 return time(NULL) + value;
871 gssEapRadiusMapError(OM_uint32 *minor,
872 struct rs_error *err)
876 GSSEAP_ASSERT(err != NULL);
878 code = rs_err_code(err, 0);
880 if (code == RSE_OK) {
882 return GSS_S_COMPLETE;
885 *minor = RS_MAP_ERROR(code);
887 gssEapSaveStatusInfo(*minor, "%s", rs_err_msg(err));
890 return GSS_S_FAILURE;
894 gssEapCreateRadiusContext(OM_uint32 *minor,
896 struct rs_context **pRadContext)
898 const char *configFile = RS_CONFIG_FILE;
899 struct rs_context *radContext;
900 struct rs_alloc_scheme ralloc;
901 struct rs_error *err;
906 if (rs_context_create(&radContext) != 0) {
907 *minor = GSSEAP_RADSEC_CONTEXT_FAILURE;
908 return GSS_S_FAILURE;
911 if (cred->radiusConfigFile.value != NULL)
912 configFile = (const char *)cred->radiusConfigFile.value;
914 ralloc.calloc = GSSEAP_CALLOC;
915 ralloc.malloc = GSSEAP_MALLOC;
916 ralloc.free = GSSEAP_FREE;
917 ralloc.realloc = GSSEAP_REALLOC;
919 rs_context_set_alloc_scheme(radContext, &ralloc);
921 if (rs_context_read_config(radContext, configFile) != 0) {
922 err = rs_err_ctx_pop(radContext);
926 *pRadContext = radContext;
929 return GSS_S_COMPLETE;
932 major = gssEapRadiusMapError(minor, err);
933 rs_context_destroy(radContext);