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