2 * Copyright 2001-2010 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/SPRequest.h>
44 #include <shibsp/handler/AssertionConsumerService.h>
45 #include <shibsp/handler/LogoutInitiator.h>
46 #include <shibsp/handler/SessionInitiator.h>
47 #include <xmltooling/logging.h>
48 #include <xmltooling/util/DateTime.h>
49 #include <xmltooling/util/NDC.h>
50 #include <xmltooling/util/URLEncoder.h>
51 #include <xmltooling/util/XMLHelper.h>
55 # include <shibsp/attribute/resolver/ResolutionContext.h>
56 # include <shibsp/metadata/MetadataProviderCriteria.h>
57 # include <saml/SAMLConfig.h>
58 # include <saml/exceptions.h>
59 # include <saml/binding/SecurityPolicy.h>
60 # include <saml/saml1/core/Assertions.h>
61 # include <saml/saml2/core/Assertions.h>
62 # include <saml/saml2/metadata/Metadata.h>
63 # include <saml/saml2/metadata/EndpointManager.h>
64 # include <xmltooling/XMLToolingConfig.h>
65 # include <xmltooling/impl/AnyElement.h>
66 # include <xmltooling/util/ParserPool.h>
67 # include <xmltooling/validation/ValidatorSuite.h>
68 using namespace opensaml::saml2md;
70 # define min(a,b) (((a) < (b)) ? (a) : (b))
73 using namespace shibsp;
74 using namespace opensaml;
75 using namespace xmltooling::logging;
76 using namespace xmltooling;
77 using namespace xercesc;
80 #define WSFED_NS "http://schemas.xmlsoap.org/ws/2003/07/secext"
81 #define WSTRUST_NS "http://schemas.xmlsoap.org/ws/2005/02/trust"
86 class SHIBSP_DLLLOCAL ADFSDecoder : public MessageDecoder
90 ADFSDecoder() : m_ns(WSTRUST_NS) {}
91 virtual ~ADFSDecoder() {}
93 const XMLCh* getProtocolFamily() const {
97 XMLObject* decode(string& relayState, const GenericRequest& genericRequest, SecurityPolicy& policy) const;
100 void extractMessageDetails(
101 const XMLObject& message, const GenericRequest& req, const XMLCh* protocol, SecurityPolicy& policy
106 MessageDecoder* ADFSDecoderFactory(const pair<const DOMElement*,const XMLCh*>& p)
108 return new ADFSDecoder();
112 #if defined (_MSC_VER)
113 #pragma warning( push )
114 #pragma warning( disable : 4250 )
117 class SHIBSP_DLLLOCAL ADFSSessionInitiator : public SessionInitiator, public AbstractHandler, public RemotedHandler
120 ADFSSessionInitiator(const DOMElement* e, const char* appId)
121 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".SessionInitiator.ADFS"), nullptr, &m_remapper), m_appId(appId), m_binding(WSFED_NS) {
122 // If Location isn't set, defer address registration until the setParent call.
123 pair<bool,const char*> loc = getString("Location");
125 string address = m_appId + loc.second + "::run::ADFSSI";
126 setAddress(address.c_str());
129 virtual ~ADFSSessionInitiator() {}
131 void setParent(const PropertySet* parent) {
132 DOMPropertySet::setParent(parent);
133 pair<bool,const char*> loc = getString("Location");
135 string address = m_appId + loc.second + "::run::ADFSSI";
136 setAddress(address.c_str());
139 m_log.warn("no Location property in ADFS SessionInitiator (or parent), can't register as remoted handler");
143 void receive(DDF& in, ostream& out);
144 pair<bool,long> unwrap(SPRequest& request, DDF& out) const;
145 pair<bool,long> run(SPRequest& request, string& entityID, bool isHandler=true) const;
147 const XMLCh* getProtocolFamily() const {
148 return m_binding.get();
152 pair<bool,long> doRequest(
153 const Application& application,
154 const HTTPRequest* httpRequest,
155 HTTPResponse& httpResponse,
156 const char* entityID,
157 const char* acsLocation,
158 const char* authnContextClassRef,
162 auto_ptr_XMLCh m_binding;
165 class SHIBSP_DLLLOCAL ADFSConsumer : public shibsp::AssertionConsumerService
167 auto_ptr_XMLCh m_protocol;
169 ADFSConsumer(const DOMElement* e, const char* appId)
170 : shibsp::AssertionConsumerService(e, appId, Category::getInstance(SHIBSP_LOGCAT".SSO.ADFS")), m_protocol(WSFED_NS) {}
171 virtual ~ADFSConsumer() {}
174 void generateMetadata(SPSSODescriptor& role, const char* handlerURL) const {
175 AssertionConsumerService::generateMetadata(role, handlerURL);
176 role.addSupport(m_protocol.get());
180 void implementProtocol(
181 const Application& application,
182 const HTTPRequest& httpRequest,
183 HTTPResponse& httpResponse,
184 SecurityPolicy& policy,
186 const XMLObject& xmlObject
189 const XMLCh* getProtocolFamily() const {
190 return m_protocol.get();
195 class SHIBSP_DLLLOCAL ADFSLogoutInitiator : public AbstractHandler, public LogoutInitiator
198 ADFSLogoutInitiator(const DOMElement* e, const char* appId)
199 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".LogoutInitiator.ADFS")), m_appId(appId), m_binding(WSFED_NS) {
200 // If Location isn't set, defer address registration until the setParent call.
201 pair<bool,const char*> loc = getString("Location");
203 string address = m_appId + loc.second + "::run::ADFSLI";
204 setAddress(address.c_str());
207 virtual ~ADFSLogoutInitiator() {}
209 void setParent(const PropertySet* parent) {
210 DOMPropertySet::setParent(parent);
211 pair<bool,const char*> loc = getString("Location");
213 string address = m_appId + loc.second + "::run::ADFSLI";
214 setAddress(address.c_str());
217 m_log.warn("no Location property in ADFS LogoutInitiator (or parent), can't register as remoted handler");
221 void receive(DDF& in, ostream& out);
222 pair<bool,long> run(SPRequest& request, bool isHandler=true) const;
224 const XMLCh* getProtocolFamily() const {
225 return m_binding.get();
229 pair<bool,long> doRequest(const Application& application, const HTTPRequest& httpRequest, HTTPResponse& httpResponse, Session* session) const;
232 auto_ptr_XMLCh m_binding;
235 class SHIBSP_DLLLOCAL ADFSLogout : public AbstractHandler, public LogoutHandler
238 ADFSLogout(const DOMElement* e, const char* appId)
239 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".Logout.ADFS")), m_login(e, appId) {
242 m_preserve.push_back("wreply");
243 string address = string(appId) + getString("Location").second + "::run::ADFSLO";
244 setAddress(address.c_str());
247 virtual ~ADFSLogout() {}
249 pair<bool,long> run(SPRequest& request, bool isHandler=true) const;
252 void generateMetadata(SPSSODescriptor& role, const char* handlerURL) const {
253 m_login.generateMetadata(role, handlerURL);
254 const char* loc = getString("Location").second;
255 string hurl(handlerURL);
259 auto_ptr_XMLCh widen(hurl.c_str());
260 SingleLogoutService* ep = SingleLogoutServiceBuilder::buildSingleLogoutService();
261 ep->setLocation(widen.get());
262 ep->setBinding(m_login.getProtocolFamily());
263 role.getSingleLogoutServices().push_back(ep);
266 const char* getType() const {
267 return m_login.getType();
270 const XMLCh* getProtocolFamily() const {
271 return m_login.getProtocolFamily();
275 ADFSConsumer m_login;
278 #if defined (_MSC_VER)
279 #pragma warning( pop )
282 SessionInitiator* ADFSSessionInitiatorFactory(const pair<const DOMElement*,const char*>& p)
284 return new ADFSSessionInitiator(p.first, p.second);
287 Handler* ADFSLogoutFactory(const pair<const DOMElement*,const char*>& p)
289 return new ADFSLogout(p.first, p.second);
292 Handler* ADFSLogoutInitiatorFactory(const pair<const DOMElement*,const char*>& p)
294 return new ADFSLogoutInitiator(p.first, p.second);
297 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);
298 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);
301 extern "C" int ADFS_EXPORTS xmltooling_extension_init(void*)
303 SPConfig& conf=SPConfig::getConfig();
304 conf.SessionInitiatorManager.registerFactory("ADFS", ADFSSessionInitiatorFactory);
305 conf.LogoutInitiatorManager.registerFactory("ADFS", ADFSLogoutInitiatorFactory);
306 conf.AssertionConsumerServiceManager.registerFactory("ADFS", ADFSLogoutFactory);
307 conf.AssertionConsumerServiceManager.registerFactory(WSFED_NS, ADFSLogoutFactory);
309 SAMLConfig::getConfig().MessageDecoderManager.registerFactory(WSFED_NS, ADFSDecoderFactory);
310 XMLObjectBuilder::registerBuilder(xmltooling::QName(WSTRUST_NS,"RequestedSecurityToken"), new AnyElementBuilder());
311 XMLObjectBuilder::registerBuilder(xmltooling::QName(WSTRUST_NS,"RequestSecurityTokenResponse"), new AnyElementBuilder());
316 extern "C" void ADFS_EXPORTS xmltooling_extension_term()
318 /* should get unregistered during normal shutdown...
319 SPConfig& conf=SPConfig::getConfig();
320 conf.SessionInitiatorManager.deregisterFactory("ADFS");
321 conf.LogoutInitiatorManager.deregisterFactory("ADFS");
322 conf.AssertionConsumerServiceManager.deregisterFactory("ADFS");
323 conf.AssertionConsumerServiceManager.deregisterFactory(WSFED_NS);
325 SAMLConfig::getConfig().MessageDecoderManager.deregisterFactory(WSFED_NS);
330 pair<bool,long> ADFSSessionInitiator::run(SPRequest& request, string& entityID, bool isHandler) const
332 // We have to know the IdP to function.
333 if (entityID.empty() || !checkCompatibility(request, isHandler))
334 return make_pair(false,0L);
337 pair<bool,const char*> prop;
338 pair<bool,const char*> acClass;
339 const Handler* ACS=nullptr;
340 const Application& app=request.getApplication();
343 prop.second = request.getParameter("acsIndex");
344 if (prop.second && *prop.second) {
345 ACS = app.getAssertionConsumerServiceByIndex(atoi(prop.second));
347 request.log(SPRequest::SPWarn, "invalid acsIndex specified in request, using acsIndex property");
350 prop = getString("target", request);
352 target = prop.second;
354 // Since we're passing the ACS by value, we need to compute the return URL,
355 // so we'll need the target resource for real.
356 recoverRelayState(app, request, request, target, false);
358 acClass = getString("authnContextClassRef", request);
361 // Check for a hardwired target value in the map or handler.
362 prop = getString("target", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
364 target = prop.second;
366 target = request.getRequestURL();
368 acClass = getString("authnContextClassRef", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
372 pair<bool,unsigned int> index = getUnsignedInt("acsIndex", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
374 ACS = app.getAssertionConsumerServiceByIndex(index.second);
376 request.log(SPRequest::SPWarn, "invalid acsIndex property, using default ACS location");
379 ACS = app.getAssertionConsumerServiceByBinding(WSFED_NS);
381 m_log.error("unable to locate a compatible ACS");
382 throw ConfigurationException("Unable to locate an ADFS-compatible ACS in the configuration.");
387 // Validate the ACS for use with this protocol.
388 if (!XMLString::equals(getProtocolFamily(), ACS->getProtocolFamily())) {
389 m_log.error("configured or requested ACS has non-ADFS binding");
390 throw ConfigurationException("Configured or requested ACS has non-ADFS binding ($1).", params(1, ACS->getString("Binding").second));
393 // Since we're not passing by index, we need to fully compute the return URL.
394 // Compute the ACS URL. We add the ACS location to the base handlerURL.
395 string ACSloc=request.getHandlerURL(target.c_str());
396 prop = ACS->getString("Location");
398 ACSloc += prop.second;
401 // We may already have RelayState set if we looped back here,
402 // but we've turned it back into a resource by this point, so if there's
403 // a target on the URL, reset to that value.
404 prop.second = request.getParameter("target");
405 if (prop.second && *prop.second)
406 target = prop.second;
409 m_log.debug("attempting to initiate session using ADFS with provider (%s)", entityID.c_str());
411 if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
412 // Out of process means the POST data via the request can be exposed directly to the private method.
413 // The method will handle POST preservation if necessary *before* issuing the response, but only if
414 // it dispatches to an IdP.
415 return doRequest(app, &request, request, entityID.c_str(), ACSloc.c_str(), (acClass.first ? acClass.second : nullptr), target);
419 DDF out,in = DDF(m_address.c_str()).structure();
420 DDFJanitor jin(in), jout(out);
421 in.addmember("application_id").string(app.getId());
422 in.addmember("entity_id").string(entityID.c_str());
423 in.addmember("acsLocation").string(ACSloc.c_str());
425 in.addmember("RelayState").unsafe_string(target.c_str());
427 in.addmember("authnContextClassRef").string(acClass.second);
429 // Remote the processing.
430 out = request.getServiceProvider().getListenerService()->send(in);
431 return unwrap(request, out);
434 pair<bool,long> ADFSSessionInitiator::unwrap(SPRequest& request, DDF& out) const
436 // See if there's any response to send back.
437 if (!out["redirect"].isnull() || !out["response"].isnull()) {
438 // If so, we're responsible for handling the POST data, probably by dropping a cookie.
439 preservePostData(request.getApplication(), request, request, out["RelayState"].string());
441 return RemotedHandler::unwrap(request, out);
444 void ADFSSessionInitiator::receive(DDF& in, ostream& out)
447 const char* aid=in["application_id"].string();
448 const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : nullptr;
450 // Something's horribly wrong.
451 m_log.error("couldn't find application (%s) to generate ADFS request", aid ? aid : "(missing)");
452 throw ConfigurationException("Unable to locate application for new session, deleted?");
455 const char* entityID = in["entity_id"].string();
456 const char* acsLocation = in["acsLocation"].string();
457 if (!entityID || !acsLocation)
458 throw ConfigurationException("No entityID or acsLocation parameter supplied to remoted SessionInitiator.");
461 DDFJanitor jout(ret);
463 // Wrap the outgoing object with a Response facade.
464 auto_ptr<HTTPResponse> http(getResponse(ret));
466 string relayState(in["RelayState"].string() ? in["RelayState"].string() : "");
468 // Since we're remoted, the result should either be a throw, which we pass on,
469 // a false/0 return, which we just return as an empty structure, or a response/redirect,
470 // which we capture in the facade and send back.
471 doRequest(*app, nullptr, *http.get(), entityID, acsLocation, in["authnContextClassRef"].string(), relayState);
474 ret.addmember("RelayState").unsafe_string(relayState.c_str());
478 pair<bool,long> ADFSSessionInitiator::doRequest(
479 const Application& app,
480 const HTTPRequest* httpRequest,
481 HTTPResponse& httpResponse,
482 const char* entityID,
483 const char* acsLocation,
484 const char* authnContextClassRef,
489 // Use metadata to invoke the SSO service directly.
490 MetadataProvider* m=app.getMetadataProvider();
492 MetadataProviderCriteria mc(app, entityID, &IDPSSODescriptor::ELEMENT_QNAME, m_binding.get());
493 pair<const EntityDescriptor*,const RoleDescriptor*> entity=m->getEntityDescriptor(mc);
495 m_log.warn("unable to locate metadata for provider (%s)", entityID);
496 throw MetadataException("Unable to locate metadata for identity provider ($entityID)", namedparams(1, "entityID", entityID));
498 else if (!entity.second) {
499 m_log.log(getParent() ? Priority::INFO : Priority::WARN, "unable to locate ADFS-aware identity provider role for provider (%s)", entityID);
501 return make_pair(false,0L);
502 throw MetadataException("Unable to locate ADFS-aware identity provider role for provider ($entityID)", namedparams(1, "entityID", entityID));
504 const EndpointType* ep = EndpointManager<SingleSignOnService>(
505 dynamic_cast<const IDPSSODescriptor*>(entity.second)->getSingleSignOnServices()
506 ).getByBinding(m_binding.get());
508 m_log.warn("unable to locate compatible SSO service for provider (%s)", entityID);
510 return make_pair(false,0L);
511 throw MetadataException("Unable to locate compatible SSO service for provider ($entityID)", namedparams(1, "entityID", entityID));
514 preserveRelayState(app, httpResponse, relayState);
517 time_t epoch=time(nullptr);
518 #ifndef HAVE_GMTIME_R
519 struct tm* ptime=gmtime(&epoch);
522 struct tm* ptime=gmtime_r(&epoch,&res);
525 strftime(timebuf,32,"%Y-%m-%dT%H:%M:%SZ",ptime);
527 auto_ptr_char dest(ep->getLocation());
528 const URLEncoder* urlenc = XMLToolingConfig::getConfig().getURLEncoder();
530 string req=string(dest.get()) + (strchr(dest.get(),'?') ? '&' : '?') + "wa=wsignin1.0&wreply=" + urlenc->encode(acsLocation) +
531 "&wct=" + urlenc->encode(timebuf) + "&wtrealm=" + urlenc->encode(app.getString("entityID").second);
532 if (authnContextClassRef)
533 req += "&wauth=" + urlenc->encode(authnContextClassRef);
534 if (!relayState.empty())
535 req += "&wctx=" + urlenc->encode(relayState.c_str());
538 // If the request object is available, we're responsible for the POST data.
539 preservePostData(app, *httpRequest, httpResponse, relayState.c_str());
542 return make_pair(true, httpResponse.sendRedirect(req.c_str()));
544 return make_pair(false,0L);
550 XMLObject* ADFSDecoder::decode(string& relayState, const GenericRequest& genericRequest, SecurityPolicy& policy) const
553 xmltooling::NDC ndc("decode");
555 Category& log = Category::getInstance(SHIBSP_LOGCAT".MessageDecoder.ADFS");
557 log.debug("validating input");
558 const HTTPRequest* httpRequest=dynamic_cast<const HTTPRequest*>(&genericRequest);
560 throw BindingException("Unable to cast request object to HTTPRequest type.");
561 if (strcmp(httpRequest->getMethod(),"POST"))
562 throw BindingException("Invalid HTTP method ($1).", params(1, httpRequest->getMethod()));
563 const char* param = httpRequest->getParameter("wa");
564 if (!param || strcmp(param, "wsignin1.0"))
565 throw BindingException("Missing or invalid wa parameter (should be wsignin1.0).");
566 param = httpRequest->getParameter("wctx");
570 param = httpRequest->getParameter("wresult");
572 throw BindingException("Request missing wresult parameter.");
574 log.debug("decoded ADFS response:\n%s", param);
576 // Parse and bind the document into an XMLObject.
577 istringstream is(param);
578 DOMDocument* doc = (policy.getValidating() ? XMLToolingConfig::getConfig().getValidatingParser()
579 : XMLToolingConfig::getConfig().getParser()).parse(is);
580 XercesJanitor<DOMDocument> janitor(doc);
581 auto_ptr<XMLObject> xmlObject(XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true));
584 if (!XMLString::equals(xmlObject->getElementQName().getLocalPart(), RequestSecurityTokenResponse)) {
585 log.error("unrecognized root element on message: %s", xmlObject->getElementQName().toString().c_str());
586 throw BindingException("Decoded message was not of the appropriate type.");
589 SchemaValidators.validate(xmlObject.get());
591 // Skip policy step here, there's no security in the wrapper.
592 // policy.evaluate(*xmlObject.get(), &genericRequest);
594 return xmlObject.release();
597 void ADFSConsumer::implementProtocol(
598 const Application& application,
599 const HTTPRequest& httpRequest,
600 HTTPResponse& httpResponse,
601 SecurityPolicy& policy,
603 const XMLObject& xmlObject
606 // Implementation of ADFS profile.
607 m_log.debug("processing message against ADFS Passive Requester profile");
609 // With ADFS, all the security comes from the assertion, which is two levels down in the message.
611 const ElementProxy* response = dynamic_cast<const ElementProxy*>(&xmlObject);
612 if (!response || !response->hasChildren())
613 throw FatalProfileException("Incoming message was not of the proper type or contains no security token.");
615 const Assertion* token = nullptr;
616 for (vector<XMLObject*>::const_iterator xo = response->getUnknownXMLObjects().begin(); xo != response->getUnknownXMLObjects().end(); ++xo) {
617 // Look for the RequestedSecurityToken element.
618 if (XMLString::equals((*xo)->getElementQName().getLocalPart(), RequestedSecurityToken)) {
619 response = dynamic_cast<const ElementProxy*>(*xo);
620 if (!response || !response->hasChildren())
621 throw FatalProfileException("Token wrapper element did not contain a security token.");
622 token = dynamic_cast<const Assertion*>(response->getUnknownXMLObjects().front());
623 if (!token || !token->getSignature())
624 throw FatalProfileException("Incoming message did not contain a signed SAML assertion.");
629 // Extract message and issuer details from assertion.
630 extractMessageDetails(*token, m_protocol.get(), policy);
632 // Populate recipient as audience.
633 const EntityDescriptor* entity = policy.getIssuerMetadata() ? dynamic_cast<const EntityDescriptor*>(policy.getIssuerMetadata()->getParent()) : nullptr;
634 policy.getAudiences().push_back(application.getRelyingParty(entity)->getXMLString("entityID").second);
636 // Run the policy over the assertion. Handles replay, freshness, and
637 // signature verification, assuming the relevant rules are configured,
638 // along with condition enforcement.
639 policy.evaluate(*token, &httpRequest);
641 // If no security is in place now, we kick it.
642 if (!policy.isAuthenticated())
643 throw SecurityPolicyException("Unable to establish security of incoming assertion.");
645 saml1::NameIdentifier* saml1name=nullptr;
646 saml2::NameID* saml2name=nullptr;
647 const XMLCh* authMethod=nullptr;
648 const XMLCh* authInstant=nullptr;
649 time_t now = time(nullptr), sessionExp = 0;
650 const PropertySet* sessionProps = application.getPropertySet("Sessions");
652 const saml1::Assertion* saml1token = dynamic_cast<const saml1::Assertion*>(token);
654 // Now do profile validation to ensure we can use it for SSO.
655 if (!saml1token->getConditions() || !saml1token->getConditions()->getNotBefore() || !saml1token->getConditions()->getNotOnOrAfter())
656 throw FatalProfileException("Assertion did not contain time conditions.");
657 else if (saml1token->getAuthenticationStatements().empty())
658 throw FatalProfileException("Assertion did not contain an authentication statement.");
660 // authnskew allows rejection of SSO if AuthnInstant is too old.
661 pair<bool,unsigned int> authnskew = sessionProps ? sessionProps->getUnsignedInt("maxTimeSinceAuthn") : pair<bool,unsigned int>(false,0);
663 const saml1::AuthenticationStatement* ssoStatement=saml1token->getAuthenticationStatements().front();
664 if (authnskew.first && authnskew.second &&
665 ssoStatement->getAuthenticationInstant() && (now - ssoStatement->getAuthenticationInstantEpoch() > authnskew.second))
666 throw FatalProfileException("The gap between now and the time you logged into your identity provider exceeds the limit.");
669 saml1::SubjectLocality* locality = ssoStatement->getSubjectLocality();
670 if (locality && locality->getIPAddress()) {
671 auto_ptr_char ip(locality->getIPAddress());
672 checkAddress(application, httpRequest, ip.get());
675 saml1name = ssoStatement->getSubject()->getNameIdentifier();
676 authMethod = ssoStatement->getAuthenticationMethod();
677 if (ssoStatement->getAuthenticationInstant())
678 authInstant = ssoStatement->getAuthenticationInstant()->getRawData();
680 // Session expiration.
681 pair<bool,unsigned int> lifetime = sessionProps ? sessionProps->getUnsignedInt("lifetime") : pair<bool,unsigned int>(true,28800);
682 if (!lifetime.first || lifetime.second == 0)
683 lifetime.second = 28800;
684 sessionExp = now + lifetime.second;
687 const saml2::Assertion* saml2token = dynamic_cast<const saml2::Assertion*>(token);
689 throw FatalProfileException("Incoming message did not contain a recognized type of SAML assertion.");
691 // Now do profile validation to ensure we can use it for SSO.
692 if (!saml2token->getConditions() || !saml2token->getConditions()->getNotBefore() || !saml2token->getConditions()->getNotOnOrAfter())
693 throw FatalProfileException("Assertion did not contain time conditions.");
694 else if (saml2token->getAuthnStatements().empty())
695 throw FatalProfileException("Assertion did not contain an authentication statement.");
697 // authnskew allows rejection of SSO if AuthnInstant is too old.
698 pair<bool,unsigned int> authnskew = sessionProps ? sessionProps->getUnsignedInt("maxTimeSinceAuthn") : pair<bool,unsigned int>(false,0);
700 const saml2::AuthnStatement* ssoStatement=saml2token->getAuthnStatements().front();
701 if (authnskew.first && authnskew.second &&
702 ssoStatement->getAuthnInstant() && (now - ssoStatement->getAuthnInstantEpoch() > authnskew.second))
703 throw FatalProfileException("The gap between now and the time you logged into your identity provider exceeds the limit.");
706 saml2::SubjectLocality* locality = ssoStatement->getSubjectLocality();
707 if (locality && locality->getAddress()) {
708 auto_ptr_char ip(locality->getAddress());
709 checkAddress(application, httpRequest, ip.get());
712 saml2name = saml2token->getSubject() ? saml2token->getSubject()->getNameID() : nullptr;
713 if (ssoStatement->getAuthnContext() && ssoStatement->getAuthnContext()->getAuthnContextClassRef())
714 authMethod = ssoStatement->getAuthnContext()->getAuthnContextClassRef()->getReference();
715 if (ssoStatement->getAuthnInstant())
716 authInstant = ssoStatement->getAuthnInstant()->getRawData();
718 // Session expiration for SAML 2.0 is jointly IdP- and SP-driven.
719 sessionExp = ssoStatement->getSessionNotOnOrAfter() ? ssoStatement->getSessionNotOnOrAfterEpoch() : 0;
720 pair<bool,unsigned int> lifetime = sessionProps ? sessionProps->getUnsignedInt("lifetime") : pair<bool,unsigned int>(true,28800);
721 if (!lifetime.first || lifetime.second == 0)
722 lifetime.second = 28800;
724 sessionExp = now + lifetime.second; // IdP says nothing, calulate based on SP.
726 sessionExp = min(sessionExp, now + lifetime.second); // Use the lowest.
729 m_log.debug("ADFS profile processing completed successfully");
731 // We've successfully "accepted" the SSO token.
732 // To complete processing, we need to extract and resolve attributes and then create the session.
734 // Normalize a SAML 1.x NameIdentifier...
735 auto_ptr<saml2::NameID> nameid(saml1name ? saml2::NameIDBuilder::buildNameID() : nullptr);
737 nameid->setName(saml1name->getName());
738 nameid->setFormat(saml1name->getFormat());
739 nameid->setNameQualifier(saml1name->getNameQualifier());
742 // The context will handle deleting attributes and new tokens.
743 vector<const Assertion*> tokens(1,token);
744 auto_ptr<ResolutionContext> ctx(
747 policy.getIssuerMetadata(),
750 (saml1name ? nameid.get() : saml2name),
758 // Copy over any new tokens, but leave them in the context for cleanup.
759 tokens.insert(tokens.end(), ctx->getResolvedAssertions().begin(), ctx->getResolvedAssertions().end());
762 application.getServiceProvider().getSessionCache()->insert(
769 (saml1name ? nameid.get() : saml2name),
775 ctx.get() ? &ctx->getResolvedAttributes() : nullptr
781 pair<bool,long> ADFSLogoutInitiator::run(SPRequest& request, bool isHandler) const
783 // Normally we'd do notifications and session clearage here, but ADFS logout
784 // is missing the needed request/response features, so we have to rely on
785 // the IdP half to notify us back about the logout and do the work there.
786 // Basically we have no way to tell in the Logout receiving handler whether
787 // we initiated the logout or not.
789 Session* session = nullptr;
791 session = request.getSession(false, true, false); // don't cache it and ignore all checks
793 return make_pair(false,0L);
795 // We only handle ADFS sessions.
796 if (!XMLString::equals(session->getProtocol(), WSFED_NS) || !session->getEntityID()) {
798 return make_pair(false,0L);
801 catch (exception& ex) {
802 m_log.error("error accessing current session: %s", ex.what());
803 return make_pair(false,0L);
806 string entityID(session->getEntityID());
809 if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
810 // When out of process, we run natively.
811 return doRequest(request.getApplication(), request, request, session);
814 // When not out of process, we remote the request.
816 vector<string> headers(1,"Cookie");
817 DDF out,in = wrap(request,&headers);
818 DDFJanitor jin(in), jout(out);
819 out=request.getServiceProvider().getListenerService()->send(in);
820 return unwrap(request, out);
824 void ADFSLogoutInitiator::receive(DDF& in, ostream& out)
827 // Defer to base class for notifications
828 if (in["notify"].integer() == 1)
829 return LogoutHandler::receive(in, out);
832 const char* aid=in["application_id"].string();
833 const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : nullptr;
835 // Something's horribly wrong.
836 m_log.error("couldn't find application (%s) for logout", aid ? aid : "(missing)");
837 throw ConfigurationException("Unable to locate application for logout, deleted?");
840 // Unpack the request.
841 auto_ptr<HTTPRequest> req(getRequest(in));
843 // Set up a response shim.
845 DDFJanitor jout(ret);
846 auto_ptr<HTTPResponse> resp(getResponse(ret));
848 Session* session = nullptr;
850 session = app->getServiceProvider().getSessionCache()->find(*app, *req.get(), nullptr, nullptr);
852 catch (exception& ex) {
853 m_log.error("error accessing current session: %s", ex.what());
856 // With no session, we just skip the request and let it fall through to an empty struct return.
858 if (session->getEntityID()) {
859 // Since we're remoted, the result should either be a throw, which we pass on,
860 // a false/0 return, which we just return as an empty structure, or a response/redirect,
861 // which we capture in the facade and send back.
862 doRequest(*app, *req.get(), *resp.get(), session);
865 m_log.error("no issuing entityID found in session");
867 app->getServiceProvider().getSessionCache()->remove(*app, *req.get(), resp.get());
872 throw ConfigurationException("Cannot perform logout using lite version of shibsp library.");
876 pair<bool,long> ADFSLogoutInitiator::doRequest(
877 const Application& application, const HTTPRequest& httpRequest, HTTPResponse& httpResponse, Session* session
880 // Do back channel notification.
881 vector<string> sessions(1, session->getID());
882 if (!notifyBackChannel(application, httpRequest.getRequestURL(), sessions, false)) {
884 application.getServiceProvider().getSessionCache()->remove(application, httpRequest, &httpResponse);
885 return sendLogoutPage(application, httpRequest, httpResponse, "partial");
889 pair<bool,long> ret = make_pair(false,0L);
892 // With a session in hand, we can create a request message, if we can find a compatible endpoint.
893 MetadataProvider* m=application.getMetadataProvider();
894 Locker metadataLocker(m);
895 MetadataProviderCriteria mc(application, session->getEntityID(), &IDPSSODescriptor::ELEMENT_QNAME, m_binding.get());
896 pair<const EntityDescriptor*,const RoleDescriptor*> entity=m->getEntityDescriptor(mc);
898 throw MetadataException(
899 "Unable to locate metadata for identity provider ($entityID)", namedparams(1, "entityID", session->getEntityID())
902 else if (!entity.second) {
903 throw MetadataException(
904 "Unable to locate ADFS IdP role for identity provider ($entityID).", namedparams(1, "entityID", session->getEntityID())
908 const EndpointType* ep = EndpointManager<SingleLogoutService>(
909 dynamic_cast<const IDPSSODescriptor*>(entity.second)->getSingleLogoutServices()
910 ).getByBinding(m_binding.get());
912 throw MetadataException(
913 "Unable to locate ADFS single logout service for identity provider ($entityID).",
914 namedparams(1, "entityID", session->getEntityID())
918 const URLEncoder* urlenc = XMLToolingConfig::getConfig().getURLEncoder();
919 const char* returnloc = httpRequest.getParameter("return");
920 auto_ptr_char dest(ep->getLocation());
921 string req=string(dest.get()) + (strchr(dest.get(),'?') ? '&' : '?') + "wa=wsignout1.0";
923 req += "&wreply=" + urlenc->encode(returnloc);
924 ret.second = httpResponse.sendRedirect(req.c_str());
927 catch (exception& ex) {
928 m_log.error("error issuing ADFS logout request: %s", ex.what());
934 application.getServiceProvider().getSessionCache()->remove(application, httpRequest, &httpResponse);
939 throw ConfigurationException("Cannot perform logout using lite version of shibsp library.");
943 pair<bool,long> ADFSLogout::run(SPRequest& request, bool isHandler) const
945 // Defer to base class for front-channel loop first.
946 // This won't initiate the loop, only continue/end it.
947 pair<bool,long> ret = LogoutHandler::run(request, isHandler);
951 // wa parameter indicates the "action" to perform
952 bool returning = false;
953 const char* param = request.getParameter("wa");
955 if (!strcmp(param, "wsignin1.0"))
956 return m_login.run(request, isHandler);
957 else if (strcmp(param, "wsignout1.0") && strcmp(param, "wsignoutcleanup1.0"))
958 throw FatalProfileException("Unsupported WS-Federation action paremeter ($1).", params(1, param));
960 else if (strcmp(request.getMethod(),"GET") || !request.getParameter("notifying"))
961 throw FatalProfileException("Unsupported request to ADFS protocol endpoint.");
965 param = request.getParameter("wreply");
966 const Application& app = request.getApplication();
969 // Pass control to the first front channel notification point, if any.
970 map<string,string> parammap;
972 parammap["wreply"] = param;
973 pair<bool,long> result = notifyFrontChannel(app, request, request, ¶mmap);
978 // Best effort on back channel and to remove the user agent's session.
979 string session_id = app.getServiceProvider().getSessionCache()->active(app, request);
980 if (!session_id.empty()) {
981 vector<string> sessions(1,session_id);
982 notifyBackChannel(app, request.getRequestURL(), sessions, false);
984 app.getServiceProvider().getSessionCache()->remove(app, request, &request);
986 catch (exception& ex) {
987 m_log.error("error removing session (%s): %s", session_id.c_str(), ex.what());
992 return make_pair(true, request.sendRedirect(param));
993 return sendLogoutPage(app, request, request, "global");