shibsp/handler/impl/AssertionConsumerService.cpp

   1 /*
   2  *  Copyright 2001-2009 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * AssertionConsumerService.cpp
  19  *
  20  * Base class for handlers that create sessions by consuming SSO protocol responses.
  21  */
  22
  23 #include "internal.h"
  24 #include "Application.h"
  25 #include "exceptions.h"
  26 #include "ServiceProvider.h"
  27 #include "handler/AssertionConsumerService.h"
  28 #include "util/SPConstants.h"
  29
  30 # include <ctime>
  31 #ifndef SHIBSP_LITE
  32 # include "attribute/Attribute.h"
  33 # include "attribute/filtering/AttributeFilter.h"
  34 # include "attribute/filtering/BasicFilteringContext.h"
  35 # include "attribute/resolver/AttributeExtractor.h"
  36 # include "attribute/resolver/AttributeResolver.h"
  37 # include "attribute/resolver/ResolutionContext.h"
  38 # include "metadata/MetadataProviderCriteria.h"
  39 # include "security/SecurityPolicy.h"
  40 # include <saml/SAMLConfig.h>
  41 # include <saml/saml1/core/Assertions.h>
  42 # include <saml/util/CommonDomainCookie.h>
  43 using namespace samlconstants;
  44 using opensaml::saml2md::MetadataProvider;
  45 using opensaml::saml2md::RoleDescriptor;
  46 using opensaml::saml2md::EntityDescriptor;
  47 using opensaml::saml2md::IDPSSODescriptor;
  48 using opensaml::saml2md::SPSSODescriptor;
  49 #else
  50 # include "lite/CommonDomainCookie.h"
  51 #endif
  52
  53 using namespace shibspconstants;
  54 using namespace shibsp;
  55 using namespace opensaml;
  56 using namespace xmltooling;
  57 using namespace std;
  58
  59 AssertionConsumerService::AssertionConsumerService(const DOMElement* e, const char* appId, Category& log)
  60     : AbstractHandler(e, log)
  61 #ifndef SHIBSP_LITE
  62         ,m_decoder(NULL), m_role(samlconstants::SAML20MD_NS, opensaml::saml2md::IDPSSODescriptor::LOCAL_NAME)
  63 #endif
  64 {
  65     if (!e)
  66         return;
  67     string address(appId);
  68     address += getString("Location").second;
  69     setAddress(address.c_str());
  70 #ifndef SHIBSP_LITE
  71     if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
  72         m_decoder = SAMLConfig::getConfig().MessageDecoderManager.newPlugin(
  73             getString("Binding").second, pair<const DOMElement*,const XMLCh*>(e,shibspconstants::SHIB2SPCONFIG_NS)
  74             );
  75         m_decoder->setArtifactResolver(SPConfig::getConfig().getArtifactResolver());
  76     }
  77 #endif
  78 }
  79
  80 AssertionConsumerService::~AssertionConsumerService()
  81 {
  82 #ifndef SHIBSP_LITE
  83     delete m_decoder;
  84 #endif
  85 }
  86
  87 pair<bool,long> AssertionConsumerService::run(SPRequest& request, bool isHandler) const
  88 {
  89     string relayState;
  90     SPConfig& conf = SPConfig::getConfig();
  91
  92     if (conf.isEnabled(SPConfig::OutOfProcess)) {
  93         // When out of process, we run natively and directly process the message.
  94         return processMessage(request.getApplication(), request, request);
  95     }
  96     else {
  97         // When not out of process, we remote all the message processing.
  98         vector<string> headers(1, "Cookie");
  99         DDF out,in = wrap(request, &headers);
 100         DDFJanitor jin(in), jout(out);
 101         out=request.getServiceProvider().getListenerService()->send(in);
 102         return unwrap(request, out);
 103     }
 104 }
 105
 106 void AssertionConsumerService::receive(DDF& in, ostream& out)
 107 {
 108     // Find application.
 109     const char* aid=in["application_id"].string();
 110     const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : NULL;
 111     if (!app) {
 112         // Something's horribly wrong.
 113         m_log.error("couldn't find application (%s) for new session", aid ? aid : "(missing)");
 114         throw ConfigurationException("Unable to locate application for new session, deleted?");
 115     }
 116
 117     // Unpack the request.
 118     auto_ptr<HTTPRequest> req(getRequest(in));
 119
 120     // Wrap a response shim.
 121     DDF ret(NULL);
 122     DDFJanitor jout(ret);
 123     auto_ptr<HTTPResponse> resp(getResponse(ret));
 124
 125     // Since we're remoted, the result should either be a throw, a false/0 return,
 126     // which we just return as an empty structure, or a response/redirect,
 127     // which we capture in the facade and send back.
 128     processMessage(*app, *req.get(), *resp.get());
 129     out << ret;
 130 }
 131
 132 pair<bool,long> AssertionConsumerService::processMessage(
 133     const Application& application, const HTTPRequest& httpRequest, HTTPResponse& httpResponse
 134     ) const
 135 {
 136 #ifndef SHIBSP_LITE
 137     // Locate policy key.
 138     pair<bool,const char*> policyId = getString("policyId", m_configNS.get());  // namespace-qualified if inside handler element
 139     if (!policyId.first)
 140         policyId = application.getString("policyId");   // unqualified in Application(s) element
 141
 142     // Access policy properties.
 143     const PropertySet* settings = application.getServiceProvider().getPolicySettings(policyId.second);
 144     pair<bool,bool> validate = settings->getBool("validate");
 145
 146     // Lock metadata for use by policy.
 147     Locker metadataLocker(application.getMetadataProvider());
 148
 149     // Create the policy.
 150     auto_ptr<opensaml::SecurityPolicy> policy(
 151         createSecurityPolicy(application, &m_role, validate.first && validate.second, policyId.second)
 152         );
 153
 154     string relayState;
 155     try {
 156         // Decode the message and process it in a protocol-specific way.
 157         auto_ptr<XMLObject> msg(m_decoder->decode(relayState, httpRequest, *(policy.get())));
 158         if (!msg.get())
 159             throw BindingException("Failed to decode an SSO protocol response.");
 160         DDF postData = recoverPostData(application, httpRequest, httpResponse, relayState.c_str());
 161         DDFJanitor postjan(postData);
 162         recoverRelayState(application, httpRequest, httpResponse, relayState);
 163         implementProtocol(application, httpRequest, httpResponse, *(policy.get()), settings, *msg.get());
 164
 165         auto_ptr_char issuer(policy->getIssuer() ? policy->getIssuer()->getName() : NULL);
 166
 167         // History cookie.
 168         if (issuer.get() && *issuer.get())
 169             maintainHistory(application, httpRequest, httpResponse, issuer.get());
 170
 171         // Now redirect to the state value. By now, it should be set to *something* usable.
 172         // First check for POST data.
 173         if (!postData.islist()) {
 174             m_log.debug("ACS returning via redirect to: %s", relayState.c_str());
 175             return make_pair(true, httpResponse.sendRedirect(relayState.c_str()));
 176         }
 177         else {
 178             m_log.debug("ACS returning via POST to: %s", relayState.c_str());
 179             return make_pair(true, sendPostResponse(application, httpResponse, relayState.c_str(), postData));
 180         }
 181     }
 182     catch (XMLToolingException& ex) {
 183         // Check for isPassive error condition.
 184         const char* sc2 = ex.getProperty("statusCode2");
 185         if (sc2 && !strcmp(sc2, "urn:oasis:names:tc:SAML:2.0:status:NoPassive")) {
 186             validate = getBool("ignoreNoPassive", m_configNS.get());  // namespace-qualified if inside handler element
 187             if (validate.first && validate.second && !relayState.empty()) {
 188                 m_log.debug("ignoring SAML status of NoPassive and redirecting to resource...");
 189                 return make_pair(true, httpResponse.sendRedirect(relayState.c_str()));
 190             }
 191         }
 192         if (!relayState.empty())
 193             ex.addProperty("RelayState", relayState.c_str());
 194         throw;
 195     }
 196 #else
 197     throw ConfigurationException("Cannot process message using lite version of shibsp library.");
 198 #endif
 199 }
 200
 201 void AssertionConsumerService::checkAddress(const Application& application, const HTTPRequest& httpRequest, const char* issuedTo) const
 202 {
 203     if (!issuedTo || !*issuedTo)
 204         return;
 205
 206     const PropertySet* props=application.getPropertySet("Sessions");
 207     pair<bool,bool> checkAddress = props ? props->getBool("checkAddress") : make_pair(false,true);
 208     if (!checkAddress.first)
 209         checkAddress.second=true;
 210
 211     if (checkAddress.second) {
 212         m_log.debug("checking client address");
 213         if (httpRequest.getRemoteAddr() != issuedTo) {
 214             throw FatalProfileException(
 215                "Your client's current address ($client_addr) differs from the one used when you authenticated "
 216                 "to your identity provider. To correct this problem, you may need to bypass a proxy server. "
 217                 "Please contact your local support staff or help desk for assistance.",
 218                 namedparams(1,"client_addr",httpRequest.getRemoteAddr().c_str())
 219                 );
 220         }
 221     }
 222 }
 223
 224 #ifndef SHIBSP_LITE
 225
 226 void AssertionConsumerService::generateMetadata(SPSSODescriptor& role, const char* handlerURL) const
 227 {
 228     const char* loc = getString("Location").second;
 229     string hurl(handlerURL);
 230     if (*loc != '/')
 231         hurl += '/';
 232     hurl += loc;
 233     auto_ptr_XMLCh widen(hurl.c_str());
 234     saml2md::AssertionConsumerService* ep = saml2md::AssertionConsumerServiceBuilder::buildAssertionConsumerService();
 235     ep->setLocation(widen.get());
 236     ep->setBinding(getXMLString("Binding").second);
 237     if (!strncmp(handlerURL, "https", 5)) {
 238         pair<bool,const XMLCh*> index = getXMLString("sslIndex", shibspconstants::ASCII_SHIB2SPCONFIG_NS);
 239         if (index.first)
 240                 ep->setIndex(index.second);
 241         else
 242                 ep->setIndex(getXMLString("index").second);
 243     }
 244     else {
 245         ep->setIndex(getXMLString("index").second);
 246     }
 247     role.getAssertionConsumerServices().push_back(ep);
 248 }
 249
 250 opensaml::SecurityPolicy* AssertionConsumerService::createSecurityPolicy(
 251     const Application& application, const xmltooling::QName* role, bool validate, const char* policyId
 252     ) const
 253 {
 254     return new SecurityPolicy(application, role, validate, policyId);
 255 }
 256
 257 class SHIBSP_DLLLOCAL DummyContext : public ResolutionContext
 258 {
 259 public:
 260     DummyContext(const vector<Attribute*>& attributes) : m_attributes(attributes) {
 261     }
 262
 263     virtual ~DummyContext() {
 264         for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<Attribute>());
 265     }
 266
 267     vector<Attribute*>& getResolvedAttributes() {
 268         return m_attributes;
 269     }
 270     vector<Assertion*>& getResolvedAssertions() {
 271         return m_tokens;
 272     }
 273
 274 private:
 275     vector<Attribute*> m_attributes;
 276     static vector<Assertion*> m_tokens; // never any tokens, so just share an empty vector
 277 };
 278
 279 vector<Assertion*> DummyContext::m_tokens;
 280
 281 ResolutionContext* AssertionConsumerService::resolveAttributes(
 282     const Application& application,
 283     const saml2md::RoleDescriptor* issuer,
 284     const XMLCh* protocol,
 285     const saml1::NameIdentifier* v1nameid,
 286     const saml2::NameID* nameid,
 287     const XMLCh* authncontext_class,
 288     const XMLCh* authncontext_decl,
 289     const vector<const Assertion*>* tokens
 290     ) const
 291 {
 292     // First we do the extraction of any pushed information, including from metadata.
 293     vector<Attribute*> resolvedAttributes;
 294     AttributeExtractor* extractor = application.getAttributeExtractor();
 295     if (extractor) {
 296         Locker extlocker(extractor);
 297         if (issuer) {
 298             pair<bool,const char*> mprefix = application.getString("metadataAttributePrefix");
 299             if (mprefix.first) {
 300                 m_log.debug("extracting metadata-derived attributes...");
 301                 try {
 302                     // We pass NULL for "issuer" because the IdP isn't the one asserting metadata-based attributes.
 303                     extractor->extractAttributes(application, NULL, *issuer, resolvedAttributes);
 304                     for (vector<Attribute*>::iterator a = resolvedAttributes.begin(); a != resolvedAttributes.end(); ++a) {
 305                         vector<string>& ids = (*a)->getAliases();
 306                         for (vector<string>::iterator id = ids.begin(); id != ids.end(); ++id)
 307                             *id = mprefix.second + *id;
 308                     }
 309                 }
 310                 catch (exception& ex) {
 311                     m_log.error("caught exception extracting attributes: %s", ex.what());
 312                 }
 313             }
 314         }
 315         m_log.debug("extracting pushed attributes...");
 316         if (v1nameid) {
 317             try {
 318                 extractor->extractAttributes(application, issuer, *v1nameid, resolvedAttributes);
 319             }
 320             catch (exception& ex) {
 321                 m_log.error("caught exception extracting attributes: %s", ex.what());
 322             }
 323         }
 324         else if (nameid) {
 325             try {
 326                 extractor->extractAttributes(application, issuer, *nameid, resolvedAttributes);
 327             }
 328             catch (exception& ex) {
 329                 m_log.error("caught exception extracting attributes: %s", ex.what());
 330             }
 331         }
 332         if (tokens) {
 333             for (vector<const Assertion*>::const_iterator t = tokens->begin(); t!=tokens->end(); ++t) {
 334                 try {
 335                     extractor->extractAttributes(application, issuer, *(*t), resolvedAttributes);
 336                 }
 337                 catch (exception& ex) {
 338                     m_log.error("caught exception extracting attributes: %s", ex.what());
 339                 }
 340             }
 341         }
 342
 343         AttributeFilter* filter = application.getAttributeFilter();
 344         if (filter && !resolvedAttributes.empty()) {
 345             BasicFilteringContext fc(application, resolvedAttributes, issuer, authncontext_class);
 346             Locker filtlocker(filter);
 347             try {
 348                 filter->filterAttributes(fc, resolvedAttributes);
 349             }
 350             catch (exception& ex) {
 351                 m_log.error("caught exception filtering attributes: %s", ex.what());
 352                 m_log.error("dumping extracted attributes due to filtering exception");
 353                 for_each(resolvedAttributes.begin(), resolvedAttributes.end(), xmltooling::cleanup<shibsp::Attribute>());
 354                 resolvedAttributes.clear();
 355             }
 356         }
 357     }
 358
 359     try {
 360         AttributeResolver* resolver = application.getAttributeResolver();
 361         if (resolver) {
 362             m_log.debug("resolving attributes...");
 363
 364             Locker locker(resolver);
 365             auto_ptr<ResolutionContext> ctx(
 366                 resolver->createResolutionContext(
 367                     application,
 368                     issuer ? dynamic_cast<const saml2md::EntityDescriptor*>(issuer->getParent()) : NULL,
 369                     protocol,
 370                     nameid,
 371                     authncontext_class,
 372                     authncontext_decl,
 373                     tokens,
 374                     &resolvedAttributes
 375                     )
 376                 );
 377             resolver->resolveAttributes(*ctx.get());
 378             // Copy over any pushed attributes.
 379             if (!resolvedAttributes.empty())
 380                 ctx->getResolvedAttributes().insert(ctx->getResolvedAttributes().end(), resolvedAttributes.begin(), resolvedAttributes.end());
 381             return ctx.release();
 382         }
 383     }
 384     catch (exception& ex) {
 385         m_log.error("attribute resolution failed: %s", ex.what());
 386     }
 387
 388     if (!resolvedAttributes.empty())
 389         return new DummyContext(resolvedAttributes);
 390     return NULL;
 391 }
 392
 393 void AssertionConsumerService::extractMessageDetails(const Assertion& assertion, const XMLCh* protocol, opensaml::SecurityPolicy& policy) const
 394 {
 395     policy.setMessageID(assertion.getID());
 396     policy.setIssueInstant(assertion.getIssueInstantEpoch());
 397
 398     if (XMLString::equals(assertion.getElementQName().getNamespaceURI(), samlconstants::SAML20_NS)) {
 399         const saml2::Assertion* a2 = dynamic_cast<const saml2::Assertion*>(&assertion);
 400         if (a2) {
 401             m_log.debug("extracting issuer from SAML 2.0 assertion");
 402             policy.setIssuer(a2->getIssuer());
 403         }
 404     }
 405     else {
 406         const saml1::Assertion* a1 = dynamic_cast<const saml1::Assertion*>(&assertion);
 407         if (a1) {
 408             m_log.debug("extracting issuer from SAML 1.x assertion");
 409             policy.setIssuer(a1->getIssuer());
 410         }
 411     }
 412
 413     if (policy.getIssuer() && !policy.getIssuerMetadata() && policy.getMetadataProvider()) {
 414         if (policy.getIssuer()->getFormat() && !XMLString::equals(policy.getIssuer()->getFormat(), saml2::NameIDType::ENTITY)) {
 415             m_log.warn("non-system entity issuer, skipping metadata lookup");
 416             return;
 417         }
 418         m_log.debug("searching metadata for assertion issuer...");
 419         pair<const EntityDescriptor*,const RoleDescriptor*> entity;
 420         MetadataProvider::Criteria& mc = policy.getMetadataProviderCriteria();
 421         mc.entityID_unicode = policy.getIssuer()->getName();
 422         mc.role = &IDPSSODescriptor::ELEMENT_QNAME;
 423         mc.protocol = protocol;
 424         entity = policy.getMetadataProvider()->getEntityDescriptor(mc);
 425         if (!entity.first) {
 426             auto_ptr_char iname(policy.getIssuer()->getName());
 427             m_log.warn("no metadata found, can't establish identity of issuer (%s)", iname.get());
 428         }
 429         else if (!entity.second) {
 430             m_log.warn("unable to find compatible IdP role in metadata");
 431         }
 432         else {
 433             policy.setIssuerMetadata(entity.second);
 434         }
 435     }
 436 }
 437
 438 #endif
 439
 440 void AssertionConsumerService::maintainHistory(
 441     const Application& application, const HTTPRequest& request, HTTPResponse& response, const char* entityID
 442     ) const
 443 {
 444     static const char* defProps="; path=/";
 445
 446     const PropertySet* sessionProps=application.getPropertySet("Sessions");
 447     pair<bool,bool> idpHistory=sessionProps->getBool("idpHistory");
 448
 449     if (idpHistory.first && idpHistory.second) {
 450         pair<bool,const char*> cookieProps=sessionProps->getString("cookieProps");
 451         if (!cookieProps.first)
 452             cookieProps.second=defProps;
 453
 454         // Set an IdP history cookie locally (essentially just a CDC).
 455         CommonDomainCookie cdc(request.getCookie(CommonDomainCookie::CDCName));
 456
 457         // Either leave in memory or set an expiration.
 458         pair<bool,unsigned int> days=sessionProps->getUnsignedInt("idpHistoryDays");
 459         if (!days.first || days.second==0) {
 460             string c = string(cdc.set(entityID)) + cookieProps.second;
 461             response.setCookie(CommonDomainCookie::CDCName, c.c_str());
 462         }
 463         else {
 464             time_t now=time(NULL) + (days.second * 24 * 60 * 60);
 465 #ifdef HAVE_GMTIME_R
 466             struct tm res;
 467             struct tm* ptime=gmtime_r(&now,&res);
 468 #else
 469             struct tm* ptime=gmtime(&now);
 470 #endif
 471             char timebuf[64];
 472             strftime(timebuf,64,"%a, %d %b %Y %H:%M:%S GMT",ptime);
 473             string c = string(cdc.set(entityID)) + cookieProps.second + "; expires=" + timebuf;
 474             response.setCookie(CommonDomainCookie::CDCName, c.c_str());
 475         }
 476     }
 477 }