Revamped binding classes with security policy layer.
[shibboleth/cpp-opensaml.git] / saml / saml2 / binding / impl / SAML2POSTDecoder.cpp
index 2258304..a7f1cda 100644 (file)
 
 #include "internal.h"
 #include "exceptions.h"
+#include "binding/HTTPRequest.h"
 #include "saml2/binding/SAML2POSTDecoder.h"
 #include "saml2/core/Protocols.h"
 #include "saml2/metadata/Metadata.h"
 #include "saml2/metadata/MetadataProvider.h"
-#include "security/X509TrustEngine.h"
 
 #include <log4cpp/Category.hh>
 #include <xercesc/util/Base64.hpp>
 #include <xmltooling/util/NDC.h>
-#include <xmltooling/util/ReplayCache.h>
 #include <xmltooling/validation/ValidatorSuite.h>
 
 using namespace opensaml::saml2md;
 using namespace opensaml::saml2p;
 using namespace opensaml::saml2;
 using namespace opensaml;
-using namespace xmlsignature;
 using namespace xmltooling;
 using namespace log4cpp;
 using namespace std;
@@ -56,14 +54,10 @@ SAML2POSTDecoder::SAML2POSTDecoder(const DOMElement* e) {}
 
 SAML2POSTDecoder::~SAML2POSTDecoder() {}
 
