xmltooling/security/impl/InlineKeyResolver.cpp

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * InlineKeyResolver.cpp
  19  *
  20  * Resolves key information directly from recognized KeyInfo structures.
  21  */
  22
  23 #include "internal.h"
  24 #include "security/BasicX509Credential.h"
  25 #include "security/KeyInfoCredentialContext.h"
  26 #include "security/KeyInfoResolver.h"
  27 #include "signature/KeyInfo.h"
  28 #include "signature/Signature.h"
  29 #include "util/NDC.h"
  30 #include "util/Threads.h"
  31 #include "util/XMLConstants.h"
  32 #include "validation/ValidatorSuite.h"
  33
  34 #include <log4cpp/Category.hh>
  35 #include <xercesc/util/XMLUniDefs.hpp>
  36 #include <xsec/dsig/DSIGKeyInfoX509.hpp>
  37 #include <xsec/enc/XSECKeyInfoResolverDefault.hpp>
  38 #include <xsec/enc/OpenSSL/OpenSSLCryptoX509.hpp>
  39 #include <xsec/enc/OpenSSL/OpenSSLCryptoKeyRSA.hpp>
  40 #include <xsec/enc/OpenSSL/OpenSSLCryptoKeyDSA.hpp>
  41 #include <xsec/enc/XSECCryptoException.hpp>
  42 #include <xsec/framework/XSECException.hpp>
  43
  44 using namespace xmlsignature;
  45 using namespace xmltooling;
  46 using namespace log4cpp;
  47 using namespace std;
  48
  49 namespace xmltooling {
  50
  51     class XMLTOOL_DLLLOCAL InlineCredential : public BasicX509Credential
  52     {
  53     public:
  54         InlineCredential(const KeyInfo* keyInfo=NULL) : BasicX509Credential(keyInfo!=NULL), m_credctx(new KeyInfoCredentialContext(keyInfo)) {
  55         }
  56         InlineCredential(DSIGKeyInfoList* keyInfo) : BasicX509Credential(false), m_credctx(new KeyInfoCredentialContext(keyInfo)) {
  57         }
  58         InlineCredential(KeyInfoCredentialContext* context) : BasicX509Credential(context->getKeyInfo()!=NULL), m_credctx(NULL) {
  59         }
  60         virtual ~InlineCredential() {
  61             delete m_credctx;
  62         }
  63
  64         XSECCryptoKey* getPrivateKey() const {
  65             return NULL;
  66         }
  67
  68         KeyInfo* getKeyInfo(bool compact=false) const {
  69             KeyInfo* ret = m_credctx->getKeyInfo() ? m_credctx->getKeyInfo()->cloneKeyInfo() : NULL;
  70             if (ret && compact) {
  71                 ret->getKeyValues().clear();
  72                 ret->getSPKIDatas().clear();
  73                 ret->getPGPDatas().clear();
  74                 ret->getUnknownXMLObjects().clear();
  75                 const vector<X509Data*> x509Datas=const_cast<const KeyInfo*>(ret)->getX509Datas();
  76                 for (vector<X509Data*>::const_iterator x=x509Datas.begin(); x!=x509Datas.end(); ++x) {
  77                     (*x)->getX509Certificates().clear();
  78                     (*x)->getX509CRLs().clear();
  79                     (*x)->getUnknownXMLObjects().clear();
  80                 }
  81             }
  82             return ret;
  83         }
  84
  85         const CredentialContext* getCredentialContext() const {
  86             return m_credctx;
  87         }
  88
  89         void setCredentialContext(KeyInfoCredentialContext* context) {
  90             m_credctx = context;
  91         }
  92
  93         void resolve(const KeyInfo* keyInfo, int types=0);
  94         void resolve(DSIGKeyInfoList* keyInfo, int types=0);
  95
  96     private:
  97         bool resolveCerts(const KeyInfo* keyInfo);
  98         bool resolveKey(const KeyInfo* keyInfo);
  99         bool resolveCRL(const KeyInfo* keyInfo);
 100
 101         KeyInfoCredentialContext* m_credctx;
 102     };
 103
 104     class XMLTOOL_DLLLOCAL InlineKeyResolver : public KeyInfoResolver
 105     {
 106     public:
 107         InlineKeyResolver() {}
 108         virtual ~InlineKeyResolver() {}
 109
 110         Credential* resolve(const KeyInfo* keyInfo, int types=0) const {
 111             if (!keyInfo)
 112                 return NULL;
 113             if (types == 0)
 114                 types = Credential::RESOLVE_KEYS|X509Credential::RESOLVE_CERTS|X509Credential::RESOLVE_CRLS;
 115             auto_ptr<InlineCredential> credential(new InlineCredential(keyInfo));
 116             credential->resolve(keyInfo, types);
 117             return credential.release();
 118         }
 119         Credential* resolve(DSIGKeyInfoList* keyInfo, int types=0) const {
 120             if (!keyInfo)
 121                 return NULL;
 122             if (types == 0)
 123                 types = Credential::RESOLVE_KEYS|X509Credential::RESOLVE_CERTS|X509Credential::RESOLVE_CRLS;
 124             auto_ptr<InlineCredential> credential(new InlineCredential(keyInfo));
 125             credential->resolve(keyInfo, types);
 126             return credential.release();
 127         }
 128         Credential* resolve(KeyInfoCredentialContext* context, int types=0) const {
 129             if (!context)
 130                 return NULL;
 131             if (types == 0)
 132                 types = Credential::RESOLVE_KEYS|X509Credential::RESOLVE_CERTS|X509Credential::RESOLVE_CRLS;
 133             auto_ptr<InlineCredential> credential(new InlineCredential(context));
 134             if (context->getKeyInfo())
 135                 credential->resolve(context->getKeyInfo(), types);
 136             else if (context->getNativeKeyInfo())
 137                 credential->resolve(context->getNativeKeyInfo(), types);
 138             credential->setCredentialContext(context);
 139             return credential.release();
 140         }
 141     };
 142
 143     KeyInfoResolver* XMLTOOL_DLLLOCAL InlineKeyInfoResolverFactory(const DOMElement* const & e)
 144     {
 145         return new InlineKeyResolver();
 146     }
 147 };
 148
 149 void InlineCredential::resolve(const KeyInfo* keyInfo, int types)
 150 {
 151 #ifdef _DEBUG
 152     NDC ndc("resolve");
 153 #endif
 154
 155     if (types & X509Credential::RESOLVE_CERTS)
 156         resolveCerts(keyInfo);
 157
 158     if (types & Credential::RESOLVE_KEYS) {
 159         if (types & X509Credential::RESOLVE_CERTS) {
 160             // If we have a cert, just use it.
 161             if (!m_xseccerts.empty())
 162                 m_key = m_xseccerts.front()->clonePublicKey();
 163         }
 164         // Otherwise try directly for a key and then go for certs if none is found.
 165         else if (!resolveKey(keyInfo) && resolveCerts(keyInfo)) {
 166             m_key = m_xseccerts.front()->clonePublicKey();
 167         }
 168     }
 169
 170     if (types & X509Credential::RESOLVE_CRLS)
 171         resolveCRL(keyInfo);
 172
 173     keyInfo->extractNames(m_keyNames);
 174 }
 175
 176 bool InlineCredential::resolveKey(const KeyInfo* keyInfo)
 177 {
 178     Category& log = Category::getInstance(XMLTOOLING_LOGCAT".KeyInfoResolver");
 179
 180     // Check for ds:KeyValue
 181     const vector<KeyValue*>& keyValues = keyInfo->getKeyValues();
 182     for (vector<KeyValue*>::const_iterator i=keyValues.begin(); i!=keyValues.end(); ++i) {
 183         try {
 184             SchemaValidators.validate(*i);    // see if it's a "valid" key
 185             RSAKeyValue* rsakv = (*i)->getRSAKeyValue();
 186             if (rsakv) {
 187                 log.debug("resolving ds:RSAKeyValue");
 188                 auto_ptr_char mod(rsakv->getModulus()->getValue());
 189                 auto_ptr_char exp(rsakv->getExponent()->getValue());
 190                 auto_ptr<XSECCryptoKeyRSA> rsa(XSECPlatformUtils::g_cryptoProvider->keyRSA());
 191                 rsa->loadPublicModulusBase64BigNums(mod.get(), strlen(mod.get()));
 192                 rsa->loadPublicExponentBase64BigNums(exp.get(), strlen(exp.get()));
 193                 m_key = rsa.release();
 194                 return true;
 195             }
 196             DSAKeyValue* dsakv = (*i)->getDSAKeyValue();
 197             if (dsakv) {
 198                 log.debug("resolving ds:DSAKeyValue");
 199                 auto_ptr<XSECCryptoKeyDSA> dsa(XSECPlatformUtils::g_cryptoProvider->keyDSA());
 200                 auto_ptr_char y(dsakv->getY()->getValue());
 201                 dsa->loadYBase64BigNums(y.get(), strlen(y.get()));
 202                 if (dsakv->getP()) {
 203                     auto_ptr_char p(dsakv->getP()->getValue());
 204                     dsa->loadPBase64BigNums(p.get(), strlen(p.get()));
 205                 }
 206                 if (dsakv->getQ()) {
 207                     auto_ptr_char q(dsakv->getQ()->getValue());
 208                     dsa->loadQBase64BigNums(q.get(), strlen(q.get()));
 209                 }
 210                 if (dsakv->getG()) {
 211                     auto_ptr_char g(dsakv->getG()->getValue());
 212                     dsa->loadGBase64BigNums(g.get(), strlen(g.get()));
 213                 }
 214                 m_key = dsa.release();
 215                 return true;
 216             }
 217         }
 218         catch (ValidationException& ex) {
 219             log.warn("skipping invalid ds:KeyValue (%s)", ex.what());
 220         }
 221         catch(XSECException& e) {
 222             auto_ptr_char temp(e.getMsg());
 223             log.error("caught XML-Security exception loading key: %s", temp.get());
 224         }
 225         catch(XSECCryptoException& e) {
 226             log.error("caught XML-Security exception loading key: %s", e.getMsg());
 227         }
 228     }
 229
 230     // Check for RetrievalMethod.
 231     const XMLCh* fragID=NULL;
 232     const XMLObject* treeRoot=NULL;
 233     const vector<RetrievalMethod*>& methods=keyInfo->getRetrievalMethods();
 234     for (vector<RetrievalMethod*>::const_iterator m=methods.begin(); m!=methods.end(); ++m) {
 235         if (!XMLString::equals((*m)->getType(),RetrievalMethod::TYPE_RSAKEYVALUE) &&
 236             !XMLString::equals((*m)->getType(),RetrievalMethod::TYPE_DSAKEYVALUE))
 237             continue;
 238         fragID = (*m)->getURI();
 239         if (!fragID || *fragID != chPound || !*(fragID+1)) {
 240             log.warn("skipping ds:RetrievalMethod with an empty or non-local reference");
 241             continue;
 242         }
 243         if (!treeRoot) {
 244             treeRoot = keyInfo;
 245             while (treeRoot->getParent())
 246                 treeRoot = treeRoot->getParent();
 247         }
 248         keyInfo = dynamic_cast<const KeyInfo*>(XMLHelper::getXMLObjectById(*treeRoot, fragID+1));
 249         if (!keyInfo) {
 250             log.warn("skipping ds:RetrievalMethod, local reference did not resolve to a ds:KeyInfo");
 251             continue;
 252         }
 253         if (resolveKey(keyInfo))
 254             return true;
 255     }
 256     return false;
 257 }
 258
 259 bool InlineCredential::resolveCerts(const KeyInfo* keyInfo)
 260 {
 261     Category& log = Category::getInstance(XMLTOOLING_LOGCAT".KeyInfoResolver");
 262
 263     // Check for ds:X509Data
 264     const vector<X509Data*>& x509Datas=keyInfo->getX509Datas();
 265     for (vector<X509Data*>::const_iterator j=x509Datas.begin(); m_xseccerts.empty() && j!=x509Datas.end(); ++j) {
 266         const vector<X509Certificate*> x509Certs=const_cast<const X509Data*>(*j)->getX509Certificates();
 267         for (vector<X509Certificate*>::const_iterator k=x509Certs.begin(); k!=x509Certs.end(); ++k) {
 268             try {
 269                 auto_ptr_char x((*k)->getValue());
 270                 if (!x.get()) {
 271                     log.warn("skipping empty ds:X509Certificate");
 272                 }
 273                 else {
 274                     log.debug("resolving ds:X509Certificate");
 275                     auto_ptr<XSECCryptoX509> x509(XSECPlatformUtils::g_cryptoProvider->X509());
 276                     x509->loadX509Base64Bin(x.get(), strlen(x.get()));
 277                     m_xseccerts.push_back(x509.release());
 278                 }
 279             }
 280             catch(XSECException& e) {
 281                 auto_ptr_char temp(e.getMsg());
 282                 log.error("caught XML-Security exception loading certificate: %s", temp.get());
 283             }
 284             catch(XSECCryptoException& e) {
 285                 log.error("caught XML-Security exception loading certificate: %s", e.getMsg());
 286             }
 287         }
 288     }
 289
 290     if (m_xseccerts.empty()) {
 291         // Check for RetrievalMethod.
 292         const XMLCh* fragID=NULL;
 293         const XMLObject* treeRoot=NULL;
 294         const vector<RetrievalMethod*> methods=keyInfo->getRetrievalMethods();
 295         for (vector<RetrievalMethod*>::const_iterator m=methods.begin(); m!=methods.end(); ++m) {
 296             if (!XMLString::equals((*m)->getType(),RetrievalMethod::TYPE_X509DATA))
 297                 continue;
 298             fragID = (*m)->getURI();
 299             if (!fragID || *fragID != chPound || !*(fragID+1)) {
 300                 log.warn("skipping ds:RetrievalMethod with an empty or non-local reference");
 301                 continue;
 302             }
 303             if (!treeRoot) {
 304                 treeRoot = keyInfo;
 305                 while (treeRoot->getParent())
 306                     treeRoot = treeRoot->getParent();
 307             }
 308             keyInfo = dynamic_cast<const KeyInfo*>(XMLHelper::getXMLObjectById(*treeRoot, fragID+1));
 309             if (!keyInfo) {
 310                 log.warn("skipping ds:RetrievalMethod, local reference did not resolve to a ds:KeyInfo");
 311                 continue;
 312             }
 313             if (resolveCerts(keyInfo))
 314                 return true;
 315         }
 316         return false;
 317     }
 318
 319     log.debug("resolved %d certificate(s)", m_xseccerts.size());
 320     return !m_xseccerts.empty();
 321 }
 322
 323 bool InlineCredential::resolveCRL(const KeyInfo* keyInfo)
 324 {
 325     Category& log = Category::getInstance(XMLTOOLING_LOGCAT".KeyInfoResolver");
 326
 327     // Check for ds:X509Data
 328     const vector<X509Data*>& x509Datas=keyInfo->getX509Datas();
 329     for (vector<X509Data*>::const_iterator j=x509Datas.begin(); j!=x509Datas.end(); ++j) {
 330         const vector<X509CRL*> x509CRLs=const_cast<const X509Data*>(*j)->getX509CRLs();
 331         for (vector<X509CRL*>::const_iterator k=x509CRLs.begin(); k!=x509CRLs.end(); ++k) {
 332             try {
 333                 auto_ptr_char x((*k)->getValue());
 334                 if (!x.get()) {
 335                     log.warn("skipping empty ds:X509CRL");
 336                 }
 337                 else {
 338                     log.debug("resolving ds:X509CRL");
 339                     auto_ptr<XSECCryptoX509CRL> crl(XMLToolingConfig::getConfig().X509CRL());
 340                     crl->loadX509CRLBase64Bin(x.get(), strlen(x.get()));
 341                     m_crl = crl.release();
 342                     return true;
 343                 }
 344             }
 345             catch(XSECException& e) {
 346                 auto_ptr_char temp(e.getMsg());
 347                 log.error("caught XML-Security exception loading certificate: %s", temp.get());
 348             }
 349             catch(XSECCryptoException& e) {
 350                 log.error("caught XML-Security exception loading certificate: %s", e.getMsg());
 351             }
 352         }
 353     }
 354
 355     // Check for RetrievalMethod.
 356     const XMLCh* fragID=NULL;
 357     const XMLObject* treeRoot=NULL;
 358     const vector<RetrievalMethod*> methods=keyInfo->getRetrievalMethods();
 359     for (vector<RetrievalMethod*>::const_iterator m=methods.begin(); m!=methods.end(); ++m) {
 360         if (!XMLString::equals((*m)->getType(),RetrievalMethod::TYPE_X509DATA))
 361             continue;
 362         fragID = (*m)->getURI();
 363         if (!fragID || *fragID != chPound || !*(fragID+1)) {
 364             log.warn("skipping ds:RetrievalMethod with an empty or non-local reference");
 365             continue;
 366         }
 367         if (!treeRoot) {
 368             treeRoot = keyInfo;
 369             while (treeRoot->getParent())
 370                 treeRoot = treeRoot->getParent();
 371         }
 372         keyInfo = dynamic_cast<const KeyInfo*>(XMLHelper::getXMLObjectById(*treeRoot, fragID+1));
 373         if (!keyInfo) {
 374             log.warn("skipping ds:RetrievalMethod, local reference did not resolve to a ds:KeyInfo");
 375             continue;
 376         }
 377         if (resolveCRL(keyInfo))
 378             return true;
 379     }
 380
 381     return false;
 382 }
 383
 384 void InlineCredential::resolve(DSIGKeyInfoList* keyInfo, int types)
 385 {
 386 #ifdef _DEBUG
 387     NDC ndc("resolve");
 388 #endif
 389
 390     if (types & Credential::RESOLVE_KEYS) {
 391         // Default resolver handles RSA/DSAKeyValue and X509Certificate elements.
 392         try {
 393             XSECKeyInfoResolverDefault def;
 394             m_key = def.resolveKey(keyInfo);
 395         }
 396         catch(XSECException& e) {
 397             auto_ptr_char temp(e.getMsg());
 398             Category::getInstance(XMLTOOLING_LOGCAT".KeyResolver").error("caught XML-Security exception loading certificate: %s", temp.get());
 399         }
 400         catch(XSECCryptoException& e) {
 401             Category::getInstance(XMLTOOLING_LOGCAT".KeyResolver").error("caught XML-Security exception loading certificate: %s", e.getMsg());
 402         }
 403     }
 404
 405         DSIGKeyInfoList::size_type sz = keyInfo->getSize();
 406
 407     if (types & X509Credential::RESOLVE_CERTS) {
 408         for (DSIGKeyInfoList::size_type i=0; i<sz; ++i) {
 409             if (keyInfo->item(i)->getKeyInfoType()==DSIGKeyInfo::KEYINFO_X509) {
 410                 DSIGKeyInfoX509* x509 = static_cast<DSIGKeyInfoX509*>(keyInfo->item(i));
 411                 int count = x509->getCertificateListSize();
 412                 if (count) {
 413                     for (int j=0; j<count; ++j)
 414                         m_xseccerts.push_back(x509->getCertificateCryptoItem(j));
 415                     break;
 416                 }
 417             }
 418         }
 419     }
 420
 421     if (types & X509Credential::RESOLVE_CRLS) {
 422         for (DSIGKeyInfoList::size_type i=0; i<sz; ++i) {
 423             if (keyInfo->item(i)->getKeyInfoType()==DSIGKeyInfo::KEYINFO_X509) {
 424                 auto_ptr_char buf(static_cast<DSIGKeyInfoX509*>(keyInfo->item(i))->getX509CRL());
 425                 if (buf.get()) {
 426                     try {
 427                         auto_ptr<XSECCryptoX509CRL> crlobj(XMLToolingConfig::getConfig().X509CRL());
 428                         crlobj->loadX509CRLBase64Bin(buf.get(), strlen(buf.get()));
 429                         m_crl = crlobj.release();
 430                         break;
 431                     }
 432                     catch(XSECException& e) {
 433                         auto_ptr_char temp(e.getMsg());
 434                         Category::getInstance(XMLTOOLING_LOGCAT".KeyResolver").error("caught XML-Security exception loading CRL: %s", temp.get());
 435                     }
 436                     catch(XSECCryptoException& e) {
 437                         Category::getInstance(XMLTOOLING_LOGCAT".KeyResolver").error("caught XML-Security exception loading CRL: %s", e.getMsg());
 438                     }
 439                 }
 440             }
 441         }
 442     }
 443
 444     Signature::extractNames(keyInfo, m_keyNames);
 445 }