Add sslIndex option to override ACS index in metadata generation.
[shibboleth/sp.git] / shibsp / handler / impl / AssertionConsumerService.cpp
index 285b0a6..f4863cd 100644 (file)
 
 # include <ctime>
 #ifndef SHIBSP_LITE
+# include "attribute/Attribute.h"
+# include "attribute/filtering/AttributeFilter.h"
+# include "attribute/filtering/BasicFilteringContext.h"
+# include "attribute/resolver/AttributeExtractor.h"
 # include "attribute/resolver/AttributeResolver.h"
 # include "attribute/resolver/ResolutionContext.h"
 # include "security/SecurityPolicy.h"
 # include <saml/saml1/core/Assertions.h>
 # include <saml/util/CommonDomainCookie.h>
 using namespace samlconstants;
+using opensaml::saml2md::MetadataProvider;
+using opensaml::saml2md::RoleDescriptor;
+using opensaml::saml2md::EntityDescriptor;
+using opensaml::saml2md::IDPSSODescriptor;
+using opensaml::saml2md::SPSSODescriptor;
 #else
 # include "lite/CommonDomainCookie.h"
 #endif
@@ -44,7 +53,6 @@ using namespace shibspconstants;
 using namespace shibsp;
 using namespace opensaml;
 using namespace xmltooling;
-using namespace log4cpp;
 using namespace std;
 
 AssertionConsumerService::AssertionConsumerService(const DOMElement* e, const char* appId, Category& log)
