Convert logging to log4shib via compile time switch.
[shibboleth/opensaml2.git] / saml / binding / impl / SimpleSigningRule.cpp
index 6ba58f8..32ef466 100644 (file)
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2001-2006 Internet2
+ *  Copyright 2001-2007 Internet2
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 
 #include "internal.h"
 #include "exceptions.h"
-#include "binding/HTTPRequest.h"
-#include "binding/SimpleSigningRule.h"
+#include "binding/SecurityPolicyRule.h"
+#include "saml2/core/Assertions.h"
 #include "saml2/metadata/Metadata.h"
+#include "saml2/metadata/MetadataCredentialCriteria.h"
 #include "saml2/metadata/MetadataProvider.h"
-#include "security/TrustEngine.h"
 
-#include <log4cpp/Category.hh>
-#include <xmltooling/util/NDC.h>
-#include <xmltooling/util/ReplayCache.h>
-#include <xsec/enc/XSECCryptoException.hpp>
-#include <xsec/enc/XSECCryptoProvider.hpp>
-#include <xsec/framework/XSECException.hpp>
+#include <xercesc/util/Base64.hpp>
+#include <xmltooling/logging.h>
+#include <xmltooling/io/HTTPRequest.h>
+#include <xmltooling/security/SignatureTrustEngine.h>
 
 using namespace opensaml::saml2md;
 using namespace opensaml;
+using namespace xmltooling::logging;
 using namespace xmltooling;
-using namespace log4cpp;
 using namespace std;
 
 using xmlsignature::KeyInfo;
+using xmlsignature::SignatureException;
 
 namespace opensaml {
+    class SAML_DLLLOCAL SimpleSigningRule : public SecurityPolicyRule
+    {
+    public:
+        SimpleSigningRule(const DOMElement* e);
+        virtual ~SimpleSigningRule() {}
+        
+        void evaluate(const xmltooling::XMLObject& message, const GenericRequest* request, SecurityPolicy& policy) const;
+
+    private:
+        // Appends a raw parameter=value pair to the string.
+        static bool appendParameter(string& s, const char* data, const char* name);
+
+        bool m_errorsFatal;
+    };
+
     SecurityPolicyRule* SAML_DLLLOCAL SimpleSigningRuleFactory(const DOMElement* const & e)
     {
         return new SimpleSigningRule(e);
     }
 
-    // Appends a raw parameter=value pair to the string.
-    static bool appendParameter(string& s, const char* data, const char* name)
-    {
-        const char* start = strstr(data,name);
-        if (!start)
-            return false;
-        if (!s.empty())
-            s += '&';
-        const char* end = strchr(start,'&');
-        if (end)
-            s.append(start, end-start);
-        else
-            s.append(start);
-        return true;
-    }
+    static const XMLCh errorsFatal[] = UNICODE_LITERAL_11(e,r,r,o,r,s,F,a,t,a,l);
 };
 
+bool SimpleSigningRule::appendParameter(string& s, const char* data, const char* name)
+{
+    const char* start = strstr(data,name);
+    if (!start)
+        return false;
+    if (!s.empty())
+        s += '&';
+    const char* end = strchr(start,'&');
+    if (end)
+        s.append(start, end-start);
+    else
+        s.append(start);
+    return true;
+}
 
