adfs/adfs.cpp

   1 /**
   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.
   6  *
   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
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  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.
  19  */
  20
  21 /**
  22  * adfs.cpp
  23  *
  24  * ADFSv1 extension library.
  25  */
  26
  27 #if defined (_MSC_VER) || defined(__BORLANDC__)
  28 # include "config_win32.h"
  29 #else
  30 # include "config.h"
  31 #endif
  32
  33 #ifdef WIN32
  34 # define _CRT_NONSTDC_NO_DEPRECATE 1
  35 # define _CRT_SECURE_NO_DEPRECATE 1
  36 # define ADFS_EXPORTS __declspec(dllexport)
  37 #else
  38 # define ADFS_EXPORTS
  39 #endif
  40
  41 #include <shibsp/base.h>
  42 #include <shibsp/exceptions.h>
  43 #include <shibsp/Application.h>
  44 #include <shibsp/ServiceProvider.h>
  45 #include <shibsp/SessionCache.h>
  46 #include <shibsp/SPConfig.h>
  47 #include <shibsp/SPRequest.h>
  48 #include <shibsp/handler/AssertionConsumerService.h>
  49 #include <shibsp/handler/LogoutInitiator.h>
  50 #include <shibsp/handler/SessionInitiator.h>
  51 #include <xmltooling/logging.h>
  52 #include <xmltooling/util/DateTime.h>
  53 #include <xmltooling/util/NDC.h>
  54 #include <xmltooling/util/URLEncoder.h>
  55 #include <xmltooling/util/XMLHelper.h>
  56 #include <memory>
  57
  58 #ifndef SHIBSP_LITE
  59 # include <shibsp/attribute/resolver/ResolutionContext.h>
  60 # include <shibsp/metadata/MetadataProviderCriteria.h>
  61 # include <saml/SAMLConfig.h>
  62 # include <saml/exceptions.h>
  63 # include <saml/binding/SecurityPolicy.h>
  64 # include <saml/saml1/core/Assertions.h>
  65 # include <saml/saml2/core/Assertions.h>
  66 # include <saml/saml2/metadata/Metadata.h>
  67 # include <saml/saml2/metadata/EndpointManager.h>
  68 # include <xmltooling/XMLToolingConfig.h>
  69 # include <xmltooling/impl/AnyElement.h>
  70 # include <xmltooling/util/ParserPool.h>
  71 # include <xmltooling/validation/ValidatorSuite.h>
  72 using namespace opensaml::saml2md;
  73 # ifndef min
  74 #  define min(a,b)            (((a) < (b)) ? (a) : (b))
  75 # endif
  76 #endif
  77 using namespace shibsp;
  78 using namespace opensaml;
  79 using namespace xmltooling::logging;
  80 using namespace xmltooling;
  81 using namespace xercesc;
  82 using namespace std;
  83
  84 #define WSFED_NS "http://schemas.xmlsoap.org/ws/2003/07/secext"
  85 #define WSTRUST_NS "http://schemas.xmlsoap.org/ws/2005/02/trust"
  86
  87 namespace {
  88
  89 #ifndef SHIBSP_LITE
  90     class SHIBSP_DLLLOCAL ADFSDecoder : public MessageDecoder
  91     {
  92         auto_ptr_XMLCh m_ns;
  93     public:
  94         ADFSDecoder() : m_ns(WSTRUST_NS) {}
  95         virtual ~ADFSDecoder() {}
  96
  97         const XMLCh* getProtocolFamily() const {
  98             return m_ns.get();
  99         }
 100
 101         XMLObject* decode(string& relayState, const GenericRequest& genericRequest, SecurityPolicy& policy) const;
 102
 103     protected:
 104         void extractMessageDetails(
 105             const XMLObject& message, const GenericRequest& req, const XMLCh* protocol, SecurityPolicy& policy
 106             ) const {
 107         }
 108     };
 109
 110     MessageDecoder* ADFSDecoderFactory(const pair<const DOMElement*,const XMLCh*>& p)
 111     {
 112         return new ADFSDecoder();
 113     }
 114 #endif
 115
 116 #if defined (_MSC_VER)
 117     #pragma warning( push )
 118     #pragma warning( disable : 4250 )
 119 #endif
 120
 121     class SHIBSP_DLLLOCAL ADFSSessionInitiator : public SessionInitiator, public AbstractHandler, public RemotedHandler
 122     {
 123     public:
 124         ADFSSessionInitiator(const DOMElement* e, const char* appId)
 125             : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".SessionInitiator.ADFS"), nullptr, &m_remapper), m_appId(appId), m_binding(WSFED_NS) {
 126             // If Location isn't set, defer address registration until the setParent call.
 127             pair<bool,const char*> loc = getString("Location");
 128             if (loc.first) {
 129                 string address = m_appId + loc.second + "::run::ADFSSI";
 130                 setAddress(address.c_str());
 131             }
 132         }
 133         virtual ~ADFSSessionInitiator() {}
 134
 135         void setParent(const PropertySet* parent) {
 136             DOMPropertySet::setParent(parent);
 137             pair<bool,const char*> loc = getString("Location");
 138             if (loc.first) {
 139                 string address = m_appId + loc.second + "::run::ADFSSI";
 140                 setAddress(address.c_str());
 141             }
 142             else {
 143                 m_log.warn("no Location property in ADFS SessionInitiator (or parent), can't register as remoted handler");
 144             }
 145         }
 146
 147         void receive(DDF& in, ostream& out);
 148         pair<bool,long> unwrap(SPRequest& request, DDF& out) const;
 149         pair<bool,long> run(SPRequest& request, string& entityID, bool isHandler=true) const;
 150
 151         const XMLCh* getProtocolFamily() const {
 152             return m_binding.get();
 153         }
 154
 155     private:
 156         pair<bool,long> doRequest(
 157             const Application& application,
 158             const HTTPRequest* httpRequest,
 159             HTTPResponse& httpResponse,
 160             const char* entityID,
 161             const char* acsLocation,
 162             const char* authnContextClassRef,
 163             string& relayState
 164             ) const;
 165         string m_appId;
 166         auto_ptr_XMLCh m_binding;
 167     };
 168
 169     class SHIBSP_DLLLOCAL ADFSConsumer : public shibsp::AssertionConsumerService
 170     {
 171         auto_ptr_XMLCh m_protocol;
 172     public:
 173         ADFSConsumer(const DOMElement* e, const char* appId)
 174             : shibsp::AssertionConsumerService(e, appId, Category::getInstance(SHIBSP_LOGCAT".SSO.ADFS")), m_protocol(WSFED_NS) {}
 175         virtual ~ADFSConsumer() {}
 176
 177 #ifndef SHIBSP_LITE
 178         void generateMetadata(SPSSODescriptor& role, const char* handlerURL) const {
 179             AssertionConsumerService::generateMetadata(role, handlerURL);
 180             role.addSupport(m_protocol.get());
 181         }
 182
 183     private:
 184         void implementProtocol(
 185             const Application& application,
 186             const HTTPRequest& httpRequest,
 187             HTTPResponse& httpResponse,
 188             SecurityPolicy& policy,
 189             const PropertySet*,
 190             const XMLObject& xmlObject
 191             ) const;
 192 #else
 193         const XMLCh* getProtocolFamily() const {
 194             return m_protocol.get();
 195         }
 196 #endif
 197     };
 198
 199     class SHIBSP_DLLLOCAL ADFSLogoutInitiator : public AbstractHandler, public LogoutInitiator
 200     {
 201     public:
 202         ADFSLogoutInitiator(const DOMElement* e, const char* appId)
 203                 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".LogoutInitiator.ADFS")), m_appId(appId), m_binding(WSFED_NS) {
 204             // If Location isn't set, defer address registration until the setParent call.
 205             pair<bool,const char*> loc = getString("Location");
 206             if (loc.first) {
 207                 string address = m_appId + loc.second + "::run::ADFSLI";
 208                 setAddress(address.c_str());
 209             }
 210         }
 211         virtual ~ADFSLogoutInitiator() {}
 212
 213         void setParent(const PropertySet* parent) {
 214             DOMPropertySet::setParent(parent);
 215             pair<bool,const char*> loc = getString("Location");
 216             if (loc.first) {
 217                 string address = m_appId + loc.second + "::run::ADFSLI";
 218                 setAddress(address.c_str());
 219             }
 220             else {
 221                 m_log.warn("no Location property in ADFS LogoutInitiator (or parent), can't register as remoted handler");
 222             }
 223         }
 224
 225         void receive(DDF& in, ostream& out);
 226         pair<bool,long> run(SPRequest& request, bool isHandler=true) const;
 227
 228         const XMLCh* getProtocolFamily() const {
 229             return m_binding.get();
 230         }
 231
 232     private:
 233         pair<bool,long> doRequest(const Application& application, const HTTPRequest& httpRequest, HTTPResponse& httpResponse, Session* session) const;
 234
 235         string m_appId;
 236         auto_ptr_XMLCh m_binding;
 237     };
 238
 239     class SHIBSP_DLLLOCAL ADFSLogout : public AbstractHandler, public LogoutHandler
 240     {
 241     public:
 242         ADFSLogout(const DOMElement* e, const char* appId)
 243                 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".Logout.ADFS")), m_login(e, appId) {
 244             m_initiator = false;
 245 #ifndef SHIBSP_LITE
 246             m_preserve.push_back("wreply");
 247             string address = string(appId) + getString("Location").second + "::run::ADFSLO";
 248             setAddress(address.c_str());
 249 #endif
 250         }
 251         virtual ~ADFSLogout() {}
 252
 253         pair<bool,long> run(SPRequest& request, bool isHandler=true) const;
 254
 255 #ifndef SHIBSP_LITE
 256         void generateMetadata(SPSSODescriptor& role, const char* handlerURL) const {
 257             m_login.generateMetadata(role, handlerURL);
 258             const char* loc = getString("Location").second;
 259             string hurl(handlerURL);
 260             if (*loc != '/')
 261                 hurl += '/';
 262             hurl += loc;
 263             auto_ptr_XMLCh widen(hurl.c_str());
 264             SingleLogoutService* ep = SingleLogoutServiceBuilder::buildSingleLogoutService();
 265             ep->setLocation(widen.get());
 266             ep->setBinding(m_login.getProtocolFamily());
 267             role.getSingleLogoutServices().push_back(ep);
 268         }
 269
 270         const char* getType() const {
 271             return m_login.getType();
 272         }
 273 #endif
 274         const XMLCh* getProtocolFamily() const {
 275             return m_login.getProtocolFamily();
 276         }
 277
 278     private:
 279         ADFSConsumer m_login;
 280     };
 281
 282 #if defined (_MSC_VER)
 283     #pragma warning( pop )
 284 #endif
 285
 286     SessionInitiator* ADFSSessionInitiatorFactory(const pair<const DOMElement*,const char*>& p)
 287     {
 288         return new ADFSSessionInitiator(p.first, p.second);
 289     }
 290
 291     Handler* ADFSLogoutFactory(const pair<const DOMElement*,const char*>& p)
 292     {
 293         return new ADFSLogout(p.first, p.second);
 294     }
 295
 296     Handler* ADFSLogoutInitiatorFactory(const pair<const DOMElement*,const char*>& p)
 297     {
 298         return new ADFSLogoutInitiator(p.first, p.second);
 299     }
 300
 301     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);
 302     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);
 303 };
 304
 305 extern "C" int ADFS_EXPORTS xmltooling_extension_init(void*)
 306 {
 307     SPConfig& conf=SPConfig::getConfig();
 308     conf.SessionInitiatorManager.registerFactory("ADFS", ADFSSessionInitiatorFactory);
 309     conf.LogoutInitiatorManager.registerFactory("ADFS", ADFSLogoutInitiatorFactory);
 310     conf.AssertionConsumerServiceManager.registerFactory("ADFS", ADFSLogoutFactory);
 311     conf.AssertionConsumerServiceManager.registerFactory(WSFED_NS, ADFSLogoutFactory);
 312 #ifndef SHIBSP_LITE
 313     SAMLConfig::getConfig().MessageDecoderManager.registerFactory(WSFED_NS, ADFSDecoderFactory);
 314     XMLObjectBuilder::registerBuilder(xmltooling::QName(WSTRUST_NS,"RequestedSecurityToken"), new AnyElementBuilder());
 315     XMLObjectBuilder::registerBuilder(xmltooling::QName(WSTRUST_NS,"RequestSecurityTokenResponse"), new AnyElementBuilder());
 316 #endif
 317     return 0;
 318 }
 319
 320 extern "C" void ADFS_EXPORTS xmltooling_extension_term()
 321 {
 322     /* should get unregistered during normal shutdown...
 323     SPConfig& conf=SPConfig::getConfig();
 324     conf.SessionInitiatorManager.deregisterFactory("ADFS");
 325     conf.LogoutInitiatorManager.deregisterFactory("ADFS");
 326     conf.AssertionConsumerServiceManager.deregisterFactory("ADFS");
 327     conf.AssertionConsumerServiceManager.deregisterFactory(WSFED_NS);
 328 #ifndef SHIBSP_LITE
 329     SAMLConfig::getConfig().MessageDecoderManager.deregisterFactory(WSFED_NS);
 330 #endif
 331     */
 332 }
 333
 334 pair<bool,long> ADFSSessionInitiator::run(SPRequest& request, string& entityID, bool isHandler) const
 335 {
 336     // We have to know the IdP to function.
 337     if (entityID.empty() || !checkCompatibility(request, isHandler))
 338         return make_pair(false,0L);
 339
 340     string target;
 341     pair<bool,const char*> prop;
 342     pair<bool,const char*> acClass;
 343     const Handler* ACS=nullptr;
 344     const Application& app=request.getApplication();
 345
 346     if (isHandler) {
 347         prop.second = request.getParameter("acsIndex");
 348         if (prop.second && *prop.second) {
 349             ACS = app.getAssertionConsumerServiceByIndex(atoi(prop.second));
 350             if (!ACS)
 351                 request.log(SPRequest::SPWarn, "invalid acsIndex specified in request, using acsIndex property");
 352         }
 353
 354         prop = getString("target", request);
 355         if (prop.first)
 356             target = prop.second;
 357
 358         // Since we're passing the ACS by value, we need to compute the return URL,
 359         // so we'll need the target resource for real.
 360         recoverRelayState(app, request, request, target, false);
 361
 362         acClass = getString("authnContextClassRef", request);
 363     }
 364     else {
 365         // Check for a hardwired target value in the map or handler.
 366         prop = getString("target", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
 367         if (prop.first)
 368             target = prop.second;
 369         else
 370             target = request.getRequestURL();
 371
 372         acClass = getString("authnContextClassRef", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
 373     }
 374
 375     if (!ACS) {
 376         pair<bool,unsigned int> index = getUnsignedInt("acsIndex", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
 377         if (index.first)
 378             ACS = app.getAssertionConsumerServiceByIndex(index.second);
 379     }
 380
 381     // Validate the ACS for use with this protocol.
 382     if (!ACS || !XMLString::equals(getProtocolFamily(), ACS->getProtocolFamily())) {
 383         if (ACS)
 384             request.log(SPRequest::SPWarn, "invalid acsIndex property, or non-ADFS ACS, using default ADFS ACS");
 385         ACS = app.getAssertionConsumerServiceByProtocol(getProtocolFamily());
 386         if (!ACS)
 387             throw ConfigurationException("Unable to locate an ADFS-compatible ACS in the configuration.");
 388     }
 389
 390     // Since we're not passing by index, we need to fully compute the return URL.
 391     // Compute the ACS URL. We add the ACS location to the base handlerURL.
 392     string ACSloc=request.getHandlerURL(target.c_str());
 393     prop = ACS->getString("Location");
 394     if (prop.first)
 395         ACSloc += prop.second;
 396
 397     if (isHandler) {
 398         // We may already have RelayState set if we looped back here,
 399         // but we've turned it back into a resource by this point, so if there's
 400         // a target on the URL, reset to that value.
 401         prop.second = request.getParameter("target");
 402         if (prop.second && *prop.second)
 403             target = prop.second;
 404     }
 405
 406     m_log.debug("attempting to initiate session using ADFS with provider (%s)", entityID.c_str());
 407
 408     if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
 409         // Out of process means the POST data via the request can be exposed directly to the private method.
 410         // The method will handle POST preservation if necessary *before* issuing the response, but only if
 411         // it dispatches to an IdP.
 412         return doRequest(app, &request, request, entityID.c_str(), ACSloc.c_str(), (acClass.first ? acClass.second : nullptr), target);
 413     }
 414
 415     // Remote the call.
 416     DDF out,in = DDF(m_address.c_str()).structure();
 417     DDFJanitor jin(in), jout(out);
 418     in.addmember("application_id").string(app.getId());
 419     in.addmember("entity_id").string(entityID.c_str());
 420     in.addmember("acsLocation").string(ACSloc.c_str());
 421     if (!target.empty())
 422         in.addmember("RelayState").unsafe_string(target.c_str());
 423     if (acClass.first)
 424         in.addmember("authnContextClassRef").string(acClass.second);
 425
 426     // Remote the processing.
 427     out = request.getServiceProvider().getListenerService()->send(in);
 428     return unwrap(request, out);
 429 }
 430
 431 pair<bool,long> ADFSSessionInitiator::unwrap(SPRequest& request, DDF& out) const
 432 {
 433     // See if there's any response to send back.
 434     if (!out["redirect"].isnull() || !out["response"].isnull()) {
 435         // If so, we're responsible for handling the POST data, probably by dropping a cookie.
 436         preservePostData(request.getApplication(), request, request, out["RelayState"].string());
 437     }
 438     return RemotedHandler::unwrap(request, out);
 439 }
 440
 441 void ADFSSessionInitiator::receive(DDF& in, ostream& out)
 442 {
 443     // Find application.
 444     const char* aid=in["application_id"].string();
 445     const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : nullptr;
 446     if (!app) {
 447         // Something's horribly wrong.
 448         m_log.error("couldn't find application (%s) to generate ADFS request", aid ? aid : "(missing)");
 449         throw ConfigurationException("Unable to locate application for new session, deleted?");
 450     }
 451
 452     const char* entityID = in["entity_id"].string();
 453     const char* acsLocation = in["acsLocation"].string();
 454     if (!entityID || !acsLocation)
 455         throw ConfigurationException("No entityID or acsLocation parameter supplied to remoted SessionInitiator.");
 456
 457     DDF ret(nullptr);
 458     DDFJanitor jout(ret);
 459
 460     // Wrap the outgoing object with a Response facade.
 461     auto_ptr<HTTPResponse> http(getResponse(ret));
 462
 463     string relayState(in["RelayState"].string() ? in["RelayState"].string() : "");
 464
 465     // Since we're remoted, the result should either be a throw, which we pass on,
 466     // a false/0 return, which we just return as an empty structure, or a response/redirect,
 467     // which we capture in the facade and send back.
 468     doRequest(*app, nullptr, *http.get(), entityID, acsLocation, in["authnContextClassRef"].string(), relayState);
 469     if (!ret.isstruct())
 470         ret.structure();
 471     ret.addmember("RelayState").unsafe_string(relayState.c_str());
 472     out << ret;
 473 }
 474
 475 pair<bool,long> ADFSSessionInitiator::doRequest(
 476     const Application& app,
 477     const HTTPRequest* httpRequest,
 478     HTTPResponse& httpResponse,
 479     const char* entityID,
 480     const char* acsLocation,
 481     const char* authnContextClassRef,
 482     string& relayState
 483     ) const
 484 {
 485 #ifndef SHIBSP_LITE
 486     // Use metadata to invoke the SSO service directly.
 487     MetadataProvider* m=app.getMetadataProvider();
 488     Locker locker(m);
 489     MetadataProviderCriteria mc(app, entityID, &IDPSSODescriptor::ELEMENT_QNAME, m_binding.get());
 490     pair<const EntityDescriptor*,const RoleDescriptor*> entity=m->getEntityDescriptor(mc);
 491     if (!entity.first) {
 492         m_log.warn("unable to locate metadata for provider (%s)", entityID);
 493         throw MetadataException("Unable to locate metadata for identity provider ($entityID)", namedparams(1, "entityID", entityID));
 494     }
 495     else if (!entity.second) {
 496         m_log.log(getParent() ? Priority::INFO : Priority::WARN, "unable to locate ADFS-aware identity provider role for provider (%s)", entityID);
 497         if (getParent())
 498             return make_pair(false,0L);
 499         throw MetadataException("Unable to locate ADFS-aware identity provider role for provider ($entityID)", namedparams(1, "entityID", entityID));
 500     }
 501     const EndpointType* ep = EndpointManager<SingleSignOnService>(
 502         dynamic_cast<const IDPSSODescriptor*>(entity.second)->getSingleSignOnServices()
 503         ).getByBinding(m_binding.get());
 504     if (!ep) {
 505         m_log.warn("unable to locate compatible SSO service for provider (%s)", entityID);
 506         if (getParent())
 507             return make_pair(false,0L);
 508         throw MetadataException("Unable to locate compatible SSO service for provider ($entityID)", namedparams(1, "entityID", entityID));
 509     }
 510
 511     preserveRelayState(app, httpResponse, relayState);
 512
 513     // UTC timestamp
 514     time_t epoch=time(nullptr);
 515 #ifndef HAVE_GMTIME_R
 516     struct tm* ptime=gmtime(&epoch);
 517 #else
 518     struct tm res;
 519     struct tm* ptime=gmtime_r(&epoch,&res);
 520 #endif
 521     char timebuf[32];
 522     strftime(timebuf,32,"%Y-%m-%dT%H:%M:%SZ",ptime);
 523
 524     auto_ptr_char dest(ep->getLocation());
 525     const URLEncoder* urlenc = XMLToolingConfig::getConfig().getURLEncoder();
 526
 527     string req=string(dest.get()) + (strchr(dest.get(),'?') ? '&' : '?') + "wa=wsignin1.0&wreply=" + urlenc->encode(acsLocation) +
 528         "&wct=" + urlenc->encode(timebuf) + "&wtrealm=" + urlenc->encode(app.getString("entityID").second);
 529     if (authnContextClassRef)
 530         req += "&wauth=" + urlenc->encode(authnContextClassRef);
 531     if (!relayState.empty())
 532         req += "&wctx=" + urlenc->encode(relayState.c_str());
 533
 534     if (httpRequest) {
 535         // If the request object is available, we're responsible for the POST data.
 536         preservePostData(app, *httpRequest, httpResponse, relayState.c_str());
 537     }
 538
 539     return make_pair(true, httpResponse.sendRedirect(req.c_str()));
 540 #else
 541     return make_pair(false,0L);
 542 #endif
 543 }
 544
 545 #ifndef SHIBSP_LITE
 546
 547 XMLObject* ADFSDecoder::decode(string& relayState, const GenericRequest& genericRequest, SecurityPolicy& policy) const
 548 {
 549 #ifdef _DEBUG
 550     xmltooling::NDC ndc("decode");
 551 #endif
 552     Category& log = Category::getInstance(SHIBSP_LOGCAT".MessageDecoder.ADFS");
 553
 554     log.debug("validating input");
 555     const HTTPRequest* httpRequest=dynamic_cast<const HTTPRequest*>(&genericRequest);
 556     if (!httpRequest)
 557         throw BindingException("Unable to cast request object to HTTPRequest type.");
 558     if (strcmp(httpRequest->getMethod(),"POST"))
 559         throw BindingException("Invalid HTTP method ($1).", params(1, httpRequest->getMethod()));
 560     const char* param = httpRequest->getParameter("wa");
 561     if (!param || strcmp(param, "wsignin1.0"))
 562         throw BindingException("Missing or invalid wa parameter (should be wsignin1.0).");
 563     param = httpRequest->getParameter("wctx");
 564     if (param)
 565         relayState = param;
 566
 567     param = httpRequest->getParameter("wresult");
 568     if (!param)
 569         throw BindingException("Request missing wresult parameter.");
 570
 571     log.debug("decoded ADFS response:\n%s", param);
 572
 573     // Parse and bind the document into an XMLObject.
 574     istringstream is(param);
 575     DOMDocument* doc = (policy.getValidating() ? XMLToolingConfig::getConfig().getValidatingParser()
 576         : XMLToolingConfig::getConfig().getParser()).parse(is);
 577     XercesJanitor<DOMDocument> janitor(doc);
 578     auto_ptr<XMLObject> xmlObject(XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true));
 579     janitor.release();
 580
 581     if (!XMLString::equals(xmlObject->getElementQName().getLocalPart(), RequestSecurityTokenResponse)) {
 582         log.error("unrecognized root element on message: %s", xmlObject->getElementQName().toString().c_str());
 583         throw BindingException("Decoded message was not of the appropriate type.");
 584     }
 585
 586     SchemaValidators.validate(xmlObject.get());
 587
 588     // Skip policy step here, there's no security in the wrapper.
 589     // policy.evaluate(*xmlObject.get(), &genericRequest);
 590
 591     return xmlObject.release();
 592 }
 593
 594 void ADFSConsumer::implementProtocol(
 595     const Application& application,
 596     const HTTPRequest& httpRequest,
 597     HTTPResponse& httpResponse,
 598     SecurityPolicy& policy,
 599     const PropertySet*,
 600     const XMLObject& xmlObject
 601     ) const
 602 {
 603     // Implementation of ADFS profile.
 604     m_log.debug("processing message against ADFS Passive Requester profile");
 605
 606     // With ADFS, all the security comes from the assertion, which is two levels down in the message.
 607
 608     const ElementProxy* response = dynamic_cast<const ElementProxy*>(&xmlObject);
 609     if (!response || !response->hasChildren())
 610         throw FatalProfileException("Incoming message was not of the proper type or contains no security token.");
 611
 612     const Assertion* token = nullptr;
 613     for (vector<XMLObject*>::const_iterator xo = response->getUnknownXMLObjects().begin(); xo != response->getUnknownXMLObjects().end(); ++xo) {
 614         // Look for the RequestedSecurityToken element.
 615         if (XMLString::equals((*xo)->getElementQName().getLocalPart(), RequestedSecurityToken)) {
 616             response = dynamic_cast<const ElementProxy*>(*xo);
 617             if (!response || !response->hasChildren())
 618                 throw FatalProfileException("Token wrapper element did not contain a security token.");
 619             token = dynamic_cast<const Assertion*>(response->getUnknownXMLObjects().front());
 620             if (!token || !token->getSignature())
 621                 throw FatalProfileException("Incoming message did not contain a signed SAML assertion.");
 622             break;
 623         }
 624     }
 625
 626     // Extract message and issuer details from assertion.
 627     extractMessageDetails(*token, m_protocol.get(), policy);
 628
 629     // Populate recipient as audience.
 630     const EntityDescriptor* entity = policy.getIssuerMetadata() ? dynamic_cast<const EntityDescriptor*>(policy.getIssuerMetadata()->getParent()) : nullptr;
 631     policy.getAudiences().push_back(application.getRelyingParty(entity)->getXMLString("entityID").second);
 632
 633     // Run the policy over the assertion. Handles replay, freshness, and
 634     // signature verification, assuming the relevant rules are configured,
 635     // along with condition enforcement.
 636     policy.evaluate(*token, &httpRequest);
 637
 638     // If no security is in place now, we kick it.
 639     if (!policy.isAuthenticated())
 640         throw SecurityPolicyException("Unable to establish security of incoming assertion.");
 641
 642     saml1::NameIdentifier* saml1name=nullptr;
 643     saml2::NameID* saml2name=nullptr;
 644     const XMLCh* authMethod=nullptr;
 645     const XMLCh* authInstant=nullptr;
 646     time_t now = time(nullptr), sessionExp = 0;
 647     const PropertySet* sessionProps = application.getPropertySet("Sessions");
 648
 649     const saml1::Assertion* saml1token = dynamic_cast<const saml1::Assertion*>(token);
 650     if (saml1token) {
 651         // Now do profile validation to ensure we can use it for SSO.
 652         if (!saml1token->getConditions() || !saml1token->getConditions()->getNotBefore() || !saml1token->getConditions()->getNotOnOrAfter())
 653             throw FatalProfileException("Assertion did not contain time conditions.");
 654         else if (saml1token->getAuthenticationStatements().empty())
 655             throw FatalProfileException("Assertion did not contain an authentication statement.");
 656
 657         // authnskew allows rejection of SSO if AuthnInstant is too old.
 658         pair<bool,unsigned int> authnskew = sessionProps ? sessionProps->getUnsignedInt("maxTimeSinceAuthn") : pair<bool,unsigned int>(false,0);
 659
 660         const saml1::AuthenticationStatement* ssoStatement=saml1token->getAuthenticationStatements().front();
 661         if (ssoStatement->getAuthenticationInstant()) {
 662             if (ssoStatement->getAuthenticationInstantEpoch() - XMLToolingConfig::getConfig().clock_skew_secs > now) {
 663                 throw FatalProfileException("The login time at your identity provider was future-dated.");
 664             }
 665             else if (authnskew.first && authnskew.second && ssoStatement->getAuthenticationInstantEpoch() <= now &&
 666                     (now - ssoStatement->getAuthenticationInstantEpoch() > authnskew.second)) {
 667                 throw FatalProfileException("The gap between now and the time you logged into your identity provider exceeds the allowed limit.");
 668             }
 669         }
 670         else if (authnskew.first && authnskew.second) {
 671             throw FatalProfileException("Your identity provider did not supply a time of login, violating local policy.");
 672         }
 673
 674         // Address checking.
 675         saml1::SubjectLocality* locality = ssoStatement->getSubjectLocality();
 676         if (locality && locality->getIPAddress()) {
 677             auto_ptr_char ip(locality->getIPAddress());
 678             checkAddress(application, httpRequest, ip.get());
 679         }
 680
 681         saml1name = ssoStatement->getSubject()->getNameIdentifier();
 682         authMethod = ssoStatement->getAuthenticationMethod();
 683         if (ssoStatement->getAuthenticationInstant())
 684             authInstant = ssoStatement->getAuthenticationInstant()->getRawData();
 685
 686         // Session expiration.
 687         pair<bool,unsigned int> lifetime = sessionProps ? sessionProps->getUnsignedInt("lifetime") : pair<bool,unsigned int>(true,28800);
 688         if (!lifetime.first || lifetime.second == 0)
 689             lifetime.second = 28800;
 690         sessionExp = now + lifetime.second;
 691     }
 692     else {
 693         const saml2::Assertion* saml2token = dynamic_cast<const saml2::Assertion*>(token);
 694         if (!saml2token)
 695             throw FatalProfileException("Incoming message did not contain a recognized type of SAML assertion.");
 696
 697         // Now do profile validation to ensure we can use it for SSO.
 698         if (!saml2token->getConditions() || !saml2token->getConditions()->getNotBefore() || !saml2token->getConditions()->getNotOnOrAfter())
 699             throw FatalProfileException("Assertion did not contain time conditions.");
 700         else if (saml2token->getAuthnStatements().empty())
 701             throw FatalProfileException("Assertion did not contain an authentication statement.");
 702
 703         // authnskew allows rejection of SSO if AuthnInstant is too old.
 704         pair<bool,unsigned int> authnskew = sessionProps ? sessionProps->getUnsignedInt("maxTimeSinceAuthn") : pair<bool,unsigned int>(false,0);
 705
 706         const saml2::AuthnStatement* ssoStatement=saml2token->getAuthnStatements().front();
 707         if (authnskew.first && authnskew.second &&
 708                 ssoStatement->getAuthnInstant() && (now - ssoStatement->getAuthnInstantEpoch() > authnskew.second))
 709             throw FatalProfileException("The gap between now and the time you logged into your identity provider exceeds the limit.");
 710
 711         // Address checking.
 712         saml2::SubjectLocality* locality = ssoStatement->getSubjectLocality();
 713         if (locality && locality->getAddress()) {
 714             auto_ptr_char ip(locality->getAddress());
 715             checkAddress(application, httpRequest, ip.get());
 716         }
 717
 718         saml2name = saml2token->getSubject() ? saml2token->getSubject()->getNameID() : nullptr;
 719         if (ssoStatement->getAuthnContext() && ssoStatement->getAuthnContext()->getAuthnContextClassRef())
 720             authMethod = ssoStatement->getAuthnContext()->getAuthnContextClassRef()->getReference();
 721         if (ssoStatement->getAuthnInstant())
 722             authInstant = ssoStatement->getAuthnInstant()->getRawData();
 723
 724         // Session expiration for SAML 2.0 is jointly IdP- and SP-driven.
 725         sessionExp = ssoStatement->getSessionNotOnOrAfter() ? ssoStatement->getSessionNotOnOrAfterEpoch() : 0;
 726         pair<bool,unsigned int> lifetime = sessionProps ? sessionProps->getUnsignedInt("lifetime") : pair<bool,unsigned int>(true,28800);
 727         if (!lifetime.first || lifetime.second == 0)
 728             lifetime.second = 28800;
 729         if (sessionExp == 0)
 730             sessionExp = now + lifetime.second;     // IdP says nothing, calulate based on SP.
 731         else
 732             sessionExp = min(sessionExp, now + lifetime.second);    // Use the lowest.
 733     }
 734
 735     m_log.debug("ADFS profile processing completed successfully");
 736
 737     // We've successfully "accepted" the SSO token.
 738     // To complete processing, we need to extract and resolve attributes and then create the session.
 739
 740     // Normalize a SAML 1.x NameIdentifier...
 741     auto_ptr<saml2::NameID> nameid(saml1name ? saml2::NameIDBuilder::buildNameID() : nullptr);
 742     if (saml1name) {
 743         nameid->setName(saml1name->getName());
 744         nameid->setFormat(saml1name->getFormat());
 745         nameid->setNameQualifier(saml1name->getNameQualifier());
 746     }
 747
 748     // The context will handle deleting attributes and new tokens.
 749     vector<const Assertion*> tokens(1,token);
 750     auto_ptr<ResolutionContext> ctx(
 751         resolveAttributes(
 752             application,
 753             policy.getIssuerMetadata(),
 754             m_protocol.get(),
 755             saml1name,
 756             (saml1name ? nameid.get() : saml2name),
 757             authMethod,
 758             nullptr,
 759             &tokens
 760             )
 761         );
 762
 763     if (ctx.get()) {
 764         // Copy over any new tokens, but leave them in the context for cleanup.
 765         tokens.insert(tokens.end(), ctx->getResolvedAssertions().begin(), ctx->getResolvedAssertions().end());
 766     }
 767
 768     application.getServiceProvider().getSessionCache()->insert(
 769         application,
 770         httpRequest,
 771         httpResponse,
 772         sessionExp,
 773         entity,
 774         m_protocol.get(),
 775         (saml1name ? nameid.get() : saml2name),
 776         authInstant,
 777         nullptr,
 778         authMethod,
 779         nullptr,
 780         &tokens,
 781         ctx.get() ? &ctx->getResolvedAttributes() : nullptr
 782         );
 783 }
 784
 785 #endif
 786
 787 pair<bool,long> ADFSLogoutInitiator::run(SPRequest& request, bool isHandler) const
 788 {
 789     // Normally we'd do notifications and session clearage here, but ADFS logout
 790     // is missing the needed request/response features, so we have to rely on
 791     // the IdP half to notify us back about the logout and do the work there.
 792     // Basically we have no way to tell in the Logout receiving handler whether
 793     // we initiated the logout or not.
 794
 795     Session* session = nullptr;
 796     try {
 797         session = request.getSession(false, true, false);  // don't cache it and ignore all checks
 798         if (!session)
 799             return make_pair(false,0L);
 800
 801         // We only handle ADFS sessions.
 802         if (!XMLString::equals(session->getProtocol(), WSFED_NS) || !session->getEntityID()) {
 803             session->unlock();
 804             return make_pair(false,0L);
 805         }
 806     }
 807     catch (exception& ex) {
 808         m_log.error("error accessing current session: %s", ex.what());
 809         return make_pair(false,0L);
 810     }
 811
 812     string entityID(session->getEntityID());
 813     session->unlock();
 814
 815     if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
 816         // When out of process, we run natively.
 817         return doRequest(request.getApplication(), request, request, session);
 818     }
 819     else {
 820         // When not out of process, we remote the request.
 821         session->unlock();
 822         vector<string> headers(1,"Cookie");
 823         DDF out,in = wrap(request,&headers);
 824         DDFJanitor jin(in), jout(out);
 825         out=request.getServiceProvider().getListenerService()->send(in);
 826         return unwrap(request, out);
 827     }
 828 }
 829
 830 void ADFSLogoutInitiator::receive(DDF& in, ostream& out)
 831 {
 832 #ifndef SHIBSP_LITE
 833     // Defer to base class for notifications
 834     if (in["notify"].integer() == 1)
 835         return LogoutHandler::receive(in, out);
 836
 837     // Find application.
 838     const char* aid=in["application_id"].string();
 839     const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : nullptr;
 840     if (!app) {
 841         // Something's horribly wrong.
 842         m_log.error("couldn't find application (%s) for logout", aid ? aid : "(missing)");
 843         throw ConfigurationException("Unable to locate application for logout, deleted?");
 844     }
 845
 846     // Unpack the request.
 847     auto_ptr<HTTPRequest> req(getRequest(in));
 848
 849     // Set up a response shim.
 850     DDF ret(nullptr);
 851     DDFJanitor jout(ret);
 852     auto_ptr<HTTPResponse> resp(getResponse(ret));
 853
 854     Session* session = nullptr;
 855     try {
 856          session = app->getServiceProvider().getSessionCache()->find(*app, *req.get(), nullptr, nullptr);
 857     }
 858     catch (exception& ex) {
 859         m_log.error("error accessing current session: %s", ex.what());
 860     }
 861
 862     // With no session, we just skip the request and let it fall through to an empty struct return.
 863     if (session) {
 864         if (session->getEntityID()) {
 865             // Since we're remoted, the result should either be a throw, which we pass on,
 866             // a false/0 return, which we just return as an empty structure, or a response/redirect,
 867             // which we capture in the facade and send back.
 868             doRequest(*app, *req.get(), *resp.get(), session);
 869         }
 870         else {
 871              m_log.error("no issuing entityID found in session");
 872              session->unlock();
 873              app->getServiceProvider().getSessionCache()->remove(*app, *req.get(), resp.get());
 874         }
 875     }
 876     out << ret;
 877 #else
 878     throw ConfigurationException("Cannot perform logout using lite version of shibsp library.");
 879 #endif
 880 }
 881
 882 pair<bool,long> ADFSLogoutInitiator::doRequest(
 883     const Application& application, const HTTPRequest& httpRequest, HTTPResponse& httpResponse, Session* session
 884     ) const
 885 {
 886     // Do back channel notification.
 887     vector<string> sessions(1, session->getID());
 888     if (!notifyBackChannel(application, httpRequest.getRequestURL(), sessions, false)) {
 889         session->unlock();
 890         application.getServiceProvider().getSessionCache()->remove(application, httpRequest, &httpResponse);
 891         return sendLogoutPage(application, httpRequest, httpResponse, "partial");
 892     }
 893
 894 #ifndef SHIBSP_LITE
 895     pair<bool,long> ret = make_pair(false,0L);
 896
 897     try {
 898         // With a session in hand, we can create a request message, if we can find a compatible endpoint.
 899         MetadataProvider* m=application.getMetadataProvider();
 900         Locker metadataLocker(m);
 901         MetadataProviderCriteria mc(application, session->getEntityID(), &IDPSSODescriptor::ELEMENT_QNAME, m_binding.get());
 902         pair<const EntityDescriptor*,const RoleDescriptor*> entity=m->getEntityDescriptor(mc);
 903         if (!entity.first) {
 904             throw MetadataException(
 905                 "Unable to locate metadata for identity provider ($entityID)", namedparams(1, "entityID", session->getEntityID())
 906                 );
 907         }
 908         else if (!entity.second) {
 909             throw MetadataException(
 910                 "Unable to locate ADFS IdP role for identity provider ($entityID).", namedparams(1, "entityID", session->getEntityID())
 911                 );
 912         }
 913
 914         const EndpointType* ep = EndpointManager<SingleLogoutService>(
 915             dynamic_cast<const IDPSSODescriptor*>(entity.second)->getSingleLogoutServices()
 916             ).getByBinding(m_binding.get());
 917         if (!ep) {
 918             throw MetadataException(
 919                 "Unable to locate ADFS single logout service for identity provider ($entityID).",
 920                 namedparams(1, "entityID", session->getEntityID())
 921                 );
 922         }
 923
 924         const URLEncoder* urlenc = XMLToolingConfig::getConfig().getURLEncoder();
 925         const char* returnloc = httpRequest.getParameter("return");
 926         auto_ptr_char dest(ep->getLocation());
 927         string req=string(dest.get()) + (strchr(dest.get(),'?') ? '&' : '?') + "wa=wsignout1.0";
 928         if (returnloc)
 929             req += "&wreply=" + urlenc->encode(returnloc);
 930         ret.second = httpResponse.sendRedirect(req.c_str());
 931         ret.first = true;
 932     }
 933     catch (exception& ex) {
 934         m_log.error("error issuing ADFS logout request: %s", ex.what());
 935     }
 936
 937     if (session) {
 938         session->unlock();
 939         session = nullptr;
 940         application.getServiceProvider().getSessionCache()->remove(application, httpRequest, &httpResponse);
 941     }
 942
 943     return ret;
 944 #else
 945     throw ConfigurationException("Cannot perform logout using lite version of shibsp library.");
 946 #endif
 947 }
 948
 949 pair<bool,long> ADFSLogout::run(SPRequest& request, bool isHandler) const
 950 {
 951     // Defer to base class for front-channel loop first.
 952     // This won't initiate the loop, only continue/end it.
 953     pair<bool,long> ret = LogoutHandler::run(request, isHandler);
 954     if (ret.first)
 955         return ret;
 956
 957     // wa parameter indicates the "action" to perform
 958     bool returning = false;
 959     const char* param = request.getParameter("wa");
 960     if (param) {
 961         if (!strcmp(param, "wsignin1.0"))
 962             return m_login.run(request, isHandler);
 963         else if (strcmp(param, "wsignout1.0") && strcmp(param, "wsignoutcleanup1.0"))
 964             throw FatalProfileException("Unsupported WS-Federation action paremeter ($1).", params(1, param));
 965     }
 966     else if (strcmp(request.getMethod(),"GET") || !request.getParameter("notifying"))
 967         throw FatalProfileException("Unsupported request to ADFS protocol endpoint.");
 968     else
 969         returning = true;
 970
 971     param = request.getParameter("wreply");
 972     const Application& app = request.getApplication();
 973
 974     if (!returning) {
 975         // Pass control to the first front channel notification point, if any.
 976         map<string,string> parammap;
 977         if (param)
 978             parammap["wreply"] = param;
 979         pair<bool,long> result = notifyFrontChannel(app, request, request, &parammap);
 980         if (result.first)
 981             return result;
 982     }
 983
 984     // Best effort on back channel and to remove the user agent's session.
 985     string session_id = app.getServiceProvider().getSessionCache()->active(app, request);
 986     if (!session_id.empty()) {
 987         vector<string> sessions(1,session_id);
 988         notifyBackChannel(app, request.getRequestURL(), sessions, false);
 989         try {
 990             app.getServiceProvider().getSessionCache()->remove(app, request, &request);
 991         }
 992         catch (exception& ex) {
 993             m_log.error("error removing session (%s): %s", session_id.c_str(), ex.what());
 994         }
 995     }
 996
 997     if (param)
 998         return make_pair(true, request.sendRedirect(param));
 999     return sendLogoutPage(app, request, request, "global");
1000 }