adfs/adfs.cpp

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