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