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 "logging.h"
  25 #include "security/BasicX509Credential.h"
  26 #include "security/KeyInfoCredentialContext.h"
  27 #include "security/KeyInfoResolver.h"
  28 #include "signature/KeyInfo.h"
  29 #include "signature/Signature.h"
  30 #include "util/NDC.h"
  31 #include "util/Threads.h"
  32 #include "util/XMLConstants.h"
  33 #include "validation/ValidatorSuite.h"
  34
  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::logging;
  46 using namespace xmltooling;
  47 using namespace xercesc;
  48 using namespace std;
  49
  50 namespace xmltooling {
  51
  52     class XMLTOOL_DLLLOCAL InlineCredential : public BasicX509Credential
  53     {
  54     public:
  55         InlineCredential(const KeyInfo* keyInfo=NULL) : BasicX509Credential(keyInfo!=NULL), m_credctx(new KeyInfoCredentialContext(keyInfo)) {
  56         }
  57         InlineCredential(DSIGKeyInfoList* keyInfo) : BasicX509Credential(false), m_credctx(new KeyInfoCredentialContext(keyInfo)) {
  58         }
  59         InlineCredential(KeyInfoCredentialContext* context) : BasicX509Credential(context->getKeyInfo()!=NULL), m_credctx(NULL) {
  60         }
  61         virtual ~InlineCredential() {
  62             delete m_credctx;
  63         }
  64
  65         XSECCryptoKey* getPrivateKey() const {
  66             return NULL;
  67         }
  68
  69         KeyInfo* getKeyInfo(bool compact=false) const {
  70             KeyInfo* ret = m_credctx->getKeyInfo() ? m_credctx->getKeyInfo()->cloneKeyInfo() : NULL;
  71             if (ret) {
  72                 ret->setId(NULL);
  73                 ret->getRetrievalMethods().clear();
  74                 if (compact) {
  75                     ret->getKeyValues().clear();
  76                     ret->getSPKIDatas().clear();
  77                     ret->getPGPDatas().clear();
  78                     ret->getUnknownXMLObjects().clear();
  79                     VectorOf(X509Data) x509Datas=ret->getX509Datas();
  80                     for (VectorOf(X509Data)::size_type pos = 0; pos < x509Datas.size();) {
  81                         x509Datas[pos]->getX509Certificates().clear();
  82                         x509Datas[pos]->getX509CRLs().clear();
  83                         x509Datas[pos]->getUnknownXMLObjects().clear();
  84                         if (x509Datas[pos]->hasChildren())
  85                             ++pos;
  86                         else
  87                             x509Datas.erase(x509Datas.begin() + pos);
  88                     }
  89                 }
  90             }
  91             if (!ret->hasChildren()) {
  92                 delete ret;
  93                 ret = NULL;
  94             }
  95             return ret;
  96         }
  97
  98         const CredentialContext* getCredentialContext() const {
  99             return m_credctx;
 100         }
 101
 102         void setCredentialContext(KeyInfoCredentialContext* context) {
 103             m_credctx = context;
 104         }
 105
 106         void resolve(const KeyInfo* keyInfo, int types=0);
 107         void resolve(DSIGKeyInfoList* keyInfo, int types=0);
 108
 109     private:
 110         bool resolveCerts(const KeyInfo* keyInfo);
 111         bool resolveKey(const KeyInfo* keyInfo);
 112         bool resolveCRLs(const KeyInfo* keyInfo);
 113
 114         KeyInfoCredentialContext* m_credctx;
 115     };
 116
 117     class XMLTOOL_DLLLOCAL InlineKeyResolver : public KeyInfoResolver
 118     {
 119     public:
 120         InlineKeyResolver() {}
 121         virtual ~InlineKeyResolver() {}
 122
 123         Credential* resolve(const KeyInfo* keyInfo, int types=0) const {
 124             if (!keyInfo)
 125                 return NULL;
 126             if (types == 0)
 127                 types = Credential::RESOLVE_KEYS|X509Credential::RESOLVE_CERTS|X509Credential::RESOLVE_CRLS;
 128             auto_ptr<InlineCredential> credential(new InlineCredential(keyInfo));
 129             credential->resolve(keyInfo, types);
 130             return credential.release();
 131         }
 132         Credential* resolve(DSIGKeyInfoList* keyInfo, int types=0) const {
 133             if (!keyInfo)
 134                 return NULL;
 135             if (types == 0)
 136                 types = Credential::RESOLVE_KEYS|X509Credential::RESOLVE_CERTS|X509Credential::RESOLVE_CRLS;
 137             auto_ptr<InlineCredential> credential(new InlineCredential(keyInfo));
 138             credential->resolve(keyInfo, types);
 139             return credential.release();
 140         }
 141         Credential* resolve(KeyInfoCredentialContext* context, int types=0) const {
 142             if (!context)
 143                 return NULL;
 144             if (types == 0)
 145                 types = Credential::RESOLVE_KEYS|X509Credential::RESOLVE_CERTS|X509Credential::RESOLVE_CRLS;
 146             auto_ptr<InlineCredential> credential(new InlineCredential(context));
 147             if (context->getKeyInfo())
 148                 credential->resolve(context->getKeyInfo(), types);
 149             else if (context->getNativeKeyInfo())
 150                 credential->resolve(context->getNativeKeyInfo(), types);
 151             credential->setCredentialContext(context);
 152             return credential.release();
 153         }
 154     };
 155
 156     KeyInfoResolver* XMLTOOL_DLLLOCAL InlineKeyInfoResolverFactory(const DOMElement* const & e)
 157     {
 158         return new InlineKeyResolver();
 159     }
 160 };
 161
 162 void InlineCredential::resolve(const KeyInfo* keyInfo, int types)
 163 {
 164 #ifdef _DEBUG
 165     NDC ndc("resolve");
 166 #endif
 167
 168     if (types & X509Credential::RESOLVE_CERTS)
 169         resolveCerts(keyInfo);
 170
 171     if (types & Credential::RESOLVE_KEYS) {
 172         if (types & X509Credential::RESOLVE_CERTS) {
 173             // If we have a cert, just use it.
 174             if (!m_xseccerts.empty())
 175                 m_key = m_xseccerts.front()->clonePublicKey();
 176             else
 177                 resolveKey(keyInfo);
 178         }
 179         // Otherwise try directly for a key and then go for certs if none is found.
 180         else if (!resolveKey(keyInfo) && resolveCerts(keyInfo)) {
 181             m_key = m_xseccerts.front()->clonePublicKey();
 182         }
 183     }
 184
 185     if (types & X509Credential::RESOLVE_CRLS)
 186         resolveCRLs(keyInfo);
 187
 188     const XMLCh* n;
 189     char* kn;
 190     const vector<KeyName*>& knames=keyInfo->getKeyNames();
 191     for (vector<KeyName*>::const_iterator kn_i=knames.begin(); kn_i!=knames.end(); ++kn_i) {
 192         n=(*kn_i)->getName();
 193         if (n && *n) {
 194             kn=toUTF8(n);
 195             m_keyNames.insert(kn);
 196             delete[] kn;
 197         }
 198     }
 199     const vector<X509Data*> datas=keyInfo->getX509Datas();
 200     for (vector<X509Data*>::const_iterator x_i=datas.begin(); x_i!=datas.end(); ++x_i) {
 201         const vector<X509SubjectName*> snames = const_cast<const X509Data*>(*x_i)->getX509SubjectNames();
 202         for (vector<X509SubjectName*>::const_iterator sn_i = snames.begin(); sn_i!=snames.end(); ++sn_i) {
 203             n = (*sn_i)->getName();
 204             if (n && *n) {
 205                 kn=toUTF8(n);
 206                 m_keyNames.insert(kn);
 207                 m_subjectName = kn;
 208                 delete[] kn;
 209             }
 210         }
 211
 212         const vector<X509IssuerSerial*> inames = const_cast<const X509Data*>(*x_i)->getX509IssuerSerials();
 213         if (!inames.empty()) {
 214             const X509IssuerName* iname = inames.front()->getX509IssuerName();
 215             if (iname) {
 216                 kn = toUTF8(iname->getName());
 217                 if (kn)
 218                     m_issuerName = kn;
 219                 delete[] kn;
 220             }
 221
 222             const X509SerialNumber* ser = inames.front()->getX509SerialNumber();
 223             if (ser) {
 224                 auto_ptr_char sn(ser->getSerialNumber());
 225                 m_serial = sn.get();
 226             }
 227         }
 228     }
 229 }
 230
 231 bool InlineCredential::resolveKey(const KeyInfo* keyInfo)
 232 {
 233     Category& log = Category::getInstance(XMLTOOLING_LOGCAT".KeyInfoResolver."INLINE_KEYINFO_RESOLVER);
 234
 235     // Check for ds:KeyValue
 236     const vector<KeyValue*>& keyValues = keyInfo->getKeyValues();
 237     for (vector<KeyValue*>::const_iterator i=keyValues.begin(); i!=keyValues.end(); ++i) {
 238         try {
 239             SchemaValidators.validate(*i);    // see if it's a "valid" key
 240             RSAKeyValue* rsakv = (*i)->getRSAKeyValue();
 241             if (rsakv) {
 242                 log.debug("resolving ds:RSAKeyValue");
 243                 auto_ptr_char mod(rsakv->getModulus()->getValue());
 244                 auto_ptr_char exp(rsakv->getExponent()->getValue());
 245                 auto_ptr<XSECCryptoKeyRSA> rsa(XSECPlatformUtils::g_cryptoProvider->keyRSA());
 246                 rsa->loadPublicModulusBase64BigNums(mod.get(), strlen(mod.get()));
 247                 rsa->loadPublicExponentBase64BigNums(exp.get(), strlen(exp.get()));
 248                 m_key = rsa.release();
 249                 return true;
 250             }
 251             DSAKeyValue* dsakv = (*i)->getDSAKeyValue();
 252             if (dsakv) {
 253                 log.debug("resolving ds:DSAKeyValue");
 254                 auto_ptr<XSECCryptoKeyDSA> dsa(XSECPlatformUtils::g_cryptoProvider->keyDSA());
 255                 auto_ptr_char y(dsakv->getY()->getValue());
 256                 dsa->loadYBase64BigNums(y.get(), strlen(y.get()));
 257                 if (dsakv->getP()) {
 258                     auto_ptr_char p(dsakv->getP()->getValue());
 259                     dsa->loadPBase64BigNums(p.get(), strlen(p.get()));
 260                 }
 261                 if (dsakv->getQ()) {
 262                     auto_ptr_char q(dsakv->getQ()->getValue());
 263                     dsa->loadQBase64BigNums(q.get(), strlen(q.get()));
 264                 }
 265                 if (dsakv->getG()) {
 266                     auto_ptr_char g(dsakv->getG()->getValue());
 267                     dsa->loadGBase64BigNums(g.get(), strlen(g.get()));
 268                 }
 269                 m_key = dsa.release();
 270                 return true;
 271             }
 272         }
 273         catch (ValidationException& ex) {
 274             log.warn("skipping invalid ds:KeyValue (%s)", ex.what());
 275         }
 276         catch(XSECException& e) {
 277             auto_ptr_char temp(e.getMsg());
 278             log.error("caught XML-Security exception loading key: %s", temp.get());
 279         }
 280         catch(XSECCryptoException& e) {
 281             log.error("caught XML-Security exception loading key: %s", e.getMsg());
 282         }
 283     }
 284
 285     return false;
 286 }
 287
 288 bool InlineCredential::resolveCerts(const KeyInfo* keyInfo)
 289 {
 290     Category& log = Category::getInstance(XMLTOOLING_LOGCAT".KeyInfoResolver."INLINE_KEYINFO_RESOLVER);
 291
 292     // Check for ds:X509Data
 293     const vector<X509Data*>& x509Datas=keyInfo->getX509Datas();
 294     for (vector<X509Data*>::const_iterator j=x509Datas.begin(); m_xseccerts.empty() && j!=x509Datas.end(); ++j) {
 295         const vector<X509Certificate*> x509Certs=const_cast<const X509Data*>(*j)->getX509Certificates();
 296         for (vector<X509Certificate*>::const_iterator k=x509Certs.begin(); k!=x509Certs.end(); ++k) {
 297             try {
 298                 auto_ptr_char x((*k)->getValue());
 299                 if (!x.get()) {
 300                     log.warn("skipping empty ds:X509Certificate");
 301                 }
 302                 else {
 303                     log.debug("resolving ds:X509Certificate");
 304                     auto_ptr<XSECCryptoX509> x509(XSECPlatformUtils::g_cryptoProvider->X509());
 305                     x509->loadX509Base64Bin(x.get(), strlen(x.get()));
 306                     m_xseccerts.push_back(x509.release());
 307                 }
 308             }
 309             catch(XSECException& e) {
 310                 auto_ptr_char temp(e.getMsg());
 311                 log.error("caught XML-Security exception loading certificate: %s", temp.get());
 312             }
 313             catch(XSECCryptoException& e) {
 314                 log.error("caught XML-Security exception loading certificate: %s", e.getMsg());
 315             }
 316         }
 317     }
 318
 319     log.debug("resolved %d certificate(s)", m_xseccerts.size());
 320     return !m_xseccerts.empty();
 321 }
 322
 323 bool InlineCredential::resolveCRLs(const KeyInfo* keyInfo)
 324 {
 325     Category& log = Category::getInstance(XMLTOOLING_LOGCAT".KeyInfoResolver."INLINE_KEYINFO_RESOLVER);
 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_crls.push_back(crl.release());
 342                 }
 343             }
 344             catch(XSECException& e) {
 345                 auto_ptr_char temp(e.getMsg());
 346                 log.error("caught XML-Security exception loading CRL: %s", temp.get());
 347             }
 348             catch(XSECCryptoException& e) {
 349                 log.error("caught XML-Security exception loading CRL: %s", e.getMsg());
 350             }
 351         }
 352     }
 353
 354     log.debug("resolved %d CRL(s)", m_crls.size());
 355     return !m_crls.empty();
 356 }
 357
 358 void InlineCredential::resolve(DSIGKeyInfoList* keyInfo, int types)
 359 {
 360 #ifdef _DEBUG
 361     NDC ndc("resolve");
 362 #endif
 363
 364     if (types & Credential::RESOLVE_KEYS) {
 365         // Default resolver handles RSA/DSAKeyValue and X509Certificate elements.
 366         try {
 367             XSECKeyInfoResolverDefault def;
 368             m_key = def.resolveKey(keyInfo);
 369         }
 370         catch(XSECException& e) {
 371             auto_ptr_char temp(e.getMsg());
 372             Category::getInstance(XMLTOOLING_LOGCAT".KeyResolver."INLINE_KEYINFO_RESOLVER).error("caught XML-Security exception loading certificate: %s", temp.get());
 373         }
 374         catch(XSECCryptoException& e) {
 375             Category::getInstance(XMLTOOLING_LOGCAT".KeyResolver."INLINE_KEYINFO_RESOLVER).error("caught XML-Security exception loading certificate: %s", e.getMsg());
 376         }
 377     }
 378
 379         DSIGKeyInfoList::size_type sz = keyInfo->getSize();
 380
 381     if (types & X509Credential::RESOLVE_CERTS) {
 382         for (DSIGKeyInfoList::size_type i=0; i<sz; ++i) {
 383             if (keyInfo->item(i)->getKeyInfoType()==DSIGKeyInfo::KEYINFO_X509) {
 384                 DSIGKeyInfoX509* x509 = static_cast<DSIGKeyInfoX509*>(keyInfo->item(i));
 385                 int count = x509->getCertificateListSize();
 386                 if (count) {
 387                     for (int j=0; j<count; ++j)
 388                         m_xseccerts.push_back(x509->getCertificateCryptoItem(j));
 389                     break;
 390                 }
 391             }
 392         }
 393     }
 394
 395     if (types & X509Credential::RESOLVE_CRLS) {
 396         DOMNode* x509Node;
 397         DOMElement* crlElement;
 398         for (DSIGKeyInfoList::size_type i=0; i<sz; ++i) {
 399             if (keyInfo->item(i)->getKeyInfoType()==DSIGKeyInfo::KEYINFO_X509) {
 400                 // The current xmlsec API is limited to one CRL per KeyInfo.
 401                 // For now, I'm going to process the DOM directly.
 402                 x509Node = keyInfo->item(i)->getKeyInfoDOMNode();
 403                 crlElement = x509Node ? XMLHelper::getFirstChildElement(x509Node, xmlconstants::XMLSIG_NS, X509CRL::LOCAL_NAME) : NULL;
 404                 while (crlElement) {
 405                     if (crlElement->hasChildNodes()) {
 406                         auto_ptr_char buf(crlElement->getFirstChild()->getNodeValue());
 407                         if (buf.get()) {
 408                             try {
 409                                 auto_ptr<XSECCryptoX509CRL> crlobj(XMLToolingConfig::getConfig().X509CRL());
 410                                 crlobj->loadX509CRLBase64Bin(buf.get(), strlen(buf.get()));
 411                                 m_crls.push_back(crlobj.release());
 412                             }
 413                             catch(XSECException& e) {
 414                                 auto_ptr_char temp(e.getMsg());
 415                                 Category::getInstance(XMLTOOLING_LOGCAT".KeyResolver."INLINE_KEYINFO_RESOLVER).error("caught XML-Security exception loading CRL: %s", temp.get());
 416                             }
 417                             catch(XSECCryptoException& e) {
 418                                 Category::getInstance(XMLTOOLING_LOGCAT".KeyResolver."INLINE_KEYINFO_RESOLVER).error("caught XML-Security exception loading CRL: %s", e.getMsg());
 419                             }
 420                         }
 421                     }
 422                     crlElement = XMLHelper::getNextSiblingElement(crlElement, xmlconstants::XMLSIG_NS, X509CRL::LOCAL_NAME);
 423                 }
 424             }
 425         }
 426     }
 427
 428     char* kn;
 429     const XMLCh* n;
 430
 431     for (size_t s=0; s<keyInfo->getSize(); s++) {
 432         DSIGKeyInfo* dki = keyInfo->item(s);
 433         n=dki->getKeyName();
 434         if (n && *n) {
 435             kn=toUTF8(n);
 436             m_keyNames.insert(kn);
 437             if (dki->getKeyInfoType() == DSIGKeyInfo::KEYINFO_X509)
 438                 m_subjectName = kn;
 439             delete[] kn;
 440         }
 441
 442         if (dki->getKeyInfoType() == DSIGKeyInfo::KEYINFO_X509) {
 443             DSIGKeyInfoX509* kix = static_cast<DSIGKeyInfoX509*>(dki);
 444             n = kix->getX509IssuerName();
 445             if (n && *n) {
 446                 kn=toUTF8(n);
 447                 m_issuerName = kn;
 448                 delete[] kn;
 449             }
 450             n = kix->getX509IssuerSerialNumber();
 451             if (n && *n) {
 452                 auto_ptr_char sn(n);
 453                 m_serial = sn.get();
 454             }
 455         }
 456     }
 457 }