shibsp/handler/impl/SAML2LogoutInitiator.cpp

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /**
  18  * SAML2LogoutInitiator.cpp
  19  *
  20  * Triggers SP-initiated logout for SAML 2.0 sessions.
  21  */
  22
  23 #include "internal.h"
  24 #include "exceptions.h"
  25 #include "Application.h"
  26 #include "ServiceProvider.h"
  27 #include "SessionCache.h"
  28 #include "handler/AbstractHandler.h"
  29 #include "handler/LogoutHandler.h"
  30
  31 #ifndef SHIBSP_LITE
  32 # include "binding/SOAPClient.h"
  33 # include <saml/SAMLConfig.h>
  34 # include <saml/saml2/core/Protocols.h>
  35 # include <saml/saml2/binding/SAML2SOAPClient.h>
  36 # include <saml/saml2/metadata/EndpointManager.h>
  37 # include <saml/saml2/metadata/MetadataCredentialCriteria.h>
  38 using namespace opensaml::saml2;
  39 using namespace opensaml::saml2p;
  40 using namespace opensaml::saml2md;
  41 using namespace opensaml;
  42 #else
  43 # include "lite/SAMLConstants.h"
  44 #endif
  45
  46 using namespace shibsp;
  47 using namespace xmltooling;
  48 using namespace log4cpp;
  49 using namespace std;
  50
  51 namespace shibsp {
  52
  53 #if defined (_MSC_VER)
  54     #pragma warning( push )
  55     #pragma warning( disable : 4250 )
  56 #endif
  57
  58     class SHIBSP_DLLLOCAL SAML2LogoutInitiator : public AbstractHandler, public LogoutHandler
  59     {
  60     public:
  61         SAML2LogoutInitiator(const DOMElement* e, const char* appId);
  62         virtual ~SAML2LogoutInitiator() {
  63 #ifndef SHIBSP_LITE
  64             if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
  65                 XMLString::release(&m_outgoing);
  66                 for_each(m_encoders.begin(), m_encoders.end(), cleanup_pair<const XMLCh*,MessageEncoder>());
  67             }
  68 #endif
  69         }
  70
  71         void setParent(const PropertySet* parent);
  72         void receive(DDF& in, ostream& out);
  73         pair<bool,long> run(SPRequest& request, bool isHandler=true) const;
  74
  75     private:
  76         pair<bool,long> doRequest(const Application& application, Session* session_id, HTTPResponse& httpResponse) const;
  77
  78         string m_appId;
  79 #ifndef SHIBSP_LITE
  80         LogoutRequest* buildRequest(
  81             const Application& application, const Session& session, const IDPSSODescriptor& role, const MessageEncoder* encoder=NULL
  82             ) const;
  83
  84         XMLCh* m_outgoing;
  85         vector<const XMLCh*> m_bindings;
  86         map<const XMLCh*,MessageEncoder*> m_encoders;
  87 #endif
  88         auto_ptr_char m_protocol;
  89     };
  90
  91 #if defined (_MSC_VER)
  92     #pragma warning( pop )
  93 #endif
  94
  95     Handler* SHIBSP_DLLLOCAL SAML2LogoutInitiatorFactory(const pair<const DOMElement*,const char*>& p)
  96     {
  97         return new SAML2LogoutInitiator(p.first, p.second);
  98     }
  99 };
 100
 101 SAML2LogoutInitiator::SAML2LogoutInitiator(const DOMElement* e, const char* appId)
 102     : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".LogoutInitiator")), m_appId(appId),
 103 #ifndef SHIBSP_LITE
 104         m_outgoing(NULL),
 105 #endif
 106         m_protocol(samlconstants::SAML20P_NS)
 107 {
 108 #ifndef SHIBSP_LITE
 109     if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
 110         // Handle outgoing binding setup.
 111         pair<bool,const XMLCh*> outgoing = getXMLString("outgoingBindings");
 112         if (outgoing.first) {
 113             m_outgoing = XMLString::replicate(outgoing.second);
 114             XMLString::trim(m_outgoing);
 115         }
 116         else {
 117             // No override, so we'll install a default binding precedence.
 118             string prec = string(samlconstants::SAML20_BINDING_HTTP_REDIRECT) + ' ' + samlconstants::SAML20_BINDING_HTTP_POST + ' ' +
 119                 samlconstants::SAML20_BINDING_HTTP_POST_SIMPLESIGN + ' ' + samlconstants::SAML20_BINDING_HTTP_ARTIFACT;
 120             m_outgoing = XMLString::transcode(prec.c_str());
 121         }
 122
 123         int pos;
 124         XMLCh* start = m_outgoing;
 125         while (start && *start) {
 126             pos = XMLString::indexOf(start,chSpace);
 127             if (pos != -1)
 128                 *(start + pos)=chNull;
 129             m_bindings.push_back(start);
 130             try {
 131                 auto_ptr_char b(start);
 132                 MessageEncoder * encoder =
 133                     SAMLConfig::getConfig().MessageEncoderManager.newPlugin(b.get(),pair<const DOMElement*,const XMLCh*>(e,NULL));
 134                 m_encoders[start] = encoder;
 135                 m_log.debug("supporting outgoing binding (%s)", b.get());
 136             }
 137             catch (exception& ex) {
 138                 m_log.error("error building MessageEncoder: %s", ex.what());
 139             }
 140             if (pos != -1)
 141                 start = start + pos + 1;
 142             else
 143                 break;
 144         }
 145     }
 146 #endif
 147
 148     pair<bool,const char*> loc = getString("Location");
 149     if (loc.first) {
 150         string address = m_appId + loc.second + "::run::SAML2LI";
 151         setAddress(address.c_str());
 152     }
 153 }
 154
 155 void SAML2LogoutInitiator::setParent(const PropertySet* parent)
 156 {
 157     DOMPropertySet::setParent(parent);
 158     pair<bool,const char*> loc = getString("Location");
 159     if (loc.first) {
 160         string address = m_appId + loc.second + "::run::SAML2LI";
 161         setAddress(address.c_str());
 162     }
 163     else {
 164         m_log.warn("no Location property in SAML2 LogoutInitiator (or parent), can't register as remoted handler");
 165     }
 166 }
 167
 168 pair<bool,long> SAML2LogoutInitiator::run(SPRequest& request, bool isHandler) const
 169 {
 170     // Defer to base class for front-channel loop first.
 171     pair<bool,long> ret = LogoutHandler::run(request, isHandler);
 172     if (ret.first)
 173         return ret;
 174
 175     // At this point we know the front-channel is handled.
 176     // We need the session to do any other work.
 177
 178     Session* session = NULL;
 179     try {
 180         session = request.getSession(false, true, false);  // don't cache it and ignore all checks
 181         if (!session)
 182             return make_pair(false,0);
 183
 184         // We only handle SAML 2.0 sessions.
 185         if (!XMLString::equals(session->getProtocol(), m_protocol.get())) {
 186             session->unlock();
 187             return make_pair(false,0);
 188         }
 189     }
 190     catch (exception& ex) {
 191         m_log.error("error accessing current session: %s", ex.what());
 192         return make_pair(false,0);
 193     }
 194
 195     if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
 196         // When out of process, we run natively.
 197         return doRequest(request.getApplication(), session, request);
 198     }
 199     else {
 200         // When not out of process, we remote the request.
 201         Locker locker(session);
 202         DDF out,in(m_address.c_str());
 203         DDFJanitor jin(in), jout(out);
 204         in.addmember("application_id").string(request.getApplication().getId());
 205         in.addmember("session_id").string(session->getID());
 206         out=request.getServiceProvider().getListenerService()->send(in);
 207         return unwrap(request, out);
 208     }
 209 }
 210
 211 void SAML2LogoutInitiator::receive(DDF& in, ostream& out)
 212 {
 213 #ifndef SHIBSP_LITE
 214     // Defer to base class for notifications
 215     if (in["notify"].integer() == 1)
 216         return LogoutHandler::receive(in, out);
 217
 218     // Find application.
 219     const char* aid=in["application_id"].string();
 220     const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : NULL;
 221     if (!app) {
 222         // Something's horribly wrong.
 223         m_log.error("couldn't find application (%s) for logout", aid ? aid : "(missing)");
 224         throw ConfigurationException("Unable to locate application for logout, deleted?");
 225     }
 226
 227     // Set up a response shim.
 228     DDF ret(NULL);
 229     DDFJanitor jout(ret);
 230     auto_ptr<HTTPResponse> resp(getResponse(ret));
 231
 232     Session* session = NULL;
 233     try {
 234          session = app->getServiceProvider().getSessionCache()->find(in["session_id"].string(), *app, NULL, NULL);
 235     }
 236     catch (exception& ex) {
 237         m_log.error("error accessing current session: %s", ex.what());
 238     }
 239
 240     // With no session, we just skip the request and let it fall through to an empty struct return.
 241     if (session) {
 242         if (session->getNameID() && session->getEntityID()) {
 243             // Since we're remoted, the result should either be a throw, which we pass on,
 244             // a false/0 return, which we just return as an empty structure, or a response/redirect,
 245             // which we capture in the facade and send back.
 246             doRequest(*app, session, *resp.get());
 247         }
 248         else {
 249              m_log.error("no NameID or issuing entityID found in session");
 250              session->unlock();
 251              session = NULL;
 252              app->getServiceProvider().getSessionCache()->remove(in["session_id"].string(), *app);
 253          }
 254     }
 255     out << ret;
 256 #else
 257     throw ConfigurationException("Cannot perform logout using lite version of shibsp library.");
 258 #endif
 259 }
 260
 261 pair<bool,long> SAML2LogoutInitiator::doRequest(const Application& application, Session* session, HTTPResponse& response) const
 262 {
 263     // Do back channel notification.
 264     vector<string> sessions(1, session->getID());
 265     if (!notifyBackChannel(application, sessions)) {
 266         session->unlock();
 267         application.getServiceProvider().getSessionCache()->remove(sessions.front().c_str(), application);
 268         return sendLogoutPage(application, response, true, "Partial logout failure.");
 269     }
 270
 271 #ifndef SHIBSP_LITE
 272     pair<bool,long> ret = make_pair(false,0);
 273     try {
 274         // With a session in hand, we can create a LogoutRequest message, if we can find a compatible endpoint.
 275         Locker metadataLocker(application.getMetadataProvider());
 276         const EntityDescriptor* entity = application.getMetadataProvider()->getEntityDescriptor(session->getEntityID());
 277         if (!entity) {
 278             throw MetadataException(
 279                 "Unable to locate metadata for identity provider ($entityID)",
 280                 namedparams(1, "entityID", session->getEntityID())
 281                 );
 282         }
 283         const IDPSSODescriptor* role = entity->getIDPSSODescriptor(samlconstants::SAML20P_NS);
 284         if (!role) {
 285             throw MetadataException(
 286                 "Unable to locate SAML 2.0 IdP role for identity provider ($entityID).",
 287                 namedparams(1, "entityID", session->getEntityID())
 288                 );
 289         }
 290
 291         const EndpointType* ep=NULL;
 292         const MessageEncoder* encoder=NULL;
 293         vector<const XMLCh*>::const_iterator b;
 294         for (b = m_bindings.begin(); b!=m_bindings.end(); ++b) {
 295             if (ep=EndpointManager<SingleLogoutService>(role->getSingleLogoutServices()).getByBinding(*b)) {
 296                 map<const XMLCh*,MessageEncoder*>::const_iterator enc = m_encoders.find(*b);
 297                 if (enc!=m_encoders.end())
 298                     encoder = enc->second;
 299                 break;
 300             }
 301         }
 302         if (!ep || !encoder) {
 303             m_log.warn("no compatible front channel SingleLogoutService, trying back channel...");
 304             shibsp::SecurityPolicy policy(application);
 305             shibsp::SOAPClient soaper(policy);
 306             MetadataCredentialCriteria mcc(*role);
 307
 308             LogoutResponse* logoutResponse=NULL;
 309             auto_ptr_XMLCh binding(samlconstants::SAML20_BINDING_SOAP);
 310             const vector<SingleLogoutService*>& endpoints=role->getSingleLogoutServices();
 311             for (vector<SingleLogoutService*>::const_iterator epit=endpoints.begin(); !logoutResponse && epit!=endpoints.end(); ++epit) {
 312                 try {
 313                     if (!XMLString::equals((*epit)->getBinding(),binding.get()))
 314                         continue;
 315                     LogoutRequest* msg = buildRequest(application, *session, *role);
 316                     auto_ptr_char dest((*epit)->getLocation());
 317
 318                     SAML2SOAPClient client(soaper, false);
 319                     client.sendSAML(msg, mcc, dest.get());
 320                     StatusResponseType* srt = client.receiveSAML();
 321                     if (!(logoutResponse = dynamic_cast<LogoutResponse*>(srt))) {
 322                         delete srt;
 323                         break;
 324                     }
 325                 }
 326                 catch (exception& ex) {
 327                     m_log.error("error sending LogoutRequest message: %s", ex.what());
 328                     soaper.reset();
 329                 }
 330             }
 331
 332             if (!logoutResponse)
 333                 return sendLogoutPage(application, response, false, "Identity provider did not respond to logout request.");
 334             if (!logoutResponse->getStatus() || !logoutResponse->getStatus()->getStatusCode() ||
 335                    !XMLString::equals(logoutResponse->getStatus()->getStatusCode()->getValue(), saml2p::StatusCode::SUCCESS)) {
 336                 delete logoutResponse;
 337                 return sendLogoutPage(application, response, false, "Identity provider returned a SAML error in response to logout request.");
 338             }
 339             delete logoutResponse;
 340             return sendLogoutPage(application, response, false, "Logout completed successfully.");
 341         }
 342
 343         auto_ptr<LogoutRequest> msg(buildRequest(application, *session, *role, encoder));
 344
 345         msg->setDestination(ep->getLocation());
 346         auto_ptr_char dest(ep->getLocation());
 347         ret.second = sendMessage(*encoder, msg.get(), NULL, dest.get(), role, application, response, "signRequests");
 348         ret.first = true;
 349         msg.release();  // freed by encoder
 350     }
 351     catch (exception& ex) {
 352         m_log.error("error issuing SAML 2.0 logout request: %s", ex.what());
 353     }
 354
 355     if (session) {
 356         string session_id = session->getID();
 357         session->unlock();
 358         session = NULL;
 359         application.getServiceProvider().getSessionCache()->remove(session_id.c_str(), application);
 360     }
 361
 362     return ret;
 363 #else
 364     string session_id = session->getID();
 365     session->unlock();
 366     application.getServiceProvider().getSessionCache()->remove(session_id.c_str(), application);
 367     throw ConfigurationException("Cannot perform logout using lite version of shibsp library.");
 368 #endif
 369 }
 370
 371 #ifndef SHIBSP_LITE
 372
 373 LogoutRequest* SAML2LogoutInitiator::buildRequest(
 374     const Application& application, const Session& session, const IDPSSODescriptor& role, const MessageEncoder* encoder
 375     ) const
 376 {
 377     auto_ptr<LogoutRequest> msg(LogoutRequestBuilder::buildLogoutRequest());
 378     Issuer* issuer = IssuerBuilder::buildIssuer();
 379     msg->setIssuer(issuer);
 380     issuer->setName(application.getXMLString("entityID").second);
 381     auto_ptr_XMLCh index(session.getSessionIndex());
 382     if (index.get() && *index.get()) {
 383         SessionIndex* si = SessionIndexBuilder::buildSessionIndex();
 384         msg->getSessionIndexs().push_back(si);
 385         si->setSessionIndex(index.get());
 386     }
 387
 388     const NameID* nameid = session.getNameID();
 389     const PropertySet* relyingParty = application.getRelyingParty(dynamic_cast<EntityDescriptor*>(role.getParent()));
 390     pair<bool,const char*> flag = relyingParty->getString("encryptRequests");
 391     if (flag.first &&
 392         (!strcmp(flag.second, "true") || (encoder && !strcmp(flag.second, "front")) || (!encoder && !strcmp(flag.second, "back")))) {
 393         auto_ptr<EncryptedID> encrypted(EncryptedIDBuilder::buildEncryptedID());
 394         MetadataCredentialCriteria mcc(role);
 395         encrypted->encrypt(
 396             *nameid,
 397             *(application.getMetadataProvider()),
 398             mcc,
 399             encoder ? encoder->isCompact() : false,
 400             relyingParty->getXMLString("encryptionAlg").second
 401             );
 402         msg->setEncryptedID(encrypted.release());
 403     }
 404
 405     if (!encoder) {
 406         // No encoder being used, so sign for SOAP client manually.
 407         flag = relyingParty->getString("signRequests");
 408         if (flag.first && (!strcmp(flag.second, "true") || !strcmp(flag.second, "back"))) {
 409             CredentialResolver* credResolver=application.getCredentialResolver();
 410             if (credResolver) {
 411                 Locker credLocker(credResolver);
 412                 // Fill in criteria to use.
 413                 MetadataCredentialCriteria mcc(role);
 414                 mcc.setUsage(CredentialCriteria::SIGNING_CREDENTIAL);
 415                 pair<bool,const char*> keyName = relyingParty->getString("keyName");
 416                 if (keyName.first)
 417                     mcc.getKeyNames().insert(keyName.second);
 418                 pair<bool,const XMLCh*> sigalg = relyingParty->getXMLString("signatureAlg");
 419                 if (sigalg.first)
 420                     mcc.setXMLAlgorithm(sigalg.second);
 421                 const Credential* cred = credResolver->resolve(&mcc);
 422                 if (cred) {
 423                     xmlsignature::Signature* sig = xmlsignature::SignatureBuilder::buildSignature();
 424                     msg->setSignature(sig);
 425                     pair<bool, const XMLCh*> alg = relyingParty->getXMLString("signatureAlg");
 426                     if (alg.first)
 427                         sig->setSignatureAlgorithm(alg.second);
 428                     alg = relyingParty->getXMLString("digestAlg");
 429                     if (alg.first) {
 430                         ContentReference* cr = dynamic_cast<ContentReference*>(sig->getContentReference());
 431                         if (cr)
 432                             cr->setDigestAlgorithm(alg.second);
 433                     }
 434
 435                     // Sign response while marshalling.
 436                     vector<xmlsignature::Signature*> sigs(1,sig);
 437                     msg->marshall((DOMDocument*)NULL,&sigs,cred);
 438                 }
 439                 else {
 440                     m_log.warn("no signing credential resolved, leaving message unsigned");
 441                 }
 442             }
 443             else {
 444                 m_log.warn("no credential resolver installed, leaving message unsigned");
 445             }
 446         }
 447     }
 448
 449     return msg.release();
 450 }
 451
 452 #endif