adfs/adfs.cpp

   1 /*
   2  *  Copyright 2001-2010 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 <shibsp/base.h>
  38 #include <shibsp/exceptions.h>
  39 #include <shibsp/Application.h>
  40 #include <shibsp/ServiceProvider.h>
  41 #include <shibsp/SessionCache.h>
  42 #include <shibsp/SPConfig.h>
  43 #include <shibsp/SPRequest.h>
  44 #include <shibsp/handler/AssertionConsumerService.h>
  45 #include <shibsp/handler/LogoutInitiator.h>
  46 #include <shibsp/handler/SessionInitiator.h>
  47 #include <xmltooling/logging.h>
  48 #include <xmltooling/util/DateTime.h>
  49 #include <xmltooling/util/NDC.h>
  50 #include <xmltooling/util/URLEncoder.h>
  51 #include <xmltooling/util/XMLHelper.h>
  52 #include <memory>
  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/exceptions.h>
  59 # include <saml/binding/SecurityPolicy.h>
  60 # include <saml/saml1/core/Assertions.h>
  61 # include <saml/saml2/core/Assertions.h>
  62 # include <saml/saml2/metadata/Metadata.h>
  63 # include <saml/saml2/metadata/EndpointManager.h>
  64 # include <xmltooling/XMLToolingConfig.h>
  65 # include <xmltooling/impl/AnyElement.h>
  66 # include <xmltooling/util/ParserPool.h>
  67 # include <xmltooling/validation/ValidatorSuite.h>
  68 using namespace opensaml::saml2md;
  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         const XMLCh* getProtocolFamily() const {
  94             return m_ns.get();
  95         }
  96
  97         XMLObject* decode(string& relayState, const GenericRequest& genericRequest, SecurityPolicy& policy) const;
  98
  99     protected:
 100         void extractMessageDetails(
 101             const XMLObject& message, const GenericRequest& req, const XMLCh* protocol, SecurityPolicy& policy
 102             ) const {
 103         }
 104     };
 105
 106     MessageDecoder* ADFSDecoderFactory(const pair<const DOMElement*,const XMLCh*>& p)
 107     {
 108         return new ADFSDecoder();
 109     }
 110 #endif
 111
 112 #if defined (_MSC_VER)
 113     #pragma warning( push )
 114     #pragma warning( disable : 4250 )
 115 #endif
 116
 117     class SHIBSP_DLLLOCAL ADFSSessionInitiator : public SessionInitiator, public AbstractHandler, public RemotedHandler
 118     {
 119     public:
 120         ADFSSessionInitiator(const DOMElement* e, const char* appId)
 121             : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".SessionInitiator.ADFS"), nullptr, &m_remapper), m_appId(appId), m_binding(WSFED_NS) {
 122             // If Location isn't set, defer address registration until the setParent call.
 123             pair<bool,const char*> loc = getString("Location");
 124             if (loc.first) {
 125                 string address = m_appId + loc.second + "::run::ADFSSI";
 126                 setAddress(address.c_str());
 127             }
 128         }
 129         virtual ~ADFSSessionInitiator() {}
 130
 131         void setParent(const PropertySet* parent) {
 132             DOMPropertySet::setParent(parent);
 133             pair<bool,const char*> loc = getString("Location");
 134             if (loc.first) {
 135                 string address = m_appId + loc.second + "::run::ADFSSI";
 136                 setAddress(address.c_str());
 137             }
 138             else {
 139                 m_log.warn("no Location property in ADFS SessionInitiator (or parent), can't register as remoted handler");
 140             }
 141         }
 142
 143         void receive(DDF& in, ostream& out);
 144         pair<bool,long> unwrap(SPRequest& request, DDF& out) const;
 145         pair<bool,long> run(SPRequest& request, string& entityID, bool isHandler=true) const;
 146
 147         const XMLCh* getProtocolFamily() const {
 148             return m_binding.get();
 149         }
 150
 151     private:
 152         pair<bool,long> doRequest(
 153             const Application& application,
 154             const HTTPRequest* httpRequest,
 155             HTTPResponse& httpResponse,
 156             const char* entityID,
 157             const char* acsLocation,
 158             const char* authnContextClassRef,
 159             string& relayState
 160             ) const;
 161         string m_appId;
 162         auto_ptr_XMLCh m_binding;
 163     };
 164
 165     class SHIBSP_DLLLOCAL ADFSConsumer : public shibsp::AssertionConsumerService
 166     {
 167         auto_ptr_XMLCh m_protocol;
 168     public:
 169         ADFSConsumer(const DOMElement* e, const char* appId)
 170             : shibsp::AssertionConsumerService(e, appId, Category::getInstance(SHIBSP_LOGCAT".SSO.ADFS")), m_protocol(WSFED_NS) {}
 171         virtual ~ADFSConsumer() {}
 172
 173 #ifndef SHIBSP_LITE
 174         void generateMetadata(SPSSODescriptor& role, const char* handlerURL) const {
 175             AssertionConsumerService::generateMetadata(role, handlerURL);
 176             role.addSupport(m_protocol.get());
 177         }
 178
 179     private:
 180         void implementProtocol(
 181             const Application& application,
 182             const HTTPRequest& httpRequest,
 183             HTTPResponse& httpResponse,
 184             SecurityPolicy& policy,
 185             const PropertySet*,
 186             const XMLObject& xmlObject
 187             ) const;
 188 #else
 189         const XMLCh* getProtocolFamily() const {
 190             return m_protocol.get();
 191         }
 192 #endif
 193     };
 194
 195     class SHIBSP_DLLLOCAL ADFSLogoutInitiator : public AbstractHandler, public LogoutInitiator
 196     {
 197     public:
 198         ADFSLogoutInitiator(const DOMElement* e, const char* appId)
 199                 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".LogoutInitiator.ADFS")), m_appId(appId), m_binding(WSFED_NS) {
 200             // If Location isn't set, defer address registration until the setParent call.
 201             pair<bool,const char*> loc = getString("Location");
 202             if (loc.first) {
 203                 string address = m_appId + loc.second + "::run::ADFSLI";
 204                 setAddress(address.c_str());
 205             }
 206         }
 207         virtual ~ADFSLogoutInitiator() {}
 208
 209         void setParent(const PropertySet* parent) {
 210             DOMPropertySet::setParent(parent);
 211             pair<bool,const char*> loc = getString("Location");
 212             if (loc.first) {
 213                 string address = m_appId + loc.second + "::run::ADFSLI";
 214                 setAddress(address.c_str());
 215             }
 216             else {
 217                 m_log.warn("no Location property in ADFS LogoutInitiator (or parent), can't register as remoted handler");
 218             }
 219         }
 220
 221         void receive(DDF& in, ostream& out);
 222         pair<bool,long> run(SPRequest& request, bool isHandler=true) const;
 223
 224         const XMLCh* getProtocolFamily() const {
 225             return m_binding.get();
 226         }
 227
 228     private:
 229         pair<bool,long> doRequest(const Application& application, const HTTPRequest& httpRequest, HTTPResponse& httpResponse, Session* session) const;
 230
 231         string m_appId;
 232         auto_ptr_XMLCh m_binding;
 233     };
 234
 235     class SHIBSP_DLLLOCAL ADFSLogout : public AbstractHandler, public LogoutHandler
 236     {
 237     public:
 238         ADFSLogout(const DOMElement* e, const char* appId)
 239                 : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".Logout.ADFS")), m_login(e, appId) {
 240             m_initiator = false;
 241 #ifndef SHIBSP_LITE
 242             m_preserve.push_back("wreply");
 243             string address = string(appId) + getString("Location").second + "::run::ADFSLO";
 244             setAddress(address.c_str());
 245 #endif
 246         }
 247         virtual ~ADFSLogout() {}
 248
 249         pair<bool,long> run(SPRequest& request, bool isHandler=true) const;
 250
 251 #ifndef SHIBSP_LITE
 252         void generateMetadata(SPSSODescriptor& role, const char* handlerURL) const {
 253             m_login.generateMetadata(role, handlerURL);
 254             const char* loc = getString("Location").second;
 255             string hurl(handlerURL);
 256             if (*loc != '/')
 257                 hurl += '/';
 258             hurl += loc;
 259             auto_ptr_XMLCh widen(hurl.c_str());
 260             SingleLogoutService* ep = SingleLogoutServiceBuilder::buildSingleLogoutService();
 261             ep->setLocation(widen.get());
 262             ep->setBinding(m_login.getProtocolFamily());
 263             role.getSingleLogoutServices().push_back(ep);
 264         }
 265
 266         const char* getType() const {
 267             return m_login.getType();
 268         }
 269 #endif
 270         const XMLCh* getProtocolFamily() const {
 271             return m_login.getProtocolFamily();
 272         }
 273
 274     private:
 275         ADFSConsumer m_login;
 276     };
 277
 278 #if defined (_MSC_VER)
 279     #pragma warning( pop )
 280 #endif
 281
 282     SessionInitiator* ADFSSessionInitiatorFactory(const pair<const DOMElement*,const char*>& p)
 283     {
 284         return new ADFSSessionInitiator(p.first, p.second);
 285     }
 286
 287     Handler* ADFSLogoutFactory(const pair<const DOMElement*,const char*>& p)
 288     {
 289         return new ADFSLogout(p.first, p.second);
 290     }
 291
 292     Handler* ADFSLogoutInitiatorFactory(const pair<const DOMElement*,const char*>& p)
 293     {
 294         return new ADFSLogoutInitiator(p.first, p.second);
 295     }
 296
 297     const XMLCh RequestedSecurityToken[] =      UNICODE_LITERAL_22(R,e,q,u,e,s,t,e,d,S,e,c,u,r,i,t,y,T,o,k,e,n);
 298     const XMLCh RequestSecurityTokenResponse[] =UNICODE_LITERAL_28(R,e,q,u,e,s,t,S,e,c,u,r,i,t,y,T,o,k,e,n,R,e,s,p,o,n,s,e);
 299 };
 300
 301 extern "C" int ADFS_EXPORTS xmltooling_extension_init(void*)
 302 {
 303     SPConfig& conf=SPConfig::getConfig();
 304     conf.SessionInitiatorManager.registerFactory("ADFS", ADFSSessionInitiatorFactory);
 305     conf.LogoutInitiatorManager.registerFactory("ADFS", ADFSLogoutInitiatorFactory);
 306     conf.AssertionConsumerServiceManager.registerFactory("ADFS", ADFSLogoutFactory);
 307     conf.AssertionConsumerServiceManager.registerFactory(WSFED_NS, ADFSLogoutFactory);
 308 #ifndef SHIBSP_LITE
 309     SAMLConfig::getConfig().MessageDecoderManager.registerFactory(WSFED_NS, ADFSDecoderFactory);
 310     XMLObjectBuilder::registerBuilder(xmltooling::QName(WSTRUST_NS,"RequestedSecurityToken"), new AnyElementBuilder());
 311     XMLObjectBuilder::registerBuilder(xmltooling::QName(WSTRUST_NS,"RequestSecurityTokenResponse"), new AnyElementBuilder());
 312 #endif
 313     return 0;
 314 }
 315
 316 extern "C" void ADFS_EXPORTS xmltooling_extension_term()
 317 {
 318     /* should get unregistered during normal shutdown...
 319     SPConfig& conf=SPConfig::getConfig();
 320     conf.SessionInitiatorManager.deregisterFactory("ADFS");
 321     conf.LogoutInitiatorManager.deregisterFactory("ADFS");
 322     conf.AssertionConsumerServiceManager.deregisterFactory("ADFS");
 323     conf.AssertionConsumerServiceManager.deregisterFactory(WSFED_NS);
 324 #ifndef SHIBSP_LITE
 325     SAMLConfig::getConfig().MessageDecoderManager.deregisterFactory(WSFED_NS);
 326 #endif
 327     */
 328 }
 329
 330 pair<bool,long> ADFSSessionInitiator::run(SPRequest& request, string& entityID, bool isHandler) const
 331 {
 332     // We have to know the IdP to function.
 333     if (entityID.empty() || !checkCompatibility(request, isHandler))
 334         return make_pair(false,0L);
 335
 336     string target;
 337     pair<bool,const char*> prop;
 338     pair<bool,const char*> acClass;
 339     const Handler* ACS=nullptr;
 340     const Application& app=request.getApplication();
 341
 342     if (isHandler) {
 343         prop.second = request.getParameter("acsIndex");
 344         if (prop.second && *prop.second) {
 345             ACS = app.getAssertionConsumerServiceByIndex(atoi(prop.second));
 346             if (!ACS)
 347                 request.log(SPRequest::SPWarn, "invalid acsIndex specified in request, using acsIndex property");
 348         }
 349
 350         prop = getString("target", request);
 351         if (prop.first)
 352             target = prop.second;
 353
 354         // Since we're passing the ACS by value, we need to compute the return URL,
 355         // so we'll need the target resource for real.
 356         recoverRelayState(app, request, request, target, false);
 357
 358         acClass = getString("authnContextClassRef", request);
 359     }
 360     else {
 361         // Check for a hardwired target value in the map or handler.
 362         prop = getString("target", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
 363         if (prop.first)
 364             target = prop.second;
 365         else
 366             target = request.getRequestURL();
 367
 368         acClass = getString("authnContextClassRef", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
 369     }
 370
 371     if (!ACS) {
 372         pair<bool,unsigned int> index = getUnsignedInt("acsIndex", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
 373         if (index.first)
 374             ACS = app.getAssertionConsumerServiceByIndex(index.second);
 375     }
 376
 377     // Validate the ACS for use with this protocol.
 378     if (!ACS || !XMLString::equals(getProtocolFamily(), ACS->getProtocolFamily())) {
 379         request.log(SPRequest::SPWarn, "invalid acsIndex property, or non-ADFS ACS, using default ADFS ACS");
 380         ACS = app.getAssertionConsumerServiceByProtocol(getProtocolFamily());
 381         if (!ACS)
 382             throw ConfigurationException("Unable to locate an ADFS-compatible ACS in the configuration.");
 383     }
 384
 385     // Since we're not passing by index, we need to fully compute the return URL.
 386     // Compute the ACS URL. We add the ACS location to the base handlerURL.
 387     string ACSloc=request.getHandlerURL(target.c_str());
 388     prop = ACS->getString("Location");
 389     if (prop.first)
 390         ACSloc += prop.second;
 391
 392     if (isHandler) {
 393         // We may already have RelayState set if we looped back here,
 394         // but we've turned it back into a resource by this point, so if there's
 395         // a target on the URL, reset to that value.
 396         prop.second = request.getParameter("target");
 397         if (prop.second && *prop.second)
 398             target = prop.second;
 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 : nullptr), 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) : nullptr;
 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(nullptr);
 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, nullptr, *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(nullptr);
 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*,
 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 = nullptr;
 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     // Populate recipient as audience.
 625     const EntityDescriptor* entity = policy.getIssuerMetadata() ? dynamic_cast<const EntityDescriptor*>(policy.getIssuerMetadata()->getParent()) : nullptr;
 626     policy.getAudiences().push_back(application.getRelyingParty(entity)->getXMLString("entityID").second);
 627
 628     // Run the policy over the assertion. Handles replay, freshness, and
 629     // signature verification, assuming the relevant rules are configured,
 630     // along with condition enforcement.
 631     policy.evaluate(*token, &httpRequest);
 632
 633     // If no security is in place now, we kick it.
 634     if (!policy.isAuthenticated())
 635         throw SecurityPolicyException("Unable to establish security of incoming assertion.");
 636
 637     saml1::NameIdentifier* saml1name=nullptr;
 638     saml2::NameID* saml2name=nullptr;
 639     const XMLCh* authMethod=nullptr;
 640     const XMLCh* authInstant=nullptr;
 641     time_t now = time(nullptr), sessionExp = 0;
 642     const PropertySet* sessionProps = application.getPropertySet("Sessions");
 643
 644     const saml1::Assertion* saml1token = dynamic_cast<const saml1::Assertion*>(token);
 645     if (saml1token) {
 646         // Now do profile validation to ensure we can use it for SSO.
 647         if (!saml1token->getConditions() || !saml1token->getConditions()->getNotBefore() || !saml1token->getConditions()->getNotOnOrAfter())
 648             throw FatalProfileException("Assertion did not contain time conditions.");
 649         else if (saml1token->getAuthenticationStatements().empty())
 650             throw FatalProfileException("Assertion did not contain an authentication statement.");
 651
 652         // authnskew allows rejection of SSO if AuthnInstant is too old.
 653         pair<bool,unsigned int> authnskew = sessionProps ? sessionProps->getUnsignedInt("maxTimeSinceAuthn") : pair<bool,unsigned int>(false,0);
 654
 655         const saml1::AuthenticationStatement* ssoStatement=saml1token->getAuthenticationStatements().front();
 656         if (authnskew.first && authnskew.second &&
 657                 ssoStatement->getAuthenticationInstant() && (now - ssoStatement->getAuthenticationInstantEpoch() > authnskew.second))
 658             throw FatalProfileException("The gap between now and the time you logged into your identity provider exceeds the limit.");
 659
 660         // Address checking.
 661         saml1::SubjectLocality* locality = ssoStatement->getSubjectLocality();
 662         if (locality && locality->getIPAddress()) {
 663             auto_ptr_char ip(locality->getIPAddress());
 664             checkAddress(application, httpRequest, ip.get());
 665         }
 666
 667         saml1name = ssoStatement->getSubject()->getNameIdentifier();
 668         authMethod = ssoStatement->getAuthenticationMethod();
 669         if (ssoStatement->getAuthenticationInstant())
 670             authInstant = ssoStatement->getAuthenticationInstant()->getRawData();
 671
 672         // Session expiration.
 673         pair<bool,unsigned int> lifetime = sessionProps ? sessionProps->getUnsignedInt("lifetime") : pair<bool,unsigned int>(true,28800);
 674         if (!lifetime.first || lifetime.second == 0)
 675             lifetime.second = 28800;
 676         sessionExp = now + lifetime.second;
 677     }
 678     else {
 679         const saml2::Assertion* saml2token = dynamic_cast<const saml2::Assertion*>(token);
 680         if (!saml2token)
 681             throw FatalProfileException("Incoming message did not contain a recognized type of SAML assertion.");
 682
 683         // Now do profile validation to ensure we can use it for SSO.
 684         if (!saml2token->getConditions() || !saml2token->getConditions()->getNotBefore() || !saml2token->getConditions()->getNotOnOrAfter())
 685             throw FatalProfileException("Assertion did not contain time conditions.");
 686         else if (saml2token->getAuthnStatements().empty())
 687             throw FatalProfileException("Assertion did not contain an authentication statement.");
 688
 689         // authnskew allows rejection of SSO if AuthnInstant is too old.
 690         pair<bool,unsigned int> authnskew = sessionProps ? sessionProps->getUnsignedInt("maxTimeSinceAuthn") : pair<bool,unsigned int>(false,0);
 691
 692         const saml2::AuthnStatement* ssoStatement=saml2token->getAuthnStatements().front();
 693         if (authnskew.first && authnskew.second &&
 694                 ssoStatement->getAuthnInstant() && (now - ssoStatement->getAuthnInstantEpoch() > authnskew.second))
 695             throw FatalProfileException("The gap between now and the time you logged into your identity provider exceeds the limit.");
 696
 697         // Address checking.
 698         saml2::SubjectLocality* locality = ssoStatement->getSubjectLocality();
 699         if (locality && locality->getAddress()) {
 700             auto_ptr_char ip(locality->getAddress());
 701             checkAddress(application, httpRequest, ip.get());
 702         }
 703
 704         saml2name = saml2token->getSubject() ? saml2token->getSubject()->getNameID() : nullptr;
 705         if (ssoStatement->getAuthnContext() && ssoStatement->getAuthnContext()->getAuthnContextClassRef())
 706             authMethod = ssoStatement->getAuthnContext()->getAuthnContextClassRef()->getReference();
 707         if (ssoStatement->getAuthnInstant())
 708             authInstant = ssoStatement->getAuthnInstant()->getRawData();
 709
 710         // Session expiration for SAML 2.0 is jointly IdP- and SP-driven.
 711         sessionExp = ssoStatement->getSessionNotOnOrAfter() ? ssoStatement->getSessionNotOnOrAfterEpoch() : 0;
 712         pair<bool,unsigned int> lifetime = sessionProps ? sessionProps->getUnsignedInt("lifetime") : pair<bool,unsigned int>(true,28800);
 713         if (!lifetime.first || lifetime.second == 0)
 714             lifetime.second = 28800;
 715         if (sessionExp == 0)
 716             sessionExp = now + lifetime.second;     // IdP says nothing, calulate based on SP.
 717         else
 718             sessionExp = min(sessionExp, now + lifetime.second);    // Use the lowest.
 719     }
 720
 721     m_log.debug("ADFS profile processing completed successfully");
 722
 723     // We've successfully "accepted" the SSO token.
 724     // To complete processing, we need to extract and resolve attributes and then create the session.
 725
 726     // Normalize a SAML 1.x NameIdentifier...
 727     auto_ptr<saml2::NameID> nameid(saml1name ? saml2::NameIDBuilder::buildNameID() : nullptr);
 728     if (saml1name) {
 729         nameid->setName(saml1name->getName());
 730         nameid->setFormat(saml1name->getFormat());
 731         nameid->setNameQualifier(saml1name->getNameQualifier());
 732     }
 733
 734     // The context will handle deleting attributes and new tokens.
 735     vector<const Assertion*> tokens(1,token);
 736     auto_ptr<ResolutionContext> ctx(
 737         resolveAttributes(
 738             application,
 739             policy.getIssuerMetadata(),
 740             m_protocol.get(),
 741             saml1name,
 742             (saml1name ? nameid.get() : saml2name),
 743             authMethod,
 744             nullptr,
 745             &tokens
 746             )
 747         );
 748
 749     if (ctx.get()) {
 750         // Copy over any new tokens, but leave them in the context for cleanup.
 751         tokens.insert(tokens.end(), ctx->getResolvedAssertions().begin(), ctx->getResolvedAssertions().end());
 752     }
 753
 754     application.getServiceProvider().getSessionCache()->insert(
 755         application,
 756         httpRequest,
 757         httpResponse,
 758         sessionExp,
 759         entity,
 760         m_protocol.get(),
 761         (saml1name ? nameid.get() : saml2name),
 762         authInstant,
 763         nullptr,
 764         authMethod,
 765         nullptr,
 766         &tokens,
 767         ctx.get() ? &ctx->getResolvedAttributes() : nullptr
 768         );
 769 }
 770
 771 #endif
 772
 773 pair<bool,long> ADFSLogoutInitiator::run(SPRequest& request, bool isHandler) const
 774 {
 775     // Normally we'd do notifications and session clearage here, but ADFS logout
 776     // is missing the needed request/response features, so we have to rely on
 777     // the IdP half to notify us back about the logout and do the work there.
 778     // Basically we have no way to tell in the Logout receiving handler whether
 779     // we initiated the logout or not.
 780
 781     Session* session = nullptr;
 782     try {
 783         session = request.getSession(false, true, false);  // don't cache it and ignore all checks
 784         if (!session)
 785             return make_pair(false,0L);
 786
 787         // We only handle ADFS sessions.
 788         if (!XMLString::equals(session->getProtocol(), WSFED_NS) || !session->getEntityID()) {
 789             session->unlock();
 790             return make_pair(false,0L);
 791         }
 792     }
 793     catch (exception& ex) {
 794         m_log.error("error accessing current session: %s", ex.what());
 795         return make_pair(false,0L);
 796     }
 797
 798     string entityID(session->getEntityID());
 799     session->unlock();
 800
 801     if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
 802         // When out of process, we run natively.
 803         return doRequest(request.getApplication(), request, request, session);
 804     }
 805     else {
 806         // When not out of process, we remote the request.
 807         session->unlock();
 808         vector<string> headers(1,"Cookie");
 809         DDF out,in = wrap(request,&headers);
 810         DDFJanitor jin(in), jout(out);
 811         out=request.getServiceProvider().getListenerService()->send(in);
 812         return unwrap(request, out);
 813     }
 814 }
 815
 816 void ADFSLogoutInitiator::receive(DDF& in, ostream& out)
 817 {
 818 #ifndef SHIBSP_LITE
 819     // Defer to base class for notifications
 820     if (in["notify"].integer() == 1)
 821         return LogoutHandler::receive(in, out);
 822
 823     // Find application.
 824     const char* aid=in["application_id"].string();
 825     const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : nullptr;
 826     if (!app) {
 827         // Something's horribly wrong.
 828         m_log.error("couldn't find application (%s) for logout", aid ? aid : "(missing)");
 829         throw ConfigurationException("Unable to locate application for logout, deleted?");
 830     }
 831
 832     // Unpack the request.
 833     auto_ptr<HTTPRequest> req(getRequest(in));
 834
 835     // Set up a response shim.
 836     DDF ret(nullptr);
 837     DDFJanitor jout(ret);
 838     auto_ptr<HTTPResponse> resp(getResponse(ret));
 839
 840     Session* session = nullptr;
 841     try {
 842          session = app->getServiceProvider().getSessionCache()->find(*app, *req.get(), nullptr, nullptr);
 843     }
 844     catch (exception& ex) {
 845         m_log.error("error accessing current session: %s", ex.what());
 846     }
 847
 848     // With no session, we just skip the request and let it fall through to an empty struct return.
 849     if (session) {
 850         if (session->getEntityID()) {
 851             // Since we're remoted, the result should either be a throw, which we pass on,
 852             // a false/0 return, which we just return as an empty structure, or a response/redirect,
 853             // which we capture in the facade and send back.
 854             doRequest(*app, *req.get(), *resp.get(), session);
 855         }
 856         else {
 857              m_log.error("no issuing entityID found in session");
 858              session->unlock();
 859              app->getServiceProvider().getSessionCache()->remove(*app, *req.get(), resp.get());
 860         }
 861     }
 862     out << ret;
 863 #else
 864     throw ConfigurationException("Cannot perform logout using lite version of shibsp library.");
 865 #endif
 866 }
 867
 868 pair<bool,long> ADFSLogoutInitiator::doRequest(
 869     const Application& application, const HTTPRequest& httpRequest, HTTPResponse& httpResponse, Session* session
 870     ) const
 871 {
 872     // Do back channel notification.
 873     vector<string> sessions(1, session->getID());
 874     if (!notifyBackChannel(application, httpRequest.getRequestURL(), sessions, false)) {
 875         session->unlock();
 876         application.getServiceProvider().getSessionCache()->remove(application, httpRequest, &httpResponse);
 877         return sendLogoutPage(application, httpRequest, httpResponse, "partial");
 878     }
 879
 880 #ifndef SHIBSP_LITE
 881     pair<bool,long> ret = make_pair(false,0L);
 882
 883     try {
 884         // With a session in hand, we can create a request message, if we can find a compatible endpoint.
 885         MetadataProvider* m=application.getMetadataProvider();
 886         Locker metadataLocker(m);
 887         MetadataProviderCriteria mc(application, session->getEntityID(), &IDPSSODescriptor::ELEMENT_QNAME, m_binding.get());
 888         pair<const EntityDescriptor*,const RoleDescriptor*> entity=m->getEntityDescriptor(mc);
 889         if (!entity.first) {
 890             throw MetadataException(
 891                 "Unable to locate metadata for identity provider ($entityID)", namedparams(1, "entityID", session->getEntityID())
 892                 );
 893         }
 894         else if (!entity.second) {
 895             throw MetadataException(
 896                 "Unable to locate ADFS IdP role for identity provider ($entityID).", namedparams(1, "entityID", session->getEntityID())
 897                 );
 898         }
 899
 900         const EndpointType* ep = EndpointManager<SingleLogoutService>(
 901             dynamic_cast<const IDPSSODescriptor*>(entity.second)->getSingleLogoutServices()
 902             ).getByBinding(m_binding.get());
 903         if (!ep) {
 904             throw MetadataException(
 905                 "Unable to locate ADFS single logout service for identity provider ($entityID).",
 906                 namedparams(1, "entityID", session->getEntityID())
 907                 );
 908         }
 909
 910         const URLEncoder* urlenc = XMLToolingConfig::getConfig().getURLEncoder();
 911         const char* returnloc = httpRequest.getParameter("return");
 912         auto_ptr_char dest(ep->getLocation());
 913         string req=string(dest.get()) + (strchr(dest.get(),'?') ? '&' : '?') + "wa=wsignout1.0";
 914         if (returnloc)
 915             req += "&wreply=" + urlenc->encode(returnloc);
 916         ret.second = httpResponse.sendRedirect(req.c_str());
 917         ret.first = true;
 918     }
 919     catch (exception& ex) {
 920         m_log.error("error issuing ADFS logout request: %s", ex.what());
 921     }
 922
 923     if (session) {
 924         session->unlock();
 925         session = nullptr;
 926         application.getServiceProvider().getSessionCache()->remove(application, httpRequest, &httpResponse);
 927     }
 928
 929     return ret;
 930 #else
 931     throw ConfigurationException("Cannot perform logout using lite version of shibsp library.");
 932 #endif
 933 }
 934
 935 pair<bool,long> ADFSLogout::run(SPRequest& request, bool isHandler) const
 936 {
 937     // Defer to base class for front-channel loop first.
 938     // This won't initiate the loop, only continue/end it.
 939     pair<bool,long> ret = LogoutHandler::run(request, isHandler);
 940     if (ret.first)
 941         return ret;
 942
 943     // wa parameter indicates the "action" to perform
 944     bool returning = false;
 945     const char* param = request.getParameter("wa");
 946     if (param) {
 947         if (!strcmp(param, "wsignin1.0"))
 948             return m_login.run(request, isHandler);
 949         else if (strcmp(param, "wsignout1.0") && strcmp(param, "wsignoutcleanup1.0"))
 950             throw FatalProfileException("Unsupported WS-Federation action paremeter ($1).", params(1, param));
 951     }
 952     else if (strcmp(request.getMethod(),"GET") || !request.getParameter("notifying"))
 953         throw FatalProfileException("Unsupported request to ADFS protocol endpoint.");
 954     else
 955         returning = true;
 956
 957     param = request.getParameter("wreply");
 958     const Application& app = request.getApplication();
 959
 960     if (!returning) {
 961         // Pass control to the first front channel notification point, if any.
 962         map<string,string> parammap;
 963         if (param)
 964             parammap["wreply"] = param;
 965         pair<bool,long> result = notifyFrontChannel(app, request, request, &parammap);
 966         if (result.first)
 967             return result;
 968     }
 969
 970     // Best effort on back channel and to remove the user agent's session.
 971     string session_id = app.getServiceProvider().getSessionCache()->active(app, request);
 972     if (!session_id.empty()) {
 973         vector<string> sessions(1,session_id);
 974         notifyBackChannel(app, request.getRequestURL(), sessions, false);
 975         try {
 976             app.getServiceProvider().getSessionCache()->remove(app, request, &request);
 977         }
 978         catch (exception& ex) {
 979             m_log.error("error removing session (%s): %s", session_id.c_str(), ex.what());
 980         }
 981     }
 982
 983     if (param)
 984         return make_pair(true, request.sendRedirect(param));
 985     return sendLogoutPage(app, request, request, "global");
 986 }