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 * SAML attribute provider implementation.
37 #include "gssapiP_eap.h"
41 #include <xercesc/util/XMLUniDefs.hpp>
42 #include <xmltooling/unicode.h>
43 #include <xmltooling/XMLToolingConfig.h>
44 #include <xmltooling/util/XMLHelper.h>
45 #include <xmltooling/util/ParserPool.h>
46 #include <xmltooling/util/DateTime.h>
48 #include <saml/exceptions.h>
49 #include <saml/saml1/core/Assertions.h>
50 #include <saml/saml2/core/Assertions.h>
51 #include <saml/saml2/metadata/Metadata.h>
52 #include <saml/saml2/metadata/MetadataProvider.h>
54 using namespace xmltooling;
55 using namespace opensaml::saml2md;
56 using namespace opensaml;
57 using namespace xercesc;
61 * gss_eap_saml_assertion_provider is for retrieving the underlying
64 gss_eap_saml_assertion_provider::gss_eap_saml_assertion_provider(void)
67 m_authenticated = false;
70 gss_eap_saml_assertion_provider::~gss_eap_saml_assertion_provider(void)
76 gss_eap_saml_assertion_provider::initFromExistingContext(const gss_eap_attr_ctx *manager,
77 const gss_eap_attr_provider *ctx)
79 /* Then we may be creating from an existing attribute context */
80 const gss_eap_saml_assertion_provider *saml;
82 assert(m_assertion == NULL);
84 if (!gss_eap_attr_provider::initFromExistingContext(manager, ctx))
87 saml = static_cast<const gss_eap_saml_assertion_provider *>(ctx);
88 setAssertion(saml->getAssertion(), saml->authenticated());
94 gss_eap_saml_assertion_provider::initFromGssContext(const gss_eap_attr_ctx *manager,
95 const gss_cred_id_t gssCred,
96 const gss_ctx_id_t gssCtx)
98 const gss_eap_radius_attr_provider *radius;
99 gss_buffer_desc value = GSS_C_EMPTY_BUFFER;
100 int authenticated, complete;
103 assert(m_assertion == NULL);
105 if (!gss_eap_attr_provider::initFromGssContext(manager, gssCred, gssCtx))
109 * XXX TODO we need to support draft-howlett-radius-saml-attr-00
111 radius = static_cast<const gss_eap_radius_attr_provider *>
112 (m_manager->getProvider(ATTR_TYPE_RADIUS));
113 if (radius != NULL &&
114 radius->getFragmentedAttribute(PW_SAML_AAA_ASSERTION,
116 &authenticated, &complete, &value)) {
117 setAssertion(&value, authenticated);
118 gss_release_buffer(&minor, &value);
127 gss_eap_saml_assertion_provider::setAssertion(const saml2::Assertion *assertion,
133 if (assertion != NULL) {
135 m_assertion = (saml2::Assertion *)((void *)assertion->clone());
137 m_assertion = dynamic_cast<saml2::Assertion *>(assertion->clone());
139 m_authenticated = authenticated;
142 m_authenticated = false;
147 gss_eap_saml_assertion_provider::setAssertion(const gss_buffer_t buffer,
152 m_assertion = parseAssertion(buffer);
153 m_authenticated = (m_assertion != NULL && authenticated);
157 gss_eap_saml_assertion_provider::parseAssertion(const gss_buffer_t buffer)
159 string str((char *)buffer->value, buffer->length);
160 istringstream istream(str);
162 const XMLObjectBuilder *b;
165 doc = XMLToolingConfig::getConfig().getParser().parse(istream);
169 b = XMLObjectBuilder::getBuilder(doc->getDocumentElement());
172 return (saml2::Assertion *)((void *)b->buildFromDocument(doc));
174 return dynamic_cast<saml2::Assertion *>(b->buildFromDocument(doc));
176 } catch (exception &e) {
182 gss_eap_saml_assertion_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute,
187 /* just add the prefix */
188 if (m_assertion != NULL)
189 ret = addAttribute(m_manager, this, GSS_C_NO_BUFFER, data);
197 gss_eap_saml_assertion_provider::setAttribute(int complete GSSEAP_UNUSED,
198 const gss_buffer_t attr,
199 const gss_buffer_t value)
201 if (attr == GSS_C_NO_BUFFER || attr->length == 0) {
210 gss_eap_saml_assertion_provider::deleteAttribute(const gss_buffer_t value GSSEAP_UNUSED)
214 m_authenticated = false;
220 gss_eap_saml_assertion_provider::getExpiryTime(void) const
222 saml2::Conditions *conditions;
223 time_t expiryTime = 0;
225 if (m_assertion == NULL)
228 conditions = m_assertion->getConditions();
230 if (conditions != NULL && conditions->getNotOnOrAfter() != NULL)
231 expiryTime = conditions->getNotOnOrAfter()->getEpoch();
237 gss_eap_saml_assertion_provider::mapException(OM_uint32 *minor,
238 std::exception &e) const
240 if (typeid(e) == typeid(SecurityPolicyException))
241 *minor = GSSEAP_SAML_SEC_POLICY_FAILURE;
242 else if (typeid(e) == typeid(BindingException))
243 *minor = GSSEAP_SAML_BINDING_FAILURE;
244 else if (typeid(e) == typeid(ProfileException))
245 *minor = GSSEAP_SAML_PROFILE_FAILURE;
246 else if (typeid(e) == typeid(FatalProfileException))
247 *minor = GSSEAP_SAML_FATAL_PROFILE_FAILURE;
248 else if (typeid(e) == typeid(RetryableProfileException))
249 *minor = GSSEAP_SAML_RETRY_PROFILE_FAILURE;
250 else if (typeid(e) == typeid(MetadataException))
251 *minor = GSSEAP_SAML_METADATA_FAILURE;
253 return GSS_S_CONTINUE_NEEDED;
255 return GSS_S_FAILURE;
259 gss_eap_saml_assertion_provider::getAttribute(const gss_buffer_t attr,
263 gss_buffer_t display_value GSSEAP_UNUSED,
268 if (attr != GSS_C_NO_BUFFER && attr->length != 0)
271 if (m_assertion == NULL)
277 if (authenticated != NULL)
278 *authenticated = m_authenticated;
279 if (complete != NULL)
282 XMLHelper::serialize(m_assertion->marshall((DOMDocument *)NULL), str);
284 duplicateBuffer(str, value);
291 gss_eap_saml_assertion_provider::mapToAny(int authenticated,
292 gss_buffer_t type_id GSSEAP_UNUSED) const
294 if (authenticated && !m_authenticated)
295 return (gss_any_t)NULL;
297 return (gss_any_t)m_assertion;
301 gss_eap_saml_assertion_provider::releaseAnyNameMapping(gss_buffer_t type_id GSSEAP_UNUSED,
302 gss_any_t input) const
304 delete ((saml2::Assertion *)input);
308 gss_eap_saml_assertion_provider::prefix(void) const
310 return "urn:ietf:params:gss-eap:saml-aaa-assertion";
314 gss_eap_saml_assertion_provider::init(void)
316 gss_eap_attr_ctx::registerProvider(ATTR_TYPE_SAML_ASSERTION, createAttrContext);
321 gss_eap_saml_assertion_provider::finalize(void)
323 gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_SAML_ASSERTION);
326 gss_eap_attr_provider *
327 gss_eap_saml_assertion_provider::createAttrContext(void)
329 return new gss_eap_saml_assertion_provider;
333 gss_eap_saml_assertion_provider::initAssertion(void)
336 m_assertion = saml2::AssertionBuilder::buildAssertion();
337 m_authenticated = false;
343 * gss_eap_saml_attr_provider is for retrieving the underlying attributes.
346 gss_eap_saml_attr_provider::getAssertion(int *authenticated,
347 saml2::Assertion **pAssertion,
348 bool createIfAbsent) const
350 gss_eap_saml_assertion_provider *saml;
352 if (authenticated != NULL)
353 *authenticated = false;
354 if (pAssertion != NULL)
357 saml = static_cast<const gss_eap_saml_assertion_provider *>
358 (m_manager->getProvider(ATTR_TYPE_SAML_ASSERTION));
362 if (authenticated != NULL)
363 *authenticated = saml->authenticated();
364 if (pAssertion != NULL)
365 *pAssertion = saml->getAssertion();
367 if (saml->getAssertion() == NULL) {
368 if (createIfAbsent) {
369 if (authenticated != NULL)
370 *authenticated = false;
371 if (pAssertion != NULL)
372 *pAssertion = saml->initAssertion();
381 gss_eap_saml_attr_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute,
384 saml2::Assertion *assertion;
387 if (!getAssertion(&authenticated, &assertion))
391 * Note: the first prefix is added by the attribute provider manager
393 * From draft-hartman-gss-eap-naming-00:
395 * Each attribute carried in the assertion SHOULD also be a GSS name
396 * attribute. The name of this attribute has three parts, all separated
397 * by an ASCII space character. The first part is
398 * urn:ietf:params:gss-eap:saml-attr. The second part is the URI for
399 * the SAML attribute name format. The final part is the name of the
400 * SAML attribute. If the mechanism performs an additional attribute
401 * query, the retrieved attributes SHOULD be GSS-API name attributes
402 * using the same name syntax.
404 /* For each attribute statement, look for an attribute match */
405 const vector <saml2::AttributeStatement *> &statements =
406 const_cast<const saml2::Assertion *>(assertion)->getAttributeStatements();
408 for (vector<saml2::AttributeStatement *>::const_iterator s = statements.begin();
409 s != statements.end();
411 const vector<saml2::Attribute*> &attrs =
412 const_cast<const saml2::AttributeStatement*>(*s)->getAttributes();
414 for (vector<saml2::Attribute*>::const_iterator a = attrs.begin(); a != attrs.end(); ++a) {
415 const XMLCh *attributeName, *attributeNameFormat;
416 XMLCh *qualifiedName;
417 XMLCh space[2] = { ' ', 0 };
418 gss_buffer_desc utf8;
421 attributeName = (*a)->getName();
422 attributeNameFormat = (*a)->getNameFormat();
423 if (attributeNameFormat == NULL || attributeNameFormat[0] == '\0')
424 attributeNameFormat = saml2::Attribute::UNSPECIFIED;
426 qualifiedName = new XMLCh[XMLString::stringLen(attributeNameFormat) + 1 +
427 XMLString::stringLen(attributeName) + 1];
428 XMLString::copyString(qualifiedName, attributeNameFormat);
429 XMLString::catString(qualifiedName, space);
430 XMLString::catString(qualifiedName, attributeName);
432 utf8.value = (void *)toUTF8(qualifiedName);
433 utf8.length = strlen((char *)utf8.value);
435 ret = addAttribute(m_manager, this, &utf8, data);
437 delete qualifiedName;
447 static BaseRefVectorOf<XMLCh> *
448 decomposeAttributeName(const gss_buffer_t attr)
450 XMLCh *qualifiedAttr = new XMLCh[attr->length + 1];
451 XMLString::transcode((const char *)attr->value, qualifiedAttr, attr->length);
453 BaseRefVectorOf<XMLCh> *components = XMLString::tokenizeString(qualifiedAttr);
455 delete qualifiedAttr;
457 if (components->size() != 2) {
466 gss_eap_saml_attr_provider::setAttribute(int complete GSSEAP_UNUSED,
467 const gss_buffer_t attr,
468 const gss_buffer_t value)
470 saml2::Assertion *assertion;
471 saml2::Attribute *attribute;
472 saml2::AttributeValue *attributeValue;
473 saml2::AttributeStatement *attributeStatement;
475 if (!getAssertion(NULL, &assertion, true))
478 if (assertion->getAttributeStatements().size() != 0) {
479 attributeStatement = assertion->getAttributeStatements().front();
481 attributeStatement = saml2::AttributeStatementBuilder::buildAttributeStatement();
482 assertion->getAttributeStatements().push_back(attributeStatement);
485 /* Check the attribute name consists of name format | whsp | name */
486 BaseRefVectorOf<XMLCh> *components = decomposeAttributeName(attr);
487 if (components == NULL)
490 attribute = saml2::AttributeBuilder::buildAttribute();
491 attribute->setNameFormat(components->elementAt(0));
492 attribute->setName(components->elementAt(1));
494 XMLCh *xmlValue = new XMLCh[value->length + 1];
495 XMLString::transcode((const char *)value->value, xmlValue, attr->length);
497 attributeValue = saml2::AttributeValueBuilder::buildAttributeValue();
498 attributeValue->setTextContent(xmlValue);
500 attribute->getAttributeValues().push_back(attributeValue);
502 assert(attributeStatement != NULL);
503 attributeStatement->getAttributes().push_back(attribute);
512 gss_eap_saml_attr_provider::deleteAttribute(const gss_buffer_t attr)
514 saml2::Assertion *assertion;
517 if (!getAssertion(NULL, &assertion) ||
518 assertion->getAttributeStatements().size() == 0)
521 /* Check the attribute name consists of name format | whsp | name */
522 BaseRefVectorOf<XMLCh> *components = decomposeAttributeName(attr);
523 if (components == NULL)
526 /* For each attribute statement, look for an attribute match */
527 const vector<saml2::AttributeStatement *> &statements =
528 const_cast<const saml2::Assertion *>(assertion)->getAttributeStatements();
530 for (vector<saml2::AttributeStatement *>::const_iterator s = statements.begin();
531 s != statements.end();
533 const vector<saml2::Attribute *> &attrs =
534 const_cast<const saml2::AttributeStatement *>(*s)->getAttributes();
535 ssize_t index = -1, i = 0;
537 /* There's got to be an easier way to do this */
538 for (vector<saml2::Attribute *>::const_iterator a = attrs.begin();
541 if (XMLString::equals((*a)->getNameFormat(), components->elementAt(0)) &&
542 XMLString::equals((*a)->getName(), components->elementAt(1))) {
549 (*s)->getAttributes().erase((*s)->getAttributes().begin() + index);
560 gss_eap_saml_attr_provider::getAttribute(const gss_buffer_t attr,
563 const saml2::Attribute **pAttribute) const
565 saml2::Assertion *assertion;
567 if (authenticated != NULL)
568 *authenticated = false;
569 if (complete != NULL)
573 if (!getAssertion(authenticated, &assertion) ||
574 assertion->getAttributeStatements().size() == 0)
577 /* Check the attribute name consists of name format | whsp | name */
578 BaseRefVectorOf<XMLCh> *components = decomposeAttributeName(attr);
579 if (components == NULL)
582 /* For each attribute statement, look for an attribute match */
583 const vector <saml2::AttributeStatement *> &statements =
584 const_cast<const saml2::Assertion *>(assertion)->getAttributeStatements();
585 const saml2::Attribute *ret = NULL;
587 for (vector<saml2::AttributeStatement *>::const_iterator s = statements.begin();
588 s != statements.end();
590 const vector<saml2::Attribute *> &attrs =
591 const_cast<const saml2::AttributeStatement*>(*s)->getAttributes();
593 for (vector<saml2::Attribute *>::const_iterator a = attrs.begin(); a != attrs.end(); ++a) {
594 const XMLCh *attributeName, *attributeNameFormat;
596 attributeName = (*a)->getName();
597 attributeNameFormat = (*a)->getNameFormat();
598 if (attributeNameFormat == NULL || attributeNameFormat[0] == '\0')
599 attributeNameFormat = saml2::Attribute::UNSPECIFIED;
601 if (XMLString::equals(attributeNameFormat, components->elementAt(0)) &&
602 XMLString::equals(attributeName, components->elementAt(1))) {
616 return (ret != NULL);
620 gss_eap_saml_attr_provider::getAttribute(const gss_buffer_t attr,
624 gss_buffer_t display_value,
627 const saml2::Attribute *a;
628 const saml2::AttributeValue *av;
629 int nvalues, i = *more;
633 if (!getAttribute(attr, authenticated, complete, &a))
636 nvalues = a->getAttributeValues().size();
640 else if (i >= nvalues)
643 av = (const saml2::AttributeValue *)((void *)(a->getAttributeValues().at(i)));
645 av = dynamic_cast<const saml2::AttributeValue *>(a->getAttributeValues().at(i));
649 value->value = toUTF8(av->getTextContent(), true);
650 value->length = strlen((char *)value->value);
652 if (display_value != NULL) {
653 display_value->value = toUTF8(av->getTextContent(), true);
654 display_value->length = strlen((char *)value->value);
665 gss_eap_saml_attr_provider::mapToAny(int authenticated GSSEAP_UNUSED,
666 gss_buffer_t type_id GSSEAP_UNUSED) const
668 return (gss_any_t)NULL;
672 gss_eap_saml_attr_provider::releaseAnyNameMapping(gss_buffer_t type_id GSSEAP_UNUSED,
673 gss_any_t input GSSEAP_UNUSED) const
678 gss_eap_saml_attr_provider::prefix(void) const
680 return "urn:ietf:params:gss-eap:saml-attr";
684 gss_eap_saml_attr_provider::init(void)
686 gss_eap_attr_ctx::registerProvider(ATTR_TYPE_SAML, createAttrContext);
691 gss_eap_saml_attr_provider::finalize(void)
693 gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_SAML);
696 gss_eap_attr_provider *
697 gss_eap_saml_attr_provider::createAttrContext(void)
699 return new gss_eap_saml_attr_provider;
703 gssEapSamlAttrProvidersInit(OM_uint32 *minor)
705 if (!gss_eap_saml_assertion_provider::init() ||
706 !gss_eap_saml_attr_provider::init()) {
707 *minor = GSSEAP_SAML_INIT_FAILURE;
708 return GSS_S_FAILURE;
711 return GSS_S_COMPLETE;
715 gssEapSamlAttrProvidersFinalize(OM_uint32 *minor)
717 gss_eap_saml_attr_provider::finalize();
718 gss_eap_saml_assertion_provider::finalize();
721 return GSS_S_COMPLETE;