1.x Artifact decoder, unit test.
[shibboleth/cpp-opensaml.git] / saml / saml1 / binding / impl / SAML1POSTDecoder.cpp
index b99ab68..de0deaa 100644 (file)
@@ -17,7 +17,7 @@
 /**
  * SAML1POSTDecoder.cpp
  * 
- * SAML 1.x POST binding/profile message encoder
+ * SAML 1.x POST binding/profile message decoder
  */
 
 #include "internal.h"
@@ -61,7 +61,7 @@ Response* SAML1POSTDecoder::decode(
     const HTTPRequest& httpRequest,
     const MetadataProvider* metadataProvider,
     const QName* role,
-    const X509TrustEngine* trustEngine
+    const opensaml::TrustEngine* trustEngine
     ) const
 {
 #ifdef _DEBUG
@@ -98,6 +98,7 @@ Response* SAML1POSTDecoder::decode(
     if (!response)
         throw BindingException("Decoded message was not a SAML 1.x Response.");
 
+    const EntityDescriptor* provider=NULL;
     try {
         if (!m_validate)
             SchemaValidators.validate(xmlObject.get());
@@ -105,77 +106,108 @@ Response* SAML1POSTDecoder::decode(
         // Check recipient URL.
         auto_ptr_char recipient(response->getRecipient());
         const char* recipient2 = httpRequest.getRequestURL();
-        if (!recipient2 || !*recipient2 || strcmp(recipient.get(),recipient2)) {
+        if (!recipient.get() || !*(recipient.get())) {
+            log.error("response missing Recipient attribute");
+            throw BindingException("SAML response did not contain Recipient attribute identifying intended destination.");
+        }
+        else if (!recipient2 || !*recipient2 || strcmp(recipient.get(),recipient2)) {
             log.error("POST targeted at (%s), but delivered to (%s)", recipient.get(), recipient2 ? recipient2 : "none");
             throw BindingException("SAML message delivered with POST to incorrect server URL.");
         }
         
+        // Check freshness.
         time_t now = time(NULL);
         if (response->getIssueInstant()->getEpoch() < now-(2*XMLToolingConfig::getConfig().clock_skew_secs))
             throw BindingException("Detected expired POST profile response.");
-            
+        
+        // Check replay.
         ReplayCache* replayCache = SAMLConfig::getConfig().getReplayCache();
         if (replayCache) {
             auto_ptr_char id(response->getResponseID());
-            if (!replayCache->check("SAML1POST", id.get(), response->getIssueInstant()->getEpoch() + (2*XMLToolingConfig::getConfig().clock_skew_secs)))
+            if (!replayCache->check("SAML1POST", 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!");
         
+        /* For SAML 1, the issuer can only be established from any assertions in the message.
+         * Generally, errors aren't delivered like this, so there should be one.
+         * The Issuer attribute is matched against metadata, and then trust checking can be
+         * applied.
+         */
         issuer = NULL;
         issuerTrusted = false;
         log.debug("attempting to establish issuer and integrity of message...");
         const vector<Assertion*>& assertions=const_cast<const Response*>(response)->getAssertions();
         if (!assertions.empty()) {
-            const EntityDescriptor* provider=
-                metadataProvider ? metadataProvider->getEntityDescriptor(assertions.front()->getIssuer()) : NULL;
+            log.debug("searching metadata for assertion issuer...");
+            provider=metadataProvider ? metadataProvider->getEntityDescriptor(assertions.front()->getIssuer()) : NULL;
             if (provider) {
+                log.debug("matched assertion issuer against metadata, searching for applicable role...");
                 pair<bool,int> minor = response->getMinorVersion();
                 issuer=provider->getRoleDescriptor(
                     *role,
                     (minor.first && minor.second==0) ? SAMLConstants::SAML10_PROTOCOL_ENUM : SAMLConstants::SAML11_PROTOCOL_ENUM
                     );
-                if (issuer && trustEngine && response->getSignature()) {
-                    issuerTrusted = static_cast<const TrustEngine*>(trustEngine)->validate(
-                        *(response->getSignature()), *issuer, metadataProvider->getKeyResolver()
+                if (issuer) {
+                    if (trustEngine && response->getSignature()) {
+                        issuerTrusted = trustEngine->validate(
+                            *(response->getSignature()), *issuer, metadataProvider->getKeyResolver()
+                            );
+                        if (!issuerTrusted) {
+                            log.error("unable to verify signature on message with supplied trust engine");
+                            throw BindingException("Message signature failed verification.");
+                        }
+                    }
+                    else {
+                        log.warn("unable to verify integrity of the message, leaving untrusted");
+                    }
+                }
+                else {
+                    log.warn(
+                        "unable to find compatible SAML 1.%d role (%s) in metadata",
+                        (minor.first && minor.second==0) ? 0 : 1,
+                        role->toString().c_str()
                         );
-                    if (!issuerTrusted)
-                        log.error("signature on message could not be verified by supplied trust engine");
                 }
                 if (log.isDebugEnabled()) {
                     auto_ptr_char iname(assertions.front()->getIssuer());
                     log.debug("message from (%s), integrity %sverified", iname.get(), issuerTrusted ? "" : "NOT ");
                 }
             }
-            else
-                log.warn("no metadata provider supplied, can't establish identity of issuer");
+            else {
+                auto_ptr_char temp(assertions.front()->getIssuer());
+                log.warn("no metadata found, can't establish identity of issuer (%s)", temp.get());
+            }
         }
-        else
+        else {
             log.warn("no assertions found, can't establish identity of issuer");
+        }
     }
     catch (XMLToolingException& ex) {
         // Check for an Issuer.
-        const vector<Assertion*>& assertions=const_cast<const Response*>(response)->getAssertions();
-        if (!assertions.empty()) {
-            if (!metadataProvider) {
+        if (!provider) {
+            const vector<Assertion*>& assertions=const_cast<const Response*>(response)->getAssertions();
+            if (!assertions.empty() || !metadataProvider ||
+                    !(provider=metadataProvider->getEntityDescriptor(assertions.front()->getIssuer(), false))) {
                 // Just record it.
-                auto_ptr_char issuer(assertions.front()->getIssuer());
-                if (issuer.get())
-                    ex.addProperty("entityID", issuer.get());
-                throw;  
-            }
-            // Try and locate metadata for error handling.
-            const EntityDescriptor* provider=metadataProvider->getEntityDescriptor(assertions.front()->getIssuer(),false);
-            if (provider) {
-                pair<bool,int> minor = response->getMinorVersion();
-                const IDPSSODescriptor* role=provider->getIDPSSODescriptor(
-                    (minor.first && minor.second==0) ? SAMLConstants::SAML10_PROTOCOL_ENUM : SAMLConstants::SAML11_PROTOCOL_ENUM
-                    );
-                if (role) annotateException(&ex,role); // throws it
-                annotateException(&ex,provider);  // throws it
+                auto_ptr_char iname(assertions.front()->getIssuer());
+                if (iname.get())
+                    ex.addProperty("entityID", iname.get());
+                throw;
             }
         }
+        if (!issuer) {
+            pair<bool,int> minor = response->getMinorVersion();
+            issuer=provider->getRoleDescriptor(
+                *role,
+                (minor.first && minor.second==0) ? SAMLConstants::SAML10_PROTOCOL_ENUM : SAMLConstants::SAML11_PROTOCOL_ENUM
+                );
+        }
+        if (issuer) annotateException(&ex,issuer); // throws it
+        annotateException(&ex,provider);  // throws it
     }
 
     xmlObject.release();