-pair<saml2::Issuer*,const RoleDescriptor*> SimpleSigningRule::evaluate(
-    const GenericRequest& request,
-    const XMLObject& message,
-    const MetadataProvider* metadataProvider,
-    const QName* role,
-    const opensaml::TrustEngine* trustEngine,
-    const MessageExtractor& extractor
-    ) const
+SimpleSigningRule::SimpleSigningRule(const DOMElement* e) : m_errorsFatal(false)
+{
+    if (e) {
+        const XMLCh* flag = e->getAttributeNS(NULL, errorsFatal);
+        m_errorsFatal = (flag && (*flag==chLatin_t || *flag==chDigit_1)); 
+    }
+}
+
+void SimpleSigningRule::evaluate(const XMLObject& message, const GenericRequest* request, SecurityPolicy& policy) const
 {
     Category& log=Category::getInstance(SAML_LOGCAT".SecurityPolicyRule.SimpleSigning");
-    log.debug("evaluating simple signing policy");
-    
-    pair<saml2::Issuer*,const RoleDescriptor*> ret = pair<saml2::Issuer*,const RoleDescriptor*>(NULL,NULL);  
     
-    if (!metadataProvider || !role || !trustEngine) {
-        log.debug("ignoring message, no metadata supplied");
-        return ret;
+    if (!policy.getIssuerMetadata()) {
+        log.debug("ignoring message, no issuer metadata supplied");
+        return;
     }
-    
-    const char* signature = request.getParameter("Signature");
-    if (!signature) {
-        log.debug("ignoring unsigned message");
-        return ret;
+
+    const SignatureTrustEngine* sigtrust;
+    if (!(sigtrust=dynamic_cast<const SignatureTrustEngine*>(policy.getTrustEngine()))) {
+        log.debug("ignoring message, no SignatureTrustEngine supplied");
+        return;
     }
+
+    const HTTPRequest* httpRequest = dynamic_cast<const HTTPRequest*>(request);
+    if (!request || !httpRequest)
+        return;
+
+    const char* signature = request->getParameter("Signature");
+    if (!signature)
+        return;
     
-    const char* sigAlgorithm = request.getParameter("SigAlg");
+    const char* sigAlgorithm = request->getParameter("SigAlg");
     if (!sigAlgorithm) {
         log.error("SigAlg parameter not found, no way to verify the signature");
-        return ret;
+        return;
     }
 
-    try {
-        log.debug("extracting issuer from message");
-        pair<saml2::Issuer*,const XMLCh*> issuerInfo = extractor.getIssuerAndProtocol(message);
-        
-        auto_ptr<saml2::Issuer> issuer(issuerInfo.first);
-        if (!issuerInfo.first || !issuerInfo.second ||
-                (issuer->getFormat() && !XMLString::equals(issuer->getFormat(), saml2::NameIDType::ENTITY))) {
-            log.warn("issuer identity not estabished, or was not an entityID");
-            return ret;
-        }
-        
-        log.debug("searching metadata for message issuer...");
-        const EntityDescriptor* entity = metadataProvider->getEntityDescriptor(issuer->getName());
-        if (!entity) {
-            auto_ptr_char temp(issuer->getName());
-            log.warn("no metadata found, can't establish identity of issuer (%s)", temp.get());
-            return ret;
-        }
+    string input;
+    const char* pch;
+    if (!strcmp(httpRequest->getMethod(), "GET")) {
+        // We have to construct a string containing the signature input by accessing the
+        // request directly. We can't use the decoded parameters because we need the raw
+        // data and URL-encoding isn't canonical.
 
-        log.debug("matched message issuer against metadata, searching for applicable role...");
-        const RoleDescriptor* roledesc=entity->getRoleDescriptor(*role, issuerInfo.second);
-        if (!roledesc) {
-            log.warn("unable to find compatible role (%s) in metadata", role->toString().c_str());
-            return ret;
-        }
+        // NOTE: SimpleSign for GET means Redirect binding, which means we verify over the
+        // base64-encoded message directly.
 
-        string input;
-        const char* pch;
-        const HTTPRequest& httpRequest = dynamic_cast<const HTTPRequest&>(request);
-        if (!strcmp(httpRequest.getMethod(), "GET")) {
-            // We have to construct a string containing the signature input by accessing the
-            // request directly. We can't use the decoded parameters because we need the raw
-            // data and URL-encoding isn't canonical.
-            pch = httpRequest.getQueryString();
-            if (!appendParameter(input, pch, "SAMLRequest="))
-                appendParameter(input, pch, "SAMLResponse=");
-            appendParameter(input, pch, "RelayState=");
-            appendParameter(input, pch, "SigAlg=");
-        }
-        else {
-            // With POST, the input string is concatenated from the decoded form controls.
-            // GET should be this way too, but I messed up the spec, sorry.
-            pch = httpRequest.getParameter("SAMLRequest");
-            if (pch)
-                input = string("SAMLRequest=") + pch;
-            else {
-                pch = httpRequest.getParameter("SAMLResponse");
-                input = string("SAMLResponse=") + pch;
-            }
-            pch = httpRequest.getParameter("RelayState");
-            if (pch)
-                input = input + "&RelayState=" + pch;
-            input = input + "&SigAlg=" + sigAlgorithm;
-        }
+        pch = httpRequest->getQueryString();
+        if (!appendParameter(input, pch, "SAMLRequest="))
+            appendParameter(input, pch, "SAMLResponse=");
+        appendParameter(input, pch, "RelayState=");
+        appendParameter(input, pch, "SigAlg=");
+    }
+    else {
+        // With POST, the input string is concatenated from the decoded form controls.
+        // GET should be this way too, but I messed up the spec, sorry.
+
+        // NOTE: SimpleSign for POST means POST binding, which means we verify over the
+        // base64-decoded XML. This sucks, because we have to decode the base64 directly.
+        // Serializing the XMLObject doesn't guarantee the signature will verify (this is
+        // why XMLSignature exists, and why this isn't really "simpler").
 
-        // Check for KeyInfo, but defensively (we might be able to run without it).
-        KeyInfo* keyInfo=NULL;
-        pch = request.getParameter("KeyInfo");
+        unsigned int x;
+        pch = httpRequest->getParameter("SAMLRequest");
         if (pch) {
-            try {
-                istringstream kstrm(pch);
-                DOMDocument* doc = XMLToolingConfig::getConfig().getParser().parse(kstrm);
-                XercesJanitor<DOMDocument> janitor(doc);
-                XMLObject* kxml = XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true);
-                janitor.release();
-                if (!(keyInfo=dynamic_cast<KeyInfo*>(kxml)))
-                    delete kxml;
-            }
-            catch (XMLToolingException& ex) {
-                log.warn("Failed to load KeyInfo from message: %s", ex.what());
+            XMLByte* decoded=Base64::decode(reinterpret_cast<const XMLByte*>(pch),&x);
+            if (!decoded) {
+                log.warn("unable to decode base64 in POST binding message");
+                return;
             }
+            input = string("SAMLRequest=") + reinterpret_cast<const char*>(decoded);
+            XMLString::release(&decoded);
         }
-        
-        auto_ptr<KeyInfo> kjanitor(keyInfo);
-        auto_ptr_XMLCh alg(sigAlgorithm);
-        
-        if (!trustEngine->validate(alg.get(), signature, keyInfo, input.c_str(), input.length(), *roledesc, metadataProvider->getKeyResolver())) {
-            log.error("unable to verify signature on message with supplied trust engine");
-            return ret;
+        else {
+            pch = httpRequest->getParameter("SAMLResponse");
+            XMLByte* decoded=Base64::decode(reinterpret_cast<const XMLByte*>(pch),&x);
+            if (!decoded) {
+                log.warn("unable to decode base64 in POST binding message");
+                return;
+            }
+            input = string("SAMLResponse=") + reinterpret_cast<const char*>(decoded);
+            XMLString::release(&decoded);
         }
 
-        if (log.isDebugEnabled()) {
-            auto_ptr_char iname(entity->getEntityID());
-            log.debug("message from (%s), signature verified", iname.get());
+        pch = httpRequest->getParameter("RelayState");
+        if (pch)
+            input = input + "&RelayState=" + pch;
+        input = input + "&SigAlg=" + sigAlgorithm;
+    }
+
+    // Check for KeyInfo, but defensively (we might be able to run without it).
+    KeyInfo* keyInfo=NULL;
+    pch = request->getParameter("KeyInfo");
+    if (pch) {
+        try {
+            istringstream kstrm(pch);
+            DOMDocument* doc = XMLToolingConfig::getConfig().getParser().parse(kstrm);
+            XercesJanitor<DOMDocument> janitor(doc);
+            XMLObject* kxml = XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true);
+            janitor.release();
+            if (!(keyInfo=dynamic_cast<KeyInfo*>(kxml)))
+                delete kxml;
+        }
+        catch (XMLToolingException& ex) {
+            log.warn("Failed to load KeyInfo from message: %s", ex.what());
         }
-        
-        ret.first = issuer.release();
-        ret.second = roledesc;
     }
-    catch (bad_cast&) {
-        // Just trap it.
-        log.warn("caught a bad_cast while extracting issuer");
+    
+    auto_ptr<KeyInfo> kjanitor(keyInfo);
+    auto_ptr_XMLCh alg(sigAlgorithm);
+
+    // Set up criteria object.
+    MetadataCredentialCriteria cc(*(policy.getIssuerMetadata()));
+    cc.setXMLAlgorithm(alg.get());
+
+    if (!sigtrust->validate(alg.get(), signature, keyInfo, input.c_str(), input.length(), *(policy.getMetadataProvider()), &cc)) {
+        log.error("unable to verify message signature with supplied trust engine");
+        if (m_errorsFatal)
+            throw SignatureException("Message was signed, but signature could not be verified.");
+        return;
     }
-    return ret;
+
+    log.debug("signature verified against message issuer");
+    policy.setSecure(true);
 }