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_GSS_ACCEPTOR_SERVICE_NAME:
175 case PW_GSS_ACCEPTOR_HOST_NAME:
176 case PW_GSS_ACCEPTOR_SERVICE_SPECIFIC:
177 case PW_GSS_ACCEPTOR_REALM_NAME:
178 case PW_SAML_AAA_ASSERTION:
179 bInternalAttribute = true;
189 return bInternalAttribute;
193 isInternalAttributeP(rs_const_avp *vp)
195 return isInternalAttributeP(avpToAttrId(vp));
199 isFragmentedAttributeP(const gss_eap_attrid &attrid)
201 /* A bit of a hack for the PAC for now. Should be configurable. */
202 return (attrid.first == VENDORPEC_UKERNA) &&
203 !isInternalAttributeP(attrid);
207 * Copy AVP list, same as paircopy except it filters out attributes
211 copyAvps(rs_const_avp *src)
216 for (vp = src; vp != NULL; vp = rs_avp_next_const(vp)) {
219 if (isSecretAttributeP(vp))
222 vpcopy = rs_avp_dup(vp);
223 if (vpcopy == NULL) {
225 throw std::bad_alloc();
228 rs_avp_append(&dst, vpcopy);
235 gss_eap_radius_attr_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute,
239 std::vector <gss_eap_attrid> seen;
241 for (vp = m_vps; vp != NULL; vp = rs_avp_next(vp)) {
242 gss_buffer_desc desc;
243 gss_eap_attrid attrid;
246 /* Don't advertise attributes that are internal to the GSS-EAP mechanism */
247 if (isInternalAttributeP(vp))
250 rs_avp_attrid(vp, &attrid.second, &attrid.first);
252 if (alreadyAddedAttributeP(seen, attrid))
255 if (rs_attr_display_name(attrid.second, attrid.first,
256 buf, sizeof(buf), TRUE) != RSE_OK ||
257 strncmp(buf, "Attr-", 5) != 0)
260 desc.value = &buf[5];
261 desc.length = strlen((char *)desc.value);
263 if (!addAttribute(m_manager, this, &desc, data))
266 seen.push_back(attrid);
273 getAttributeId(const gss_buffer_t desc,
274 gss_eap_attrid *attrid)
279 if (desc->length == 0)
282 canon = isdigit(*(char *)desc->value);
284 /* need to duplicate because attr may not be NUL terminated */
285 strAttr = (char *)GSSEAP_MALLOC((canon ? 5 : 0) + desc->length + 1);
287 throw new std::bad_alloc();
292 memcpy(s, "Attr-", 5);
296 memcpy(s, desc->value, desc->length);
300 code = rs_attr_parse_name(strAttr, &attrid->second, &attrid->first);
302 GSSEAP_FREE(strAttr);
304 return (code == RSE_OK);
308 gss_eap_radius_attr_provider::setAttribute(int complete GSSEAP_UNUSED,
309 const gss_eap_attrid &attrid,
310 const gss_buffer_t value)
312 OM_uint32 major = GSS_S_UNAVAILABLE, minor;
314 if (!isSecretAttributeP(attrid) &&
315 !isInternalAttributeP(attrid)) {
316 deleteAttribute(attrid);
318 major = gssEapRadiusAddAvp(&minor, &m_vps, attrid, value);
321 return !GSS_ERROR(major);
325 gss_eap_radius_attr_provider::setAttribute(int complete,
326 const gss_buffer_t attr,
327 const gss_buffer_t value)
329 gss_eap_attrid attrid;
331 if (!getAttributeId(attr, &attrid))
334 return setAttribute(complete, attrid, value);
338 gss_eap_radius_attr_provider::deleteAttribute(const gss_eap_attrid &attrid)
340 if (isSecretAttributeP(attrid) ||
341 isInternalAttributeP(attrid) ||
342 rs_avp_find(m_vps, attrid.second, attrid.first) == NULL)
345 return (rs_avp_delete(&m_vps, attrid.second, attrid.first) == RSE_OK);
349 gss_eap_radius_attr_provider::deleteAttribute(const gss_buffer_t attr)
351 gss_eap_attrid attrid;
353 if (!getAttributeId(attr, &attrid))
356 return deleteAttribute(attrid);
360 gss_eap_radius_attr_provider::getAttribute(const gss_buffer_t attr,
364 gss_buffer_t display_value,
367 gss_eap_attrid attrid;
369 if (!getAttributeId(attr, &attrid))
372 return getAttribute(attrid,
373 authenticated, complete,
374 value, display_value, more);
378 gss_eap_radius_attr_provider::getAttribute(const gss_eap_attrid &attrid,
382 gss_buffer_t display_value,
386 int i = *more, count = 0;
393 if (isSecretAttributeP(attrid) ||
394 isInternalAttributeP(attrid)) {
396 } else if (isFragmentedAttributeP(attrid)) {
397 return getFragmentedAttribute(attrid,
403 for (vp = rs_avp_find_const(m_vps, attrid.second, attrid.first);
405 vp = rs_avp_find_const(rs_avp_next_const(vp), attrid.second, attrid.first)) {
407 if (rs_avp_find_const(rs_avp_next_const(vp), attrid.second, attrid.first) != NULL)
413 if (vp == NULL && *more == 0)
416 if (value != GSS_C_NO_BUFFER) {
417 gss_buffer_desc valueBuf;
419 rs_avp_octets_value_byref((rs_avp *)vp,
420 (unsigned char **)&valueBuf.value,
423 duplicateBuffer(valueBuf, value);
426 if (display_value != GSS_C_NO_BUFFER &&
427 !rs_avp_is_octets(vp)) {
428 char displayString[RS_MAX_STRING_LEN];
429 gss_buffer_desc displayBuf;
431 displayBuf.length = rs_avp_display_value(vp, displayString,
432 sizeof(displayString));
433 displayBuf.value = (void *)displayString;
435 duplicateBuffer(displayBuf, display_value);
438 if (authenticated != NULL)
439 *authenticated = m_authenticated;
440 if (complete != NULL)
447 gss_eap_radius_attr_provider::getFragmentedAttribute(const gss_eap_attrid &attrid,
450 gss_buffer_t value) const
452 OM_uint32 major, minor;
454 major = gssEapRadiusGetAvp(&minor, m_vps, attrid, value, TRUE);
456 if (authenticated != NULL)
457 *authenticated = m_authenticated;
458 if (complete != NULL)
461 return !GSS_ERROR(major);
465 gss_eap_radius_attr_provider::mapToAny(int authenticated,
466 gss_buffer_t type_id GSSEAP_UNUSED) const
468 if (authenticated && !m_authenticated)
469 return (gss_any_t)NULL;
471 return (gss_any_t)copyAvps(m_vps);
475 gss_eap_radius_attr_provider::releaseAnyNameMapping(gss_buffer_t type_id GSSEAP_UNUSED,
476 gss_any_t input) const
478 rs_avp *vp = (rs_avp *)input;
483 gss_eap_radius_attr_provider::init(void)
485 gss_eap_attr_ctx::registerProvider(ATTR_TYPE_RADIUS, createAttrContext);
491 gss_eap_radius_attr_provider::finalize(void)
493 gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_RADIUS);
496 gss_eap_attr_provider *
497 gss_eap_radius_attr_provider::createAttrContext(void)
499 return new gss_eap_radius_attr_provider;
503 gssEapRadiusAddAvp(OM_uint32 *minor,
505 const gss_eap_attrid &attrid,
506 const gss_buffer_t buffer)
508 unsigned char *p = (unsigned char *)buffer->value;
509 size_t remain = buffer->length;
516 * There's an extra byte of padding; RADIUS AVPs can only
519 if (n >= RS_MAX_STRING_LEN)
520 n = RS_MAX_STRING_LEN - 1;
522 vp = rs_avp_alloc(attrid.second, attrid.first);
525 return GSS_S_FAILURE;
528 rs_avp_octets_set(vp, p, n);
530 rs_avp_append(vps, vp);
534 } while (remain != 0);
536 return GSS_S_COMPLETE;
540 gssEapRadiusAddAvp(OM_uint32 *minor,
541 struct rs_packet *pkt,
542 unsigned int attribute,
544 const gss_buffer_t buffer)
546 gss_eap_attrid attrid(vendor, attribute);
549 code = rs_packet_append_avp(pkt, attrid.second, attrid.first,
550 buffer->value, buffer->length);
551 if (code != RSE_OK) {
552 *minor = RS_MAP_ERROR(code);
553 return GSS_S_FAILURE;
557 return GSS_S_COMPLETE;
561 gssEapRadiusGetRawAvp(OM_uint32 *minor,
563 unsigned int attribute,
567 *vp = rs_avp_find_const(vps, attribute, vendor);
569 *minor = GSSEAP_NO_SUCH_ATTR;
570 return GSS_S_UNAVAILABLE;
573 return GSS_S_COMPLETE;
577 gssEapRadiusGetAvp(OM_uint32 *minor,
579 const gss_eap_attrid &attrid,
586 if (buffer != GSS_C_NO_BUFFER) {
588 buffer->value = NULL;
591 vp = rs_avp_find_const(vps, attrid.second, attrid.first);
593 *minor = GSSEAP_NO_SUCH_ATTR;
594 return GSS_S_UNAVAILABLE;
597 if (buffer != GSS_C_NO_BUFFER) {
599 rs_avp_fragmented_value(vp, NULL, &buffer->length);
601 buffer->length = rs_avp_length(vp);
603 buffer->value = GSSEAP_MALLOC(buffer->length);
604 if (buffer->value == NULL) {
606 return GSS_S_FAILURE;
610 err = rs_avp_fragmented_value(vp, (unsigned char *)buffer->value, &buffer->length);
612 err = rs_avp_octets_value(vp, (unsigned char *)buffer->value, &buffer->length);
615 *minor = RS_MAP_ERROR(err);
616 return GSS_S_FAILURE;
621 return GSS_S_COMPLETE;
625 gssEapRadiusGetAvp(OM_uint32 *minor,
626 struct rs_packet *pkt,
627 unsigned int attribute,
633 gss_eap_attrid attrid(vendor, attribute);
635 rs_packet_avps(pkt, &vps);
637 return gssEapRadiusGetAvp(minor, *vps, attrid, buffer, concat);
641 gssEapRadiusFreeAvps(OM_uint32 *minor,
646 return GSS_S_COMPLETE;
650 gssEapRadiusAttrProviderInit(OM_uint32 *minor)
652 if (!gss_eap_radius_attr_provider::init()) {
653 *minor = GSSEAP_RADSEC_INIT_FAILURE;
654 return GSS_S_FAILURE;
657 return GSS_S_COMPLETE;
661 gssEapRadiusAttrProviderFinalize(OM_uint32 *minor)
663 gss_eap_radius_attr_provider::finalize();
666 return GSS_S_COMPLETE;
670 avpToJson(rs_const_avp *vp)
673 gss_eap_attrid attrid;
675 GSSEAP_ASSERT(rs_avp_length(vp) <= RS_MAX_STRING_LEN);
677 switch (rs_avp_typeof(vp)) {
678 case RS_TYPE_INTEGER:
679 obj.set("value", rs_avp_integer_value(vp));
682 obj.set("value", rs_avp_date_value(vp));
685 obj.set("value", rs_avp_string_value(vp));
690 if (base64Encode(rs_avp_octets_value_const_ptr(vp),
691 rs_avp_length(vp), &b64) < 0)
692 throw std::bad_alloc();
694 obj.set("value", b64);
700 attrid = avpToAttrId(vp);
702 obj.set("type", attrid.second);
703 if (attrid.first != 0)
704 obj.set("vendor", attrid.first);
710 jsonToAvp(rs_avp **pVp, JSONObject &obj)
713 gss_eap_attrid attrid;
715 JSONObject type = obj["type"];
716 JSONObject vendor = obj["vendor"];
717 JSONObject value = obj["value"];
719 if (!type.isInteger())
721 attrid.second = type.integer();
723 if (!vendor.isNull()) {
724 if (!vendor.isInteger())
726 attrid.first = vendor.integer();
731 vp = rs_avp_alloc(attrid.second, attrid.first);
733 throw std::bad_alloc();
735 switch (rs_avp_typeof(vp)) {
736 case RS_TYPE_INTEGER:
739 if (!value.isInteger())
742 if (rs_avp_integer_set(vp, value.integer()) != RSE_OK)
746 case RS_TYPE_STRING: {
747 if (!value.isString())
750 if (rs_avp_string_set(vp, value.string()) != RSE_OK)
757 unsigned char buf[RS_MAX_STRING_LEN];
759 if (!value.isString())
762 const char *str = value.string();
763 ssize_t len = strlen(str);
765 /* this optimization requires base64Decode only understand packed encoding */
766 if (len >= BASE64_EXPAND(RS_MAX_STRING_LEN))
769 len = base64Decode(str, buf);
773 if (rs_avp_octets_set(vp, buf, len) != RSE_OK)
792 gss_eap_radius_attr_provider::name(void) const
798 gss_eap_radius_attr_provider::initWithJsonObject(const gss_eap_attr_ctx *ctx,
801 if (!gss_eap_attr_provider::initWithJsonObject(ctx, obj))
804 JSONObject attrs = obj["attributes"];
805 size_t nelems = attrs.size();
807 for (size_t i = 0; i < nelems; i++) {
808 JSONObject attr = attrs[i];
811 if (!jsonToAvp(&vp, attr))
814 rs_avp_append(&m_vps, vp);
817 m_authenticated = obj["authenticated"].integer() ? true : false;
823 gss_eap_radius_attr_provider::prefix(void) const
825 return "urn:ietf:params:gssapi:aaa-radius";
829 gss_eap_radius_attr_provider::jsonRepresentation(void) const
831 JSONObject obj, attrs = JSONObject::array();
833 for (rs_avp *vp = m_vps; vp != NULL; vp = rs_avp_next(vp)) {
834 JSONObject attr = avpToJson(vp);
838 obj.set("attributes", attrs);
840 obj.set("authenticated", m_authenticated);
846 gss_eap_radius_attr_provider::getExpiryTime(void) const
851 vp = rs_avp_find(m_vps, PW_SESSION_TIMEOUT, 0);
855 value = rs_avp_integer_value(vp);
859 return time(NULL) + value;
863 gssEapRadiusMapError(OM_uint32 *minor,
864 struct rs_error *err)
868 GSSEAP_ASSERT(err != NULL);
870 code = rs_err_code(err, 0);
872 if (code == RSE_OK) {
874 return GSS_S_COMPLETE;
877 *minor = RS_MAP_ERROR(code);
879 gssEapSaveStatusInfo(*minor, "%s", rs_err_msg(err));
882 return GSS_S_FAILURE;
886 gssEapCreateRadiusContext(OM_uint32 *minor,
888 struct rs_context **pRadContext)
890 const char *configFile = RS_CONFIG_FILE;
891 struct rs_context *radContext;
892 struct rs_alloc_scheme ralloc;
893 struct rs_error *err;
898 if (rs_context_create(&radContext) != 0) {
899 *minor = GSSEAP_RADSEC_CONTEXT_FAILURE;
900 return GSS_S_FAILURE;
903 if (cred->radiusConfigFile.value != NULL)
904 configFile = (const char *)cred->radiusConfigFile.value;
906 ralloc.calloc = GSSEAP_CALLOC;
907 ralloc.malloc = GSSEAP_MALLOC;
908 ralloc.free = GSSEAP_FREE;
909 ralloc.realloc = GSSEAP_REALLOC;
911 rs_context_set_alloc_scheme(radContext, &ralloc);
913 if (rs_context_read_config(radContext, configFile) != 0) {
914 err = rs_err_ctx_pop(radContext);
918 *pRadContext = radContext;
921 return GSS_S_COMPLETE;
924 major = gssEapRadiusMapError(minor, err);
925 rs_context_destroy(radContext);