2 * Licensed to the University Corporation for Advanced Internet
3 * Development, Inc. (UCAID) under one or more contributor license
4 * agreements. See the NOTICE file distributed with this work for
5 * additional information regarding copyright ownership.
7 * UCAID licenses this file to you under the Apache License,
8 * Version 2.0 (the "License"); you may not use this file except
9 * in compliance with the License. You may obtain a copy of the
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
17 * either express or implied. See the License for the specific
18 * language governing permissions and limitations under the License.
24 * Handles SAML 2.0 single logout protocol messages.
28 #include "exceptions.h"
29 #include "Application.h"
30 #include "ServiceProvider.h"
31 #include "SPRequest.h"
32 #include "handler/AbstractHandler.h"
33 #include "handler/LogoutHandler.h"
34 #include "util/SPConstants.h"
37 # include "SessionCacheEx.h"
38 # include "security/SecurityPolicy.h"
39 # include "security/SecurityPolicyProvider.h"
40 # include "metadata/MetadataProviderCriteria.h"
42 # include <boost/algorithm/string.hpp>
43 # include <boost/iterator/indirect_iterator.hpp>
44 # include <saml/exceptions.h>
45 # include <saml/SAMLConfig.h>
46 # include <saml/saml2/core/Protocols.h>
47 # include <saml/saml2/metadata/EndpointManager.h>
48 # include <saml/saml2/metadata/Metadata.h>
49 # include <saml/saml2/metadata/MetadataCredentialCriteria.h>
50 # include <xmltooling/util/URLEncoder.h>
51 using namespace opensaml::saml2;
52 using namespace opensaml::saml2p;
53 using namespace opensaml::saml2md;
54 using namespace opensaml;
56 # include "lite/SAMLConstants.h"
59 #include <boost/scoped_ptr.hpp>
61 using namespace shibsp;
62 using namespace xmltooling;
63 using namespace boost;
68 #if defined (_MSC_VER)
69 #pragma warning( push )
70 #pragma warning( disable : 4250 )
73 class SHIBSP_DLLLOCAL SAML2Logout : public AbstractHandler, public LogoutHandler
76 SAML2Logout(const DOMElement* e, const char* appId);
77 virtual ~SAML2Logout() {}
79 void receive(DDF& in, ostream& out);
80 pair<bool,long> run(SPRequest& request, bool isHandler=true) const;
83 void generateMetadata(SPSSODescriptor& role, const char* handlerURL) const {
84 const char* loc = getString("Location").second;
85 string hurl(handlerURL);
89 auto_ptr_XMLCh widen(hurl.c_str());
90 SingleLogoutService* ep = SingleLogoutServiceBuilder::buildSingleLogoutService();
91 ep->setLocation(widen.get());
92 ep->setBinding(getXMLString("Binding").second);
93 role.getSingleLogoutServices().push_back(ep);
94 role.addSupport(samlconstants::SAML20P_NS);
97 const char* getType() const {
98 return "SingleLogoutService";
101 const XMLCh* getProtocolFamily() const {
102 return samlconstants::SAML20P_NS;
106 pair<bool,long> doRequest(const Application& application, const HTTPRequest& httpRequest, HTTPResponse& httpResponse) const;
109 pair<bool,long> sendResponse(
110 LogoutEvent* logoutEvent,
111 const XMLCh* requestID,
113 const XMLCh* subcode,
115 const char* relayState,
116 const RoleDescriptor* role,
117 const Application& application,
118 HTTPResponse& httpResponse,
122 LogoutEvent* newLogoutEvent(
123 const Application& application, const HTTPRequest* request=nullptr, const Session* session=nullptr
125 LogoutEvent* e = LogoutHandler::newLogoutEvent(application, request, session);
127 e->m_protocol = m_protocol.get();
131 scoped_ptr<MessageDecoder> m_decoder;
132 vector<string> m_bindings;
133 map< string,boost::shared_ptr<MessageEncoder> > m_encoders;
134 auto_ptr_char m_protocol;
138 #if defined (_MSC_VER)
139 #pragma warning( pop )
142 Handler* SHIBSP_DLLLOCAL SAML2LogoutFactory(const pair<const DOMElement*,const char*>& p)
144 return new SAML2Logout(p.first, p.second);
148 SAML2Logout::SAML2Logout(const DOMElement* e, const char* appId)
149 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".Logout.SAML2"))
151 ,m_protocol(samlconstants::SAML20P_NS)
156 m_preserve.push_back("ID");
157 m_preserve.push_back("entityID");
158 m_preserve.push_back("RelayState");
160 if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
161 SAMLConfig& conf = SAMLConfig::getConfig();
163 // Handle incoming binding.
165 conf.MessageDecoderManager.newPlugin(
166 getString("Binding").second, pair<const DOMElement*,const XMLCh*>(e,shibspconstants::SHIB2SPCONFIG_NS)
169 m_decoder->setArtifactResolver(SPConfig::getConfig().getArtifactResolver());
171 if (m_decoder->isUserAgentPresent()) {
172 // Handle front-channel binding setup.
174 pair<bool,const char*> outgoing = getString("outgoingBindings", m_configNS.get());
175 if (outgoing.first) {
176 dupBindings = outgoing.second;
179 // No override, so we'll install a default binding precedence.
180 dupBindings = string(samlconstants::SAML20_BINDING_HTTP_REDIRECT) + ' ' + samlconstants::SAML20_BINDING_HTTP_POST + ' ' +
181 samlconstants::SAML20_BINDING_HTTP_POST_SIMPLESIGN + ' ' + samlconstants::SAML20_BINDING_HTTP_ARTIFACT;
184 split(m_bindings, dupBindings, is_space(), algorithm::token_compress_on);
185 for (vector<string>::const_iterator b = m_bindings.begin(); b != m_bindings.end(); ++b) {
187 boost::shared_ptr<MessageEncoder> encoder(
188 conf.MessageEncoderManager.newPlugin(*b, pair<const DOMElement*,const XMLCh*>(e,shibspconstants::SHIB2SPCONFIG_NS))
190 if (encoder->isUserAgentPresent() && XMLString::equals(getProtocolFamily(), encoder->getProtocolFamily())) {
191 m_encoders[*b] = encoder;
192 m_log.debug("supporting outgoing binding (%s)", b->c_str());
195 m_log.warn("skipping outgoing binding (%s), not a SAML 2.0 front-channel mechanism", b->c_str());
198 catch (std::exception& ex) {
199 m_log.error("error building MessageEncoder: %s", ex.what());
204 pair<bool,const char*> b = getString("Binding");
205 boost::shared_ptr<MessageEncoder> encoder(
206 conf.MessageEncoderManager.newPlugin(b.second, pair<const DOMElement*,const XMLCh*>(e,shibspconstants::SHIB2SPCONFIG_NS))
208 m_encoders[b.second] = encoder;
213 string address(appId);
214 address += getString("Location").second;
215 setAddress(address.c_str());
218 pair<bool,long> SAML2Logout::run(SPRequest& request, bool isHandler) const
220 // Defer to base class for front-channel loop first.
221 // This won't initiate the loop, only continue/end it.
222 pair<bool,long> ret = LogoutHandler::run(request, isHandler);
226 SPConfig& conf = SPConfig::getConfig();
227 if (conf.isEnabled(SPConfig::OutOfProcess)) {
228 // When out of process, we run natively and directly process the message.
229 return doRequest(request.getApplication(), request, request);
232 // When not out of process, we remote all the message processing.
233 vector<string> headers(1,"Cookie");
234 headers.push_back("User-Agent");
235 DDF out,in = wrap(request, &headers, true);
236 DDFJanitor jin(in), jout(out);
237 out=request.getServiceProvider().getListenerService()->send(in);
238 return unwrap(request, out);
242 void SAML2Logout::receive(DDF& in, ostream& out)
245 const char* aid = in["application_id"].string();
246 const Application* app = aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : nullptr;
248 // Something's horribly wrong.
249 m_log.error("couldn't find application (%s) for logout", aid ? aid : "(missing)");
250 throw ConfigurationException("Unable to locate application for logout, deleted?");
253 // Unpack the request.
254 scoped_ptr<HTTPRequest> req(getRequest(in));
256 // Wrap a response shim.
258 DDFJanitor jout(ret);
259 scoped_ptr<HTTPResponse> resp(getResponse(ret));
261 // Since we're remoted, the result should either be a throw, which we pass on,
262 // a false/0 return, which we just return as an empty structure, or a response/redirect,
263 // which we capture in the facade and send back.
264 doRequest(*app, *req, *resp);
268 pair<bool,long> SAML2Logout::doRequest(const Application& application, const HTTPRequest& request, HTTPResponse& response) const
271 // First capture the active session ID.
272 SessionCache* cache = application.getServiceProvider().getSessionCache();
273 SessionCacheEx* cacheex = dynamic_cast<SessionCacheEx*>(cache);
274 string session_id = cache->active(application, request);
276 scoped_ptr<LogoutEvent> logout_event(newLogoutEvent(application, &request));
277 if (logout_event.get() && !session_id.empty())
278 logout_event->m_sessions.push_back(session_id);
280 if (!strcmp(request.getMethod(),"GET") && request.getParameter("notifying")) {
281 // This is returning from a front-channel notification, so we have to do the back-channel and then
282 // respond. To do that, we need state from the original request.
283 if (!request.getParameter("entityID")) {
284 cache->remove(application, request, &response);
285 throw FatalProfileException("Application notification loop did not return entityID for LogoutResponse.");
288 // Best effort on back channel and to remove the user agent's session.
289 bool worked1 = false,worked2 = false;
290 if (!session_id.empty()) {
291 vector<string> sessions(1,session_id);
292 worked1 = notifyBackChannel(application, request.getRequestURL(), sessions, false);
294 cache->remove(application, request, &response);
297 catch (std::exception& ex) {
298 m_log.error("error removing session (%s): %s", session_id.c_str(), ex.what());
302 worked1 = worked2 = true;
305 // We need metadata to issue a response.
306 MetadataProvider* m = application.getMetadataProvider();
307 Locker metadataLocker(m);
308 MetadataProviderCriteria mc(
309 application, request.getParameter("entityID"), &IDPSSODescriptor::ELEMENT_QNAME, samlconstants::SAML20P_NS
311 pair<const EntityDescriptor*,const RoleDescriptor*> entity = m->getEntityDescriptor(mc);
313 throw MetadataException(
314 "Unable to locate metadata for identity provider ($entityID)",
315 namedparams(1, "entityID", request.getParameter("entityID"))
318 else if (!entity.second) {
319 throw MetadataException(
320 "Unable to locate SAML 2.0 IdP role for identity provider ($entityID).",
321 namedparams(1, "entityID", request.getParameter("entityID"))
325 auto_ptr_XMLCh reqid(request.getParameter("ID"));
326 if (worked1 && worked2) {
327 // Successful LogoutResponse. Has to be front-channel or we couldn't be here.
328 if (logout_event.get())
329 logout_event->m_logoutType = LogoutEvent::LOGOUT_EVENT_GLOBAL;
333 StatusCode::SUCCESS, nullptr, nullptr,
334 request.getParameter("RelayState"),
345 StatusCode::RESPONDER, nullptr, "Unable to fully destroy principal's session.",
346 request.getParameter("RelayState"),
354 // If we get here, it's an external protocol message to decode.
356 // Locate policy key.
357 pair<bool,const char*> policyId = getString("policyId", m_configNS.get()); // namespace-qualified if inside handler element
359 policyId = application.getString("policyId"); // unqualified in Application(s) element
361 // Lock metadata for use by policy.
362 Locker metadataLocker(application.getMetadataProvider());
364 // Create the policy.
365 scoped_ptr<SecurityPolicy> policy(
366 application.getServiceProvider().getSecurityPolicyProvider()->createSecurityPolicy(application, &IDPSSODescriptor::ELEMENT_QNAME, policyId.second)
369 // Decode the message.
371 scoped_ptr<XMLObject> msg(m_decoder->decode(relayState, request, *policy));
372 const LogoutRequest* logoutRequest = dynamic_cast<LogoutRequest*>(msg.get());
374 if (!policy->isAuthenticated())
375 throw SecurityPolicyException("Security of LogoutRequest not established.");
378 logout_event->m_saml2Request = logoutRequest;
379 if (policy->getIssuerMetadata())
380 logout_event->m_peer = dynamic_cast<const EntityDescriptor*>(policy->getIssuerMetadata()->getParent());
381 application.getServiceProvider().getTransactionLog()->write(*logout_event);
382 logout_event->m_saml2Request = nullptr;
385 // Message from IdP to logout one or more sessions.
387 // If this is front-channel, we have to have a session_id to use already.
388 if (m_decoder->isUserAgentPresent() && session_id.empty()) {
389 m_log.error("no active session");
392 logoutRequest->getID(),
393 StatusCode::REQUESTER, StatusCode::UNKNOWN_PRINCIPAL, "No active session found in request.",
395 policy->getIssuerMetadata(),
402 scoped_ptr<XMLObject> decryptedID;
403 NameID* nameid = logoutRequest->getNameID();
405 // Check for EncryptedID.
406 EncryptedID* encname = logoutRequest->getEncryptedID();
408 CredentialResolver* cr=application.getCredentialResolver();
410 m_log.warn("found encrypted NameID, but no decryption credential was available");
412 Locker credlocker(cr);
413 scoped_ptr<MetadataCredentialCriteria> mcc(
414 policy->getIssuerMetadata() ? new MetadataCredentialCriteria(*policy->getIssuerMetadata()) : nullptr
420 application.getRelyingParty(
421 policy->getIssuerMetadata() ?
422 dynamic_cast<EntityDescriptor*>(policy->getIssuerMetadata()->getParent()) :
423 nullptr)->getXMLString("entityID").second,
427 nameid = dynamic_cast<NameID*>(decryptedID.get());
429 catch (std::exception& ex) {
430 m_log.error(ex.what());
436 // No NameID, so must respond with an error.
437 m_log.error("NameID not found in request");
440 logoutRequest->getID(),
441 StatusCode::REQUESTER, StatusCode::UNKNOWN_PRINCIPAL, "NameID not found in request.",
443 policy->getIssuerMetadata(),
446 m_decoder->isUserAgentPresent()
450 // Suck indexes out of the request for next steps.
452 EntityDescriptor* entity = policy->getIssuerMetadata() ? dynamic_cast<EntityDescriptor*>(policy->getIssuerMetadata()->getParent()) : nullptr;
453 const vector<SessionIndex*> sindexes = logoutRequest->getSessionIndexs();
454 for (indirect_iterator<vector<SessionIndex*>::const_iterator> i = make_indirect_iterator(sindexes.begin());
455 i != make_indirect_iterator(sindexes.end()); ++i) {
456 auto_ptr_char sindex(i->getSessionIndex());
457 indexes.insert(sindex.get());
460 // For a front-channel LogoutRequest, we have to match the information in the request
461 // against the current session.
462 if (!session_id.empty()) {
463 if (!cache->matches(application, request, entity, *nameid, &indexes)) {
466 logoutRequest->getID(),
467 StatusCode::REQUESTER, StatusCode::REQUEST_DENIED, "Active session did not match logout request.",
469 policy->getIssuerMetadata(),
478 // Now we perform "logout" by finding the matching sessions.
479 vector<string> sessions;
482 time_t expires = logoutRequest->getNotOnOrAfter() ? logoutRequest->getNotOnOrAfterEpoch() : 0;
483 cacheex->logout(application, entity, *nameid, &indexes, expires, sessions);
484 m_log.debug("session cache returned %d sessions bound to NameID in logout request", sessions.size());
486 // Now we actually terminate everything except for the active session,
487 // if this is front-channel, for notification purposes.
488 for (vector<string>::const_iterator sit = sessions.begin(); sit != sessions.end(); ++sit)
489 if (*sit != session_id)
490 cacheex->remove(application, sit->c_str()); // using the ID-based removal operation
493 m_log.warn("session cache does not support extended API, can't implement indirect logout of sessions");
494 if (!session_id.empty())
495 sessions.push_back(session_id);
498 catch (std::exception& ex) {
499 m_log.error("error while logging out matching sessions: %s", ex.what());
501 logout_event->m_nameID = nameid;
502 logout_event->m_sessions = sessions;
503 logout_event->m_logoutType = LogoutEvent::LOGOUT_EVENT_PARTIAL;
507 logoutRequest->getID(),
508 StatusCode::RESPONDER, nullptr, ex.what(),
510 policy->getIssuerMetadata(),
513 m_decoder->isUserAgentPresent()
517 if (m_decoder->isUserAgentPresent()) {
518 // Pass control to the first front channel notification point, if any.
519 map<string,string> parammap;
520 if (!relayState.empty())
521 parammap["RelayState"] = relayState;
522 auto_ptr_char entityID(entity ? entity->getEntityID() : nullptr);
524 parammap["entityID"] = entityID.get();
525 auto_ptr_char reqID(logoutRequest->getID());
527 parammap["ID"] = reqID.get();
528 pair<bool,long> result = notifyFrontChannel(application, request, response, ¶mmap);
533 // For back-channel requests, or if no front-channel notification is needed...
534 bool worked1 = notifyBackChannel(application, request.getRequestURL(), sessions, false);
536 if (!session_id.empty()) {
537 // One last session to yoink...
539 cache->remove(application, request, &response);
541 catch (std::exception& ex) {
543 m_log.error("error removing active session (%s): %s", session_id.c_str(), ex.what());
548 logout_event->m_nameID = nameid;
549 logout_event->m_sessions = sessions;
550 logout_event->m_logoutType = (worked1 && worked2) ? LogoutEvent::LOGOUT_EVENT_PARTIAL : LogoutEvent::LOGOUT_EVENT_GLOBAL;
554 logoutRequest->getID(),
555 (worked1 && worked2) ? StatusCode::SUCCESS : StatusCode::RESPONDER,
556 (worked1 && worked2) ? nullptr : StatusCode::PARTIAL_LOGOUT,
559 policy->getIssuerMetadata(),
562 m_decoder->isUserAgentPresent()
566 // A LogoutResponse completes an SP-initiated logout sequence.
567 const LogoutResponse* logoutResponse = dynamic_cast<LogoutResponse*>(msg.get());
568 if (logoutResponse) {
569 if (!policy->isAuthenticated()) {
570 SecurityPolicyException ex("Security of LogoutResponse not established.");
571 annotateException(&ex, policy->getIssuerMetadata()); // throws it
575 logout_event->m_logoutType = LogoutEvent::LOGOUT_EVENT_PARTIAL;
576 logout_event->m_saml2Response = logoutResponse;
577 if (policy->getIssuerMetadata())
578 logout_event->m_peer = dynamic_cast<const EntityDescriptor*>(policy->getIssuerMetadata()->getParent());
582 checkError(logoutResponse, policy->getIssuerMetadata()); // throws if Status doesn't look good...
584 catch (std::exception& ex) {
586 logout_event->m_exception = &ex;
587 application.getServiceProvider().getTransactionLog()->write(*logout_event);
592 // If relay state is set, recover the original return URL.
593 if (!relayState.empty())
594 recoverRelayState(application, request, response, relayState);
596 // Check for partial logout.
597 const StatusCode* sc = logoutResponse->getStatus() ? logoutResponse->getStatus()->getStatusCode() : nullptr;
598 sc = sc ? sc->getStatusCode() : nullptr;
599 if (sc && XMLString::equals(sc->getValue(), StatusCode::PARTIAL_LOGOUT)) {
601 application.getServiceProvider().getTransactionLog()->write(*logout_event);
602 return sendLogoutPage(application, request, response, "partial");
606 logout_event->m_logoutType = LogoutEvent::LOGOUT_EVENT_GLOBAL;
607 application.getServiceProvider().getTransactionLog()->write(*logout_event);
610 if (!relayState.empty()) {
611 application.limitRedirect(request, relayState.c_str());
612 return make_pair(true, response.sendRedirect(relayState.c_str()));
615 // Return template for completion of logout.
616 return sendLogoutPage(application, request, response, "global");
619 FatalProfileException ex("Incoming message was not a samlp:LogoutRequest or samlp:LogoutResponse.");
620 if (policy->getIssuerMetadata())
621 annotateException(&ex, policy->getIssuerMetadata()); // throws it
623 return make_pair(false,0L); // never happen, satisfies compiler
625 throw ConfigurationException("Cannot process logout message using lite version of shibsp library.");
631 pair<bool,long> SAML2Logout::sendResponse(
632 LogoutEvent* logoutEvent,
633 const XMLCh* requestID,
635 const XMLCh* subcode,
637 const char* relayState,
638 const RoleDescriptor* role,
639 const Application& application,
640 HTTPResponse& httpResponse,
644 // Get endpoint and encoder to use.
645 const EndpointType* ep = nullptr;
646 const MessageEncoder* encoder = nullptr;
648 const IDPSSODescriptor* idp = dynamic_cast<const IDPSSODescriptor*>(role);
649 for (vector<string>::const_iterator b = m_bindings.begin(); idp && b != m_bindings.end(); ++b) {
650 auto_ptr_XMLCh wideb(b->c_str());
651 if ((ep = EndpointManager<SingleLogoutService>(idp->getSingleLogoutServices()).getByBinding(wideb.get()))) {
652 map< string,boost::shared_ptr<MessageEncoder> >::const_iterator enc = m_encoders.find(*b);
653 if (enc != m_encoders.end())
654 encoder = enc->second.get();
658 if (!ep || !encoder) {
659 auto_ptr_char id(dynamic_cast<EntityDescriptor*>(role->getParent())->getEntityID());
660 m_log.error("unable to locate compatible SLO service for provider (%s)", id.get());
661 MetadataException ex("Unable to locate endpoint at IdP ($entityID) to send LogoutResponse.");
662 annotateException(&ex, role); // throws it
666 encoder = m_encoders.begin()->second.get();
670 auto_ptr<LogoutResponse> logout(LogoutResponseBuilder::buildLogoutResponse());
671 logout->setInResponseTo(requestID);
673 const XMLCh* loc = ep->getResponseLocation();
675 loc = ep->getLocation();
676 logout->setDestination(loc);
678 Issuer* issuer = IssuerBuilder::buildIssuer();
679 logout->setIssuer(issuer);
680 issuer->setName(application.getRelyingParty(dynamic_cast<EntityDescriptor*>(role->getParent()))->getXMLString("entityID").second);
681 fillStatus(*logout, code, subcode, msg);
682 XMLCh* msgid = SAMLConfig::getConfig().generateIdentifier();
683 logout->setID(msgid);
684 XMLString::release(&msgid);
685 logout->setIssueInstant(time(nullptr));
688 logoutEvent->m_peer = dynamic_cast<EntityDescriptor*>(role->getParent());
689 logoutEvent->m_saml2Response = logout.get();
690 application.getServiceProvider().getTransactionLog()->write(*logoutEvent);
693 auto_ptr_char dest(logout->getDestination());
694 long ret = sendMessage(*encoder, logout.get(), relayState, dest.get(), role, application, httpResponse, front);
695 logout.release(); // freed by encoder
696 return make_pair(true, ret);