-/*
- * Copyright 2001-2009 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
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you 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
+ * 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.
+ * 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.
*/
/**
#include "logging.h"
#include "security/AbstractPKIXTrustEngine.h"
#include "signature/KeyInfo.h"
-
-#include <openssl/x509_vfy.h>
-#include <openssl/x509v3.h>
-#include <xmltooling/security/CredentialCriteria.h>
-#include <xmltooling/security/CredentialResolver.h>
-#include <xmltooling/security/KeyInfoResolver.h>
-#include <xmltooling/security/OpenSSLCryptoX509CRL.h>
-#include <xmltooling/security/X509Credential.h>
-#include <xmltooling/signature/SignatureValidator.h>
-#include <xmltooling/util/NDC.h>
+#include "signature/Signature.h"
+#include "security/CredentialCriteria.h"
+#include "security/CredentialResolver.h"
+#include "security/KeyInfoResolver.h"
+#include "security/OpenSSLCryptoX509CRL.h"
+#include "security/OpenSSLPathValidator.h"
+#include "security/PKIXPathValidatorParams.h"
+#include "security/SecurityHelper.h"
+#include "security/X509Credential.h"
+#include "signature/SignatureValidator.h"
+#include "util/NDC.h"
+#include "util/PathResolver.h"
+
+#include <fstream>
#include <xercesc/util/XMLUniDefs.hpp>
#include <xsec/enc/OpenSSL/OpenSSLCryptoX509.hpp>
using namespace xmltooling::logging;
using namespace xmltooling;
using namespace std;
+using boost::ptr_vector;
-
-namespace {
- static int XMLTOOL_DLLLOCAL error_callback(int ok, X509_STORE_CTX* ctx)
- {
- if (!ok)
- Category::getInstance("OpenSSL").error("path validation failure: %s", X509_verify_cert_error_string(ctx->error));
- return ok;
- }
-
- static bool XMLTOOL_DLLLOCAL validate(
- X509* EE,
- STACK_OF(X509)* untrusted,
- AbstractPKIXTrustEngine::PKIXValidationInfoIterator* pkixInfo,
- bool fullCRLChain,
- const vector<XSECCryptoX509CRL*>* inlineCRLs=NULL
- )
+namespace xmltooling {
+ // Adapter between TrustEngine and PathValidator
+ class XMLTOOL_DLLLOCAL PKIXParams : public PKIXPathValidatorParams
{
- Category& log=Category::getInstance(XMLTOOLING_LOGCAT".TrustEngine");
-
- // First we build a stack of CA certs. These objects are all referenced in place.
- log.debug("supplying PKIX Validation information");
-
- // We need this for CRL support.
- X509_STORE* store=X509_STORE_new();
- if (!store) {
- log_openssl();
- return false;
- }
-
- STACK_OF(X509)* CAstack = sk_X509_new_null();
-
- // This contains the state of the validate operation.
- int count=0;
- X509_STORE_CTX ctx;
-
- const vector<XSECCryptoX509*>& CAcerts = pkixInfo->getTrustAnchors();
- for (vector<XSECCryptoX509*>::const_iterator i=CAcerts.begin(); i!=CAcerts.end(); ++i) {
- if ((*i)->getProviderName()==DSIGConstants::s_unicodeStrPROVOpenSSL) {
- sk_X509_push(CAstack,static_cast<OpenSSLCryptoX509*>(*i)->getOpenSSLX509());
- ++count;
+ const AbstractPKIXTrustEngine& m_trust;
+ const AbstractPKIXTrustEngine::PKIXValidationInfoIterator& m_pkixInfo;
+ vector<XSECCryptoX509CRL*> m_crls;
+ public:
+ PKIXParams(
+ const AbstractPKIXTrustEngine& t,
+ const AbstractPKIXTrustEngine::PKIXValidationInfoIterator& pkixInfo,
+ const vector<XSECCryptoX509CRL*>* inlineCRLs
+ ) : m_trust(t), m_pkixInfo(pkixInfo) {
+ if (inlineCRLs && !inlineCRLs->empty()) {
+ m_crls = *inlineCRLs;
+ m_crls.insert(m_crls.end(), pkixInfo.getCRLs().begin(), pkixInfo.getCRLs().end());
}
}
- log.debug("supplied (%d) CA certificate(s)", count);
+ virtual ~PKIXParams() {}
-#if (OPENSSL_VERSION_NUMBER >= 0x00907000L)
- count=0;
- if (inlineCRLs) {
- for (vector<XSECCryptoX509CRL*>::const_iterator j=inlineCRLs->begin(); j!=inlineCRLs->end(); ++j) {
- if ((*j)->getProviderName()==DSIGConstants::s_unicodeStrPROVOpenSSL) {
- // owned by store
- X509_STORE_add_crl(store, X509_CRL_dup(static_cast<OpenSSLCryptoX509CRL*>(*j)->getOpenSSLX509CRL()));
- ++count;
- }
- }
+ int getVerificationDepth() const {
+ return m_pkixInfo.getVerificationDepth();
}
- const vector<XSECCryptoX509CRL*>& crls = pkixInfo->getCRLs();
- for (vector<XSECCryptoX509CRL*>::const_iterator j=crls.begin(); j!=crls.end(); ++j) {
- if ((*j)->getProviderName()==DSIGConstants::s_unicodeStrPROVOpenSSL) {
- // owned by store
- X509_STORE_add_crl(store, X509_CRL_dup(static_cast<OpenSSLCryptoX509CRL*>(*j)->getOpenSSLX509CRL()));
- ++count;
- }
+ bool isAnyPolicyInhibited() const {
+ return m_trust.m_anyPolicyInhibit;
}
- log.debug("supplied (%d) CRL(s)", count);
- if (count > 0)
- X509_STORE_set_flags(store, fullCRLChain ? (X509_V_FLAG_CRL_CHECK|X509_V_FLAG_CRL_CHECK_ALL) : (X509_V_FLAG_CRL_CHECK));
-#else
- if ((inlineCRLs && !inlineCRLs->empty()) || !pkixInfo->getCRLs().empty()) {
- log.warn("OpenSSL versions < 0.9.7 do not support CRL checking");
+ bool isPolicyMappingInhibited() const {
+ return m_trust.m_policyMappingInhibit;
}
-#endif
+ const set<string>& getPolicies() const {
+ return m_trust.m_policyOIDs;
+ }
+ const vector<XSECCryptoX509*>& getTrustAnchors() const {
+ return m_pkixInfo.getTrustAnchors();
+ }
+ PKIXPathValidatorParams::revocation_t getRevocationChecking() const {
+ if (m_trust.m_checkRevocation.empty() || m_trust.m_checkRevocation == "off")
+ return PKIXPathValidatorParams::REVOCATION_OFF;
+ else if (m_trust.m_checkRevocation == "entityOnly")
+ return PKIXPathValidatorParams::REVOCATION_ENTITYONLY;
+ else if (m_trust.m_checkRevocation == "fullChain")
+ return PKIXPathValidatorParams::REVOCATION_FULLCHAIN;
+ return PKIXPathValidatorParams::REVOCATION_OFF;
+ }
+ const vector<XSECCryptoX509CRL*>& getCRLs() const {
+ return m_crls.empty() ? m_pkixInfo.getCRLs() : m_crls;
+ }
+ };
- // AFAICT, EE and untrusted are passed in but not owned by the ctx.
-#if (OPENSSL_VERSION_NUMBER >= 0x00907000L)
- if (X509_STORE_CTX_init(&ctx,store,EE,untrusted)!=1) {
- log_openssl();
- log.error("unable to initialize X509_STORE_CTX");
- sk_X509_free(CAstack);
- X509_STORE_free(store);
- return false;
+
+ static XMLCh fullCRLChain[] = UNICODE_LITERAL_12(f,u,l,l,C,R,L,C,h,a,i,n);
+ static XMLCh checkRevocation[] = UNICODE_LITERAL_15(c,h,e,c,k,R,e,v,o,c,a,t,i,o,n);
+ static XMLCh policyMappingInhibit[] = UNICODE_LITERAL_20(p,o,l,i,c,y,M,a,p,p,i,n,g,I,n,h,i,b,i,t);
+ static XMLCh anyPolicyInhibit[] = UNICODE_LITERAL_16(a,n,y,P,o,l,i,c,y,I,n,h,i,b,i,t);
+ static XMLCh _PathValidator[] = UNICODE_LITERAL_13(P,a,t,h,V,a,l,i,d,a,t,o,r);
+ static XMLCh PolicyOID[] = UNICODE_LITERAL_9(P,o,l,i,c,y,O,I,D);
+ static XMLCh TrustedName[] = UNICODE_LITERAL_11(T,r,u,s,t,e,d,N,a,m,e);
+ static XMLCh type[] = UNICODE_LITERAL_4(t,y,p,e);
+};
+
+AbstractPKIXTrustEngine::PKIXValidationInfoIterator::PKIXValidationInfoIterator()
+{
+}
+
+AbstractPKIXTrustEngine::PKIXValidationInfoIterator::~PKIXValidationInfoIterator()
+{
+}
+
+AbstractPKIXTrustEngine::AbstractPKIXTrustEngine(const xercesc::DOMElement* e)
+ : TrustEngine(e),
+ m_checkRevocation(XMLHelper::getAttrString(e, nullptr, checkRevocation)),
+ m_fullCRLChain(XMLHelper::getAttrBool(e, false, fullCRLChain)),
+ m_policyMappingInhibit(XMLHelper::getAttrBool(e, false, policyMappingInhibit)),
+ m_anyPolicyInhibit(XMLHelper::getAttrBool(e, false, anyPolicyInhibit))
+{
+ if (m_fullCRLChain) {
+ Category::getInstance(XMLTOOLING_LOGCAT".TrustEngine.PKIX").warn(
+ "fullCRLChain option is deprecated, setting checkRevocation to \"fullChain\""
+ );
+ m_checkRevocation = "fullChain";
+ }
+ else if (m_checkRevocation == "fullChain") {
+ m_fullCRLChain = true; // in case anything's using this
+ }
+
+ xercesc::DOMElement* c = XMLHelper::getFirstChildElement(e);
+ while (c) {
+ if (c->hasChildNodes()) {
+ auto_ptr_char v(c->getTextContent());
+ if (v.get() && *v.get()) {
+ if (XMLString::equals(c->getLocalName(), PolicyOID))
+ m_policyOIDs.insert(v.get());
+ else if (XMLString::equals(c->getLocalName(), TrustedName))
+ m_trustedNames.insert(v.get());
+ }
}
-#else
- X509_STORE_CTX_init(&ctx,store,EE,untrusted);
-#endif
-
- // Seems to be most efficient to just pass in the CA stack.
- X509_STORE_CTX_trusted_stack(&ctx,CAstack);
- X509_STORE_CTX_set_depth(&ctx,100); // we check the depth down below
- X509_STORE_CTX_set_verify_cb(&ctx,error_callback);
-
- int ret=X509_verify_cert(&ctx);
- if (ret==1) {
- // Now see if the depth was acceptable by counting the number of intermediates.
- int depth=sk_X509_num(ctx.chain)-2;
- if (pkixInfo->getVerificationDepth() < depth) {
- log.error(
- "certificate chain was too long (%d intermediates, only %d allowed)",
- (depth==-1) ? 0 : depth,
- pkixInfo->getVerificationDepth()
+ else if (XMLString::equals(c->getLocalName(), _PathValidator)) {
+ try {
+ string t = XMLHelper::getAttrString(c, nullptr, type);
+ if (!t.empty()) {
+ Category::getInstance(XMLTOOLING_LOGCAT".TrustEngine.PKIX").info(
+ "building PathValidator of type %s", t.c_str()
+ );
+ PathValidator* pv = XMLToolingConfig::getConfig().PathValidatorManager.newPlugin(t.c_str(), c);
+ OpenSSLPathValidator* ospv = dynamic_cast<OpenSSLPathValidator*>(pv);
+ if (!ospv) {
+ delete pv;
+ throw XMLSecurityException("PathValidator doesn't support OpenSSL interface.");
+ }
+ m_pathValidators.push_back(ospv);
+ }
+ }
+ catch (exception& ex) {
+ Category::getInstance(XMLTOOLING_LOGCAT".TrustEngine.PKIX").error(
+ "error building PathValidator: %s", ex.what()
);
- ret=0;
}
}
-
- // Clean up...
- X509_STORE_CTX_cleanup(&ctx);
- X509_STORE_free(store);
- sk_X509_free(CAstack);
-
- if (ret==1) {
- log.debug("successfully validated certificate chain");
- return true;
- }
-
- return false;
+ c = XMLHelper::getNextSiblingElement(c);
}
-};
-AbstractPKIXTrustEngine::AbstractPKIXTrustEngine(const xercesc::DOMElement* e) : TrustEngine(e), m_fullCRLChain(false)
+ if (m_pathValidators.empty()) {
+ m_pathValidators.push_back(
+ dynamic_cast<OpenSSLPathValidator*>(
+ XMLToolingConfig::getConfig().PathValidatorManager.newPlugin(PKIX_PATHVALIDATOR, e)
+ )
+ );
+ }
+}
+
+AbstractPKIXTrustEngine::~AbstractPKIXTrustEngine()
{
- static XMLCh fullCRLChain[] = UNICODE_LITERAL_12(f,u,l,l,C,R,L,C,h,a,i,n);
- const XMLCh* flag = e ? e->getAttributeNS(NULL, fullCRLChain) : NULL;
- m_fullCRLChain = (flag && (*flag == xercesc::chLatin_t || *flag == xercesc::chDigit_1));
}
bool AbstractPKIXTrustEngine::checkEntityNames(
credResolver.resolve(creds,&criteria);
// Build a list of acceptable names.
- set<string> trustednames;
- trustednames.insert(criteria.getPeerName());
- for (vector<const Credential*>::const_iterator cred = creds.begin(); cred!=creds.end(); ++cred)
+ set<string> trustednames = m_trustedNames;
+ if (log.isDebugEnabled()) {
+ for (set<string>::const_iterator n=m_trustedNames.begin(); n!=m_trustedNames.end(); n++) {
+ log.debug("adding to list of trusted names (%s)", n->c_str());
+ }
+ }
+ if (criteria.getPeerName()) {
+ trustednames.insert(criteria.getPeerName());
+ log.debug("adding to list of trusted names (%s)", criteria.getPeerName());
+ }
+ for (vector<const Credential*>::const_iterator cred = creds.begin(); cred!=creds.end(); ++cred) {
trustednames.insert((*cred)->getKeyNames().begin(), (*cred)->getKeyNames().end());
+ if (log.isDebugEnabled()) {
+ for (set<string>::const_iterator n=(*cred)->getKeyNames().begin(); n!=(*cred)->getKeyNames().end(); n++) {
+ log.debug("adding to list of trusted names (%s)", n->c_str());
+ }
+ }
+ }
X509_NAME* subject=X509_get_subject_name(certEE);
if (subject) {
X509_NAME_print_ex(b2,subject,0,XN_FLAG_RFC2253 + XN_FLAG_SEP_CPLUS_SPC - XN_FLAG_SEP_COMMA_PLUS);
BIO_flush(b2);
- BUF_MEM* bptr=NULL;
- BUF_MEM* bptr2=NULL;
+ BUF_MEM* bptr=nullptr;
+ BUF_MEM* bptr2=nullptr;
BIO_get_mem_ptr(b, &bptr);
BIO_get_mem_ptr(b2, &bptr2);
BIO_free(b2);
log.debug("unable to match DN, trying TLS subjectAltName match");
- STACK_OF(GENERAL_NAME)* altnames=(STACK_OF(GENERAL_NAME)*)X509_get_ext_d2i(certEE, NID_subject_alt_name, NULL, NULL);
+ STACK_OF(GENERAL_NAME)* altnames=(STACK_OF(GENERAL_NAME)*)X509_get_ext_d2i(certEE, NID_subject_alt_name, nullptr, nullptr);
if (altnames) {
int numalts = sk_GENERAL_NAME_num(altnames);
for (int an=0; an<numalts; an++) {
log.debug("unable to match subjectAltName, trying TLS CN match");
// Fetch the last CN RDN.
- char* peer_CN = NULL;\r
- int j,i = -1;\r
- while ((j=X509_NAME_get_index_by_NID(subject, NID_commonName, i)) >= 0)\r
- i = j;\r
- if (i >= 0) {\r
- ASN1_STRING* tmp = X509_NAME_ENTRY_get_data(X509_NAME_get_entry(subject, i));\r
- // Copied in from libcurl.\r
- /* In OpenSSL 0.9.7d and earlier, ASN1_STRING_to_UTF8 fails if the input\r
- is already UTF-8 encoded. We check for this case and copy the raw\r
- string manually to avoid the problem. */\r
- if(tmp && ASN1_STRING_type(tmp) == V_ASN1_UTF8STRING) {\r
- j = ASN1_STRING_length(tmp);\r
- if(j >= 0) {\r
- peer_CN = (char*)OPENSSL_malloc(j + 1);\r
- memcpy(peer_CN, ASN1_STRING_data(tmp), j);\r
- peer_CN[j] = '\0';\r
- }\r
- }\r
- else /* not a UTF8 name */ {\r
- j = ASN1_STRING_to_UTF8(reinterpret_cast<unsigned char**>(&peer_CN), tmp);\r
- }\r
-\r
+ char* peer_CN = nullptr;
+ int j,i = -1;
+ while ((j=X509_NAME_get_index_by_NID(subject, NID_commonName, i)) >= 0)
+ i = j;
+ if (i >= 0) {
+ ASN1_STRING* tmp = X509_NAME_ENTRY_get_data(X509_NAME_get_entry(subject, i));
+ // Copied in from libcurl.
+ /* In OpenSSL 0.9.7d and earlier, ASN1_STRING_to_UTF8 fails if the input
+ is already UTF-8 encoded. We check for this case and copy the raw
+ string manually to avoid the problem. */
+ if(tmp && ASN1_STRING_type(tmp) == V_ASN1_UTF8STRING) {
+ j = ASN1_STRING_length(tmp);
+ if(j >= 0) {
+ peer_CN = (char*)OPENSSL_malloc(j + 1);
+ memcpy(peer_CN, ASN1_STRING_data(tmp), j);
+ peer_CN[j] = '\0';
+ }
+ }
+ else /* not a UTF8 name */ {
+ j = ASN1_STRING_to_UTF8(reinterpret_cast<unsigned char**>(&peer_CN), tmp);
+ }
+
for (set<string>::const_iterator n=trustednames.begin(); n!=trustednames.end(); n++) {
#ifdef HAVE_STRCASECMP
if (n->length() == j && !strncasecmp(peer_CN, n->c_str(), j)) {
if (n->length() == j && !strnicmp(peer_CN, n->c_str(), j)) {
#endif
log.debug("matched subject CN to a key name (%s)", n->c_str());
- if(peer_CN)\r
- OPENSSL_free(peer_CN);\r
+ if(peer_CN)
+ OPENSSL_free(peer_CN);
return true;
}
}
- if(peer_CN)\r
- OPENSSL_free(peer_CN);\r
+ if(peer_CN)
+ OPENSSL_free(peer_CN);
}
else {
log.warn("no common name in certificate subject");
- }\r
+ }
}
else {
log.error("certificate has no subject?!");
STACK_OF(X509)* certChain,
const CredentialResolver& credResolver,
CredentialCriteria* criteria,
- const std::vector<XSECCryptoX509CRL*>* inlineCRLs
+ const vector<XSECCryptoX509CRL*>* inlineCRLs
) const
{
#ifdef _DEBUG
if (criteria && criteria->getPeerName() && *(criteria->getPeerName())) {
log.debug("checking that the certificate name is acceptable");
- if (criteria->getUsage()==Credential::UNSPECIFIED_CREDENTIAL)
+ if (criteria && criteria->getUsage()==Credential::UNSPECIFIED_CREDENTIAL)
criteria->setUsage(Credential::SIGNING_CREDENTIAL);
if (!checkEntityNames(certEE,credResolver,*criteria)) {
log.error("certificate name was not acceptable");
return false;
}
}
+ else if (!m_trustedNames.empty()) {
+ log.debug("checking that the certificate name is acceptable");
+ CredentialCriteria cc;
+ cc.setUsage(Credential::SIGNING_CREDENTIAL);
+ if (!checkEntityNames(certEE,credResolver,cc)) {
+ log.error("certificate name was not acceptable");
+ return false;
+ }
+ }
log.debug("performing certificate path validation...");
auto_ptr<PKIXValidationInfoIterator> pkix(getPKIXValidationInfoIterator(credResolver, criteria));
while (pkix->next()) {
- if (::validate(certEE,certChain,pkix.get(),m_fullCRLChain,inlineCRLs)) {
- return true;
+ PKIXParams params(*this, *pkix.get(), inlineCRLs);
+ for (ptr_vector<OpenSSLPathValidator>::const_iterator v = m_pathValidators.begin(); v != m_pathValidators.end(); ++v) {
+ if (v->validate(certEE, certChain, params)) {
+ return true;
+ }
}
}
// Find and save off a pointer to the certificate that unlocks the object.
// Most of the time, this will be the first one anyway.
- XSECCryptoX509* certEE=NULL;
+ XSECCryptoX509* certEE=nullptr;
SignatureValidator keyValidator;
for (vector<XSECCryptoX509*>::const_iterator i=certs.begin(); !certEE && i!=certs.end(); ++i) {
try {
// Find and save off a pointer to the certificate that unlocks the object.
// Most of the time, this will be the first one anyway.
- XSECCryptoX509* certEE=NULL;
+ XSECCryptoX509* certEE=nullptr;
for (vector<XSECCryptoX509*>::const_iterator i=certs.begin(); !certEE && i!=certs.end(); ++i) {
try {
auto_ptr<XSECCryptoKey> key((*i)->clonePublicKey());
log.debug(ex.what());
}
}
-
- if (certEE)
- return validate(certEE,certs,credResolver,criteria);
-
- log.debug("failed to verify signature with embedded certificates");
- return false;
+
+ if (!certEE) {
+ log.debug("failed to verify signature with embedded certificates");
+ return false;
+ }
+ else if (certEE->getProviderName()!=DSIGConstants::s_unicodeStrPROVOpenSSL) {
+ log.error("only the OpenSSL XSEC provider is supported");
+ return false;
+ }
+
+ STACK_OF(X509)* untrusted=sk_X509_new_null();
+ for (vector<XSECCryptoX509*>::const_iterator i=certs.begin(); i!=certs.end(); ++i)
+ sk_X509_push(untrusted,static_cast<OpenSSLCryptoX509*>(*i)->getOpenSSLX509());
+ const vector<XSECCryptoX509CRL*>& crls = x509cred->getCRLs();
+ bool ret = validateWithCRLs(static_cast<OpenSSLCryptoX509*>(certEE)->getOpenSSLX509(), untrusted, credResolver, criteria, &crls);
+ sk_X509_free(untrusted);
+ return ret;
}