shibsp/handler/impl/SAML2SessionInitiator.cpp

   1 /*
   2  *  Copyright 2001-2007 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 "SPRequest.h"
  28 #include "handler/AbstractHandler.h"
  29 #include "handler/RemotedHandler.h"
  30 #include "handler/SessionInitiator.h"
  31 #include "util/SPConstants.h"
  32
  33 #ifndef SHIBSP_LITE
  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 using namespace opensaml::saml2;
  40 using namespace opensaml::saml2p;
  41 using namespace opensaml::saml2md;
  42 #endif
  43
  44 using namespace shibsp;
  45 using namespace opensaml;
  46 using namespace xmltooling;
  47 using namespace log4cpp;
  48 using namespace std;
  49
  50 namespace shibsp {
  51
  52 #if defined (_MSC_VER)
  53     #pragma warning( push )
  54     #pragma warning( disable : 4250 )
  55 #endif
  56
  57     class SHIBSP_DLLLOCAL SAML2SessionInitiator : public SessionInitiator, public AbstractHandler, public RemotedHandler
  58     {
  59     public:
  60         SAML2SessionInitiator(const DOMElement* e, const char* appId);
  61         virtual ~SAML2SessionInitiator() {
  62 #ifndef SHIBSP_LITE
  63             if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
  64                 XMLString::release(&m_outgoing);
  65                 for_each(m_encoders.begin(), m_encoders.end(), cleanup_pair<const XMLCh*,MessageEncoder>());
  66                 delete m_requestTemplate;
  67             }
  68 #endif
  69         }
  70
  71         void setParent(const PropertySet* parent);
  72         void receive(DDF& in, ostream& out);
  73         pair<bool,long> run(SPRequest& request, const char* entityID=NULL, bool isHandler=true) const;
  74
  75     private:
  76         pair<bool,long> doRequest(
  77             const Application& application,
  78             HTTPResponse& httpResponse,
  79             const char* entityID,
  80             const XMLCh* acsIndex,
  81             const char* acsLocation,
  82             const XMLCh* acsBinding,
  83             bool isPassive,
  84             bool forceAuthn,
  85             const char* authnContextClassRef,
  86             const char* authnContextComparison,
  87             string& relayState
  88             ) const;
  89
  90         string m_appId;
  91 #ifndef SHIBSP_LITE
  92         XMLCh* m_outgoing;
  93         vector<const XMLCh*> m_bindings;
  94         map<const XMLCh*,MessageEncoder*> m_encoders;
  95         AuthnRequest* m_requestTemplate;
  96 #endif
  97     };
  98
  99 #if defined (_MSC_VER)
 100     #pragma warning( pop )
 101 #endif
 102
 103     SessionInitiator* SHIBSP_DLLLOCAL SAML2SessionInitiatorFactory(const pair<const DOMElement*,const char*>& p)
 104     {
 105         return new SAML2SessionInitiator(p.first, p.second);
 106     }
 107
 108 };
 109
 110 SAML2SessionInitiator::SAML2SessionInitiator(const DOMElement* e, const char* appId)
 111     : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".SessionInitiator")), m_appId(appId)
 112 {
 113 #ifndef SHIBSP_LITE
 114     m_outgoing=NULL;
 115     m_requestTemplate=NULL;
 116     if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
 117         // Check for a template AuthnRequest to build from.
 118         DOMElement* child = XMLHelper::getFirstChildElement(e, samlconstants::SAML20P_NS, AuthnRequest::LOCAL_NAME);
 119         if (child)
 120             m_requestTemplate = dynamic_cast<AuthnRequest*>(AuthnRequestBuilder::buildOneFromElement(child));
 121
 122         // Handle outgoing binding setup.
 123         pair<bool,const XMLCh*> outgoing = getXMLString("outgoingBindings");
 124         if (outgoing.first) {
 125             m_outgoing = XMLString::replicate(outgoing.second);
 126         }
 127         else {
 128             // No override, so we'll install a default binding precedence.
 129             string prec = string(samlconstants::SAML20_BINDING_HTTP_REDIRECT) + ' ' + samlconstants::SAML20_BINDING_HTTP_POST + ' ' +
 130                 samlconstants::SAML20_BINDING_HTTP_POST_SIMPLESIGN + ' ' + samlconstants::SAML20_BINDING_HTTP_ARTIFACT;
 131             m_outgoing = XMLString::transcode(prec.c_str());
 132             XMLString::trim(m_outgoing);
 133         }
 134
 135         int pos;
 136         XMLCh* start = m_outgoing;
 137         while (start && *start) {
 138             pos = XMLString::indexOf(start,chSpace);
 139             if (pos != -1)
 140                 *(start + pos)=chNull;
 141             m_bindings.push_back(start);
 142             try {
 143                 auto_ptr_char b(start);
 144                 MessageEncoder * encoder = SAMLConfig::getConfig().MessageEncoderManager.newPlugin(b.get(),e);
 145                 m_encoders[start] = encoder;
 146                 m_log.debug("supporting outgoing binding (%s)", b.get());
 147             }
 148             catch (exception& ex) {
 149                 m_log.error("error building MessageEncoder: %s", ex.what());
 150             }
 151             if (pos != -1)
 152                 start = start + pos + 1;
 153             else
 154                 break;
 155         }
 156     }
 157 #endif
 158
 159     // If Location isn't set, defer address registration until the setParent call.
 160     pair<bool,const char*> loc = getString("Location");
 161     if (loc.first) {
 162         string address = m_appId + loc.second + "::run::SAML2SI";
 163         setAddress(address.c_str());
 164     }
 165 }
 166
 167 void SAML2SessionInitiator::setParent(const PropertySet* parent)
 168 {
 169     DOMPropertySet::setParent(parent);
 170     pair<bool,const char*> loc = getString("Location");
 171     if (loc.first) {
 172         string address = m_appId + loc.second + "::run::SAML2SI";
 173         setAddress(address.c_str());
 174     }
 175     else {
 176         m_log.warn("no Location property in SAML2 SessionInitiator (or parent), can't register as remoted handler");
 177     }
 178 }
 179
 180 pair<bool,long> SAML2SessionInitiator::run(SPRequest& request, const char* entityID, bool isHandler) const
 181 {
 182     // We have to know the IdP to function.
 183     if (!entityID || !*entityID)
 184         return make_pair(false,0);
 185
 186     string target;
 187     const Handler* ACS=NULL;
 188     const char* option;
 189     pair<bool,const char*> acClass;
 190     pair<bool,const char*> acComp;
 191     bool isPassive=false,forceAuthn=false;
 192     const Application& app=request.getApplication();
 193     pair<bool,bool> acsByIndex = getBool("acsByIndex");
 194
 195     if (isHandler) {
 196         option=request.getParameter("acsIndex");
 197         if (option) {
 198             ACS = app.getAssertionConsumerServiceByIndex(atoi(option));
 199             if (!ACS)
 200                 throw ConfigurationException("AssertionConsumerService with index ($1) not found, check configuration.", params(1,option));
 201         }
 202
 203         option = request.getParameter("target");
 204         if (option)
 205             target = option;
 206         if (acsByIndex.first && !acsByIndex.second) {
 207             // Since we're passing the ACS by value, we need to compute the return URL,
 208             // so we'll need the target resource for real.
 209             recoverRelayState(request.getApplication(), request, target, false);
 210         }
 211
 212         option = request.getParameter("isPassive");
 213         isPassive = (option && (*option=='1' || *option=='t'));
 214         if (!isPassive) {
 215             option = request.getParameter("forceAuthn");
 216             forceAuthn = (option && (*option=='1' || *option=='t'));
 217         }
 218
 219         acClass.second = request.getParameter("authnContextClassRef");
 220         acClass.first = (acClass.second!=NULL);
 221         acComp.second = request.getParameter("authnContextComparison");
 222         acComp.first = (acComp.second!=NULL);
 223     }
 224     else {
 225         // We're running as a "virtual handler" from within the filter.
 226         // The target resource is the current one and everything else is defaulted.
 227         target=request.getRequestURL();
 228         const PropertySet* settings = request.getRequestSettings().first;
 229
 230         pair<bool,bool> flag = settings->getBool("isPassive");
 231         isPassive = flag.first && flag.second;
 232         if (!isPassive) {
 233             flag = settings->getBool("forceAuthn");
 234             forceAuthn = flag.first && flag.second;
 235         }
 236
 237         acClass = settings->getString("authnContextClassRef");
 238         acComp = settings->getString("authnContextComparison");
 239     }
 240
 241     m_log.debug("attempting to initiate session using SAML 2.0 with provider (%s)", entityID);
 242
 243     // To invoke the request builder, the key requirement is to figure out how and whether
 244     // to express the ACS, by index or value, and if by value, where.
 245
 246     SPConfig& conf = SPConfig::getConfig();
 247     if (conf.isEnabled(SPConfig::OutOfProcess)) {
 248         if (!acsByIndex.first || acsByIndex.second) {
 249             // Pass by Index. This also allows for defaulting it entirely and sending nothing.
 250             if (isHandler) {
 251                 // We may already have RelayState set if we looped back here,
 252                 // but just in case target is a resource, we reset it back.
 253                 target.erase();
 254                 option = request.getParameter("target");
 255                 if (option)
 256                     target = option;
 257             }
 258             return doRequest(
 259                 app, request, entityID,
 260                 ACS ? ACS->getXMLString("index").second : NULL, NULL, NULL,
 261                 isPassive, forceAuthn,
 262                 acClass.first ? acClass.second : NULL,
 263                 acComp.first ? acComp.second : NULL,
 264                 target
 265                 );
 266         }
 267
 268         // Since we're not passing by index, we need to fully compute the return URL and binding.
 269         if (!ACS)
 270             ACS = app.getDefaultAssertionConsumerService();
 271
 272         // Compute the ACS URL. We add the ACS location to the base handlerURL.
 273         string ACSloc=request.getHandlerURL(target.c_str());
 274         pair<bool,const char*> loc=ACS ? ACS->getString("Location") : pair<bool,const char*>(false,NULL);
 275         if (loc.first) ACSloc+=loc.second;
 276
 277         if (isHandler) {
 278             // We may already have RelayState set if we looped back here,
 279             // but just in case target is a resource, we reset it back.
 280             target.erase();
 281             option = request.getParameter("target");
 282             if (option)
 283                 target = option;
 284         }
 285
 286         return doRequest(
 287             app, request, entityID,
 288             NULL, ACSloc.c_str(), ACS ? ACS->getXMLString("Binding").second : NULL,
 289             isPassive, forceAuthn,
 290             acClass.first ? acClass.second : NULL,
 291             acComp.first ? acComp.second : NULL,
 292             target
 293             );
 294     }
 295
 296     // Remote the call.
 297     DDF out,in = DDF(m_address.c_str()).structure();
 298     DDFJanitor jin(in), jout(out);
 299     in.addmember("application_id").string(app.getId());
 300     in.addmember("entity_id").string(entityID);
 301     if (isPassive)
 302         in.addmember("isPassive").integer(1);
 303     else if (forceAuthn)
 304         in.addmember("forceAuthn").integer(1);
 305     if (acClass.first)
 306         in.addmember("authnContextClassRef").string(acClass.second);
 307     if (acComp.first)
 308         in.addmember("authnContextComparison").string(acComp.second);
 309     if (!acsByIndex.first || acsByIndex.second) {
 310         if (ACS)
 311             in.addmember("acsIndex").string(ACS->getString("index").second);
 312     }
 313     else {
 314         // Since we're not passing by index, we need to fully compute the return URL and binding.
 315         if (!ACS)
 316             ACS = app.getDefaultAssertionConsumerService();
 317
 318         // Compute the ACS URL. We add the ACS location to the base handlerURL.
 319         string ACSloc=request.getHandlerURL(target.c_str());
 320         pair<bool,const char*> loc=ACS ? ACS->getString("Location") : pair<bool,const char*>(false,NULL);
 321         if (loc.first) ACSloc+=loc.second;
 322         in.addmember("acsLocation").string(ACSloc.c_str());
 323         if (ACS)
 324             in.addmember("acsBinding").string(ACS->getString("Binding").second);
 325     }
 326
 327     if (isHandler) {
 328         // We may already have RelayState set if we looped back here,
 329         // but just in case target is a resource, we reset it back.
 330         target.erase();
 331         option = request.getParameter("target");
 332         if (option)
 333             target = option;
 334     }
 335     if (!target.empty())
 336         in.addmember("RelayState").string(target.c_str());
 337
 338     // Remote the processing.
 339     out = request.getServiceProvider().getListenerService()->send(in);
 340     return unwrap(request, out);
 341 }
 342
 343 void SAML2SessionInitiator::receive(DDF& in, ostream& out)
 344 {
 345     // Find application.
 346     const char* aid=in["application_id"].string();
 347     const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : NULL;
 348     if (!app) {
 349         // Something's horribly wrong.
 350         m_log.error("couldn't find application (%s) to generate AuthnRequest", aid ? aid : "(missing)");
 351         throw ConfigurationException("Unable to locate application for new session, deleted?");
 352     }
 353
 354     const char* entityID = in["entity_id"].string();
 355     if (!entityID)
 356         throw ConfigurationException("No entityID parameter supplied to remoted SessionInitiator.");
 357
 358     DDF ret(NULL);
 359     DDFJanitor jout(ret);
 360
 361     // Wrap the outgoing object with a Response facade.
 362     auto_ptr<HTTPResponse> http(getResponse(ret));
 363
 364     auto_ptr_XMLCh index(in["acsIndex"].string());
 365     auto_ptr_XMLCh bind(in["acsBinding"].string());
 366
 367     string relayState(in["RelayState"].string() ? in["RelayState"].string() : "");
 368
 369     // Since we're remoted, the result should either be a throw, which we pass on,
 370     // a false/0 return, which we just return as an empty structure, or a response/redirect,
 371     // which we capture in the facade and send back.
 372     doRequest(
 373         *app, *http.get(), entityID,
 374         index.get(), in["acsLocation"].string(), bind.get(),
 375         in["isPassive"].integer()==1, in["forceAuthn"].integer()==1,
 376         in["authnContextClassRef"].string(), in["authnContextComparison"].string(),
 377         relayState
 378         );
 379     out << ret;
 380 }
 381
 382 pair<bool,long> SAML2SessionInitiator::doRequest(
 383     const Application& app,
 384     HTTPResponse& httpResponse,
 385     const char* entityID,
 386     const XMLCh* acsIndex,
 387     const char* acsLocation,
 388     const XMLCh* acsBinding,
 389     bool isPassive,
 390     bool forceAuthn,
 391     const char* authnContextClassRef,
 392     const char* authnContextComparison,
 393     string& relayState
 394     ) const
 395 {
 396 #ifndef SHIBSP_LITE
 397     // Use metadata to locate the IdP's SSO service.
 398     MetadataProvider* m=app.getMetadataProvider();
 399     Locker locker(m);
 400     const EntityDescriptor* entity=m->getEntityDescriptor(entityID);
 401     if (!entity) {
 402         m_log.error("unable to locate metadata for provider (%s)", entityID);
 403         throw MetadataException("Unable to locate metadata for identity provider ($entityID)",
 404             namedparams(1, "entityID", entityID));
 405     }
 406     const IDPSSODescriptor* role=entity->getIDPSSODescriptor(samlconstants::SAML20P_NS);
 407     if (!role) {
 408         m_log.error("unable to locate SAML 2.0 identity provider role for provider (%s)", entityID);
 409         return make_pair(false,0);
 410     }
 411
 412     // Loop over the supportable outgoing bindings.
 413     const EndpointType* ep=NULL;
 414     const MessageEncoder* encoder=NULL;
 415     vector<const XMLCh*>::const_iterator b;
 416     for (b = m_bindings.begin(); b!=m_bindings.end(); ++b) {
 417         if (ep=EndpointManager<SingleSignOnService>(role->getSingleSignOnServices()).getByBinding(*b)) {
 418             map<const XMLCh*,MessageEncoder*>::const_iterator enc = m_encoders.find(*b);
 419             if (enc!=m_encoders.end())
 420                 encoder = enc->second;
 421             break;
 422         }
 423     }
 424     if (!ep || !encoder) {
 425         m_log.error("unable to locate compatible SSO service for provider (%s)", entityID);
 426         return make_pair(false,0);
 427     }
 428
 429     preserveRelayState(app, httpResponse, relayState);
 430
 431     auto_ptr<AuthnRequest> req(m_requestTemplate ? m_requestTemplate->cloneAuthnRequest() : AuthnRequestBuilder::buildAuthnRequest());
 432     if (m_requestTemplate) {
 433         // Freshen TS and ID.
 434         req->setID(NULL);
 435         req->setIssueInstant(time(NULL));
 436     }
 437
 438     req->setDestination(ep->getLocation());
 439     if (acsIndex && *acsIndex)
 440         req->setAssertionConsumerServiceIndex(acsIndex);
 441     if (acsLocation) {
 442         auto_ptr_XMLCh wideloc(acsLocation);
 443         req->setAssertionConsumerServiceURL(wideloc.get());
 444     }
 445     if (acsBinding && *acsBinding)
 446         req->setProtocolBinding(acsBinding);
 447     if (isPassive)
 448         req->IsPassive(isPassive);
 449     else if (forceAuthn)
 450         req->ForceAuthn(forceAuthn);
 451     if (!req->getIssuer()) {
 452         Issuer* issuer = IssuerBuilder::buildIssuer();
 453         req->setIssuer(issuer);
 454         issuer->setName(app.getXMLString("entityID").second);
 455     }
 456     if (!req->getNameIDPolicy()) {
 457         NameIDPolicy* namepol = NameIDPolicyBuilder::buildNameIDPolicy();
 458         req->setNameIDPolicy(namepol);
 459         namepol->AllowCreate(true);
 460     }
 461     if (authnContextClassRef || authnContextComparison) {
 462         RequestedAuthnContext* reqContext = req->getRequestedAuthnContext();
 463         if (!reqContext) {
 464             reqContext = RequestedAuthnContextBuilder::buildRequestedAuthnContext();
 465             req->setRequestedAuthnContext(reqContext);
 466         }
 467         if (authnContextClassRef) {
 468             reqContext->getAuthnContextDeclRefs().clear();
 469             auto_ptr_XMLCh wideclass(authnContextClassRef);
 470             AuthnContextClassRef* cref = AuthnContextClassRefBuilder::buildAuthnContextClassRef();
 471             cref->setReference(wideclass.get());
 472             reqContext->getAuthnContextClassRefs().push_back(cref);
 473         }
 474         if (authnContextComparison &&
 475                 (!reqContext->getAuthnContextClassRefs().empty() || !reqContext->getAuthnContextDeclRefs().empty())) {
 476             auto_ptr_XMLCh widecomp(authnContextComparison);
 477             reqContext->setComparison(widecomp.get());
 478         }
 479     }
 480
 481     auto_ptr_char dest(ep->getLocation());
 482
 483     // Check for signing.
 484     const PropertySet* relyingParty = app.getRelyingParty(entity);
 485     pair<bool,bool> flag = relyingParty->getBool("signRequests");
 486     if ((flag.first && flag.second) || role->WantAuthnRequestsSigned()) {
 487         CredentialResolver* credResolver=app.getCredentialResolver();
 488         if (credResolver) {
 489             Locker credLocker(credResolver);
 490             // Fill in criteria to use.
 491             MetadataCredentialCriteria mcc(*role);
 492             mcc.setUsage(CredentialCriteria::SIGNING_CREDENTIAL);
 493             pair<bool,const char*> keyName = relyingParty->getString("keyName");
 494             if (keyName.first)
 495                 mcc.getKeyNames().insert(keyName.second);
 496             pair<bool,const XMLCh*> sigalg = relyingParty->getXMLString("signatureAlg");
 497             if (sigalg.first)
 498                 mcc.setXMLAlgorithm(sigalg.second);
 499             const Credential* cred = credResolver->resolve(&mcc);
 500             if (cred) {
 501                 // Signed request.
 502                 long ret = encoder->encode(
 503                     httpResponse,
 504                     req.get(),
 505                     dest.get(),
 506                     entity,
 507                     relayState.c_str(),
 508                     &app,
 509                     cred,
 510                     sigalg.second,
 511                     relyingParty->getXMLString("digestAlg").second
 512                     );
 513                 req.release();  // freed by encoder
 514                 return make_pair(true,ret);
 515             }
 516             else {
 517                 m_log.warn("no signing credential resolved, leaving AuthnRequest unsigned");
 518             }
 519         }
 520     }
 521
 522     // Unsigned request.
 523     long ret = encoder->encode(httpResponse, req.get(), dest.get(), entity, relayState.c_str(), &app);
 524     req.release();  // freed by encoder
 525     return make_pair(true,ret);
 526 #else
 527     return make_pair(false,0);
 528 #endif
 529 }