-XMLObject* SAML2POSTDecoder::decode(
-    string& relayState,
-    const RoleDescriptor*& issuer,
-    const XMLCh*& securityMech,
-    const HTTPRequest& httpRequest,
-    const MetadataProvider* metadataProvider,
-    const QName* role,
-    const opensaml::TrustEngine* trustEngine
+saml2::RootObject* SAML2POSTDecoder::decode(
+    std::string& relayState,
+    const GenericRequest& genericRequest,
+    SecurityPolicy& policy
     ) const
 {
 #ifdef _DEBUG
@@ -72,14 +66,19 @@ XMLObject* SAML2POSTDecoder::decode(
     Category& log = Category::getInstance(SAML_LOGCAT".MessageDecoder.SAML2POST");
 
     log.debug("validating input");
-    if (strcmp(httpRequest.getMethod(),"POST"))
+    const HTTPRequest* httpRequest=dynamic_cast<const HTTPRequest*>(&genericRequest);
+    if (!httpRequest) {
+        log.error("unable to cast request to HTTPRequest type");
         return NULL;
-    const char* msg = httpRequest.getParameter("SAMLResponse");
+    }
+    if (strcmp(httpRequest->getMethod(),"POST"))
+        return NULL;
+    const char* msg = httpRequest->getParameter("SAMLResponse");
     if (!msg)
-        msg = httpRequest.getParameter("SAMLRequest");
+        msg = httpRequest->getParameter("SAMLRequest");
     if (!msg)
         return NULL;
-    const char* state = httpRequest.getParameter("RelayState");
+    const char* state = httpRequest->getParameter("RelayState");
     if (state)
         relayState = state;
     else
@@ -101,40 +100,27 @@ XMLObject* SAML2POSTDecoder::decode(
     auto_ptr<XMLObject> xmlObject(XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true));
     janitor.release();
 
+    saml2::RootObject* root = NULL;
     StatusResponseType* response = NULL;
     RequestAbstractType* request = dynamic_cast<RequestAbstractType*>(xmlObject.get());
     if (!request) {
         response = dynamic_cast<StatusResponseType*>(xmlObject.get());
         if (!response)
             throw BindingException("XML content for SAML 2.0 HTTP-POST Decoder must be a SAML 2.0 protocol message.");
+        root = static_cast<saml2::RootObject*>(response);
     }
-    
-    /* For SAML 2, the issuer can be established either from the message, or in some profiles
-     * it's possible to omit it and defer to assertions in a Response.
-     * The Issuer is later matched against metadata, and then trust checking can be applied.
-     */
-    const Issuer* claimedIssuer = request ? request->getIssuer() : response->getIssuer();
-    if (!claimedIssuer) {
-        // Check assertion option. I cannot resist the variable name, for the sake of google.
-        const Response* assbag = dynamic_cast<const Response*>(response);
-        if (assbag) {
-            const vector<Assertion*>& assertions=assbag->getAssertions();
-            if (!assertions.empty())
-                claimedIssuer = assertions.front()->getIssuer();
-        }
+    else {
+        root = static_cast<saml2::RootObject*>(request);
     }
-
-    const EntityDescriptor* provider=NULL;
+    
     try {
         if (!m_validate)
             SchemaValidators.validate(xmlObject.get());
         
-        Signature* signature = request ? request->getSignature() : response->getSignature();
-        
         // Check destination URL.
         auto_ptr_char dest(request ? request->getDestination() : response->getDestination());
-        const char* dest2 = httpRequest.getRequestURL();
-        if (signature && !dest.get() || !*(dest.get())) {
+        const char* dest2 = httpRequest->getRequestURL();
+        if (root->getSignature() && !dest.get() || !*(dest.get())) {
             log.error("signed SAML message missing Destination attribute");
             throw BindingException("Signed SAML message missing Destination attribute identifying intended destination.");
         }
@@ -143,88 +129,44 @@ XMLObject* SAML2POSTDecoder::decode(
             throw BindingException("SAML message delivered with POST to incorrect server URL.");
         }
         
-        // Check freshness.
-        time_t now = time(NULL);
-        if ((request ? request->getIssueInstant()->getEpoch() : response->getIssueInstant()->getEpoch())
-                < now-(2*XMLToolingConfig::getConfig().clock_skew_secs))
-            throw BindingException("Detected expired POST binding message.");
-        
-        // Check replay.
-        ReplayCache* replayCache = XMLToolingConfig::getConfig().getReplayCache();
-        if (replayCache) {
-            auto_ptr_char id(xmlObject->getXMLID());
-            if (!replayCache->check("SAML2POST", id.get(), response->getIssueInstant()->getEpoch() + (2*XMLToolingConfig::getConfig().clock_skew_secs))) {
-                log.error("replay detected of response ID (%s)", id.get());
-                throw BindingException("Rejecting replayed response ID ($1).", params(1,id.get()));
-            }
-        }
-        else
-            log.warn("replay cache was not provided, this is a serious security risk!");
-        
-        issuer = NULL;
-        securityMech = false;
-        log.debug("attempting to establish issuer and integrity of message...");
-        
-        // If we can't identify the issuer, we're done, since we can't lookup or verify anything.
-        if (!claimedIssuer || !claimedIssuer->getName()) {
-            log.warn("unable to establish identity of message issuer");
-            return xmlObject.release();
-        }
-        else if (claimedIssuer->getFormat() && !XMLString::equals(claimedIssuer->getFormat(), NameIDType::ENTITY)) {
-            auto_ptr_char iformat(claimedIssuer->getFormat());
-            log.warn("message issuer was in an unsupported format (%s)", iformat.get());
-            return xmlObject.release();
-        }
-        
-        log.debug("searching metadata for assertion issuer...");
-        provider=metadataProvider ? metadataProvider->getEntityDescriptor(claimedIssuer->getName()) : NULL;
-        if (provider) {
-            log.debug("matched assertion issuer against metadata, searching for applicable role...");
-            issuer=provider->getRoleDescriptor(*role, samlconstants::SAML20P_NS);
-            if (issuer) {
-                if (trustEngine && signature) {
-                    if (!trustEngine->validate(*signature, *issuer, metadataProvider->getKeyResolver())) {
-                        log.error("unable to verify signature on message with supplied trust engine");
-                        throw BindingException("Message signature failed verification.");
-                    }
-                    else {
-                        securityMech = samlconstants::SAML20P_NS;
-                    }
-                }
-                else {
-                    log.warn("unable to authenticate the message, leaving untrusted");
-                }
-            }
-            else {
-                log.warn("unable to find compatible SAML 2.0 role (%s) in metadata", role->toString().c_str());
-            }
-            if (log.isDebugEnabled()) {
-                auto_ptr_char iname(provider->getEntityID());
-                log.debug("message from (%s), integrity %sverified", iname.get(), securityMech ? "" : "NOT ");
-            }
-        }
-        else {
-            auto_ptr_char temp(claimedIssuer->getName());
-            log.warn("no metadata found, can't establish identity of issuer (%s)", temp.get());
-        }
+        // Run through the policy.
+        policy.evaluate(genericRequest, *response);
     }
     catch (XMLToolingException& ex) {
-        if (!provider) {
-            if (!claimedIssuer || !claimedIssuer->getName())
-                throw;
-            if (!metadataProvider || !(provider=metadataProvider->getEntityDescriptor(claimedIssuer->getName(), false))) {
-                // Just record it.
-                auto_ptr_char iname(claimedIssuer->getName());
-                if (iname.get())
-                    ex.addProperty("entityID", iname.get());
-                throw;
+        // This is just to maximize the likelihood of attaching a source to the message for support purposes.
+        if (policy.getIssuerMetadata())
+            annotateException(&ex,policy.getIssuerMetadata()); // throws it
+
+        const Issuer* claimedIssuer = root->getIssuer();
+        if (!claimedIssuer) {
+            // Check for assertions.
+            const Response* assbag = dynamic_cast<Response*>(response);
+            if (assbag) {
+                const vector<Assertion*>& assertions=assbag->getAssertions();
+                if (!assertions.empty())
+                    claimedIssuer = assertions.front()->getIssuer();
             }
         }
-        if (!issuer)
-            issuer=provider->getRoleDescriptor(*role, samlconstants::SAML20P_NS);
-        if (issuer) annotateException(&ex,issuer); // throws it
+    
+        if (!claimedIssuer || !claimedIssuer->getName())
+            throw;
+        const EntityDescriptor* provider=NULL;
+        if (!policy.getMetadataProvider() ||
+                !(provider=policy.getMetadataProvider()->getEntityDescriptor(claimedIssuer->getName(), false))) {
+            // Just record it.
+            auto_ptr_char iname(claimedIssuer->getName());
+            if (iname.get())
+                ex.addProperty("entityID", iname.get());
+            throw;
+        }
+
+        if (policy.getRole()) {
+            const RoleDescriptor* roledesc=provider->getRoleDescriptor(*(policy.getRole()), samlconstants::SAML20P_NS);
+            if (roledesc) annotateException(&ex,roledesc); // throws it
+        }
         annotateException(&ex,provider);  // throws it
     }
 
-    return xmlObject.release();
+    xmlObject.release();
+    return root;
 }