@@ -53,13 +61,16 @@ AssertionConsumerService::AssertionConsumerService(const DOMElement* e, const ch
         ,m_decoder(NULL), m_role(samlconstants::SAML20MD_NS, opensaml::saml2md::IDPSSODescriptor::LOCAL_NAME)
 #endif
 {
+    if (!e)
+        return;
     string address(appId);
     address += getString("Location").second;
-    address += "::run::ACS";
     setAddress(address.c_str());
 #ifndef SHIBSP_LITE
     if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
-        m_decoder = SAMLConfig::getConfig().MessageDecoderManager.newPlugin(getString("Binding").second,e);
+        m_decoder = SAMLConfig::getConfig().MessageDecoderManager.newPlugin(
+            getString("Binding").second, pair<const DOMElement*,const XMLCh*>(e,shibspconstants::SHIB2SPCONFIG_NS)
+            );
         m_decoder->setArtifactResolver(SPConfig::getConfig().getArtifactResolver());
     }
 #endif
@@ -77,53 +88,17 @@ pair<bool,long> AssertionConsumerService::run(SPRequest& request, bool isHandler
     string relayState;
     SPConfig& conf = SPConfig::getConfig();
     
-    try {
-        if (conf.isEnabled(SPConfig::OutOfProcess)) {
-            // When out of process, we run natively and directly process the message.
-            // RelayState will be fully handled during message processing.
-            string entityID;
-            string key = processMessage(request.getApplication(), request, entityID, relayState);
-            return sendRedirect(request, key.c_str(), entityID.c_str(), relayState.c_str());
-        }
-        else {
-            // When not out of process, we remote all the message processing.
-            DDF out,in = wrap(request);
-            DDFJanitor jin(in), jout(out);
-            
-            try {
-                out=request.getServiceProvider().getListenerService()->send(in);
-            }
-            catch (XMLToolingException& ex) {
-                // Try for RelayState recovery.
-                if (ex.getProperty("RelayState"))
-                    relayState = ex.getProperty("RelayState");
-                try {
-                    recoverRelayState(request.getApplication(), request, relayState);
-                }
-                catch (exception& ex2) {
-                    m_log.error("trapped an error during RelayState recovery while handling an error: %s", ex2.what());
-                }
-                throw;
-            }
-                
-            // We invoke RelayState recovery one last time on this side of the boundary.
-            if (out["RelayState"].isstring())
-                relayState = out["RelayState"].string(); 
-            recoverRelayState(request.getApplication(), request, relayState);
-    
-            // If it worked, we have a session key.
-            if (!out["key"].isstring())
-                throw FatalProfileException("Remote processing of SSO profile did not return a usable session key.");
-            
-            // Take care of cookie business and wrap it up.
-            return sendRedirect(request, out["key"].string(), out["entity_id"].string(), relayState.c_str());
-        }
+    if (conf.isEnabled(SPConfig::OutOfProcess)) {
+        // When out of process, we run natively and directly process the message.
+        return processMessage(request.getApplication(), request, request);
     }
-    catch (XMLToolingException& ex) {
-        // Try and preserve RelayState.
-        if (!relayState.empty())
-            ex.addProperty("RelayState", relayState.c_str());
-        throw;
+    else {
+        // When not out of process, we remote all the message processing.
+        vector<string> headers(1, "Cookie");
+        DDF out,in = wrap(request, &headers);
+        DDFJanitor jin(in), jout(out);
+        out=request.getServiceProvider().getListenerService()->send(in);
+        return unwrap(request, out);
     }
 }
 
@@ -139,33 +114,22 @@ void AssertionConsumerService::receive(DDF& in, ostream& out)
     }
     
     // Unpack the request.
-    auto_ptr<HTTPRequest> http(getRequest(in));
-    
-    // Do the work.
-    string relayState, entityID;
-    try {
-        string key = processMessage(*app, *http.get(), entityID, relayState);
-
-        // Repack for return to caller.
-        DDF ret=DDF(NULL).structure();
-        DDFJanitor jret(ret);
-        ret.addmember("key").string(key.c_str());
-        if (!entityID.empty())
-            ret.addmember("entity_id").string(entityID.c_str());
-        if (!relayState.empty())
-            ret.addmember("RelayState").string(relayState.c_str());
-        out << ret;
-    }
-    catch (XMLToolingException& ex) {
-        // Try and preserve RelayState if we can.
-        if (!relayState.empty())
-            ex.addProperty("RelayState", relayState.c_str());
-        throw;
-    }
+    auto_ptr<HTTPRequest> req(getRequest(in));
+
+    // Wrap a response shim.
+    DDF ret(NULL);
+    DDFJanitor jout(ret);
+    auto_ptr<HTTPResponse> resp(getResponse(ret));
+
+    // Since we're remoted, the result should either be a throw, a false/0 return,
+    // which we just return as an empty structure, or a response/redirect,
+    // which we capture in the facade and send back.
+    processMessage(*app, *req.get(), *resp.get());
+    out << ret;
 }
 
-string AssertionConsumerService::processMessage(
-    const Application& application, HTTPRequest& httpRequest, string& entityID, string& relayState
+pair<bool,long> AssertionConsumerService::processMessage(
+    const Application& application, const HTTPRequest& httpRequest, HTTPResponse& httpResponse
     ) const
 {
 #ifndef SHIBSP_LITE
@@ -184,44 +148,40 @@ string AssertionConsumerService::processMessage(
     // Create the policy.
     shibsp::SecurityPolicy policy(application, &m_role, validate.first && validate.second);
     
-    // Decode the message and process it in a protocol-specific way.
-    auto_ptr<XMLObject> msg(m_decoder->decode(relayState, httpRequest, policy));
-    if (!msg.get())
-        throw BindingException("Failed to decode an SSO protocol response.");
-    recoverRelayState(application, httpRequest, relayState);
-    string key = implementProtocol(application, httpRequest, policy, settings, *msg.get());
-
-    auto_ptr_char issuer(policy.getIssuer() ? policy.getIssuer()->getName() : NULL);
-    if (issuer.get())
-        entityID = issuer.get();
-    
-    return key;
-#else
-    throw ConfigurationException("Cannot process message using lite version of shibsp library.");
-#endif
-}
+    string relayState;
 
-pair<bool,long> AssertionConsumerService::sendRedirect(
-    SPRequest& request, const char* key, const char* entityID, const char* relayState
-    ) const
-{
-    // We've got a good session, so set the session cookie.
-    pair<string,const char*> shib_cookie=request.getApplication().getCookieNameProps("_shibsession_");
-    string k(key);
-    k += shib_cookie.second;
-    request.setCookie(shib_cookie.first.c_str(), k.c_str());
+    try {
+        // Decode the message and process it in a protocol-specific way.
+        auto_ptr<XMLObject> msg(m_decoder->decode(relayState, httpRequest, policy));
+        if (!msg.get())
+            throw BindingException("Failed to decode an SSO protocol response.");
+        recoverRelayState(application, httpRequest, httpResponse, relayState);
+        implementProtocol(application, httpRequest, httpResponse, policy, settings, *msg.get());
 
-    // History cookie.
-    maintainHistory(request, entityID, shib_cookie.second);
+        auto_ptr_char issuer(policy.getIssuer() ? policy.getIssuer()->getName() : NULL);
+        
+        // History cookie.
+        if (issuer.get() && *issuer.get())
+            maintainHistory(application, httpRequest, httpResponse, issuer.get());
 
-    // Now redirect to the state value. By now, it should be set to *something* usable.
-    return make_pair(true, request.sendRedirect(relayState));
+        // Now redirect to the state value. By now, it should be set to *something* usable.
+        return make_pair(true, httpResponse.sendRedirect(relayState.c_str()));
+    }
+    catch (XMLToolingException& ex) {
+        if (!relayState.empty())
+            ex.addProperty("RelayState", relayState.c_str());
+        throw;
+    }
+#else
+    throw ConfigurationException("Cannot process message using lite version of shibsp library.");
+#endif
 }
 
-void AssertionConsumerService::checkAddress(
-    const Application& application, const HTTPRequest& httpRequest, const char* issuedTo
-    ) const
+void AssertionConsumerService::checkAddress(const Application& application, const HTTPRequest& httpRequest, const char* issuedTo) const
 {
+    if (!issuedTo || !*issuedTo)
+        return;
+    
     const PropertySet* props=application.getPropertySet("Sessions");
     pair<bool,bool> checkAddress = props ? props->getBool("checkAddress") : make_pair(false,true);
     if (!checkAddress.first)
@@ -241,56 +201,254 @@ void AssertionConsumerService::checkAddress(
 }
 
 #ifndef SHIBSP_LITE
+
+void AssertionConsumerService::generateMetadata(SPSSODescriptor& role, const char* handlerURL) const {
+    const char* loc = getString("Location").second;
+    string hurl(handlerURL);
+    if (*loc != '/')
+        hurl += '/';
+    hurl += loc;
+    auto_ptr_XMLCh widen(hurl.c_str());
+    saml2md::AssertionConsumerService* ep = saml2md::AssertionConsumerServiceBuilder::buildAssertionConsumerService();
+    ep->setLocation(widen.get());
+    ep->setBinding(getXMLString("Binding").second);
+    if (!strncmp(handlerURL, "https", 5)) {
+       pair<bool,const XMLCh*> index = getXMLString("sslIndex", shibspconstants::ASCII_SHIB2SPCONFIG_NS);
+       if (index.first)
+               ep->setIndex(index.second);
+       else
+               ep->setIndex(getXMLString("index").second);
+    }
+    else {
+       ep->setIndex(getXMLString("index").second);
+    }
+    role.getAssertionConsumerServices().push_back(ep);
+}
+
+class SHIBSP_DLLLOCAL DummyContext : public ResolutionContext
+{
+public:
+    DummyContext(const vector<Attribute*>& attributes) : m_attributes(attributes) {
+    }
+
+    virtual ~DummyContext() {
+        for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<Attribute>());
+    }
+
+    vector<Attribute*>& getResolvedAttributes() {
+        return m_attributes;
+    }
+    vector<Assertion*>& getResolvedAssertions() {
+        return m_tokens;
+    }
+
+private:
+    vector<Attribute*> m_attributes;
+    static vector<Assertion*> m_tokens; // never any tokens, so just share an empty vector
+};
+
+vector<Assertion*> DummyContext::m_tokens;
+
 ResolutionContext* AssertionConsumerService::resolveAttributes(
     const Application& application,
-    const saml2md::EntityDescriptor* issuer,
+    const saml2md::RoleDescriptor* issuer,
+    const XMLCh* protocol,
+    const saml1::NameIdentifier* v1nameid,
     const saml2::NameID* nameid,
-    const char* authncontext_class,
-    const char* authncontext_decl,
-    const vector<const Assertion*>* tokens,
-    const multimap<string,Attribute*>* attributes
+    const XMLCh* authncontext_class,
+    const XMLCh* authncontext_decl,
+    const vector<const Assertion*>* tokens
     ) const
 {
+    const saml2md::EntityDescriptor* entity = issuer ? dynamic_cast<const saml2md::EntityDescriptor*>(issuer->getParent()) : NULL;
+
+    // First we do the extraction of any pushed information, including from metadata.
+    vector<Attribute*> resolvedAttributes;
+    AttributeExtractor* extractor = application.getAttributeExtractor();
+    if (extractor) {
+        Locker extlocker(extractor);
+        if (entity) {
+            pair<bool,const char*> mprefix = application.getString("metadataAttributePrefix");
+            if (mprefix.first) {
+                m_log.debug("extracting metadata-derived attributes...");
+                try {
+                    extractor->extractAttributes(application, issuer, *entity, resolvedAttributes);
+                    for (vector<Attribute*>::iterator a = resolvedAttributes.begin(); a != resolvedAttributes.end(); ++a) {
+                        vector<string>& ids = (*a)->getAliases();
+                        for (vector<string>::iterator id = ids.begin(); id != ids.end(); ++id)
+                            *id = mprefix.second + *id;
+                    }
+                }
+                catch (exception& ex) {
+                    m_log.error("caught exception extracting attributes: %s", ex.what());
+                }
+            }
+        }
+        m_log.debug("extracting pushed attributes...");
+        if (v1nameid) {
+            try {
+                extractor->extractAttributes(application, issuer, *v1nameid, resolvedAttributes);
+            }
+            catch (exception& ex) {
+                m_log.error("caught exception extracting attributes: %s", ex.what());
+            }
+        }
+        else if (nameid) {
+            try {
+                extractor->extractAttributes(application, issuer, *nameid, resolvedAttributes);
+            }
+            catch (exception& ex) {
+                m_log.error("caught exception extracting attributes: %s", ex.what());
+            }
+        }
+        if (tokens) {
+            for (vector<const Assertion*>::const_iterator t = tokens->begin(); t!=tokens->end(); ++t) {
+                try {
+                    extractor->extractAttributes(application, issuer, *(*t), resolvedAttributes);
+                }
+                catch (exception& ex) {
+                    m_log.error("caught exception extracting attributes: %s", ex.what());
+                }
+            }
+        }
+
+        AttributeFilter* filter = application.getAttributeFilter();
+        if (filter && !resolvedAttributes.empty()) {
+            BasicFilteringContext fc(application, resolvedAttributes, issuer, authncontext_class);
+            Locker filtlocker(filter);
+            try {
+                filter->filterAttributes(fc, resolvedAttributes);
+            }
+            catch (exception& ex) {
+                m_log.error("caught exception filtering attributes: %s", ex.what());
+                m_log.error("dumping extracted attributes due to filtering exception");
+                for_each(resolvedAttributes.begin(), resolvedAttributes.end(), xmltooling::cleanup<shibsp::Attribute>());
+                resolvedAttributes.clear();
+            }
+        }
+    }
+    
     try {
         AttributeResolver* resolver = application.getAttributeResolver();
-        if (!resolver) {
-            m_log.info("no AttributeResolver available, skipping resolution");
-            return NULL;
-        }
-        
-        m_log.debug("resolving attributes...");
+        if (resolver) {
+            m_log.debug("resolving attributes...");
 
-        Locker locker(resolver);
-        auto_ptr<ResolutionContext> ctx(
-            resolver->createResolutionContext(application, issuer, nameid, authncontext_class, authncontext_decl, tokens, attributes)
-            );
-        resolver->resolveAttributes(*ctx.get());
-        return ctx.release();
+            Locker locker(resolver);
+            auto_ptr<ResolutionContext> ctx(
+                resolver->createResolutionContext(
+                    application,
+                    entity,
+                    protocol,
+                    nameid,
+                    authncontext_class,
+                    authncontext_decl,
+                    tokens,
+                    &resolvedAttributes
+                    )
+                );
+            resolver->resolveAttributes(*ctx.get());
+            // Copy over any pushed attributes.
+            if (!resolvedAttributes.empty())
+                ctx->getResolvedAttributes().insert(ctx->getResolvedAttributes().end(), resolvedAttributes.begin(), resolvedAttributes.end());
+
+            // Attach global prefix if needed.
+            pair<bool,const char*> prefix = application.getString("attributePrefix");
+            if (prefix.first) {
+                for (vector<Attribute*>::iterator a = ctx->getResolvedAttributes().begin(); a != ctx->getResolvedAttributes().end(); ++a) {
+                    vector<string>& ids = (*a)->getAliases();
+                    for (vector<string>::iterator id = ids.begin(); id != ids.end(); ++id)
+                        *id = prefix.second + *id;
+                }
+            }
+
+            return ctx.release();
+        }
     }
     catch (exception& ex) {
         m_log.error("attribute resolution failed: %s", ex.what());
     }
     
+    if (!resolvedAttributes.empty()) {
+        // Attach global prefix if needed.
+        pair<bool,const char*> prefix = application.getString("attributePrefix");
+        if (prefix.first) {
+            for (vector<Attribute*>::iterator a = resolvedAttributes.begin(); a != resolvedAttributes.end(); ++a) {
+                vector<string>& ids = (*a)->getAliases();
+                for (vector<string>::iterator id = ids.begin(); id != ids.end(); ++id)
+                    *id = prefix.second + *id;
+            }
+        }
+
+        return new DummyContext(resolvedAttributes);
+    }
     return NULL;
 }
+
+void AssertionConsumerService::extractMessageDetails(const Assertion& assertion, const XMLCh* protocol, opensaml::SecurityPolicy& policy) const
+{
+    policy.setMessageID(assertion.getID());
+    policy.setIssueInstant(assertion.getIssueInstantEpoch());
+
+    if (XMLString::equals(assertion.getElementQName().getNamespaceURI(), samlconstants::SAML20_NS)) {
+        const saml2::Assertion* a2 = dynamic_cast<const saml2::Assertion*>(&assertion);
+        if (a2) {
+            m_log.debug("extracting issuer from SAML 2.0 assertion");
+            policy.setIssuer(a2->getIssuer());
+        }
+    }
+    else {
+        const saml1::Assertion* a1 = dynamic_cast<const saml1::Assertion*>(&assertion);
+        if (a1) {
+            m_log.debug("extracting issuer from SAML 1.x assertion");
+            policy.setIssuer(a1->getIssuer());
+        }
+    }
+
+    if (policy.getIssuer() && !policy.getIssuerMetadata() && policy.getMetadataProvider()) {
+        if (policy.getIssuer()->getFormat() && !XMLString::equals(policy.getIssuer()->getFormat(), saml2::NameIDType::ENTITY)) {
+            m_log.warn("non-system entity issuer, skipping metadata lookup");
+            return;
+        }
+        m_log.debug("searching metadata for assertion issuer...");
+        MetadataProvider::Criteria mc(policy.getIssuer()->getName(), &IDPSSODescriptor::ELEMENT_QNAME, protocol);
+        pair<const EntityDescriptor*,const RoleDescriptor*> entity = policy.getMetadataProvider()->getEntityDescriptor(mc);
+        if (!entity.first) {
+            auto_ptr_char iname(policy.getIssuer()->getName());
+            m_log.warn("no metadata found, can't establish identity of issuer (%s)", iname.get());
+        }
+        else if (!entity.second) {
+            m_log.warn("unable to find compatible IdP role in metadata");
+        }
+        else {
+            policy.setIssuerMetadata(entity.second);
+        }
+    }
+}
+
 #endif
 
-void AssertionConsumerService::maintainHistory(SPRequest& request, const char* entityID, const char* cookieProps) const
+void AssertionConsumerService::maintainHistory(
+    const Application& application, const HTTPRequest& request, HTTPResponse& response, const char* entityID
+    ) const
 {
-    if (!entityID)
-        return;
-        
-    const PropertySet* sessionProps=request.getApplication().getPropertySet("Sessions");
+    static const char* defProps="; path=/";
+
+    const PropertySet* sessionProps=application.getPropertySet("Sessions");
     pair<bool,bool> idpHistory=sessionProps->getBool("idpHistory");
+
     if (!idpHistory.first || idpHistory.second) {
+        pair<bool,const char*> cookieProps=sessionProps->getString("cookieProps");
+        if (!cookieProps.first)
+            cookieProps.second=defProps;
+
         // Set an IdP history cookie locally (essentially just a CDC).
         CommonDomainCookie cdc(request.getCookie(CommonDomainCookie::CDCName));
 
         // Either leave in memory or set an expiration.
         pair<bool,unsigned int> days=sessionProps->getUnsignedInt("idpHistoryDays");
         if (!days.first || days.second==0) {
-            string c = string(cdc.set(entityID)) + cookieProps;
-            request.setCookie(CommonDomainCookie::CDCName, c.c_str());
+            string c = string(cdc.set(entityID)) + cookieProps.second;
+            response.setCookie(CommonDomainCookie::CDCName, c.c_str());
         }
         else {
             time_t now=time(NULL) + (days.second * 24 * 60 * 60);
@@ -302,8 +460,8 @@ void AssertionConsumerService::maintainHistory(SPRequest& request, const char* e
 #endif
             char timebuf[64];
             strftime(timebuf,64,"%a, %d %b %Y %H:%M:%S GMT",ptime);
-            string c = string(cdc.set(entityID)) + cookieProps + "; expires=" + timebuf;
-            request.setCookie(CommonDomainCookie::CDCName, c.c_str());
+            string c = string(cdc.set(entityID)) + cookieProps.second + "; expires=" + timebuf;
+            response.setCookie(CommonDomainCookie::CDCName, c.c_str());
         }
     }
 }