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