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 * Copyright 2001-2009 Internet2
35 * Licensed under the Apache License, Version 2.0 (the "License");
36 * you may not use this file except in compliance with the License.
37 * You may obtain a copy of the License at
39 * http://www.apache.org/licenses/LICENSE-2.0
41 * Unless required by applicable law or agreed to in writing, software
42 * distributed under the License is distributed on an "AS IS" BASIS,
43 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
44 * See the License for the specific language governing permissions and
45 * limitations under the License.
48 #include <gssapi/gssapi.h>
49 #include <gssapi/gssapi_ext.h>
52 #include <shibsp/Application.h>
53 #include <shibsp/exceptions.h>
54 #include <shibsp/SPConfig.h>
55 #include <shibsp/ServiceProvider.h>
56 #include <shibsp/attribute/Attribute.h>
57 #include <shibsp/attribute/SimpleAttribute.h>
58 #include <shibsp/attribute/resolver/ResolutionContext.h>
59 #include <shibsp/handler/AssertionConsumerService.h>
60 #include <shibsp/metadata/MetadataProviderCriteria.h>
61 #include <shibsp/util/SPConstants.h>
63 #include <saml/saml1/core/Assertions.h>
64 #include <saml/saml2/core/Assertions.h>
65 #include <saml/saml2/metadata/Metadata.h>
66 #include <xercesc/util/XMLUniDefs.hpp>
67 #include <xmltooling/XMLToolingConfig.h>
68 #include <xmltooling/util/XMLHelper.h>
70 using namespace shibsp;
71 using namespace opensaml::saml2md;
72 using namespace opensaml;
73 using namespace xmltooling::logging;
74 using namespace xmltooling;
75 using namespace xercesc;
78 class GSSEAPResolver : public shibsp::AssertionConsumerService
81 GSSEAPResolver(const DOMElement *e, const char *appId)
82 : shibsp::AssertionConsumerService(e, appId, Category::getInstance(SHIBSP_LOGCAT".GSSEAPResolver")) {
84 virtual ~GSSEAPResolver() {}
86 ResolutionContext* resolveAttributes (
87 const Application& application,
88 const RoleDescriptor* issuer,
89 const XMLCh* protocol,
90 const saml1::NameIdentifier* v1nameid,
91 const saml2::NameID* nameid,
92 const XMLCh* authncontext_class,
93 const XMLCh* authncontext_decl,
94 const vector<const Assertion*>* tokens
96 return shibsp::AssertionConsumerService::resolveAttributes(
97 application, issuer, protocol, v1nameid,
98 nameid, authncontext_class, authncontext_decl, tokens
103 void implementProtocol(
104 const Application& application,
105 const HTTPRequest& httpRequest,
106 HTTPResponse& httpResponse,
107 SecurityPolicy& policy,
108 const PropertySet* settings,
109 const XMLObject& xmlObject
111 throw FatalProfileException("Should never be called.");
115 struct eap_gss_saml_attr_ctx {
117 eap_gss_saml_attr_ctx(const gss_buffer_t buffer) {
118 parseAssertion(buffer);
121 eap_gss_saml_attr_ctx(const vector<Attribute*>& attributes,
122 const Assertion *assertion = NULL) {
123 if (assertion != NULL)
124 m_assertion = dynamic_cast<Assertion *>(assertion->clone());
125 if (attributes.size())
126 setAttributes(attributes);
129 eap_gss_saml_attr_ctx(const eap_gss_saml_attr_ctx &ctx) {
130 eap_gss_saml_attr_ctx(ctx.m_attributes, ctx.m_assertion);
133 eap_gss_saml_attr_ctx() {}
134 ~eap_gss_saml_attr_ctx() {
135 for_each(m_attributes.begin(),
137 xmltooling::cleanup<Attribute>())
142 const vector <Attribute *> getAttributes(void) const {
146 void addAttribute(Attribute *attr, bool copy = true);
147 void setAttributes(const vector<Attribute*> attributes);
149 void setAttribute(int complete,
150 const gss_buffer_t attr,
151 const gss_buffer_t value);
152 void deleteAttribute(const gss_buffer_t attr);
154 int getAttributeIndex(const gss_buffer_t attr) const;
155 const Attribute *getAttribute(const gss_buffer_t attr) const;
157 bool getAttribute(const gss_buffer_t attr,
161 gss_buffer_t display_value,
164 const Assertion *getAssertion(void) const {
168 bool getAssertion(gss_buffer_t buffer);
170 DDF marshall() const;
171 static eap_gss_saml_attr_ctx *unmarshall(DDF &in);
173 void marshall(gss_buffer_t buffer);
174 static eap_gss_saml_attr_ctx *unmarshall(const gss_buffer_t buffer);
177 mutable vector<Attribute*> m_attributes;
178 mutable Assertion *m_assertion;
180 bool parseAssertion(const gss_buffer_t buffer);
184 mapException(OM_uint32 *minor, exception &e)
187 return GSS_S_FAILURE;
191 eap_gss_saml_attr_ctx::parseAssertion(const gss_buffer_t buffer)
194 const XMLObjectBuilder *b;
197 string str((char *)buffer->value, buffer->length);
198 istringstream istream(str);
200 doc = XMLToolingConfig::getConfig().getParser().parse(istream);
201 b = XMLObjectBuilder::getDefaultBuilder();
202 elem = doc->getDocumentElement();
203 xobj = b->buildOneFromElement(elem, true);
205 m_assertion = dynamic_cast<Assertion *>(xobj);
207 return (m_assertion != NULL);
211 duplicateBuffer(gss_buffer_desc &src, gss_buffer_t dst)
215 if (GSS_ERROR(duplicateBuffer(&minor, &src, dst)))
216 throw new bad_alloc();
220 duplicateBuffer(string &str, gss_buffer_t buffer)
224 tmp.length = str.length();
225 tmp.value = (char *)str.c_str();
227 duplicateBuffer(tmp, buffer);
231 eap_gss_saml_attr_ctx::marshall() const
237 obj.addmember("version").integer(1);
239 attrs = obj.addmember("attributes").list();
240 for (vector<Attribute*>::const_iterator a = m_attributes.begin();
241 a != m_attributes.end(); ++a) {
242 DDF attr = (*a)->marshall();
247 sink << *m_assertion;
248 assertion = obj.addmember("assertion").string(sink.str().c_str());
253 eap_gss_saml_attr_ctx *
254 eap_gss_saml_attr_ctx::unmarshall(DDF &obj)
256 eap_gss_saml_attr_ctx *ctx = new eap_gss_saml_attr_ctx();
258 DDF version = obj["version"];
259 if (version.integer() != 1)
262 DDF assertion = obj["assertion"];
263 gss_buffer_desc buffer;
265 if (!assertion.isnull()) {
266 buffer.length = assertion.strlen();
267 buffer.value = (void *)assertion.string();
272 if (buffer.length != 0)
273 ctx->parseAssertion(&buffer);
275 DDF attrs = obj["attributes"];
276 DDF attr = attrs.first();
277 while (!attr.isnull()) {
278 Attribute *attribute = Attribute::unmarshall(attr);
279 ctx->addAttribute(attribute, false);
287 eap_gss_saml_attr_ctx::marshall(gss_buffer_t buffer)
289 DDF obj = marshall();
292 string str = sink.str();
294 duplicateBuffer(str, buffer);
299 eap_gss_saml_attr_ctx *
300 eap_gss_saml_attr_ctx::unmarshall(const gss_buffer_t buffer)
302 eap_gss_saml_attr_ctx *ctx;
304 string str((const char *)buffer->value, buffer->length);
305 istringstream source(str);
309 ctx = unmarshall(obj);
317 eap_gss_saml_attr_ctx::getAssertion(gss_buffer_t buffer)
321 if (m_assertion == NULL)
324 buffer->value = NULL;
327 XMLHelper::serialize(m_assertion->marshall((DOMDocument *)NULL), str);
329 duplicateBuffer(str, buffer);
335 duplicateAttribute(const Attribute *src)
337 Attribute *attribute;
339 DDF obj = src->marshall();
340 attribute = Attribute::unmarshall(obj);
346 static vector <Attribute *>
347 duplicateAttributes(const vector <Attribute *>src)
349 vector <Attribute *> dst;
351 for (vector<Attribute *>::const_iterator a = src.begin();
354 dst.push_back(duplicateAttribute(*a));
360 eap_gss_saml_attr_ctx::addAttribute(Attribute *attribute, bool copy)
364 a = copy ? duplicateAttribute(attribute) : attribute;
366 m_attributes.push_back(a);
370 eap_gss_saml_attr_ctx::setAttributes(const vector<Attribute*> attributes)
372 for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<Attribute>());
373 m_attributes = duplicateAttributes(attributes);
377 eap_gss_saml_attr_ctx::getAttributeIndex(const gss_buffer_t attr) const
381 for (vector<Attribute *>::const_iterator a = getAttributes().begin();
382 a != getAttributes().end();
385 for (vector<string>::const_iterator s = (*a)->getAliases().begin();
386 s != (*a)->getAliases().end();
388 if (attr->length == (*s).length() &&
389 memcmp((*s).c_str(), attr->value, attr->length) == 0) {
399 eap_gss_saml_attr_ctx::getAttribute(const gss_buffer_t attr) const
401 const Attribute *ret = NULL;
403 for (vector<Attribute *>::const_iterator a = getAttributes().begin();
404 a != getAttributes().end();
407 for (vector<string>::const_iterator s = (*a)->getAliases().begin();
408 s != (*a)->getAliases().end();
410 if (attr->length == (*s).length() &&
411 memcmp((*s).c_str(), attr->value, attr->length) == 0) {
424 eap_gss_saml_attr_ctx::getAttribute(const gss_buffer_t attr,
428 gss_buffer_t display_value,
431 const Attribute *shibAttr = NULL;
434 shibAttr = getAttribute(attr);
435 if (shibAttr == NULL)
440 } else if (*more >= (int)shibAttr->valueCount()) {
445 buf.value = (void *)shibAttr->getString(*more);
446 buf.length = strlen((char *)buf.value);
448 duplicateBuffer(buf, value);
450 *authenticated = TRUE;
457 eap_gss_saml_attr_ctx::setAttribute(int complete,
458 const gss_buffer_t attr,
459 const gss_buffer_t value)
461 string attrStr((char *)attr->value, attr->length);
462 vector <string> ids(1);
465 ids.push_back(attrStr);
467 a = new SimpleAttribute(ids);
469 if (value->length != 0) {
470 string valStr((char *)value->value, value->length);
472 a->getValues().push_back(valStr);
475 m_attributes.push_back(a);
479 eap_gss_saml_attr_ctx::deleteAttribute(const gss_buffer_t attr)
483 i = getAttributeIndex(attr);
485 m_attributes.erase(m_attributes.begin() + i);
489 samlReleaseAttrContext(OM_uint32 *minor,
490 struct eap_gss_saml_attr_ctx **pCtx)
492 eap_gss_saml_attr_ctx *ctx = *pCtx;
500 return GSS_S_COMPLETE;
504 samlCreateAttrContext(OM_uint32 *minor,
506 gss_name_t acceptorName,
507 struct eap_gss_saml_attr_ctx **pCtx,
510 OM_uint32 major, tmpMinor;
511 eap_gss_saml_attr_ctx *ctx = NULL;
512 SPConfig &conf = SPConfig::getConfig();
514 const Application *app;
516 gss_buffer_desc nameBuf;
517 const XMLCh *issuer = NULL;
518 saml2::NameID *subjectName = NULL;
519 saml2::Assertion *assertion;
520 ResolutionContext *resolverContext;
523 nameBuf.value = NULL;
525 conf.setFeatures(SPConfig::Metadata |
527 SPConfig::AttributeResolution |
528 SPConfig::Credentials |
529 SPConfig::OutOfProcess);
531 return GSS_S_FAILURE;
532 if (!conf.instantiate())
533 return GSS_S_FAILURE;
535 sp = conf.getServiceProvider();
538 major = gss_display_name(minor, acceptorName, &nameBuf, NULL);
539 if (GSS_ERROR(major))
542 app = sp->getApplication((const char *)nameBuf.value);
544 major = GSS_S_FAILURE;
549 ctx = new eap_gss_saml_attr_ctx(buffer);
551 if (assertion->getIssuer() != NULL)
552 issuer = assertion->getIssuer()->getName();
553 if (assertion->getSubject() != NULL)
554 subjectName = assertion->getSubject()->getNameID();
555 if (assertion->getConditions())
556 *pExpiryTime = assertion->getConditions()->getNotOnOrAfter()->getEpoch();
558 m = app->getMetadataProvider();
559 xmltooling::Locker mlocker(m);
560 MetadataProviderCriteria mc(*app, issuer,
561 &IDPSSODescriptor::ELEMENT_QNAME,
562 samlconstants::SAML20P_NS);
563 pair<const EntityDescriptor *, const RoleDescriptor *> site =
564 m->getEntityDescriptor(mc);
566 auto_ptr_char temp(issuer);
567 throw MetadataException("Unable to locate metadata for IdP ($1).",
568 params(1,temp.get()));
570 vector<const Assertion*> tokens(1, assertion);
571 GSSEAPResolver gssResolver(NULL, (const char *)nameBuf.value);
572 resolverContext = gssResolver.resolveAttributes(*app, site.second,
573 samlconstants::SAML20P_NS,
574 NULL, subjectName, NULL,
576 ctx->setAttributes(resolverContext->getResolvedAttributes());
577 } catch (exception &ex) {
578 major = mapException(minor, ex);
582 major = GSS_S_COMPLETE;
589 if (GSS_ERROR(major))
591 gss_release_buffer(&tmpMinor, &nameBuf);
597 samlGetAttributeTypes(OM_uint32 *minor,
598 const struct eap_gss_saml_attr_ctx *ctx,
600 OM_uint32 (*addAttribute)(OM_uint32 *, void *, gss_buffer_t))
602 OM_uint32 major = GSS_S_COMPLETE;
605 return GSS_S_COMPLETE;
607 for (vector<Attribute*>::const_iterator a = ctx->getAttributes().begin();
608 a != ctx->getAttributes().end();
611 gss_buffer_desc attribute;
613 attribute.value = (void *)((*a)->getId());
614 attribute.length = strlen((char *)attribute.value);
616 major = addAttribute(minor, data, &attribute);
617 if (GSS_ERROR(major))
625 * SAML implementation of gss_get_name_attribute
628 samlGetAttribute(OM_uint32 *minor,
629 struct eap_gss_saml_attr_ctx *ctx,
634 gss_buffer_t display_value,
638 return GSS_S_UNAVAILABLE;
640 if (!ctx->getAttribute(attr, authenticated, complete,
641 value, display_value, more))
642 return GSS_S_UNAVAILABLE;
644 return GSS_S_COMPLETE;
648 samlSetAttribute(OM_uint32 *minor,
649 struct eap_gss_saml_attr_ctx *ctx,
655 ctx->setAttribute(complete, attr, value);
656 } catch (exception &e) {
657 return mapException(minor, e);
660 return GSS_S_COMPLETE;
664 samlDeleteAttribute(OM_uint32 *minor,
665 struct eap_gss_saml_attr_ctx *ctx,
669 ctx->deleteAttribute(attr);
670 } catch (exception &e) {
671 return mapException(minor, e);
674 return GSS_S_COMPLETE;
678 * In order to implement gss_export_name and gss_export_sec_context,
679 * we need to serialise a resolved attribute context to a buffer.
682 samlExportAttrContext(OM_uint32 *minor,
683 struct eap_gss_saml_attr_ctx *ctx,
687 ctx->marshall(buffer);
688 } catch (exception &e) {
689 return mapException(minor, e);
692 return GSS_S_COMPLETE;
696 * In order to implement gss_import_name and gss_import_sec_context,
697 * we need to deserialise a resolved attribute context from a buffer.
700 samlImportAttrContext(OM_uint32 *minor,
702 struct eap_gss_saml_attr_ctx **pCtx)
705 *pCtx = eap_gss_saml_attr_ctx::unmarshall(buffer);
706 } catch (exception &e) {
707 return mapException(minor, e);
710 return GSS_S_COMPLETE;
714 samlGetAssertion(OM_uint32 *minor,
715 struct eap_gss_saml_attr_ctx *ctx,
716 gss_buffer_t assertion)
719 ctx->getAssertion(assertion);
720 } catch (exception &e) {
721 return mapException(minor, e);
724 return GSS_S_COMPLETE;
728 samlDuplicateAttrContext(OM_uint32 *minor,
729 const struct eap_gss_saml_attr_ctx *in,
730 struct eap_gss_saml_attr_ctx **out)
733 *out = new eap_gss_saml_attr_ctx(*in);
734 } catch (exception &e) {
735 return mapException(minor, e);
738 return GSS_S_COMPLETE;
742 samlMapNameToAny(OM_uint32 *minor,
743 const struct eap_gss_saml_attr_ctx *ctx,
745 gss_buffer_t type_id,
748 if (bufferEqualString(type_id, "shibsp::Attribute")) {
749 vector <Attribute *>v = duplicateAttributes(ctx->getAttributes());
751 *output = (gss_any_t)new vector <Attribute *>(v);
752 } else if (bufferEqualString(type_id, "opensaml::Assertion")) {
753 *output = (gss_any_t)ctx->getAssertion()->clone();
755 *output = (gss_any_t)NULL;
756 return GSS_S_UNAVAILABLE;
759 return GSS_S_COMPLETE;
763 samlReleaseAnyNameMapping(OM_uint32 *minor,
764 const struct eap_gss_saml_attr_ctx *ctx,
765 gss_buffer_t type_id,
768 if (bufferEqualString(type_id, "vector<shibsp::Attribute>")) {
769 vector <Attribute *> *v = ((vector <Attribute *> *)*input);
771 } else if (bufferEqualString(type_id, "opensaml::Assertion")) {
772 delete (Assertion *)*input;
774 return GSS_S_UNAVAILABLE;
777 *input = (gss_any_t)NULL;
778 return GSS_S_COMPLETE;