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
33 #include "gssapiP_eap.h"
37 #include <xercesc/util/XMLUniDefs.hpp>
38 #include <xmltooling/XMLToolingConfig.h>
39 #include <xmltooling/util/XMLHelper.h>
41 #include <saml/saml1/core/Assertions.h>
42 #include <saml/saml2/core/Assertions.h>
43 #include <saml/saml2/metadata/Metadata.h>
45 using namespace xmltooling;
46 using namespace opensaml::saml2md;
47 using namespace opensaml;
48 using namespace xercesc;
52 * gss_eap_saml_assertion_provider is for retrieving the underlying
55 gss_eap_saml_assertion_provider::gss_eap_saml_assertion_provider(void)
58 m_authenticated = false;
61 gss_eap_saml_assertion_provider::~gss_eap_saml_assertion_provider(void)
67 gss_eap_saml_assertion_provider::initFromExistingContext(const gss_eap_attr_ctx *manager,
68 const gss_eap_attr_provider *ctx)
70 /* Then we may be creating from an existing attribute context */
71 const gss_eap_saml_assertion_provider *saml;
73 assert(m_assertion == NULL);
75 if (!gss_eap_attr_provider::initFromExistingContext(manager, ctx))
78 saml = static_cast<const gss_eap_saml_assertion_provider *>(ctx);
79 setAssertion(saml->getAssertion(), saml->authenticated());
85 gss_eap_saml_assertion_provider::initFromGssContext(const gss_eap_attr_ctx *manager,
86 const gss_cred_id_t gssCred,
87 const gss_ctx_id_t gssCtx)
89 const gss_eap_radius_attr_provider *radius;
90 gss_buffer_desc value = GSS_C_EMPTY_BUFFER;
91 int authenticated, complete, more = -1;
94 assert(m_assertion == NULL);
96 if (!gss_eap_attr_provider::initFromGssContext(manager, gssCred, gssCtx))
99 radius = static_cast<const gss_eap_radius_attr_provider *>
100 (m_manager->getProvider(ATTR_TYPE_RADIUS));
101 if (radius != NULL &&
102 radius->getAttribute(PW_SAML_ASSERTION, &authenticated, &complete,
103 &value, NULL, &more)) {
104 setAssertion(&value, authenticated);
105 gss_release_buffer(&minor, &value);
114 gss_eap_saml_assertion_provider::setAssertion(const saml2::Assertion *assertion,
120 if (assertion != NULL) {
121 m_assertion = dynamic_cast<saml2::Assertion *>(assertion->clone());
122 m_authenticated = authenticated;
125 m_authenticated = false;
130 gss_eap_saml_assertion_provider::setAssertion(const gss_buffer_t buffer,
135 m_assertion = parseAssertion(buffer);
136 m_authenticated = (m_assertion != NULL && authenticated);
140 gss_eap_saml_assertion_provider::parseAssertion(const gss_buffer_t buffer)
142 string str((char *)buffer->value, buffer->length);
143 istringstream istream(str);
145 const XMLObjectBuilder *b;
147 doc = XMLToolingConfig::getConfig().getParser().parse(istream);
148 b = XMLObjectBuilder::getBuilder(doc->getDocumentElement());
150 return dynamic_cast<saml2::Assertion *>(b->buildFromDocument(doc));
154 gss_eap_saml_assertion_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute,
159 /* just add the prefix */
160 if (m_assertion != NULL)
161 ret = addAttribute(this, GSS_C_NO_BUFFER, data);
169 gss_eap_saml_assertion_provider::setAttribute(int complete,
170 const gss_buffer_t attr,
171 const gss_buffer_t value)
173 if (attr == GSS_C_NO_BUFFER || attr->length == 0) {
179 gss_eap_saml_assertion_provider::deleteAttribute(const gss_buffer_t value)
183 m_authenticated = false;
187 gss_eap_saml_assertion_provider::getExpiryTime(void) const
189 saml2::Conditions *conditions;
190 time_t expiryTime = 0;
192 if (m_assertion == NULL)
195 conditions = m_assertion->getConditions();
197 if (conditions != NULL && conditions->getNotOnOrAfter() != NULL)
198 expiryTime = conditions->getNotOnOrAfter()->getEpoch();
204 gss_eap_saml_assertion_provider::getAttribute(const gss_buffer_t attr,
208 gss_buffer_t display_value,
213 if (attr != GSS_C_NO_BUFFER || attr->length != 0)
216 if (m_assertion == NULL)
222 if (authenticated != NULL)
223 *authenticated = m_authenticated;
224 if (complete != NULL)
227 XMLHelper::serialize(m_assertion->marshall((DOMDocument *)NULL), str);
229 duplicateBuffer(str, value);
236 gss_eap_saml_assertion_provider::mapToAny(int authenticated,
237 gss_buffer_t type_id) const
239 if (authenticated && !m_authenticated)
240 return (gss_any_t)NULL;
242 return (gss_any_t)m_assertion;
246 gss_eap_saml_assertion_provider::releaseAnyNameMapping(gss_buffer_t type_id,
247 gss_any_t input) const
249 delete ((saml2::Assertion *)input);
253 gss_eap_saml_assertion_provider::exportToBuffer(gss_buffer_t buffer) const
259 buffer->value = NULL;
261 if (m_assertion == NULL)
264 sink << *m_assertion;
267 duplicateBuffer(str, buffer);
271 gss_eap_saml_assertion_provider::initFromBuffer(const gss_eap_attr_ctx *ctx,
272 const gss_buffer_t buffer)
274 if (!gss_eap_attr_provider::initFromBuffer(ctx, buffer))
277 if (buffer->length == 0)
280 assert(m_assertion == NULL);
282 setAssertion(buffer);
283 /* TODO XXX how to propagate authenticated flag? */
289 gss_eap_saml_assertion_provider::init(void)
291 gss_eap_attr_ctx::registerProvider(ATTR_TYPE_SAML_ASSERTION,
292 "urn:ietf:params:gss-eap:saml-aaa-assertion",
293 gss_eap_saml_assertion_provider::createAttrContext);
298 gss_eap_saml_assertion_provider::finalize(void)
300 gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_SAML_ASSERTION);
303 gss_eap_attr_provider *
304 gss_eap_saml_assertion_provider::createAttrContext(void)
306 return new gss_eap_saml_assertion_provider;
310 * gss_eap_saml_attr_provider is for retrieving the underlying attributes.
313 gss_eap_saml_attr_provider::getAssertion(int *authenticated,
314 const saml2::Assertion **pAssertion) const
316 const gss_eap_saml_assertion_provider *saml;
318 if (authenticated != NULL)
319 *authenticated = false;
320 if (pAssertion != NULL)
323 saml = static_cast<const gss_eap_saml_assertion_provider *>
324 (m_manager->getProvider(ATTR_TYPE_SAML_ASSERTION));
328 if (authenticated != NULL)
329 *authenticated = saml->authenticated();
330 if (pAssertion != NULL)
331 *pAssertion = saml->getAssertion();
333 return (saml->getAssertion() != NULL);
337 gss_eap_saml_attr_provider::getAttributeTypes(gss_eap_attr_enumeration_cb addAttribute,
340 const saml2::Assertion *assertion;
344 if (!getAssertion(&authenticated, &assertion))
348 * Note: the first prefix is added by the attribute provider manager
350 * From draft-hartman-gss-eap-naming-00:
352 * Each attribute carried in the assertion SHOULD also be a GSS name
353 * attribute. The name of this attribute has three parts, all separated
354 * by an ASCII space character. The first part is
355 * urn:ietf:params:gss-eap:saml-attr. The second part is the URI for
356 * the SAML attribute name format. The final part is the name of the
357 * SAML attribute. If the mechanism performs an additional attribute
358 * query, the retrieved attributes SHOULD be GSS-API name attributes
359 * using the same name syntax.
361 const vector<saml2::Attribute*>& attrs2 =
362 const_cast<const saml2::AttributeStatement*>(assertion->getAttributeStatements().front())->getAttributes();
363 for (vector<saml2::Attribute*>::const_iterator a = attrs2.begin();
367 const XMLCh *attributeName = (*a)->getName();
368 const XMLCh *attributeNameFormat = (*a)->getNameFormat();
369 XMLCh *qualifiedName;
370 XMLCh space[2] = { ' ', 0 };
371 gss_buffer_desc utf8;
373 qualifiedName = new XMLCh[XMLString::stringLen(attributeName) + 1 +
374 XMLString::stringLen(attributeNameFormat) + 1];
375 XMLString::copyString(qualifiedName, attributeName);
376 XMLString::catString(qualifiedName, space);
377 XMLString::catString(qualifiedName, attributeNameFormat);
379 utf8.value = (void *)toUTF8(qualifiedName);
380 utf8.length = strlen((char *)utf8.value);
382 ret = addAttribute(this, &utf8, data);
384 delete qualifiedName;
394 gss_eap_saml_attr_provider::setAttribute(int complete,
395 const gss_buffer_t attr,
396 const gss_buffer_t value)
401 gss_eap_saml_attr_provider::deleteAttribute(const gss_buffer_t value)
405 static BaseRefVectorOf<XMLCh> *
406 decomposeAttributeName(const gss_buffer_t attr)
408 XMLCh *qualifiedAttr = new XMLCh[attr->length + 1];
409 XMLString::transcode((const char *)attr->value, qualifiedAttr, attr->length);
411 BaseRefVectorOf<XMLCh> *components = XMLString::tokenizeString(qualifiedAttr);
413 delete qualifiedAttr;
419 gss_eap_saml_attr_provider::getAttribute(const gss_buffer_t attr,
422 const saml2::Attribute **pAttribute) const
424 const saml2::Assertion *assertion;
426 if (authenticated != NULL)
427 *authenticated = false;
428 if (complete != NULL)
432 if (!getAssertion(authenticated, &assertion) ||
433 assertion->getAttributeStatements().size() == 0)
436 /* Check the attribute name consists of name format | whsp | name */
437 BaseRefVectorOf<XMLCh> *components = decomposeAttributeName(attr);
438 if (components == NULL || components->size() != 2) {
443 /* For each attribute statement, look for an attribute match */
444 const vector <saml2::AttributeStatement *>&statements =
445 assertion->getAttributeStatements();
446 const saml2::Attribute *ret = NULL;
448 for (vector<saml2::AttributeStatement *>::const_iterator s = statements.begin();
449 s != statements.end();
451 const vector<saml2::Attribute*>& attrs =
452 const_cast<const saml2::AttributeStatement*>(*s)->getAttributes();
454 for (vector<saml2::Attribute*>::const_iterator a = attrs.begin(); a != attrs.end(); ++a) {
455 if (XMLString::equals((*a)->getNameFormat(), components->elementAt(0)) &&
456 XMLString::equals((*a)->getName(), components->elementAt(1))) {
470 return (ret != NULL);
474 gss_eap_saml_attr_provider::getAttribute(const gss_buffer_t attr,
478 gss_buffer_t display_value,
481 const saml2::Attribute *a;
482 const saml2::AttributeValue *av;
483 int nvalues, i = *more;
487 if (!getAttribute(attr, authenticated, complete, &a))
490 nvalues = a->getAttributeValues().size();
494 else if (i >= nvalues)
496 av = dynamic_cast<const saml2::AttributeValue *>(a->getAttributeValues().at(i)
500 value->value = toUTF8(av->getTextContent(), true);
501 value->length = strlen((char *)value->value);
503 if (display_value != NULL) {
504 display_value->value = toUTF8(av->getTextContent(), true);
505 display_value->length = strlen((char *)value->value);
516 gss_eap_saml_attr_provider::mapToAny(int authenticated,
517 gss_buffer_t type_id) const
519 return (gss_any_t)NULL;
523 gss_eap_saml_attr_provider::releaseAnyNameMapping(gss_buffer_t type_id,
524 gss_any_t input) const
529 gss_eap_saml_attr_provider::exportToBuffer(gss_buffer_t buffer) const
532 buffer->value = NULL;
536 gss_eap_saml_attr_provider::initFromBuffer(const gss_eap_attr_ctx *ctx,
537 const gss_buffer_t buffer)
539 return gss_eap_attr_provider::initFromBuffer(ctx, buffer);
543 gss_eap_saml_attr_provider::init(void)
545 gss_eap_attr_ctx::registerProvider(ATTR_TYPE_SAML,
546 "urn:ietf:params:gss-eap:saml-attr",
547 gss_eap_saml_attr_provider::createAttrContext);
552 gss_eap_saml_attr_provider::finalize(void)
554 gss_eap_attr_ctx::unregisterProvider(ATTR_TYPE_SAML);
557 gss_eap_attr_provider *
558 gss_eap_saml_attr_provider::createAttrContext(void)
560 return new gss_eap_saml_attr_provider;
564 gssEapSamlAttrProvidersInit(OM_uint32 *minor)
566 if (gss_eap_saml_assertion_provider::init() &&
567 gss_eap_saml_attr_provider::init())
568 return GSS_S_COMPLETE;
570 return GSS_S_FAILURE;
574 gssEapSamlAttrProvidersFinalize(OM_uint32 *minor)
576 gss_eap_saml_attr_provider::finalize();
577 gss_eap_saml_assertion_provider::finalize();
578 return GSS_S_COMPLETE;