2 * Copyright 2001-2005 Internet2
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
20 * ADFSv1 extension library
23 #if defined (_MSC_VER) || defined(__BORLANDC__)
24 # include "config_win32.h"
30 # define _CRT_NONSTDC_NO_DEPRECATE 1
31 # define _CRT_SECURE_NO_DEPRECATE 1
32 # define ADFS_EXPORTS __declspec(dllexport)
37 #include <shibsp/base.h>
38 #include <shibsp/exceptions.h>
39 #include <shibsp/Application.h>
40 #include <shibsp/ServiceProvider.h>
41 #include <shibsp/SessionCache.h>
42 #include <shibsp/SPConfig.h>
43 #include <shibsp/handler/AssertionConsumerService.h>
44 #include <shibsp/handler/LogoutHandler.h>
45 #include <shibsp/handler/SessionInitiator.h>
46 #include <xmltooling/logging.h>
47 #include <xmltooling/util/NDC.h>
48 #include <xmltooling/util/URLEncoder.h>
49 #include <xmltooling/util/XMLHelper.h>
50 #include <xercesc/util/XMLUniDefs.hpp>
53 # include <shibsp/attribute/resolver/ResolutionContext.h>
54 # include <saml/SAMLConfig.h>
55 # include <saml/saml1/core/Assertions.h>
56 # include <saml/saml1/profile/AssertionValidator.h>
57 # include <saml/saml2/core/Assertions.h>
58 # include <saml/saml2/metadata/Metadata.h>
59 # include <saml/saml2/metadata/EndpointManager.h>
60 # include <xmltooling/impl/AnyElement.h>
61 # include <xmltooling/validation/ValidatorSuite.h>
62 using namespace opensaml::saml2md;
64 using namespace shibsp;
65 using namespace opensaml;
66 using namespace xmltooling::logging;
67 using namespace xmltooling;
68 using namespace xercesc;
71 #define WSFED_NS "http://schemas.xmlsoap.org/ws/2003/07/secext"
72 #define WSTRUST_NS "http://schemas.xmlsoap.org/ws/2005/02/trust"
77 class SHIBSP_DLLLOCAL ADFSDecoder : public MessageDecoder
81 ADFSDecoder() : m_ns(WSTRUST_NS) {}
82 virtual ~ADFSDecoder() {}
84 XMLObject* decode(string& relayState, const GenericRequest& genericRequest, SecurityPolicy& policy) const;
87 void extractMessageDetails(
88 const XMLObject& message, const GenericRequest& req, const XMLCh* protocol, SecurityPolicy& policy
93 MessageDecoder* ADFSDecoderFactory(const pair<const DOMElement*,const XMLCh*>& p)
95 return new ADFSDecoder();
99 #if defined (_MSC_VER)
100 #pragma warning( push )
101 #pragma warning( disable : 4250 )
104 class SHIBSP_DLLLOCAL ADFSSessionInitiator : public SessionInitiator, public AbstractHandler, public RemotedHandler
107 ADFSSessionInitiator(const DOMElement* e, const char* appId)
108 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".SessionInitiator.ADFS")), m_appId(appId), m_binding(WSFED_NS) {
109 // If Location isn't set, defer address registration until the setParent call.
110 pair<bool,const char*> loc = getString("Location");
112 string address = m_appId + loc.second + "::run::ADFSSI";
113 setAddress(address.c_str());
116 virtual ~ADFSSessionInitiator() {}
118 void setParent(const PropertySet* parent) {
119 DOMPropertySet::setParent(parent);
120 pair<bool,const char*> loc = getString("Location");
122 string address = m_appId + loc.second + "::run::ADFSSI";
123 setAddress(address.c_str());
126 m_log.warn("no Location property in ADFS SessionInitiator (or parent), can't register as remoted handler");
130 void receive(DDF& in, ostream& out);
131 pair<bool,long> run(SPRequest& request, const char* entityID=NULL, bool isHandler=true) const;
134 pair<bool,long> doRequest(
135 const Application& application,
136 HTTPResponse& httpResponse,
137 const char* entityID,
138 const char* acsLocation,
142 auto_ptr_XMLCh m_binding;
145 class SHIBSP_DLLLOCAL ADFSConsumer : public shibsp::AssertionConsumerService
148 ADFSConsumer(const DOMElement* e, const char* appId)
149 : shibsp::AssertionConsumerService(e, appId, Category::getInstance(SHIBSP_LOGCAT".SSO.ADFS"))
151 ,m_protocol(WSFED_NS)
154 virtual ~ADFSConsumer() {}
157 void generateMetadata(SPSSODescriptor& role, const char* handlerURL) const {
158 AssertionConsumerService::generateMetadata(role, handlerURL);
159 role.addSupport(m_protocol.get());
162 auto_ptr_XMLCh m_protocol;
165 void implementProtocol(
166 const Application& application,
167 const HTTPRequest& httpRequest,
168 HTTPResponse& httpResponse,
169 SecurityPolicy& policy,
170 const PropertySet* settings,
171 const XMLObject& xmlObject
176 class SHIBSP_DLLLOCAL ADFSLogoutInitiator : public AbstractHandler, public RemotedHandler
179 ADFSLogoutInitiator(const DOMElement* e, const char* appId)
180 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".LogoutInitiator.ADFS")), m_appId(appId), m_binding(WSFED_NS) {
181 // If Location isn't set, defer address registration until the setParent call.
182 pair<bool,const char*> loc = getString("Location");
184 string address = m_appId + loc.second + "::run::ADFSLI";
185 setAddress(address.c_str());
188 virtual ~ADFSLogoutInitiator() {}
190 void setParent(const PropertySet* parent) {
191 DOMPropertySet::setParent(parent);
192 pair<bool,const char*> loc = getString("Location");
194 string address = m_appId + loc.second + "::run::ADFSLI";
195 setAddress(address.c_str());
198 m_log.warn("no Location property in ADFS LogoutInitiator (or parent), can't register as remoted handler");
202 void receive(DDF& in, ostream& out);
203 pair<bool,long> run(SPRequest& request, bool isHandler=true) const;
206 const char* getType() const {
207 return "LogoutInitiator";
212 pair<bool,long> doRequest(const Application& application, const char* entityID, HTTPResponse& httpResponse) const;
215 auto_ptr_XMLCh m_binding;
218 class SHIBSP_DLLLOCAL ADFSLogout : public AbstractHandler, public LogoutHandler
221 ADFSLogout(const DOMElement* e, const char* appId)
222 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".Logout.ADFS")), m_login(e, appId) {
225 m_preserve.push_back("wreply");
226 string address = string(appId) + getString("Location").second + "::run::ADFSLO";
227 setAddress(address.c_str());
230 virtual ~ADFSLogout() {}
232 pair<bool,long> run(SPRequest& request, bool isHandler=true) const;
235 void generateMetadata(SPSSODescriptor& role, const char* handlerURL) const {
236 m_login.generateMetadata(role, handlerURL);
237 const char* loc = getString("Location").second;
238 string hurl(handlerURL);
242 auto_ptr_XMLCh widen(hurl.c_str());
243 SingleLogoutService* ep = SingleLogoutServiceBuilder::buildSingleLogoutService();
244 ep->setLocation(widen.get());
245 ep->setBinding(m_login.m_protocol.get());
246 role.getSingleLogoutServices().push_back(ep);
249 const char* getType() const {
250 return m_login.getType();
255 ADFSConsumer m_login;
258 #if defined (_MSC_VER)
259 #pragma warning( pop )
262 SessionInitiator* ADFSSessionInitiatorFactory(const pair<const DOMElement*,const char*>& p)
264 return new ADFSSessionInitiator(p.first, p.second);
267 Handler* ADFSLogoutFactory(const pair<const DOMElement*,const char*>& p)
269 return new ADFSLogout(p.first, p.second);
272 Handler* ADFSLogoutInitiatorFactory(const pair<const DOMElement*,const char*>& p)
274 return new ADFSLogoutInitiator(p.first, p.second);
277 const XMLCh RequestedSecurityToken[] = UNICODE_LITERAL_22(R,e,q,u,e,s,t,e,d,S,e,c,u,r,i,t,y,T,o,k,e,n);
278 const XMLCh RequestSecurityTokenResponse[] =UNICODE_LITERAL_28(R,e,q,u,e,s,t,S,e,c,u,r,i,t,y,T,o,k,e,n,R,e,s,p,o,n,s,e);
281 extern "C" int ADFS_EXPORTS xmltooling_extension_init(void*)
283 SPConfig& conf=SPConfig::getConfig();
284 conf.SessionInitiatorManager.registerFactory("ADFS", ADFSSessionInitiatorFactory);
285 conf.LogoutInitiatorManager.registerFactory("ADFS", ADFSLogoutInitiatorFactory);
286 conf.AssertionConsumerServiceManager.registerFactory("ADFS", ADFSLogoutFactory);
287 conf.AssertionConsumerServiceManager.registerFactory(WSFED_NS, ADFSLogoutFactory);
289 SAMLConfig::getConfig().MessageDecoderManager.registerFactory(WSFED_NS, ADFSDecoderFactory);
290 XMLObjectBuilder::registerBuilder(QName(WSTRUST_NS,"RequestedSecurityToken"), new AnyElementBuilder());
291 XMLObjectBuilder::registerBuilder(QName(WSTRUST_NS,"RequestSecurityTokenResponse"), new AnyElementBuilder());
296 extern "C" void ADFS_EXPORTS xmltooling_extension_term()
298 /* should get unregistered during normal shutdown...
299 SPConfig& conf=SPConfig::getConfig();
300 conf.SessionInitiatorManager.deregisterFactory("ADFS");
301 conf.LogoutInitiatorManager.deregisterFactory("ADFS");
302 conf.AssertionConsumerServiceManager.deregisterFactory("ADFS");
303 conf.AssertionConsumerServiceManager.deregisterFactory(WSFED_NS);
305 SAMLConfig::getConfig().MessageDecoderManager.deregisterFactory(WSFED_NS);
310 pair<bool,long> ADFSSessionInitiator::run(SPRequest& request, const char* entityID, bool isHandler) const
312 // We have to know the IdP to function.
313 if (!entityID || !*entityID)
314 return make_pair(false,0L);
317 const Handler* ACS=NULL;
319 const Application& app=request.getApplication();
322 option = request.getParameter("target");
326 // Since we're passing the ACS by value, we need to compute the return URL,
327 // so we'll need the target resource for real.
328 recoverRelayState(request.getApplication(), request, request, target, false);
331 // We're running as a "virtual handler" from within the filter.
332 // The target resource is the current one and everything else is defaulted.
333 target=request.getRequestURL();
336 // Since we're not passing by index, we need to fully compute the return URL.
337 // Get all the ADFS endpoints.
338 const vector<const Handler*>& handlers = app.getAssertionConsumerServicesByBinding(m_binding.get());
340 // Index comes from request, or default set in the handler, or we just pick the first endpoint.
341 pair<bool,unsigned int> index(false,0);
343 option = request.getParameter("acsIndex");
345 index = pair<bool,unsigned int>(true, atoi(option));
348 index = getUnsignedInt("defaultACSIndex");
350 for (vector<const Handler*>::const_iterator h = handlers.begin(); !ACS && h!=handlers.end(); ++h) {
351 if (index.second == (*h)->getUnsignedInt("index").second)
355 else if (!handlers.empty()) {
356 ACS = handlers.front();
359 throw ConfigurationException("Unable to locate ADFS response endpoint.");
361 // Compute the ACS URL. We add the ACS location to the base handlerURL.
362 string ACSloc=request.getHandlerURL(target.c_str());
363 pair<bool,const char*> loc=ACS ? ACS->getString("Location") : pair<bool,const char*>(false,NULL);
364 if (loc.first) ACSloc+=loc.second;
367 // We may already have RelayState set if we looped back here,
368 // but just in case target is a resource, we reset it back.
370 option = request.getParameter("target");
375 m_log.debug("attempting to initiate session using ADFS with provider (%s)", entityID);
377 if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess))
378 return doRequest(app, request, entityID, ACSloc.c_str(), target);
381 DDF out,in = DDF(m_address.c_str()).structure();
382 DDFJanitor jin(in), jout(out);
383 in.addmember("application_id").string(app.getId());
384 in.addmember("entity_id").string(entityID);
385 in.addmember("acsLocation").string(ACSloc.c_str());
387 in.addmember("RelayState").string(target.c_str());
389 // Remote the processing.
390 out = request.getServiceProvider().getListenerService()->send(in);
391 return unwrap(request, out);
394 void ADFSSessionInitiator::receive(DDF& in, ostream& out)
397 const char* aid=in["application_id"].string();
398 const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : NULL;
400 // Something's horribly wrong.
401 m_log.error("couldn't find application (%s) to generate ADFS request", aid ? aid : "(missing)");
402 throw ConfigurationException("Unable to locate application for new session, deleted?");
405 const char* entityID = in["entity_id"].string();
406 const char* acsLocation = in["acsLocation"].string();
407 if (!entityID || !acsLocation)
408 throw ConfigurationException("No entityID or acsLocation parameter supplied to remoted SessionInitiator.");
411 DDFJanitor jout(ret);
413 // Wrap the outgoing object with a Response facade.
414 auto_ptr<HTTPResponse> http(getResponse(ret));
416 string relayState(in["RelayState"].string() ? in["RelayState"].string() : "");
418 // Since we're remoted, the result should either be a throw, which we pass on,
419 // a false/0 return, which we just return as an empty structure, or a response/redirect,
420 // which we capture in the facade and send back.
421 doRequest(*app, *http.get(), entityID, acsLocation, relayState);
425 pair<bool,long> ADFSSessionInitiator::doRequest(
426 const Application& app,
427 HTTPResponse& httpResponse,
428 const char* entityID,
429 const char* acsLocation,
434 // Use metadata to invoke the SSO service directly.
435 MetadataProvider* m=app.getMetadataProvider();
437 MetadataProvider::Criteria mc(entityID, &IDPSSODescriptor::ELEMENT_QNAME, m_binding.get());
438 pair<const EntityDescriptor*,const RoleDescriptor*> entity=m->getEntityDescriptor(mc);
440 m_log.error("unable to locate metadata for provider (%s)", entityID);
441 throw MetadataException("Unable to locate metadata for identity provider ($entityID)", namedparams(1, "entityID", entityID));
443 else if (!entity.second) {
444 m_log.error("unable to locate ADFS-aware identity provider role for provider (%s)", entityID);
445 return make_pair(false,0L);
447 const EndpointType* ep = EndpointManager<SingleSignOnService>(
448 dynamic_cast<const IDPSSODescriptor*>(entity.second)->getSingleSignOnServices()
449 ).getByBinding(m_binding.get());
451 m_log.error("unable to locate compatible SSO service for provider (%s)", entityID);
452 return make_pair(false,0L);
455 preserveRelayState(app, httpResponse, relayState);
458 time_t epoch=time(NULL);
459 #ifndef HAVE_GMTIME_R
460 struct tm* ptime=gmtime(&epoch);
463 struct tm* ptime=gmtime_r(&epoch,&res);
466 strftime(timebuf,32,"%Y-%m-%dT%H:%M:%SZ",ptime);
468 auto_ptr_char dest(ep->getLocation());
469 const URLEncoder* urlenc = XMLToolingConfig::getConfig().getURLEncoder();
471 string req=string(dest.get()) + (strchr(dest.get(),'?') ? '&' : '?') + "wa=wsignin1.0&wreply=" + urlenc->encode(acsLocation) +
472 "&wct=" + urlenc->encode(timebuf) + "&wtrealm=" + urlenc->encode(app.getString("entityID").second);
473 if (!relayState.empty())
474 req += "&wctx=" + urlenc->encode(relayState.c_str());
476 return make_pair(true, httpResponse.sendRedirect(req.c_str()));
478 return make_pair(false,0L);
484 XMLObject* ADFSDecoder::decode(string& relayState, const GenericRequest& genericRequest, SecurityPolicy& policy) const
487 xmltooling::NDC ndc("decode");
489 Category& log = Category::getInstance(SHIBSP_LOGCAT".MessageDecoder.ADFS");
491 log.debug("validating input");
492 const HTTPRequest* httpRequest=dynamic_cast<const HTTPRequest*>(&genericRequest);
494 throw BindingException("Unable to cast request object to HTTPRequest type.");
495 if (strcmp(httpRequest->getMethod(),"POST"))
496 throw BindingException("Invalid HTTP method ($1).", params(1, httpRequest->getMethod()));
497 const char* param = httpRequest->getParameter("wa");
498 if (!param || strcmp(param, "wsignin1.0"))
499 throw BindingException("Missing or invalid wa parameter (should be wsignin1.0).");
500 param = httpRequest->getParameter("wctx");
504 param = httpRequest->getParameter("wresult");
506 throw BindingException("Request missing wresult parameter.");
508 log.debug("decoded ADFS response:\n%s", param);
510 // Parse and bind the document into an XMLObject.
511 istringstream is(param);
512 DOMDocument* doc = (policy.getValidating() ? XMLToolingConfig::getConfig().getValidatingParser()
513 : XMLToolingConfig::getConfig().getParser()).parse(is);
514 XercesJanitor<DOMDocument> janitor(doc);
515 auto_ptr<XMLObject> xmlObject(XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true));
518 if (!XMLHelper::isNodeNamed(xmlObject->getDOM(), m_ns.get(), RequestSecurityTokenResponse))
519 throw BindingException("Decoded message was not of the appropriate type.");
521 if (!policy.getValidating())
522 SchemaValidators.validate(xmlObject.get());
524 // Skip policy step here, there's no security in the wrapper.
525 // policy.evaluate(*xmlObject.get(), &genericRequest);
527 return xmlObject.release();
530 void ADFSConsumer::implementProtocol(
531 const Application& application,
532 const HTTPRequest& httpRequest,
533 HTTPResponse& httpResponse,
534 SecurityPolicy& policy,
535 const PropertySet* settings,
536 const XMLObject& xmlObject
539 // Implementation of ADFS profile.
540 m_log.debug("processing message against ADFS Passive Requester profile");
542 // With ADFS, all the security comes from the assertion, which is two levels down in the message.
544 const ElementProxy* response = dynamic_cast<const ElementProxy*>(&xmlObject);
545 if (!response || !response->hasChildren())
546 throw FatalProfileException("Incoming message was not of the proper type or contains no security token.");
547 response = dynamic_cast<const ElementProxy*>(response->getUnknownXMLObjects().front());
548 if (!response || !response->hasChildren())
549 throw FatalProfileException("Token wrapper element did not contain a security token.");
550 const saml1::Assertion* token = dynamic_cast<const saml1::Assertion*>(response->getUnknownXMLObjects().front());
551 if (!token || !token->getSignature())
552 throw FatalProfileException("Incoming message did not contain a signed SAML 1.1 assertion.");
554 // Extract message and issuer details from assertion.
555 extractMessageDetails(*token, m_protocol.get(), policy);
557 // Run the policy over the assertion. Handles replay, freshness, and
558 // signature verification, assuming the relevant rules are configured.
559 policy.evaluate(*token);
561 // If no security is in place now, we kick it.
562 if (!policy.isAuthenticated())
563 throw SecurityPolicyException("Unable to establish security of incoming assertion.");
565 // Now do profile and core semantic validation to ensure we can use it for SSO.
566 // Profile validator.
567 time_t now = time(NULL);
568 saml1::AssertionValidator ssoValidator(application.getAudiences(), now);
569 ssoValidator.validateAssertion(*token);
570 if (!token->getConditions() || !token->getConditions()->getNotBefore() || !token->getConditions()->getNotOnOrAfter())
571 throw FatalProfileException("Assertion did not contain time conditions.");
572 else if (token->getAuthenticationStatements().empty())
573 throw FatalProfileException("Assertion did not contain an authentication statement.");
576 // With ADFS, we only have one token, but we need to put it in a vector.
577 vector<const Assertion*> tokens(1,token);
578 const saml1::AuthenticationStatement* ssoStatement=token->getAuthenticationStatements().front();
580 // authnskew allows rejection of SSO if AuthnInstant is too old.
581 const PropertySet* sessionProps = application.getPropertySet("Sessions");
582 pair<bool,unsigned int> authnskew = sessionProps ? sessionProps->getUnsignedInt("authnskew") : pair<bool,unsigned int>(false,0);
584 if (authnskew.first && authnskew.second &&
585 ssoStatement->getAuthenticationInstant() && (now - ssoStatement->getAuthenticationInstantEpoch() > authnskew.second))
586 throw FatalProfileException("The gap between now and the time you logged into your identity provider exceeds the limit.");
589 saml1::SubjectLocality* locality = ssoStatement->getSubjectLocality();
590 if (locality && locality->getIPAddress()) {
591 auto_ptr_char ip(locality->getIPAddress());
592 checkAddress(application, httpRequest, ip.get());
595 m_log.debug("ADFS profile processing completed successfully");
597 saml1::NameIdentifier* n = ssoStatement->getSubject()->getNameIdentifier();
599 // Now we have to extract the authentication details for attribute and session setup.
601 // Session expiration for ADFS is purely SP-driven, and the method is mapped to a ctx class.
602 pair<bool,unsigned int> lifetime = sessionProps ? sessionProps->getUnsignedInt("lifetime") : pair<bool,unsigned int>(true,28800);
603 if (!lifetime.first || lifetime.second == 0)
604 lifetime.second = 28800;
606 // We've successfully "accepted" the SSO token.
607 // To complete processing, we need to extract and resolve attributes and then create the session.
609 // Normalize the SAML 1.x NameIdentifier...
610 auto_ptr<saml2::NameID> nameid(n ? saml2::NameIDBuilder::buildNameID() : NULL);
612 nameid->setName(n->getName());
613 nameid->setFormat(n->getFormat());
614 nameid->setNameQualifier(n->getNameQualifier());
617 // The context will handle deleting attributes and new tokens.
618 auto_ptr<ResolutionContext> ctx(
621 policy.getIssuerMetadata(),
625 ssoStatement->getAuthenticationMethod(),
632 // Copy over any new tokens, but leave them in the context for cleanup.
633 tokens.insert(tokens.end(), ctx->getResolvedAssertions().begin(), ctx->getResolvedAssertions().end());
636 application.getServiceProvider().getSessionCache()->insert(
640 now + lifetime.second,
641 policy.getIssuerMetadata() ? dynamic_cast<const EntityDescriptor*>(policy.getIssuerMetadata()->getParent()) : NULL,
644 ssoStatement->getAuthenticationInstant() ? ssoStatement->getAuthenticationInstant()->getRawData() : NULL,
646 ssoStatement->getAuthenticationMethod(),
649 ctx.get() ? &ctx->getResolvedAttributes() : NULL
655 pair<bool,long> ADFSLogoutInitiator::run(SPRequest& request, bool isHandler) const
657 // Normally we'd do notifications and session clearage here, but ADFS logout
658 // is missing the needed request/response features, so we have to rely on
659 // the IdP half to notify us back about the logout and do the work there.
660 // Basically we have no way to tell in the Logout receiving handler whether
661 // we initiated the logout or not.
663 Session* session = NULL;
665 session = request.getSession(false, true, false); // don't cache it and ignore all checks
667 return make_pair(false,0L);
669 // We only handle ADFS sessions.
670 if (!XMLString::equals(session->getProtocol(), WSFED_NS) || !session->getEntityID()) {
672 return make_pair(false,0L);
675 catch (exception& ex) {
676 m_log.error("error accessing current session: %s", ex.what());
677 return make_pair(false,0L);
680 string entityID(session->getEntityID());
683 if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
684 // When out of process, we run natively.
685 return doRequest(request.getApplication(), entityID.c_str(), request);
688 // When not out of process, we remote the request.
689 Locker locker(session, false);
690 DDF out,in(m_address.c_str());
691 DDFJanitor jin(in), jout(out);
692 in.addmember("application_id").string(request.getApplication().getId());
693 in.addmember("entity_id").string(entityID.c_str());
694 out=request.getServiceProvider().getListenerService()->send(in);
695 return unwrap(request, out);
699 void ADFSLogoutInitiator::receive(DDF& in, ostream& out)
703 const char* aid=in["application_id"].string();
704 const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : NULL;
706 // Something's horribly wrong.
707 m_log.error("couldn't find application (%s) for logout", aid ? aid : "(missing)");
708 throw ConfigurationException("Unable to locate application for logout, deleted?");
711 // Set up a response shim.
713 DDFJanitor jout(ret);
714 auto_ptr<HTTPResponse> resp(getResponse(ret));
716 // Since we're remoted, the result should either be a throw, which we pass on,
717 // a false/0 return, which we just return as an empty structure, or a response/redirect,
718 // which we capture in the facade and send back.
719 doRequest(*app, in["entity_id"].string(), *resp.get());
723 throw ConfigurationException("Cannot perform logout using lite version of shibsp library.");
727 pair<bool,long> ADFSLogoutInitiator::doRequest(const Application& application, const char* entityID, HTTPResponse& response) const
732 throw ConfigurationException("Missing entityID parameter.");
734 // With a session in hand, we can create a request message, if we can find a compatible endpoint.
735 MetadataProvider* m=application.getMetadataProvider();
737 MetadataProvider::Criteria mc(entityID, &IDPSSODescriptor::ELEMENT_QNAME, m_binding.get());
738 pair<const EntityDescriptor*,const RoleDescriptor*> entity=m->getEntityDescriptor(mc);
740 throw MetadataException("Unable to locate metadata for identity provider ($entityID)", namedparams(1, "entityID", entityID));
741 else if (!entity.second)
742 throw MetadataException("Unable to locate ADFS IdP role for identity provider ($entityID).", namedparams(1, "entityID", entityID));
744 const EndpointType* ep = EndpointManager<SingleLogoutService>(
745 dynamic_cast<const IDPSSODescriptor*>(entity.second)->getSingleLogoutServices()
746 ).getByBinding(m_binding.get());
748 throw MetadataException(
749 "Unable to locate ADFS single logout service for identity provider ($entityID).",
750 namedparams(1, "entityID", entityID)
754 auto_ptr_char dest(ep->getLocation());
756 string req=string(dest.get()) + (strchr(dest.get(),'?') ? '&' : '?') + "wa=wsignout1.0";
757 return make_pair(true,response.sendRedirect(req.c_str()));
759 catch (exception& ex) {
760 m_log.error("error issuing ADFS logout request: %s", ex.what());
763 return make_pair(false,0L);
765 throw ConfigurationException("Cannot perform logout using lite version of shibsp library.");
769 pair<bool,long> ADFSLogout::run(SPRequest& request, bool isHandler) const
771 // Defer to base class for front-channel loop first.
772 // This won't initiate the loop, only continue/end it.
773 pair<bool,long> ret = LogoutHandler::run(request, isHandler);
777 // wa parameter indicates the "action" to perform
778 bool returning = false;
779 const char* param = request.getParameter("wa");
781 if (!strcmp(param, "wsignin1.0"))
782 return m_login.run(request, isHandler);
783 else if (strcmp(param, "wsignout1.0") && strcmp(param, "wsignoutcleanup1.0"))
784 throw FatalProfileException("Unsupported WS-Federation action paremeter ($1).", params(1, param));
786 else if (strcmp(request.getMethod(),"GET") || !request.getParameter("notifying"))
787 throw FatalProfileException("Unsupported request to ADFS protocol endpoint.");
791 param = request.getParameter("wreply");
792 const Application& app = request.getApplication();
795 // Pass control to the first front channel notification point, if any.
796 map<string,string> parammap;
798 parammap["wreply"] = param;
799 pair<bool,long> result = notifyFrontChannel(app, request, request, ¶mmap);
804 // Best effort on back channel and to remove the user agent's session.
805 string session_id = app.getServiceProvider().getSessionCache()->active(app, request);
806 if (!session_id.empty()) {
807 vector<string> sessions(1,session_id);
808 notifyBackChannel(app, request.getRequestURL(), sessions, false);
810 app.getServiceProvider().getSessionCache()->remove(app, request, &request);
812 catch (exception& ex) {
813 m_log.error("error removing session (%s): %s", session_id.c_str(), ex.what());
818 return make_pair(true, request.sendRedirect(param));
819 return sendLogoutPage(app, request, false, "Logout complete.");