2 * Copyright (c) 2010, 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;
164 doc = XMLToolingConfig::getConfig().getParser().parse(istream);
168 b = XMLObjectBuilder::getBuilder(doc->getDocumentElement());
171 return (saml2::Assertion *)((void *)b->buildFromDocument(doc));
173 return dynamic_cast<saml2::Assertion *>(b->buildFromDocument(doc));
178 gss_eap_saml_assertion_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute,
183 /* just add the prefix */
184 if (m_assertion != NULL)
185 ret = addAttribute(this, GSS_C_NO_BUFFER, data);
193 gss_eap_saml_assertion_provider::setAttribute(int complete,
194 const gss_buffer_t attr,
195 const gss_buffer_t value)
197 if (attr == GSS_C_NO_BUFFER || attr->length == 0) {
206 gss_eap_saml_assertion_provider::deleteAttribute(const gss_buffer_t value)
210 m_authenticated = false;
216 gss_eap_saml_assertion_provider::getExpiryTime(void) const
218 saml2::Conditions *conditions;
219 time_t expiryTime = 0;
221 if (m_assertion == NULL)
224 conditions = m_assertion->getConditions();
226 if (conditions != NULL && conditions->getNotOnOrAfter() != NULL)
227 expiryTime = conditions->getNotOnOrAfter()->getEpoch();
233 gss_eap_saml_assertion_provider::mapException(OM_uint32 *minor,
234 std::exception &e) const
236 if (typeid(e) == typeid(SecurityPolicyException))
237 *minor = GSSEAP_SAML_SEC_POLICY_FAILURE;
238 else if (typeid(e) == typeid(BindingException))
239 *minor = GSSEAP_SAML_BINDING_FAILURE;
240 else if (typeid(e) == typeid(ProfileException))
241 *minor = GSSEAP_SAML_PROFILE_FAILURE;
242 else if (typeid(e) == typeid(FatalProfileException))
243 *minor = GSSEAP_SAML_FATAL_PROFILE_FAILURE;
244 else if (typeid(e) == typeid(RetryableProfileException))
245 *minor = GSSEAP_SAML_RETRY_PROFILE_FAILURE;
246 else if (typeid(e) == typeid(MetadataException))
247 *minor = GSSEAP_SAML_METADATA_FAILURE;
249 return GSS_S_CONTINUE_NEEDED;
251 return GSS_S_FAILURE;
255 gss_eap_saml_assertion_provider::getAttribute(const gss_buffer_t attr,
259 gss_buffer_t display_value,
264 if (attr != GSS_C_NO_BUFFER && attr->length != 0)
267 if (m_assertion == NULL)
273 if (authenticated != NULL)
274 *authenticated = m_authenticated;
275 if (complete != NULL)
278 XMLHelper::serialize(m_assertion->marshall((DOMDocument *)NULL), str);
280 duplicateBuffer(str, value);
287 gss_eap_saml_assertion_provider::mapToAny(int authenticated,
288 gss_buffer_t type_id) const
290 if (authenticated && !m_authenticated)
291 return (gss_any_t)NULL;
293 return (gss_any_t)m_assertion;
297 gss_eap_saml_assertion_provider::releaseAnyNameMapping(gss_buffer_t type_id,
298 gss_any_t input) const
300 delete ((saml2::Assertion *)input);
304 gss_eap_saml_assertion_provider::exportToBuffer(gss_buffer_t buffer) const
310 buffer->value = NULL;
312 if (m_assertion == NULL)
315 sink << *m_assertion;
318 duplicateBuffer(str, buffer);
322 gss_eap_saml_assertion_provider::initFromBuffer(const gss_eap_attr_ctx *ctx,
323 const gss_buffer_t buffer)
325 if (!gss_eap_attr_provider::initFromBuffer(ctx, buffer))
328 if (buffer->length == 0)
331 assert(m_assertion == NULL);
333 setAssertion(buffer);
334 /* TODO XXX how to propagate authenticated flag? */
340 gss_eap_saml_assertion_provider::init(void)
342 gss_eap_attr_ctx::registerProvider(ATTR_TYPE_SAML_ASSERTION,
343 "urn:ietf:params:gss-eap:saml-aaa-assertion",
344 gss_eap_saml_assertion_provider::createAttrContext);
349 gss_eap_saml_assertion_provider::finalize(void)
351 gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_SAML_ASSERTION);
354 gss_eap_attr_provider *
355 gss_eap_saml_assertion_provider::createAttrContext(void)
357 return new gss_eap_saml_assertion_provider;
361 gss_eap_saml_assertion_provider::initAssertion(void)
364 m_assertion = saml2::AssertionBuilder::buildAssertion();
365 m_authenticated = false;
371 * gss_eap_saml_attr_provider is for retrieving the underlying attributes.
374 gss_eap_saml_attr_provider::getAssertion(int *authenticated,
375 saml2::Assertion **pAssertion,
376 bool createIfAbsent) const
378 gss_eap_saml_assertion_provider *saml;
380 if (authenticated != NULL)
381 *authenticated = false;
382 if (pAssertion != NULL)
385 saml = static_cast<const gss_eap_saml_assertion_provider *>
386 (m_manager->getProvider(ATTR_TYPE_SAML_ASSERTION));
390 if (authenticated != NULL)
391 *authenticated = saml->authenticated();
392 if (pAssertion != NULL)
393 *pAssertion = saml->getAssertion();
395 if (saml->getAssertion() == NULL) {
396 if (createIfAbsent) {
397 if (authenticated != NULL)
398 *authenticated = false;
399 if (pAssertion != NULL)
400 *pAssertion = saml->initAssertion();
409 gss_eap_saml_attr_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute,
412 saml2::Assertion *assertion;
415 if (!getAssertion(&authenticated, &assertion))
419 * Note: the first prefix is added by the attribute provider manager
421 * From draft-hartman-gss-eap-naming-00:
423 * Each attribute carried in the assertion SHOULD also be a GSS name
424 * attribute. The name of this attribute has three parts, all separated
425 * by an ASCII space character. The first part is
426 * urn:ietf:params:gss-eap:saml-attr. The second part is the URI for
427 * the SAML attribute name format. The final part is the name of the
428 * SAML attribute. If the mechanism performs an additional attribute
429 * query, the retrieved attributes SHOULD be GSS-API name attributes
430 * using the same name syntax.
432 /* For each attribute statement, look for an attribute match */
433 const vector <saml2::AttributeStatement *> &statements =
434 const_cast<const saml2::Assertion *>(assertion)->getAttributeStatements();
436 for (vector<saml2::AttributeStatement *>::const_iterator s = statements.begin();
437 s != statements.end();
439 const vector<saml2::Attribute*> &attrs =
440 const_cast<const saml2::AttributeStatement*>(*s)->getAttributes();
442 for (vector<saml2::Attribute*>::const_iterator a = attrs.begin(); a != attrs.end(); ++a) {
443 const XMLCh *attributeName = (*a)->getName();
444 const XMLCh *attributeNameFormat = (*a)->getNameFormat();
445 XMLCh *qualifiedName;
446 XMLCh space[2] = { ' ', 0 };
447 gss_buffer_desc utf8;
450 qualifiedName = new XMLCh[XMLString::stringLen(attributeNameFormat) + 1 +
451 XMLString::stringLen(attributeName) + 1];
452 XMLString::copyString(qualifiedName, attributeNameFormat);
453 XMLString::catString(qualifiedName, space);
454 XMLString::catString(qualifiedName, attributeName);
456 utf8.value = (void *)toUTF8(qualifiedName);
457 utf8.length = strlen((char *)utf8.value);
459 ret = addAttribute(this, &utf8, data);
461 delete qualifiedName;
471 static BaseRefVectorOf<XMLCh> *
472 decomposeAttributeName(const gss_buffer_t attr)
474 XMLCh *qualifiedAttr = new XMLCh[attr->length + 1];
475 XMLString::transcode((const char *)attr->value, qualifiedAttr, attr->length);
477 BaseRefVectorOf<XMLCh> *components = XMLString::tokenizeString(qualifiedAttr);
479 delete qualifiedAttr;
481 if (components->size() != 2) {
490 gss_eap_saml_attr_provider::setAttribute(int complete,
491 const gss_buffer_t attr,
492 const gss_buffer_t value)
494 saml2::Assertion *assertion;
495 saml2::Attribute *attribute;
496 saml2::AttributeValue *attributeValue;
497 saml2::AttributeStatement *attributeStatement;
499 if (!getAssertion(NULL, &assertion, true))
502 if (assertion->getAttributeStatements().size() != 0) {
503 attributeStatement = assertion->getAttributeStatements().front();
505 attributeStatement = saml2::AttributeStatementBuilder::buildAttributeStatement();
506 assertion->getAttributeStatements().push_back(attributeStatement);
509 /* Check the attribute name consists of name format | whsp | name */
510 BaseRefVectorOf<XMLCh> *components = decomposeAttributeName(attr);
511 if (components == NULL)
514 attribute = saml2::AttributeBuilder::buildAttribute();
515 attribute->setNameFormat(components->elementAt(0));
516 attribute->setName(components->elementAt(1));
518 XMLCh *xmlValue = new XMLCh[value->length + 1];
519 XMLString::transcode((const char *)value->value, xmlValue, attr->length);
521 attributeValue = saml2::AttributeValueBuilder::buildAttributeValue();
522 attributeValue->setTextContent(xmlValue);
524 attribute->getAttributeValues().push_back(attributeValue);
526 assert(attributeStatement != NULL);
527 attributeStatement->getAttributes().push_back(attribute);
536 gss_eap_saml_attr_provider::deleteAttribute(const gss_buffer_t attr)
538 saml2::Assertion *assertion;
541 if (!getAssertion(NULL, &assertion) ||
542 assertion->getAttributeStatements().size() == 0)
545 /* Check the attribute name consists of name format | whsp | name */
546 BaseRefVectorOf<XMLCh> *components = decomposeAttributeName(attr);
547 if (components == NULL)
550 /* For each attribute statement, look for an attribute match */
551 const vector<saml2::AttributeStatement *> &statements =
552 const_cast<const saml2::Assertion *>(assertion)->getAttributeStatements();
554 for (vector<saml2::AttributeStatement *>::const_iterator s = statements.begin();
555 s != statements.end();
557 const vector<saml2::Attribute *> &attrs =
558 const_cast<const saml2::AttributeStatement *>(*s)->getAttributes();
559 ssize_t index = -1, i = 0;
561 /* There's got to be an easier way to do this */
562 for (vector<saml2::Attribute *>::const_iterator a = attrs.begin();
565 if (XMLString::equals((*a)->getNameFormat(), components->elementAt(0)) &&
566 XMLString::equals((*a)->getName(), components->elementAt(1))) {
573 (*s)->getAttributes().erase((*s)->getAttributes().begin() + index);
584 gss_eap_saml_attr_provider::getAttribute(const gss_buffer_t attr,
587 const saml2::Attribute **pAttribute) const
589 saml2::Assertion *assertion;
591 if (authenticated != NULL)
592 *authenticated = false;
593 if (complete != NULL)
597 if (!getAssertion(authenticated, &assertion) ||
598 assertion->getAttributeStatements().size() == 0)
601 /* Check the attribute name consists of name format | whsp | name */
602 BaseRefVectorOf<XMLCh> *components = decomposeAttributeName(attr);
603 if (components == NULL)
606 /* For each attribute statement, look for an attribute match */
607 const vector <saml2::AttributeStatement *> &statements =
608 const_cast<const saml2::Assertion *>(assertion)->getAttributeStatements();
609 const saml2::Attribute *ret = NULL;
611 for (vector<saml2::AttributeStatement *>::const_iterator s = statements.begin();
612 s != statements.end();
614 const vector<saml2::Attribute *> &attrs =
615 const_cast<const saml2::AttributeStatement*>(*s)->getAttributes();
617 for (vector<saml2::Attribute *>::const_iterator a = attrs.begin(); a != attrs.end(); ++a) {
618 if (XMLString::equals((*a)->getNameFormat(), components->elementAt(0)) &&
619 XMLString::equals((*a)->getName(), components->elementAt(1))) {
633 return (ret != NULL);
637 gss_eap_saml_attr_provider::getAttribute(const gss_buffer_t attr,
641 gss_buffer_t display_value,
644 const saml2::Attribute *a;
645 const saml2::AttributeValue *av;
646 int nvalues, i = *more;
650 if (!getAttribute(attr, authenticated, complete, &a))
653 nvalues = a->getAttributeValues().size();
657 else if (i >= nvalues)
660 av = (const saml2::AttributeValue *)((void *)(a->getAttributeValues().at(i)));
662 av = dynamic_cast<const saml2::AttributeValue *>(a->getAttributeValues().at(i));
666 value->value = toUTF8(av->getTextContent(), true);
667 value->length = strlen((char *)value->value);
669 if (display_value != NULL) {
670 display_value->value = toUTF8(av->getTextContent(), true);
671 display_value->length = strlen((char *)value->value);
682 gss_eap_saml_attr_provider::mapToAny(int authenticated,
683 gss_buffer_t type_id) const
685 return (gss_any_t)NULL;
689 gss_eap_saml_attr_provider::releaseAnyNameMapping(gss_buffer_t type_id,
690 gss_any_t input) const
695 gss_eap_saml_attr_provider::exportToBuffer(gss_buffer_t buffer) const
698 buffer->value = NULL;
702 gss_eap_saml_attr_provider::initFromBuffer(const gss_eap_attr_ctx *ctx,
703 const gss_buffer_t buffer)
705 return gss_eap_attr_provider::initFromBuffer(ctx, buffer);
709 gss_eap_saml_attr_provider::init(void)
711 gss_eap_attr_ctx::registerProvider(ATTR_TYPE_SAML,
712 "urn:ietf:params:gss-eap:saml-attr",
713 gss_eap_saml_attr_provider::createAttrContext);
718 gss_eap_saml_attr_provider::finalize(void)
720 gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_SAML);
723 gss_eap_attr_provider *
724 gss_eap_saml_attr_provider::createAttrContext(void)
726 return new gss_eap_saml_attr_provider;
730 gssEapSamlAttrProvidersInit(OM_uint32 *minor)
732 if (!gss_eap_saml_assertion_provider::init() ||
733 !gss_eap_saml_attr_provider::init()) {
734 *minor = GSSEAP_SAML_INIT_FAILURE;
735 return GSS_S_FAILURE;
738 return GSS_S_COMPLETE;
742 gssEapSamlAttrProvidersFinalize(OM_uint32 *minor)
744 gss_eap_saml_attr_provider::finalize();
745 gss_eap_saml_assertion_provider::finalize();
746 return GSS_S_COMPLETE;