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();
118 eap_gss_saml_attr_ctx(const gss_buffer_t buffer);
119 eap_gss_saml_attr_ctx(const Assertion *assertion);
121 eap_gss_saml_attr_ctx(const vector<Attribute*>& attributes,
122 const Assertion *assertion);
124 eap_gss_saml_attr_ctx(const eap_gss_saml_attr_ctx &ctx) {
125 eap_gss_saml_attr_ctx(ctx.m_attributes, ctx.m_assertion);
128 ~eap_gss_saml_attr_ctx();
130 const vector <Attribute *> getAttributes(void) const {
134 void addAttribute(Attribute *attr, bool copy = true);
135 void setAttributes(const vector<Attribute*> attributes);
137 void setAttribute(int complete,
138 const gss_buffer_t attr,
139 const gss_buffer_t value);
140 void deleteAttribute(const gss_buffer_t attr);
142 int getAttributeIndex(const gss_buffer_t attr) const;
143 const Attribute *getAttribute(const gss_buffer_t attr) const;
145 bool getAttribute(const gss_buffer_t attr,
149 gss_buffer_t display_value,
152 const Assertion *getAssertion(void) const {
156 bool getAssertion(gss_buffer_t buffer);
158 DDF marshall() const;
159 static eap_gss_saml_attr_ctx *unmarshall(DDF &in);
161 void marshall(gss_buffer_t buffer);
162 static eap_gss_saml_attr_ctx *unmarshall(const gss_buffer_t buffer);
165 mutable vector<Attribute*> m_attributes;
166 mutable Assertion *m_assertion;
168 bool parseAssertion(const gss_buffer_t buffer);
171 eap_gss_saml_attr_ctx::eap_gss_saml_attr_ctx(const vector<Attribute*>& attributes,
172 const Assertion *assertion)
174 m_assertion = dynamic_cast<Assertion *>(assertion->clone());
175 setAttributes(attributes);
178 eap_gss_saml_attr_ctx::~eap_gss_saml_attr_ctx()
180 for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<Attribute>());
184 eap_gss_saml_attr_ctx::eap_gss_saml_attr_ctx(const gss_buffer_t buffer)
186 parseAssertion(buffer);
190 mapException(OM_uint32 *minor, exception &e)
192 return GSS_S_FAILURE;
196 eap_gss_saml_attr_ctx::parseAssertion(const gss_buffer_t buffer)
199 const XMLObjectBuilder *b;
202 string str((char *)buffer->value, buffer->length);
203 istringstream istream(str);
205 doc = XMLToolingConfig::getConfig().getParser().parse(istream);
206 b = XMLObjectBuilder::getDefaultBuilder();
207 elem = doc->getDocumentElement();
208 xobj = b->buildOneFromElement(elem, true);
210 m_assertion = dynamic_cast<Assertion *>(xobj);
212 return (m_assertion != NULL);
216 duplicateBuffer(gss_buffer_desc &src, gss_buffer_t dst)
220 if (GSS_ERROR(duplicateBuffer(&minor, &src, dst)))
221 throw new bad_alloc();
225 duplicateBuffer(string &str, gss_buffer_t buffer)
229 tmp.length = str.length();
230 tmp.value = (char *)str.c_str();
232 duplicateBuffer(tmp, buffer);
236 eap_gss_saml_attr_ctx::marshall() const
242 obj.addmember("version").integer(1);
244 attrs = obj.addmember("attributes").list();
245 for (vector<Attribute*>::const_iterator a = m_attributes.begin();
246 a != m_attributes.end(); ++a) {
247 DDF attr = (*a)->marshall();
252 sink << *m_assertion;
253 assertion = obj.addmember("assertion").string(sink.str().c_str());
258 eap_gss_saml_attr_ctx *
259 eap_gss_saml_attr_ctx::unmarshall(DDF &obj)
261 eap_gss_saml_attr_ctx *ctx = new eap_gss_saml_attr_ctx();
263 DDF version = obj["version"];
264 if (version.integer() != 1)
267 DDF assertion = obj["assertion"];
268 gss_buffer_desc buffer;
270 if (!assertion.isnull()) {
271 buffer.length = assertion.strlen();
272 buffer.value = (void *)assertion.string();
277 if (buffer.length != 0)
278 ctx->parseAssertion(&buffer);
280 DDF attrs = obj["attributes"];
281 DDF attr = attrs.first();
282 while (!attr.isnull()) {
283 Attribute *attribute = Attribute::unmarshall(attr);
284 ctx->addAttribute(attribute, false);
292 eap_gss_saml_attr_ctx::marshall(gss_buffer_t buffer)
294 DDF obj = marshall();
297 string str = sink.str();
299 duplicateBuffer(str, buffer);
304 eap_gss_saml_attr_ctx *
305 eap_gss_saml_attr_ctx::unmarshall(const gss_buffer_t buffer)
307 eap_gss_saml_attr_ctx *ctx;
309 string str((const char *)buffer->value, buffer->length);
310 istringstream source(str);
314 ctx = unmarshall(obj);
322 eap_gss_saml_attr_ctx::getAssertion(gss_buffer_t buffer)
326 if (m_assertion == NULL)
329 buffer->value = NULL;
332 XMLHelper::serialize(m_assertion->marshall((DOMDocument *)NULL), str);
334 duplicateBuffer(str, buffer);
340 duplicateAttribute(const Attribute *src)
342 Attribute *attribute;
344 DDF obj = src->marshall();
345 attribute = Attribute::unmarshall(obj);
351 static vector <Attribute *>
352 duplicateAttributes(const vector <Attribute *>src)
354 vector <Attribute *> dst;
356 for (vector<Attribute *>::const_iterator a = src.begin();
359 dst.push_back(duplicateAttribute(*a));
365 eap_gss_saml_attr_ctx::addAttribute(Attribute *attribute, bool copy)
369 a = copy ? duplicateAttribute(attribute) : attribute;
371 m_attributes.push_back(a);
375 eap_gss_saml_attr_ctx::setAttributes(const vector<Attribute*> attributes)
377 for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<Attribute>());
378 m_attributes = duplicateAttributes(attributes);
382 eap_gss_saml_attr_ctx::getAttributeIndex(const gss_buffer_t attr) const
386 for (vector<Attribute *>::const_iterator a = getAttributes().begin();
387 a != getAttributes().end();
390 for (vector<string>::const_iterator s = (*a)->getAliases().begin();
391 s != (*a)->getAliases().end();
393 if (attr->length == (*s).length() &&
394 memcmp((*s).c_str(), attr->value, attr->length) == 0) {
404 eap_gss_saml_attr_ctx::getAttribute(const gss_buffer_t attr) const
406 const Attribute *ret = NULL;
408 for (vector<Attribute *>::const_iterator a = getAttributes().begin();
409 a != getAttributes().end();
412 for (vector<string>::const_iterator s = (*a)->getAliases().begin();
413 s != (*a)->getAliases().end();
415 if (attr->length == (*s).length() &&
416 memcmp((*s).c_str(), attr->value, attr->length) == 0) {
429 eap_gss_saml_attr_ctx::getAttribute(const gss_buffer_t attr,
433 gss_buffer_t display_value,
436 const Attribute *shibAttr = NULL;
439 shibAttr = getAttribute(attr);
440 if (shibAttr == NULL)
445 } else if (*more >= (int)shibAttr->valueCount()) {
450 buf.value = (void *)shibAttr->getString(*more);
451 buf.length = strlen((char *)buf.value);
453 duplicateBuffer(buf, value);
455 *authenticated = TRUE;
462 eap_gss_saml_attr_ctx::setAttribute(int complete,
463 const gss_buffer_t attr,
464 const gss_buffer_t value)
466 string attrStr((char *)attr->value, attr->length);
467 vector <string> ids(1);
470 ids.push_back(attrStr);
472 a = new SimpleAttribute(ids);
474 if (value->length != 0) {
475 string valStr((char *)value->value, value->length);
477 a->getValues().push_back(valStr);
480 m_attributes.push_back(a);
484 eap_gss_saml_attr_ctx::deleteAttribute(const gss_buffer_t attr)
488 i = getAttributeIndex(attr);
490 m_attributes.erase(m_attributes.begin() + i);
494 samlReleaseAttrContext(OM_uint32 *minor,
495 struct eap_gss_saml_attr_ctx **pCtx)
497 eap_gss_saml_attr_ctx *ctx = *pCtx;
505 return GSS_S_COMPLETE;
509 samlCreateAttrContext(OM_uint32 *minor,
511 gss_name_t acceptorName,
512 struct eap_gss_saml_attr_ctx **pCtx)
514 OM_uint32 major, tmpMinor;
515 eap_gss_saml_attr_ctx *ctx = NULL;
516 SPConfig &conf = SPConfig::getConfig();
518 const Application *app;
520 gss_buffer_desc nameBuf;
521 const XMLCh *issuer = NULL;
522 saml2::NameID *subjectName = NULL;
523 saml2::Assertion *assertion;
524 ResolutionContext *resolverContext;
527 nameBuf.value = NULL;
529 conf.setFeatures(SPConfig::Metadata |
531 SPConfig::AttributeResolution |
532 SPConfig::Credentials |
533 SPConfig::OutOfProcess);
535 return GSS_S_FAILURE;
536 if (!conf.instantiate())
537 return GSS_S_FAILURE;
539 sp = conf.getServiceProvider();
542 major = gss_display_name(minor, acceptorName, &nameBuf, NULL);
543 if (GSS_ERROR(major))
546 app = sp->getApplication((const char *)nameBuf.value);
548 major = GSS_S_FAILURE;
553 ctx = new eap_gss_saml_attr_ctx(buffer);
555 if (assertion->getIssuer() != NULL)
556 issuer = assertion->getIssuer()->getName();
557 if (assertion->getSubject() != NULL)
558 subjectName = assertion->getSubject()->getNameID();
560 m = app->getMetadataProvider();
561 xmltooling::Locker mlocker(m);
562 MetadataProviderCriteria mc(*app, issuer,
563 &IDPSSODescriptor::ELEMENT_QNAME,
564 samlconstants::SAML20P_NS);
565 pair<const EntityDescriptor *, const RoleDescriptor *> site =
566 m->getEntityDescriptor(mc);
568 auto_ptr_char temp(issuer);
569 throw MetadataException("Unable to locate metadata for IdP ($1).",
570 params(1,temp.get()));
572 vector<const Assertion*> tokens(1, assertion);
573 GSSEAPResolver gssResolver(NULL, (const char *)nameBuf.value);
574 resolverContext = gssResolver.resolveAttributes(*app, site.second,
575 samlconstants::SAML20P_NS,
576 NULL, subjectName, NULL,
578 ctx->setAttributes(resolverContext->getResolvedAttributes());
579 } catch (exception &ex) {
580 major = mapException(minor, ex);
584 major = GSS_S_COMPLETE;
591 if (GSS_ERROR(major))
593 gss_release_buffer(&tmpMinor, &nameBuf);
599 samlGetAttributeTypes(OM_uint32 *minor,
600 const struct eap_gss_saml_attr_ctx *ctx,
602 OM_uint32 (*addAttribute)(OM_uint32 *, void *, gss_buffer_t))
604 OM_uint32 major = GSS_S_COMPLETE;
607 return GSS_S_COMPLETE;
609 for (vector<Attribute*>::const_iterator a = ctx->getAttributes().begin();
610 a != ctx->getAttributes().end();
613 gss_buffer_desc attribute;
615 attribute.value = (void *)((*a)->getId());
616 attribute.length = strlen((char *)attribute.value);
618 major = addAttribute(minor, data, &attribute);
619 if (GSS_ERROR(major))
627 * SAML implementation of gss_get_name_attribute
630 samlGetAttribute(OM_uint32 *minor,
631 struct eap_gss_saml_attr_ctx *ctx,
636 gss_buffer_t display_value,
640 return GSS_S_UNAVAILABLE;
642 if (!ctx->getAttribute(attr, authenticated, complete,
643 value, display_value, more))
644 return GSS_S_UNAVAILABLE;
646 return GSS_S_COMPLETE;
650 samlSetAttribute(OM_uint32 *minor,
651 struct eap_gss_saml_attr_ctx *ctx,
657 ctx->setAttribute(complete, attr, value);
658 } catch (exception &e) {
659 return mapException(minor, e);
662 return GSS_S_COMPLETE;
666 samlDeleteAttribute(OM_uint32 *minor,
667 struct eap_gss_saml_attr_ctx *ctx,
671 ctx->deleteAttribute(attr);
672 } catch (exception &e) {
673 return mapException(minor, e);
676 return GSS_S_COMPLETE;
680 * In order to implement gss_export_name and gss_export_sec_context,
681 * we need to serialise a resolved attribute context to a buffer.
684 samlExportAttrContext(OM_uint32 *minor,
685 struct eap_gss_saml_attr_ctx *ctx,
689 ctx->marshall(buffer);
690 } catch (exception &e) {
691 return mapException(minor, e);
694 return GSS_S_COMPLETE;
698 * In order to implement gss_import_name and gss_import_sec_context,
699 * we need to deserialise a resolved attribute context from a buffer.
702 samlImportAttrContext(OM_uint32 *minor,
704 struct eap_gss_saml_attr_ctx **pCtx)
707 *pCtx = eap_gss_saml_attr_ctx::unmarshall(buffer);
708 } catch (exception &e) {
709 return mapException(minor, e);
712 return GSS_S_COMPLETE;
716 samlGetAssertion(OM_uint32 *minor,
717 struct eap_gss_saml_attr_ctx *ctx,
718 gss_buffer_t assertion)
721 ctx->getAssertion(assertion);
722 } catch (exception &e) {
723 return mapException(minor, e);
726 return GSS_S_COMPLETE;
730 samlDuplicateAttrContext(OM_uint32 *minor,
731 const struct eap_gss_saml_attr_ctx *in,
732 struct eap_gss_saml_attr_ctx **out)
735 *out = new eap_gss_saml_attr_ctx(*in);
736 } catch (exception &e) {
737 return mapException(minor, e);
740 return GSS_S_COMPLETE;
744 samlMapNametoAny(OM_uint32 *minor,
745 const struct eap_gss_saml_attr_ctx *ctx,
747 gss_buffer_t type_id,
750 if (bufferEqualString(type_id, "shibsp::Attribute")) {
751 vector <Attribute *>v = duplicateAttributes(ctx->getAttributes());
753 *output = (gss_any_t)new vector <Attribute *>(v);
754 } else if (bufferEqualString(type_id, "opensaml::Assertion")) {
755 *output = (gss_any_t)ctx->getAssertion()->clone();
757 *output = (gss_any_t)NULL;
758 return GSS_S_UNAVAILABLE;
761 return GSS_S_COMPLETE;
765 samlReleaseAnyNameMapping(OM_uint32 *minor,
766 const struct eap_gss_saml_attr_ctx *ctx,
767 gss_buffer_t type_id,
770 if (bufferEqualString(type_id, "vector<shibsp::Attribute>")) {
771 vector <Attribute *> *v = ((vector <Attribute *> *)*input);
773 } else if (bufferEqualString(type_id, "opensaml::Assertion")) {
774 delete (Assertion *)*input;
776 return GSS_S_UNAVAILABLE;
779 *input = (gss_any_t)NULL;
780 return GSS_S_COMPLETE;