shibsp/handler/impl/SAML2SessionInitiator.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  * SAML2SessionInitiator.cpp
  23  *
  24  * SAML 2.0 AuthnRequest support.
  25  */
  26
  27 #include "internal.h"
  28 #include "Application.h"
  29 #include "exceptions.h"
  30 #include "ServiceProvider.h"
  31 #include "handler/AbstractHandler.h"
  32 #include "handler/RemotedHandler.h"
  33 #include "handler/SessionInitiator.h"
  34 #include "util/SPConstants.h"
  35
  36 #ifndef SHIBSP_LITE
  37 # include "metadata/MetadataProviderCriteria.h"
  38 # include <boost/bind.hpp>
  39 # include <boost/algorithm/string.hpp>
  40 # include <boost/iterator/indirect_iterator.hpp>
  41 # include <saml/SAMLConfig.h>
  42 # include <saml/saml2/core/Protocols.h>
  43 # include <saml/saml2/metadata/EndpointManager.h>
  44 # include <saml/saml2/metadata/Metadata.h>
  45 # include <saml/saml2/metadata/MetadataCredentialCriteria.h>
  46 # include <saml/util/SAMLConstants.h>
  47 using namespace opensaml::saml2;
  48 using namespace opensaml::saml2p;
  49 using namespace opensaml::saml2md;
  50 #else
  51 # include "lite/SAMLConstants.h"
  52 # include <xercesc/util/XMLUniDefs.hpp>
  53 #endif
  54
  55 #include <boost/scoped_ptr.hpp>
  56
  57 using namespace shibsp;
  58 using namespace opensaml;
  59 using namespace xmltooling;
  60 using namespace boost;
  61 using namespace std;
  62
  63 namespace shibsp {
  64
  65 #if defined (_MSC_VER)
  66     #pragma warning( push )
  67     #pragma warning( disable : 4250 )
  68 #endif
  69
  70     class SHIBSP_DLLLOCAL SAML2SessionInitiator : public SessionInitiator, public AbstractHandler, public RemotedHandler
  71     {
  72     public:
  73         SAML2SessionInitiator(const DOMElement* e, const char* appId);
  74         virtual ~SAML2SessionInitiator() {}
  75
  76         void init(const char* location);    // encapsulates actions that need to run either in the c'tor or setParent
  77
  78         void setParent(const PropertySet* parent);
  79         void receive(DDF& in, ostream& out);
  80         pair<bool,long> unwrap(SPRequest& request, DDF& out) const;
  81         pair<bool,long> run(SPRequest& request, string& entityID, bool isHandler=true) const;
  82
  83         const XMLCh* getProtocolFamily() const {
  84             return samlconstants::SAML20P_NS;
  85         }
  86
  87 #ifndef SHIBSP_LITE
  88         void generateMetadata(saml2md::SPSSODescriptor& role, const char* handlerURL) const {
  89             doGenerateMetadata(role, handlerURL);
  90         }
  91 #endif
  92
  93     private:
  94         pair<bool,long> doRequest(
  95             const Application& application,
  96             const HTTPRequest* httpRequest,
  97             HTTPResponse& httpResponse,
  98             const char* entityID,
  99             const XMLCh* acsIndex,
 100             bool artifactInbound,
 101             const char* acsLocation,
 102             const XMLCh* acsBinding,
 103             bool isPassive,
 104             bool forceAuthn,
 105             const char* authnContextClassRef,
 106             const char* authnContextComparison,
 107             const char* NameIDFormat,
 108             const char* SPNameQualifier,
 109             string& relayState
 110             ) const;
 111
 112         string m_appId;
 113         auto_ptr_char m_paosNS,m_ecpNS;
 114         auto_ptr_XMLCh m_paosBinding;
 115 #ifndef SHIBSP_LITE
 116         vector<string> m_bindings;
 117         map< string,boost::shared_ptr<MessageEncoder> > m_encoders;
 118         scoped_ptr<MessageEncoder> m_ecp;
 119         scoped_ptr<AuthnRequest> m_requestTemplate;
 120 #else
 121         bool m_ecp;
 122 #endif
 123     };
 124
 125 #if defined (_MSC_VER)
 126     #pragma warning( pop )
 127 #endif
 128
 129     class SHIBSP_DLLLOCAL SessionInitiatorNodeFilter : public DOMNodeFilter
 130     {
 131     public:
 132 #ifdef SHIBSP_XERCESC_SHORT_ACCEPTNODE
 133         short
 134 #else
 135         FilterAction
 136 #endif
 137         acceptNode(const DOMNode* node) const {
 138             return FILTER_REJECT;
 139         }
 140     };
 141
 142     static SHIBSP_DLLLOCAL SessionInitiatorNodeFilter g_SINFilter;
 143
 144     SessionInitiator* SHIBSP_DLLLOCAL SAML2SessionInitiatorFactory(const pair<const DOMElement*,const char*>& p)
 145     {
 146         return new SAML2SessionInitiator(p.first, p.second);
 147     }
 148
 149 };
 150
 151 SAML2SessionInitiator::SAML2SessionInitiator(const DOMElement* e, const char* appId)
 152     : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".SessionInitiator.SAML2"), &g_SINFilter, &m_remapper), m_appId(appId),
 153         m_paosNS(samlconstants::PAOS_NS), m_ecpNS(samlconstants::SAML20ECP_NS), m_paosBinding(samlconstants::SAML20_BINDING_PAOS)
 154 #ifdef SHIBSP_LITE
 155         ,m_ecp(false)
 156 #endif
 157 {
 158 #ifndef SHIBSP_LITE
 159     if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
 160         // Check for a template AuthnRequest to build from.
 161         DOMElement* child = XMLHelper::getFirstChildElement(e, samlconstants::SAML20P_NS, AuthnRequest::LOCAL_NAME);
 162         if (child)
 163             m_requestTemplate.reset(dynamic_cast<AuthnRequest*>(AuthnRequestBuilder::buildOneFromElement(child)));
 164     }
 165 #endif
 166
 167     // If Location isn't set, defer initialization until the setParent call.
 168     pair<bool,const char*> loc = getString("Location");
 169     if (loc.first) {
 170         init(loc.second);
 171     }
 172
 173     m_supportedOptions.insert("isPassive");
 174 }
 175
 176 void SAML2SessionInitiator::setParent(const PropertySet* parent)
 177 {
 178     DOMPropertySet::setParent(parent);
 179     pair<bool,const char*> loc = getString("Location");
 180     init(loc.second);
 181 }
 182
 183 void SAML2SessionInitiator::init(const char* location)
 184 {
 185     if (location) {
 186         string address = m_appId + location + "::run::SAML2SI";
 187         setAddress(address.c_str());
 188     }
 189     else {
 190         m_log.warn("no Location property in SAML2 SessionInitiator (or parent), can't register as remoted handler");
 191     }
 192
 193     pair<bool,bool> flag = getBool("ECP");
 194 #ifdef SHIBSP_LITE
 195     m_ecp = flag.first && flag.second;
 196 #else
 197
 198     if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
 199         // If directed, build an ECP encoder.
 200         if (flag.first && flag.second) {
 201             try {
 202                 m_ecp.reset(
 203                     SAMLConfig::getConfig().MessageEncoderManager.newPlugin(
 204                         samlconstants::SAML20_BINDING_PAOS, pair<const DOMElement*,const XMLCh*>(getElement(), nullptr)
 205                         )
 206                     );
 207             }
 208             catch (std::exception& ex) {
 209                 m_log.error("error building PAOS/ECP MessageEncoder: %s", ex.what());
 210             }
 211         }
 212
 213         string dupBindings;
 214         pair<bool,const char*> outgoing = getString("outgoingBindings");
 215         if (outgoing.first) {
 216             dupBindings = outgoing.second;
 217             trim(dupBindings);
 218         }
 219         else {
 220             // No override, so we'll install a default binding precedence.
 221             dupBindings = string(samlconstants::SAML20_BINDING_HTTP_REDIRECT) + ' ' + samlconstants::SAML20_BINDING_HTTP_POST + ' ' +
 222                 samlconstants::SAML20_BINDING_HTTP_POST_SIMPLESIGN + ' ' + samlconstants::SAML20_BINDING_HTTP_ARTIFACT;
 223         }
 224         split(m_bindings, dupBindings, is_space(), algorithm::token_compress_on);
 225         for (vector<string>::const_iterator b = m_bindings.begin(); b != m_bindings.end(); ++b) {
 226             try {
 227                 boost::shared_ptr<MessageEncoder> encoder(
 228                     SAMLConfig::getConfig().MessageEncoderManager.newPlugin(*b, pair<const DOMElement*,const XMLCh*>(getElement(),nullptr))
 229                     );
 230                 if (encoder->isUserAgentPresent() && XMLString::equals(getProtocolFamily(), encoder->getProtocolFamily())) {
 231                     m_encoders[*b] = encoder;
 232                     m_log.debug("supporting outgoing binding (%s)", b->c_str());
 233                 }
 234                 else {
 235                     m_log.warn("skipping outgoing binding (%s), not a SAML 2.0 front-channel mechanism", b->c_str());
 236                 }
 237             }
 238             catch (std::exception& ex) {
 239                 m_log.error("error building MessageEncoder: %s", ex.what());
 240             }
 241         }
 242     }
 243 #endif
 244 }
 245
 246 pair<bool,long> SAML2SessionInitiator::run(SPRequest& request, string& entityID, bool isHandler) const
 247 {
 248     // First check for ECP support, since that doesn't require an IdP to be known.
 249     bool ECP = false;
 250     if (m_ecp && request.getHeader("Accept").find("application/vnd.paos+xml") != string::npos) {
 251         string PAOS = request.getHeader("PAOS");
 252         if (PAOS.find(m_paosNS.get()) != string::npos && PAOS.find(m_ecpNS.get()) != string::npos)
 253             ECP = true;
 254     }
 255
 256     // We have to know the IdP to function unless this is ECP.
 257     if ((!ECP && entityID.empty()) || !checkCompatibility(request, isHandler))
 258         return make_pair(false, 0L);
 259
 260     string target;
 261     pair<bool,const char*> prop;
 262     const Handler* ACS = nullptr;
 263     pair<bool,const char*> acClass, acComp, nidFormat, spQual;
 264     bool isPassive=false,forceAuthn=false;
 265     const Application& app = request.getApplication();
 266
 267     // ECP means the ACS will be by value no matter what.
 268     pair<bool,bool> acsByIndex = ECP ? make_pair(true,false) : getBool("acsByIndex");
 269
 270     if (isHandler) {
 271         prop.second = request.getParameter("acsIndex");
 272         if (prop.second && *prop.second) {
 273             ACS = app.getAssertionConsumerServiceByIndex(atoi(prop.second));
 274             if (!ACS)
 275                 request.log(SPRequest::SPWarn, "invalid acsIndex specified in request, using acsIndex property");
 276             else if (ECP && !XMLString::equals(ACS->getString("Binding").second, samlconstants::SAML20_BINDING_PAOS)) {
 277                 request.log(SPRequest::SPWarn, "acsIndex in request referenced a non-PAOS ACS, using default ACS location");
 278                 ACS = nullptr;
 279             }
 280         }
 281
 282         prop = getString("target", request);
 283         if (prop.first)
 284             target = prop.second;
 285
 286         // Always need to recover target URL to compute handler below.
 287         recoverRelayState(app, request, request, target, false);
 288         app.limitRedirect(request, target.c_str());
 289
 290         pair<bool,bool> flag = getBool("isPassive", request);
 291         isPassive = (flag.first && flag.second);
 292
 293         if (!isPassive) {
 294             flag = getBool("forceAuthn", request);
 295             forceAuthn = (flag.first && flag.second);
 296         }
 297
 298         // Populate via parameter, map, or property.
 299         acClass = getString("authnContextClassRef", request);
 300         acComp = getString("authnContextComparison", request);
 301         nidFormat = getString("NameIDFormat", request);
 302         spQual = getString("SPNameQualifier", request);
 303     }
 304     else {
 305         // Check for a hardwired target value in the map or handler.
 306         prop = getString("target", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
 307         if (prop.first)
 308             target = prop.second;
 309         else
 310             target = request.getRequestURL();
 311
 312         pair<bool,bool> flag = getBool("isPassive", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
 313         isPassive = flag.first && flag.second;
 314         if (!isPassive) {
 315             flag = getBool("forceAuthn", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
 316             forceAuthn = flag.first && flag.second;
 317         }
 318
 319         // Populate via map or property.
 320         acClass = getString("authnContextClassRef", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
 321         acComp = getString("authnContextComparison", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
 322         nidFormat = getString("NameIDFormat", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
 323         spQual = getString("SPNameQualifier", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
 324     }
 325
 326     if (ECP)
 327         m_log.debug("attempting to initiate session using SAML 2.0 Enhanced Client Profile");
 328     else
 329         m_log.debug("attempting to initiate session using SAML 2.0 with provider (%s)", entityID.c_str());
 330
 331     if (!ACS) {
 332         if (ECP) {
 333             ACS = app.getAssertionConsumerServiceByProtocol(getProtocolFamily(), samlconstants::SAML20_BINDING_PAOS);
 334             if (!ACS)
 335                 throw ConfigurationException("Unable to locate PAOS response endpoint.");
 336         }
 337         else {
 338             // Try fixed index property.
 339             pair<bool,unsigned int> index = getUnsignedInt("acsIndex", request, HANDLER_PROPERTY_MAP|HANDLER_PROPERTY_FIXED);
 340             if (index.first)
 341                 ACS = app.getAssertionConsumerServiceByIndex(index.second);
 342         }
 343     }
 344
 345     // If we picked by index, validate the ACS for use with this protocol.
 346     if (!ECP && (!ACS || !XMLString::equals(getProtocolFamily(), ACS->getProtocolFamily()))) {
 347         if (ACS)
 348             request.log(SPRequest::SPWarn, "invalid acsIndex property, or non-SAML 2.0 ACS, using default SAML 2.0 ACS");
 349         ACS = app.getAssertionConsumerServiceByProtocol(getProtocolFamily());
 350         if (!ACS)
 351             throw ConfigurationException("Unable to locate a SAML 2.0 ACS endpoint to use for response.");
 352     }
 353
 354     // To invoke the request builder, the key requirement is to figure out how
 355     // to express the ACS, by index or value, and if by value, where.
 356     // We have to compute the handlerURL no matter what, because we may need to
 357     // flip the index to an SSL-version.
 358     string ACSloc = request.getHandlerURL(target.c_str());
 359
 360     SPConfig& conf = SPConfig::getConfig();
 361     if (conf.isEnabled(SPConfig::OutOfProcess)) {
 362         if (acsByIndex.first && acsByIndex.second) {
 363             // Pass by Index.
 364             if (isHandler) {
 365                 // We may already have RelayState set if we looped back here,
 366                 // but we've turned it back into a resource by this point, so if there's
 367                 // a target on the URL, reset to that value.
 368                 prop.second = request.getParameter("target");
 369                 if (prop.second && *prop.second)
 370                     target = prop.second;
 371             }
 372
 373             // Determine index to use.
 374             pair<bool,const XMLCh*> ix = pair<bool,const XMLCh*>(false,nullptr);
 375             if (!strncmp(ACSloc.c_str(), "https://", 8)) {
 376                 ix = ACS->getXMLString("sslIndex", shibspconstants::ASCII_SHIB2SPCONFIG_NS);
 377                 if (!ix.first)
 378                         ix = ACS->getXMLString("index");
 379             }
 380             else {
 381                 ix = ACS->getXMLString("index");
 382             }
 383
 384             return doRequest(
 385                 app, &request, request, entityID.c_str(),
 386                 ix.second,
 387                 XMLString::equals(ACS->getString("Binding").second, samlconstants::SAML20_BINDING_HTTP_ARTIFACT),
 388                 nullptr, nullptr,
 389                 isPassive, forceAuthn,
 390                 acClass.first ? acClass.second : nullptr,
 391                 acComp.first ? acComp.second : nullptr,
 392                 nidFormat.first ? nidFormat.second : nullptr,
 393                 spQual.first ? spQual.second : nullptr,
 394                 target
 395                 );
 396         }
 397
 398         // Since we're not passing by index, we need to fully compute the return URL and binding.
 399         // Compute the ACS URL. We add the ACS location to the base handlerURL.
 400         prop = ACS->getString("Location");
 401         if (prop.first)
 402             ACSloc += prop.second;
 403
 404         if (isHandler) {
 405             // We may already have RelayState set if we looped back here,
 406             // but we've turned it back into a resource by this point, so if there's
 407             // a target on the URL, reset to that value.
 408             prop.second = request.getParameter("target");
 409             if (prop.second && *prop.second)
 410                 target = prop.second;
 411         }
 412
 413         return doRequest(
 414             app, &request, request, entityID.c_str(),
 415             nullptr,
 416             XMLString::equals(ACS->getString("Binding").second, samlconstants::SAML20_BINDING_HTTP_ARTIFACT),
 417             ACSloc.c_str(), ACS->getXMLString("Binding").second,
 418             isPassive, forceAuthn,
 419             acClass.first ? acClass.second : nullptr,
 420             acComp.first ? acComp.second : nullptr,
 421             nidFormat.first ? nidFormat.second : nullptr,
 422             spQual.first ? spQual.second : nullptr,
 423             target
 424             );
 425     }
 426
 427     // Remote the call.
 428     DDF out,in = DDF(m_address.c_str()).structure();
 429     DDFJanitor jin(in), jout(out);
 430     in.addmember("application_id").string(app.getId());
 431     if (!entityID.empty())
 432         in.addmember("entity_id").string(entityID.c_str());
 433     if (isPassive)
 434         in.addmember("isPassive").integer(1);
 435     else if (forceAuthn)
 436         in.addmember("forceAuthn").integer(1);
 437     if (acClass.first)
 438         in.addmember("authnContextClassRef").string(acClass.second);
 439     if (acComp.first)
 440         in.addmember("authnContextComparison").string(acComp.second);
 441     if (nidFormat.first)
 442         in.addmember("NameIDFormat").string(nidFormat.second);
 443     if (spQual.first)
 444         in.addmember("SPNameQualifier").string(spQual.second);
 445     if (acsByIndex.first && acsByIndex.second) {
 446         // Determine index to use.
 447         pair<bool,const char*> ix = pair<bool,const char*>(false,nullptr);
 448         if (!strncmp(ACSloc.c_str(), "https://", 8)) {
 449                 ix = ACS->getString("sslIndex", shibspconstants::ASCII_SHIB2SPCONFIG_NS);
 450                 if (!ix.first)
 451                         ix = ACS->getString("index");
 452         }
 453         else {
 454                 ix = ACS->getString("index");
 455         }
 456         in.addmember("acsIndex").string(ix.second);
 457         if (XMLString::equals(ACS->getString("Binding").second, samlconstants::SAML20_BINDING_HTTP_ARTIFACT))
 458             in.addmember("artifact").integer(1);
 459     }
 460     else {
 461         // Since we're not passing by index, we need to fully compute the return URL and binding.
 462         // Compute the ACS URL. We add the ACS location to the base handlerURL.
 463         prop = ACS->getString("Location");
 464         if (prop.first)
 465             ACSloc += prop.second;
 466         in.addmember("acsLocation").string(ACSloc.c_str());
 467         prop = ACS->getString("Binding");
 468         in.addmember("acsBinding").string(prop.second);
 469         if (XMLString::equals(prop.second, samlconstants::SAML20_BINDING_HTTP_ARTIFACT))
 470             in.addmember("artifact").integer(1);
 471     }
 472
 473     if (isHandler) {
 474         // We may already have RelayState set if we looped back here,
 475         // but we've turned it back into a resource by this point, so if there's
 476         // a target on the URL, reset to that value.
 477         prop.second = request.getParameter("target");
 478         if (prop.second && *prop.second)
 479             target = prop.second;
 480     }
 481     if (!target.empty())
 482         in.addmember("RelayState").unsafe_string(target.c_str());
 483
 484     // Remote the processing.
 485     out = request.getServiceProvider().getListenerService()->send(in);
 486     return unwrap(request, out);
 487 }
 488
 489 pair<bool,long> SAML2SessionInitiator::unwrap(SPRequest& request, DDF& out) const
 490 {
 491     // See if there's any response to send back.
 492     if (!out["redirect"].isnull() || !out["response"].isnull()) {
 493         // If so, we're responsible for handling the POST data, probably by dropping a cookie.
 494         preservePostData(request.getApplication(), request, request, out["RelayState"].string());
 495     }
 496     return RemotedHandler::unwrap(request, out);
 497 }
 498
 499 void SAML2SessionInitiator::receive(DDF& in, ostream& out)
 500 {
 501     // Find application.
 502     const char* aid = in["application_id"].string();
 503     const Application* app = aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : nullptr;
 504     if (!app) {
 505         // Something's horribly wrong.
 506         m_log.error("couldn't find application (%s) to generate AuthnRequest", aid ? aid : "(missing)");
 507         throw ConfigurationException("Unable to locate application for new session, deleted?");
 508     }
 509
 510     DDF ret(nullptr);
 511     DDFJanitor jout(ret);
 512
 513     // Wrap the outgoing object with a Response facade.
 514     scoped_ptr<HTTPResponse> http(getResponse(ret));
 515
 516     auto_ptr_XMLCh index(in["acsIndex"].string());
 517     auto_ptr_XMLCh bind(in["acsBinding"].string());
 518
 519     string relayState(in["RelayState"].string() ? in["RelayState"].string() : "");
 520     string postData(in["PostData"].string() ? in["PostData"].string() : "");
 521
 522     // Since we're remoted, the result should either be a throw, which we pass on,
 523     // a false/0 return, which we just return as an empty structure, or a response/redirect,
 524     // which we capture in the facade and send back.
 525     doRequest(
 526         *app, nullptr, *http, in["entity_id"].string(),
 527         index.get(),
 528         (in["artifact"].integer() != 0),
 529         in["acsLocation"].string(), bind.get(),
 530         in["isPassive"].integer()==1, in["forceAuthn"].integer()==1,
 531         in["authnContextClassRef"].string(), in["authnContextComparison"].string(),
 532         in["NameIDFormat"].string(), in["SPNameQualifier"].string(),
 533         relayState
 534         );
 535     if (!ret.isstruct())
 536         ret.structure();
 537     ret.addmember("RelayState").unsafe_string(relayState.c_str());
 538     out << ret;
 539 }
 540
 541 pair<bool,long> SAML2SessionInitiator::doRequest(
 542     const Application& app,
 543     const HTTPRequest* httpRequest,
 544     HTTPResponse& httpResponse,
 545     const char* entityID,
 546     const XMLCh* acsIndex,
 547     bool artifactInbound,
 548     const char* acsLocation,
 549     const XMLCh* acsBinding,
 550     bool isPassive,
 551     bool forceAuthn,
 552     const char* authnContextClassRef,
 553     const char* authnContextComparison,
 554     const char* NameIDFormat,
 555     const char* SPNameQualifier,
 556     string& relayState
 557     ) const
 558 {
 559 #ifndef SHIBSP_LITE
 560     bool ECP = XMLString::equals(acsBinding, m_paosBinding.get());
 561
 562     pair<const EntityDescriptor*,const RoleDescriptor*> entity = pair<const EntityDescriptor*,const RoleDescriptor*>(nullptr,nullptr);
 563     const IDPSSODescriptor* role = nullptr;
 564     const EndpointType* ep = nullptr;
 565     const MessageEncoder* encoder = nullptr;
 566
 567     // We won't need this for ECP, but safety dictates we get the lock here.
 568     MetadataProvider* m = app.getMetadataProvider();
 569     Locker locker(m);
 570
 571     if (ECP) {
 572         encoder = m_ecp.get();
 573         if (!encoder) {
 574             m_log.error("MessageEncoder for PAOS binding not available");
 575             return make_pair(false, 0L);
 576         }
 577     }
 578     else {
 579         // Use metadata to locate the IdP's SSO service.
 580         MetadataProviderCriteria mc(app, entityID, &IDPSSODescriptor::ELEMENT_QNAME, samlconstants::SAML20P_NS);
 581         entity = m->getEntityDescriptor(mc);
 582         if (!entity.first) {
 583             m_log.warn("unable to locate metadata for provider (%s)", entityID);
 584             throw MetadataException("Unable to locate metadata for identity provider ($entityID)", namedparams(1, "entityID", entityID));
 585         }
 586         else if (!entity.second) {
 587             m_log.log(getParent() ? Priority::INFO : Priority::WARN, "unable to locate SAML 2.0 identity provider role for provider (%s)", entityID);
 588             if (getParent())
 589                 return make_pair(false, 0L);
 590             throw MetadataException("Unable to locate SAML 2.0 identity provider role for provider ($entityID)", namedparams(1, "entityID", entityID));
 591         }
 592         else if (artifactInbound && !SPConfig::getConfig().getArtifactResolver()->isSupported(dynamic_cast<const SSODescriptorType&>(*entity.second))) {
 593             m_log.warn("artifact binding selected for response, but identity provider lacks support");
 594             if (getParent())
 595                 return make_pair(false, 0L);
 596             throw MetadataException("Identity provider ($entityID) lacks SAML 2.0 artifact support.", namedparams(1, "entityID", entityID));
 597         }
 598
 599         // Loop over the supportable outgoing bindings.
 600         role = dynamic_cast<const IDPSSODescriptor*>(entity.second);
 601         for (vector<string>::const_iterator b = m_bindings.begin(); b != m_bindings.end(); ++b) {
 602             auto_ptr_XMLCh wideb(b->c_str());
 603             if (ep=EndpointManager<SingleSignOnService>(role->getSingleSignOnServices()).getByBinding(wideb.get())) {
 604                 map< string,boost::shared_ptr<MessageEncoder> >::const_iterator enc = m_encoders.find(*b);
 605                 if (enc != m_encoders.end())
 606                     encoder = enc->second.get();
 607                 break;
 608             }
 609         }
 610         if (!ep || !encoder) {
 611             m_log.warn("unable to locate compatible SSO service for provider (%s)", entityID);
 612             if (getParent())
 613                 return make_pair(false, 0L);
 614             throw MetadataException("Unable to locate compatible SSO service for provider ($entityID)", namedparams(1, "entityID", entityID));
 615         }
 616     }
 617
 618     preserveRelayState(app, httpResponse, relayState);
 619
 620     auto_ptr<AuthnRequest> req(m_requestTemplate ? m_requestTemplate->cloneAuthnRequest() : AuthnRequestBuilder::buildAuthnRequest());
 621     if (m_requestTemplate) {
 622         // Freshen TS and ID.
 623         req->setID(nullptr);
 624         req->setIssueInstant(time(nullptr));
 625     }
 626
 627     if (ep)
 628         req->setDestination(ep->getLocation());
 629     if (acsIndex && *acsIndex)
 630         req->setAssertionConsumerServiceIndex(acsIndex);
 631     if (acsLocation) {
 632         auto_ptr_XMLCh wideloc(acsLocation);
 633         req->setAssertionConsumerServiceURL(wideloc.get());
 634     }
 635     if (acsBinding && *acsBinding)
 636         req->setProtocolBinding(acsBinding);
 637     if (isPassive)
 638         req->IsPassive(isPassive);
 639     else if (forceAuthn)
 640         req->ForceAuthn(forceAuthn);
 641     if (!req->getIssuer()) {
 642         Issuer* issuer = IssuerBuilder::buildIssuer();
 643         req->setIssuer(issuer);
 644         issuer->setName(app.getRelyingParty(entity.first)->getXMLString("entityID").second);
 645     }
 646     if (!req->getNameIDPolicy()) {
 647         NameIDPolicy* namepol = NameIDPolicyBuilder::buildNameIDPolicy();
 648         req->setNameIDPolicy(namepol);
 649         namepol->AllowCreate(true);
 650     }
 651     if (NameIDFormat && *NameIDFormat) {
 652         auto_ptr_XMLCh wideform(NameIDFormat);
 653         req->getNameIDPolicy()->setFormat(wideform.get());
 654     }
 655     if (SPNameQualifier && *SPNameQualifier) {
 656         auto_ptr_XMLCh widequal(SPNameQualifier);
 657         req->getNameIDPolicy()->setSPNameQualifier(widequal.get());
 658     }
 659     if (authnContextClassRef || authnContextComparison) {
 660         RequestedAuthnContext* reqContext = req->getRequestedAuthnContext();
 661         if (!reqContext) {
 662             reqContext = RequestedAuthnContextBuilder::buildRequestedAuthnContext();
 663             req->setRequestedAuthnContext(reqContext);
 664         }
 665         if (authnContextClassRef) {
 666             reqContext->getAuthnContextDeclRefs().clear();
 667             string dup(authnContextClassRef);
 668             trim(dup);
 669             vector<string> contexts;
 670             split(contexts, dup, is_space(), algorithm::token_compress_on);
 671             for (vector<string>::const_iterator ac = contexts.begin(); ac != contexts.end(); ++ac) {
 672                 auto_ptr_XMLCh wideac(ac->c_str());
 673                 auto_ptr<AuthnContextClassRef> cref(AuthnContextClassRefBuilder::buildAuthnContextClassRef());
 674                 cref->setReference(wideac.get());
 675                 reqContext->getAuthnContextClassRefs().push_back(cref.get());
 676                 cref.release();
 677             }
 678         }
 679
 680         if (reqContext->getAuthnContextClassRefs().empty() && reqContext->getAuthnContextDeclRefs().empty()) {
 681                 req->setRequestedAuthnContext(nullptr);
 682         }
 683         else if (authnContextComparison) {
 684             auto_ptr_XMLCh widecomp(authnContextComparison);
 685             reqContext->setComparison(widecomp.get());
 686         }
 687     }
 688
 689     pair<bool,bool> requestDelegation = getBool("requestDelegation");
 690     if (requestDelegation.first && requestDelegation.second) {
 691         if (entity.first) {
 692             // Request delegation by including the IdP as an Audience.
 693             // Also specify the expected session lifetime as the bound on the assertion lifetime.
 694             const PropertySet* sessionProps = app.getPropertySet("Sessions");
 695             pair<bool,unsigned int> lifetime = sessionProps ? sessionProps->getUnsignedInt("lifetime") : pair<bool,unsigned int>(true,28800);
 696             if (!lifetime.first || lifetime.second == 0)
 697                 lifetime.second = 28800;
 698             if (!req->getConditions())
 699                 req->setConditions(ConditionsBuilder::buildConditions());
 700             req->getConditions()->setNotOnOrAfter(time(nullptr) + lifetime.second + 300);
 701             AudienceRestriction* audrest = AudienceRestrictionBuilder::buildAudienceRestriction();
 702             req->getConditions()->getConditions().push_back(audrest);
 703             Audience* aud = AudienceBuilder::buildAudience();
 704             audrest->getAudiences().push_back(aud);
 705             aud->setAudienceURI(entity.first->getEntityID());
 706         }
 707         else {
 708             m_log.warn("requestDelegation set, but IdP unknown at request time");
 709         }
 710     }
 711
 712     if (ECP && entityID) {
 713         auto_ptr_XMLCh wideid(entityID);
 714         Scoping* scoping = req->getScoping();
 715         if (!scoping) {
 716             scoping = ScopingBuilder::buildScoping();
 717             req->setScoping(scoping);
 718         }
 719         IDPList* idplist = scoping->getIDPList();
 720         if (!idplist) {
 721             idplist = IDPListBuilder::buildIDPList();
 722             scoping->setIDPList(idplist);
 723         }
 724         VectorOf(IDPEntry) entries = idplist->getIDPEntrys();
 725         static bool (*wideequals)(const XMLCh*,const XMLCh*) = &XMLString::equals;
 726         if (find_if(entries, boost::bind(wideequals, boost::bind(&IDPEntry::getProviderID, _1), wideid.get())) == nullptr) {
 727             IDPEntry* entry = IDPEntryBuilder::buildIDPEntry();
 728             entry->setProviderID(wideid.get());
 729             entries.push_back(entry);
 730         }
 731     }
 732
 733     XMLCh* genid = SAMLConfig::getConfig().generateIdentifier();
 734     req->setID(genid);
 735     XMLString::release(&genid);
 736     req->setIssueInstant(time(nullptr));
 737
 738     scoped_ptr<AuthnRequestEvent> ar_event(newAuthnRequestEvent(app, httpRequest));
 739     if (ar_event) {
 740         auto_ptr_char b(ep ? ep->getBinding() : nullptr);
 741         ar_event->m_binding = b.get() ? b.get() : samlconstants::SAML20_BINDING_SOAP;
 742         auto_ptr_char prot(getProtocolFamily());
 743         ar_event->m_protocol = prot.get();
 744         ar_event->m_peer = entity.first;
 745         ar_event->m_saml2Request = req.get();
 746         app.getServiceProvider().getTransactionLog()->write(*ar_event);
 747     }
 748
 749     auto_ptr_char dest(ep ? ep->getLocation() : nullptr);
 750
 751     if (httpRequest) {
 752         // If the request object is available, we're responsible for the POST data.
 753         preservePostData(app, *httpRequest, httpResponse, relayState.c_str());
 754     }
 755
 756     long ret = sendMessage(
 757         *encoder, req.get(), relayState.c_str(), dest.get(), role, app, httpResponse, role ? role->WantAuthnRequestsSigned() : false
 758         );
 759     req.release();  // freed by encoder
 760     return make_pair(true, ret);
 761 #else
 762     return make_pair(false, 0L);
 763 #endif
 764 }