Multi-line svn commit, see body.
[shibboleth/cpp-xmltooling.git] / xmltooling / security / impl / ExplicitKeyTrustEngine.cpp
index 69c381a..346c35f 100644 (file)
-/*\r
- *  Copyright 2001-2005 Internet2\r
- * \r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- *     http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-\r
-/**\r
- * ExplicitKeyTrustEngine.cpp\r
- * \r
- * TrustEngine based on explicit knowledge of peer key information.\r
- */\r
-\r
-#include "internal.h"\r
-#include "security/X509TrustEngine.h"\r
-#include "signature/SignatureValidator.h"\r
-#include "util/NDC.h"\r
-\r
-#include <log4cpp/Category.hh>\r
-#include <xercesc/util/XMLUniDefs.hpp>\r
-#include <xsec/enc/OpenSSL/OpenSSLCryptoX509.hpp>\r
-\r
-using namespace xmlsignature;\r
-using namespace xmltooling;\r
-using namespace log4cpp;\r
-using namespace std;\r
-\r
-namespace xmltooling {\r
-    class XMLTOOL_DLLLOCAL ExplicitKeyTrustEngine : public X509TrustEngine\r
-    {\r
-    public:\r
-        ExplicitKeyTrustEngine(const DOMElement* e) : X509TrustEngine(e) {}\r
-        virtual ~ExplicitKeyTrustEngine() {}\r
-\r
-        virtual bool validate(\r
-            Signature& sig,\r
-            TrustEngine::KeyInfoIterator& keyInfoSource,\r
-            const KeyResolver* keyResolver=NULL\r
-            );\r
-        virtual bool validate(\r
-            XSECCryptoX509* certEE,\r
-            const vector<XSECCryptoX509*>& certChain,\r
-            TrustEngine::KeyInfoIterator& keyInfoSource,\r
-            bool checkName=true,\r
-            const KeyResolver* keyResolver=NULL\r
-            );\r
-\r
-    private:\r
-    };\r
-\r
-    TrustEngine* XMLTOOL_DLLLOCAL ExplicitKeyTrustEngineFactory(const DOMElement* const & e)\r
-    {\r
-        return new ExplicitKeyTrustEngine(e);\r
-    }\r
-};\r
-\r
-bool ExplicitKeyTrustEngine::validate(\r
-    Signature& sig,\r
-    TrustEngine::KeyInfoIterator& keyInfoSource,\r
-    const KeyResolver* keyResolver\r
-    )\r
-{\r
-#ifdef _DEBUG\r
-    NDC ndc("validate");\r
-#endif\r
-    Category& log=Category::getInstance(XMLTOOLING_LOGCAT".TrustEngine");\r
-    \r
-    if (!keyInfoSource.hasNext()) {\r
-        log.warn("unable to validate signature, no key information available for peer");\r
-        return false;\r
-    }\r
-    \r
-    log.debug("attempting to validate signature with the key information for peer");\r
-    SignatureValidator sigValidator;\r
-    while (keyInfoSource.hasNext()) {\r
-        XSECCryptoKey* key = (keyResolver ? keyResolver : m_keyResolver)->resolveKey(keyInfoSource.next());\r
-        if (key) {\r
-            log.debug("attempting to validate signature with public key...");\r
-            try {\r
-                sigValidator.setKey(key);   // key now owned by validator\r
-                sigValidator.validate(&sig);\r
-                log.info("signature validated with public key");\r
-                return true;\r
-            }\r
-            catch (ValidationException& e) {\r
-                if (log.isDebugEnabled()) {\r
-                    log.debug("public key did not validate signature: %s", e.what());\r
-                }\r
-            }\r
-        }\r
-        else {\r
-            log.debug("key information does not resolve to a public key, skipping it");\r
-        }\r
-    }\r
-\r
-    log.error("no peer key information validated the signature");\r
-    return false;\r
-}\r
-\r
-bool ExplicitKeyTrustEngine::validate(\r
-    XSECCryptoX509* certEE,\r
-    const vector<XSECCryptoX509*>& certChain,\r
-    TrustEngine::KeyInfoIterator& keyInfoSource,\r
-    bool checkName,\r
-    const KeyResolver* keyResolver\r
-    )\r
-{\r
-#ifdef _DEBUG\r
-    NDC ndc("validate");\r
-#endif\r
-    Category& log=Category::getInstance(XMLTOOLING_LOGCAT".TrustEngine");\r
-    \r
-    if (!certEE) {\r
-        log.error("unable to validate, end-entity certificate was null");\r
-        return false;\r
-    }\r
-    else if (certEE->getProviderName()!=DSIGConstants::s_unicodeStrPROVOpenSSL) {\r
-        log.error("only the OpenSSL XSEC provider is supported");\r
-        return false;\r
-    }\r
-    else if (!keyInfoSource.hasNext()) {\r
-        log.warn("unable to validate, no key information available for peer");\r
-        return false;\r
-    }\r
-\r
-    // The new "basic" trust implementation relies solely on certificates living within the\r
-    // role interface to verify the EE certificate.\r
-\r
-    log.debug("attempting to match key information from peer with end-entity certificate");\r
-    vector<XSECCryptoX509*> resolvedCerts;\r
-    while (keyInfoSource.hasNext()) {\r
-        resolvedCerts.clear();\r
-        if (0 == (keyResolver ? keyResolver : m_keyResolver)->resolveCertificates(keyInfoSource.next(),resolvedCerts)) {\r
-            log.debug("key information does not resolve to a certificate, skipping it");\r
-            continue;\r
-        }\r
-\r
-        log.debug("checking if certificates contained within key information match end-entity certificate");\r
-        if (resolvedCerts.front()->getProviderName()!=DSIGConstants::s_unicodeStrPROVOpenSSL) {\r
-            log.error("only the OpenSSL XSEC provider is supported");\r
-            continue;\r
-        }\r
-        else if (!X509_cmp(static_cast<OpenSSLCryptoX509*>(certEE)->getOpenSSLX509(),static_cast<OpenSSLCryptoX509*>(resolvedCerts.front())->getOpenSSLX509())) {\r
-            log.info("end-entity certificate matches certificate from peer key information");\r
-            return true;\r
-        }\r
-    }\r
-\r
-    log.debug("no certificates within this peer's key information matched the given end-entity certificate");\r
-    return false;\r
-}\r
+/*
+ *  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.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * ExplicitKeyTrustEngine.cpp
+ * 
+ * TrustEngine based on explicit knowledge of peer key information.
+ */
+
+#include "internal.h"
+#include "logging.h"
+#include "security/Credential.h"
+#include "security/CredentialCriteria.h"
+#include "security/CredentialResolver.h"
+#include "security/OpenSSLTrustEngine.h"
+#include "security/SignatureTrustEngine.h"
+#include "signature/SignatureValidator.h"
+#include "util/NDC.h"
+
+#include <xercesc/util/XMLUniDefs.hpp>
+#include <xsec/enc/OpenSSL/OpenSSLCryptoKeyDSA.hpp>
+#include <xsec/enc/OpenSSL/OpenSSLCryptoKeyRSA.hpp>
+#include <xsec/enc/OpenSSL/OpenSSLCryptoX509.hpp>
+
+using namespace xmlsignature;
+using namespace xmltooling::logging;
+using namespace xmltooling;
+using namespace std;
+
+namespace xmltooling {
+    class XMLTOOL_DLLLOCAL ExplicitKeyTrustEngine : public SignatureTrustEngine, public OpenSSLTrustEngine
+    {
+    public:
+        ExplicitKeyTrustEngine(const DOMElement* e) : TrustEngine(e) {}
+        virtual ~ExplicitKeyTrustEngine() {}
+
+        virtual bool validate(
+            Signature& sig,
+            const CredentialResolver& credResolver,
+            CredentialCriteria* criteria=NULL
+            ) const;
+        virtual bool validate(
+            const XMLCh* sigAlgorithm,
+            const char* sig,
+            KeyInfo* keyInfo,
+            const char* in,
+            unsigned int in_len,
+            const CredentialResolver& credResolver,
+            CredentialCriteria* criteria=NULL
+            ) const;
+        virtual bool validate(
+            XSECCryptoX509* certEE,
+            const vector<XSECCryptoX509*>& certChain,
+            const CredentialResolver& credResolver,
+            CredentialCriteria* criteria=NULL
+            ) const;
+        virtual bool validate(
+            X509* certEE,
+            STACK_OF(X509)* certChain,
+            const CredentialResolver& credResolver,
+            CredentialCriteria* criteria=NULL
+            ) const;
+    };
+
+    TrustEngine* XMLTOOL_DLLLOCAL ExplicitKeyTrustEngineFactory(const DOMElement* const & e)
+    {
+        return new ExplicitKeyTrustEngine(e);
+    }
+};
+
+bool ExplicitKeyTrustEngine::validate(
+    Signature& sig,
+    const CredentialResolver& credResolver,
+    CredentialCriteria* criteria
+    ) const
+{
+#ifdef _DEBUG
+    NDC ndc("validate");
+#endif
+    Category& log=Category::getInstance(XMLTOOLING_LOGCAT".TrustEngine."EXPLICIT_KEY_TRUSTENGINE);
+
+    vector<const Credential*> credentials;
+    if (criteria) {
+        criteria->setUsage(Credential::SIGNING_CREDENTIAL);
+        criteria->setSignature(sig, CredentialCriteria::KEYINFO_EXTRACTION_KEY);
+        credResolver.resolve(credentials,criteria);
+    }
+    else {
+        CredentialCriteria cc;
+        cc.setUsage(Credential::SIGNING_CREDENTIAL);
+        cc.setSignature(sig, CredentialCriteria::KEYINFO_EXTRACTION_KEY);
+        credResolver.resolve(credentials,&cc);
+    }
+    if (credentials.empty()) {
+        log.debug("unable to validate signature, no credentials available from peer");
+        return false;
+    }
+    
+    log.debug("attempting to validate signature with the peer's credentials");
+    SignatureValidator sigValidator;
+    for (vector<const Credential*>::const_iterator c=credentials.begin(); c!=credentials.end(); ++c) {
+        sigValidator.setCredential(*c);
+        try {
+            sigValidator.validate(&sig);
+            log.debug("signature validated with credential");
+            return true;
+        }
+        catch (ValidationException& e) {
+            log.debug("public key did not validate signature: %s", e.what());
+        }
+    }
+
+    log.debug("no peer credentials validated the signature");
+    return false;
+}
+
+bool ExplicitKeyTrustEngine::validate(
+    const XMLCh* sigAlgorithm,
+    const char* sig,
+    KeyInfo* keyInfo,
+    const char* in,
+    unsigned int in_len,
+    const CredentialResolver& credResolver,
+    CredentialCriteria* criteria
+    ) const
+{
+#ifdef _DEBUG
+    NDC ndc("validate");
+#endif
+    Category& log=Category::getInstance(XMLTOOLING_LOGCAT".TrustEngine."EXPLICIT_KEY_TRUSTENGINE);
+    
+    vector<const Credential*> credentials;
+    if (criteria) {
+        criteria->setUsage(Credential::SIGNING_CREDENTIAL);
+        criteria->setKeyInfo(keyInfo, CredentialCriteria::KEYINFO_EXTRACTION_KEY);
+        criteria->setXMLAlgorithm(sigAlgorithm);
+        credResolver.resolve(credentials,criteria);
+    }
+    else {
+        CredentialCriteria cc;
+        cc.setUsage(Credential::SIGNING_CREDENTIAL);
+        cc.setKeyInfo(keyInfo, CredentialCriteria::KEYINFO_EXTRACTION_KEY);
+        cc.setXMLAlgorithm(sigAlgorithm);
+        credResolver.resolve(credentials,&cc);
+    }
+    if (credentials.empty()) {
+        log.debug("unable to validate signature, no credentials available from peer");
+        return false;
+    }
+    
+    log.debug("attempting to validate signature with the peer's credentials");
+    for (vector<const Credential*>::const_iterator c=credentials.begin(); c!=credentials.end(); ++c) {
+        if ((*c)->getPublicKey()) {
+            try {
+                if (Signature::verifyRawSignature((*c)->getPublicKey(), sigAlgorithm, sig, in, in_len)) {
+                    log.debug("signature validated with public key");
+                    return true;
+                }
+            }
+            catch (SignatureException& e) {
+                if (log.isDebugEnabled()) {
+                    log.debug("public key did not validate signature: %s", e.what());
+                }
+            }
+        }
+    }
+
+    log.debug("no peer credentials validated the signature");
+    return false;
+}
+
+bool ExplicitKeyTrustEngine::validate(
+    XSECCryptoX509* certEE,
+    const vector<XSECCryptoX509*>& certChain,
+    const CredentialResolver& credResolver,
+    CredentialCriteria* criteria
+    ) const
+{
+#ifdef _DEBUG
+        NDC ndc("validate");
+#endif
+    if (!certEE) {
+        Category::getInstance(XMLTOOLING_LOGCAT".TrustEngine."EXPLICIT_KEY_TRUSTENGINE).error("unable to validate, end-entity certificate was null");
+        return false;
+    }
+    else if (certEE->getProviderName()!=DSIGConstants::s_unicodeStrPROVOpenSSL) {
+        Category::getInstance(XMLTOOLING_LOGCAT".TrustEngine."EXPLICIT_KEY_TRUSTENGINE).error("only the OpenSSL XSEC provider is supported");
+        return false;
+    }
+
+    return validate(static_cast<OpenSSLCryptoX509*>(certEE)->getOpenSSLX509(), NULL, credResolver, criteria);
+}
+
+bool ExplicitKeyTrustEngine::validate(
+    X509* certEE,
+    STACK_OF(X509)* certChain,
+    const CredentialResolver& credResolver,
+    CredentialCriteria* criteria
+    ) const
+{
+#ifdef _DEBUG
+    NDC ndc("validate");
+#endif
+    Category& log=Category::getInstance(XMLTOOLING_LOGCAT".TrustEngine."EXPLICIT_KEY_TRUSTENGINE);
+    
+    if (!certEE) {
+        log.error("unable to validate, end-entity certificate was null");
+        return false;
+    }
+
+    vector<const Credential*> credentials;
+    if (criteria) {
+        if (criteria->getUsage()==Credential::UNSPECIFIED_CREDENTIAL)
+            criteria->setUsage(Credential::SIGNING_CREDENTIAL);
+        credResolver.resolve(credentials,criteria);
+    }
+    else {
+        CredentialCriteria cc;
+        cc.setUsage(Credential::SIGNING_CREDENTIAL);
+        credResolver.resolve(credentials,&cc);
+    }
+    if (credentials.empty()) {
+        log.debug("unable to validate certificate, no credentials available from peer");
+        return false;
+    }
+
+    // The "explicit" trust implementation relies solely on keys living within the
+    // peer resolver to verify the EE certificate.
+
+    log.debug("attempting to match credentials from peer with end-entity certificate");
+    for (vector<const Credential*>::const_iterator c=credentials.begin(); c!=credentials.end(); ++c) {
+        XSECCryptoKey* key = (*c)->getPublicKey();
+        if (key) {
+            if (key->getProviderName()!=DSIGConstants::s_unicodeStrPROVOpenSSL) {
+                log.error("only the OpenSSL XSEC provider is supported");
+                continue;
+            }
+            switch (key->getKeyType()) {
+                case XSECCryptoKey::KEY_RSA_PUBLIC:
+                {
+                    RSA* rsa = static_cast<OpenSSLCryptoKeyRSA*>(key)->getOpenSSLRSA();
+                    EVP_PKEY* evp = X509_PUBKEY_get(X509_get_X509_PUBKEY(certEE));
+                    if (rsa && evp && evp->type == EVP_PKEY_RSA &&
+                            BN_cmp(rsa->n,evp->pkey.rsa->n) == 0 && BN_cmp(rsa->e,evp->pkey.rsa->e) == 0) {
+                        if (evp)
+                            EVP_PKEY_free(evp);
+                        log.debug("end-entity certificate matches peer RSA key information");
+                        return true;
+                    }
+                    if (evp)
+                        EVP_PKEY_free(evp);
+                    break;
+                }
+                
+                case XSECCryptoKey::KEY_DSA_PUBLIC:
+                {
+                    DSA* dsa = static_cast<OpenSSLCryptoKeyDSA*>(key)->getOpenSSLDSA();
+                    EVP_PKEY* evp = X509_PUBKEY_get(X509_get_X509_PUBKEY(certEE));
+                    if (dsa && evp && evp->type == EVP_PKEY_DSA && BN_cmp(dsa->pub_key,evp->pkey.dsa->pub_key) == 0) {
+                        if (evp)
+                            EVP_PKEY_free(evp);
+                        log.debug("end-entity certificate matches peer DSA key information");
+                        return true;
+                    }
+                    if (evp)
+                        EVP_PKEY_free(evp);
+                    break;
+                }
+
+                default:
+                    log.warn("unknown peer key type, skipping...");
+            }
+        }
+    }
+
+    log.debug("no keys within this peer's key information matched the given end-entity certificate");
+    return false;
+}