xmltooling/security/impl/FilesystemCredentialResolver.cpp

   1 /*
   2  *  Copyright 2001-2010 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  * FilesystemCredentialResolver.cpp
  19  *
  20  * Supplies credentials from local files.
  21  */
  22
  23 #include "internal.h"
  24 #include "logging.h"
  25 #include "io/HTTPResponse.h"
  26 #include "security/BasicX509Credential.h"
  27 #include "security/CredentialCriteria.h"
  28 #include "security/CredentialResolver.h"
  29 #include "security/KeyInfoResolver.h"
  30 #include "security/OpenSSLCredential.h"
  31 #include "security/SecurityHelper.h"
  32 #include "security/XSECCryptoX509CRL.h"
  33 #include "util/NDC.h"
  34 #include "util/PathResolver.h"
  35 #include "util/Threads.h"
  36 #include "util/XMLHelper.h"
  37
  38 #include <memory>
  39 #include <algorithm>
  40 #include <sys/types.h>
  41 #include <sys/stat.h>
  42 #include <openssl/pkcs12.h>
  43 #include <xercesc/util/XMLUniDefs.hpp>
  44 #include <xsec/enc/OpenSSL/OpenSSLCryptoX509.hpp>
  45
  46 using namespace xmlsignature;
  47 using namespace xmltooling::logging;
  48 using namespace xmltooling;
  49 using namespace std;
  50
  51 using xercesc::DOMElement;
  52 using xercesc::chLatin_f;
  53 using xercesc::chDigit_0;
  54
  55 namespace xmltooling {
  56
  57     // The ManagedResource classes handle memory management, loading of the files
  58     // and staleness detection. A copy of the active objects is always stored in
  59     // these instances.
  60
  61     class XMLTOOL_DLLLOCAL ManagedResource {
  62     protected:
  63         ManagedResource() : local(true), reloadChanges(true), filestamp(0), reloadInterval(0) {}
  64         ~ManagedResource() {}
  65
  66         SOAPTransport* getTransport() {
  67             SOAPTransport::Address addr("FilesystemCredentialResolver", source.c_str(), source.c_str());
  68             string scheme(addr.m_endpoint, strchr(addr.m_endpoint,':') - addr.m_endpoint);
  69             SOAPTransport* ret = XMLToolingConfig::getConfig().SOAPTransportManager.newPlugin(scheme.c_str(), addr);
  70             if (ret)
  71                 ret->setCacheTag(&cacheTag);
  72             return ret;
  73         }
  74
  75     public:
  76         bool stale(Category& log, RWLock* lock=nullptr) {
  77             if (local) {
  78 #ifdef WIN32
  79                 struct _stat stat_buf;
  80                 if (_stat(source.c_str(), &stat_buf) != 0)
  81                     return false;
  82 #else
  83                 struct stat stat_buf;
  84                 if (stat(source.c_str(), &stat_buf) != 0)
  85                     return false;
  86 #endif
  87                 if (filestamp >= stat_buf.st_mtime)
  88                     return false;
  89
  90                 // If necessary, elevate lock and recheck.
  91                 if (lock) {
  92                     log.debug("timestamp of local resource changed, elevating to a write lock");
  93                     lock->unlock();
  94                     lock->wrlock();
  95                     if (filestamp >= stat_buf.st_mtime) {
  96                         // Somebody else handled it, just downgrade.
  97                         log.debug("update of local resource handled by another thread, downgrading lock");
  98                         lock->unlock();
  99                         lock->rdlock();
 100                         return false;
 101                     }
 102                 }
 103
 104                 // Update the timestamp regardless. No point in repeatedly trying.
 105                 filestamp = stat_buf.st_mtime;
 106                 log.info("change detected, reloading local resource...");
 107             }
 108             else {
 109                 time_t now = time(nullptr);
 110
 111                 // Time to reload?
 112                 if (now - filestamp < reloadInterval)
 113                     return false;
 114
 115                 // If necessary, elevate lock and recheck.
 116                 if (lock) {
 117                     log.debug("reload interval for remote resource elapsed, elevating to a write lock");
 118                     lock->unlock();
 119                     lock->wrlock();
 120                     if (now - filestamp < reloadInterval) {
 121                         // Somebody else handled it, just downgrade.
 122                         log.debug("update of remote resource handled by another thread, downgrading lock");
 123                         lock->unlock();
 124                         lock->rdlock();
 125                         return false;
 126                     }
 127                 }
 128
 129                 filestamp = now;
 130                 log.info("reloading remote resource...");
 131             }
 132             return true;
 133         }
 134
 135         bool local,reloadChanges;
 136         string format,source,backing,cacheTag;
 137         time_t filestamp,reloadInterval;
 138     };
 139
 140     class XMLTOOL_DLLLOCAL ManagedKey : public ManagedResource {
 141     public:
 142         ManagedKey() : key(nullptr) {}
 143         ~ManagedKey() { delete key; }
 144         void load(Category& log, const char* password) {
 145             if (source.empty())
 146                 return;
 147             XSECCryptoKey* nkey=nullptr;
 148             if (local) {
 149                 nkey = SecurityHelper::loadKeyFromFile(source.c_str(), format.c_str(), password);
 150             }
 151             else {
 152                 auto_ptr<SOAPTransport> t(getTransport());
 153                 log.info("loading private key from URL (%s)", source.c_str());
 154                 nkey = SecurityHelper::loadKeyFromURL(*t.get(), backing.c_str(), format.c_str(), password);
 155             }
 156             delete key;
 157             key = nkey;
 158             if (format.empty())
 159                 format = SecurityHelper::guessEncodingFormat(local ? source.c_str() : backing.c_str());
 160         }
 161
 162         XSECCryptoKey* key;
 163     };
 164
 165     class XMLTOOL_DLLLOCAL ManagedCert : public ManagedResource {
 166     public:
 167         ManagedCert() {}
 168         ~ManagedCert() { for_each(certs.begin(), certs.end(), xmltooling::cleanup<XSECCryptoX509>()); }
 169         void load(Category& log, const char* password) {
 170             if (source.empty())
 171                 return;
 172             vector<XSECCryptoX509*> ncerts;
 173             if (local) {
 174                 SecurityHelper::loadCertificatesFromFile(ncerts, source.c_str(), format.c_str(), password);
 175             }
 176             else {
 177                 auto_ptr<SOAPTransport> t(getTransport());
 178                 log.info("loading certificate(s) from URL (%s)", source.c_str());
 179                 SecurityHelper::loadCertificatesFromURL(ncerts, *t.get(), backing.c_str(), format.c_str(), password);
 180             }
 181             for_each(certs.begin(), certs.end(), xmltooling::cleanup<XSECCryptoX509>());
 182             certs = ncerts;
 183             if (format.empty())
 184                 format = SecurityHelper::guessEncodingFormat(local ? source.c_str() : backing.c_str());
 185         }
 186         vector<XSECCryptoX509*> certs;
 187     };
 188
 189     class XMLTOOL_DLLLOCAL ManagedCRL : public ManagedResource {
 190     public:
 191         ManagedCRL() {}
 192         ~ManagedCRL() { for_each(crls.begin(), crls.end(), xmltooling::cleanup<XSECCryptoX509CRL>()); }
 193         void load(Category& log) {
 194             if (source.empty())
 195                 return;
 196             vector<XSECCryptoX509CRL*> ncrls;
 197             if (local) {
 198                 SecurityHelper::loadCRLsFromFile(ncrls, source.c_str(), format.c_str());
 199             }
 200             else {
 201                 auto_ptr<SOAPTransport> t(getTransport());
 202                 log.info("loading CRL(s) from URL (%s)", source.c_str());
 203                 SecurityHelper::loadCRLsFromURL(ncrls, *t.get(), backing.c_str(), format.c_str());
 204             }
 205             for_each(crls.begin(), crls.end(), xmltooling::cleanup<XSECCryptoX509CRL>());
 206             crls = ncrls;
 207             if (format.empty())
 208                 format = SecurityHelper::guessEncodingFormat(local ? source.c_str() : backing.c_str());
 209         }
 210         vector<XSECCryptoX509CRL*> crls;
 211     };
 212
 213     class XMLTOOL_DLLLOCAL FilesystemCredential;
 214     class XMLTOOL_DLLLOCAL FilesystemCredentialResolver : public CredentialResolver
 215     {
 216     public:
 217         FilesystemCredentialResolver(const DOMElement* e);
 218         virtual ~FilesystemCredentialResolver();
 219
 220         Lockable* lock();
 221         void unlock() {
 222             m_lock->unlock();
 223         }
 224
 225         const Credential* resolve(const CredentialCriteria* criteria=nullptr) const;
 226
 227         virtual vector<const Credential*>::size_type resolve(
 228             vector<const Credential*>& results, const CredentialCriteria* criteria=nullptr
 229             ) const;
 230
 231     private:
 232         Credential* getCredential();
 233
 234         RWLock* m_lock;
 235         Credential* m_credential;
 236         string m_keypass,m_certpass;
 237         unsigned int m_keyinfomask,m_usage;
 238         bool m_extractNames;
 239         vector<string> m_keynames;
 240
 241         ManagedKey m_key;
 242         vector<ManagedCert> m_certs;
 243         vector<ManagedCRL> m_crls;
 244
 245         friend class XMLTOOL_DLLLOCAL FilesystemCredential;
 246     };
 247
 248 #if defined (_MSC_VER)
 249     #pragma warning( push )
 250     #pragma warning( disable : 4250 )
 251 #endif
 252
 253     class XMLTOOL_DLLLOCAL FilesystemCredential : public OpenSSLCredential, public BasicX509Credential
 254     {
 255     public:
 256         FilesystemCredential(
 257             FilesystemCredentialResolver* resolver,
 258             XSECCryptoKey* key,
 259             const vector<XSECCryptoX509*>& xseccerts,
 260             const vector<XSECCryptoX509CRL*>& crls
 261             ) : BasicX509Credential(key ? key : (xseccerts.empty() ? nullptr : xseccerts.front()->clonePublicKey()), xseccerts, crls), m_resolver(resolver) {
 262             if (m_resolver->m_extractNames)
 263                 extract();
 264             m_keyNames.insert(m_resolver->m_keynames.begin(), m_resolver->m_keynames.end());
 265         }
 266
 267         virtual ~FilesystemCredential() {
 268         }
 269
 270         unsigned int getUsage() const {
 271             return m_resolver->m_usage;
 272         }
 273
 274         void initKeyInfo(unsigned int types=0) {
 275             BasicX509Credential::initKeyInfo(types);
 276         }
 277
 278         void attach(SSL_CTX* ctx) const;
 279
 280     private:
 281         FilesystemCredentialResolver* m_resolver;
 282     };
 283
 284 #if defined (_MSC_VER)
 285     #pragma warning( pop )
 286 #endif
 287
 288     CredentialResolver* XMLTOOL_DLLLOCAL FilesystemCredentialResolverFactory(const DOMElement* const & e)
 289     {
 290         return new FilesystemCredentialResolver(e);
 291     }
 292
 293     static const XMLCh backingFilePath[] =  UNICODE_LITERAL_15(b,a,c,k,i,n,g,F,i,l,e,P,a,t,h);
 294     static const XMLCh _CredentialResolver[] = UNICODE_LITERAL_18(C,r,e,d,e,n,t,i,a,l,R,e,s,o,l,v,e,r);
 295     static const XMLCh CAPath[] =           UNICODE_LITERAL_6(C,A,P,a,t,h);
 296     static const XMLCh Certificate[] =      UNICODE_LITERAL_11(C,e,r,t,i,f,i,c,a,t,e);
 297     static const XMLCh _certificate[] =     UNICODE_LITERAL_11(c,e,r,t,i,f,i,c,a,t,e);
 298     static const XMLCh CRL[] =              UNICODE_LITERAL_3(C,R,L);
 299     static const XMLCh extractNames[] =     UNICODE_LITERAL_12(e,x,t,r,a,c,t,N,a,m,e,s);
 300     static const XMLCh _format[] =          UNICODE_LITERAL_6(f,o,r,m,a,t);
 301     static const XMLCh Key[] =              UNICODE_LITERAL_3(K,e,y);
 302     static const XMLCh _key[] =             UNICODE_LITERAL_3(k,e,y);
 303     static const XMLCh keyInfoMask[] =      UNICODE_LITERAL_11(k,e,y,I,n,f,o,M,a,s,k);
 304     static const XMLCh keyName[] =          UNICODE_LITERAL_7(k,e,y,N,a,m,e);
 305     static const XMLCh Name[] =             UNICODE_LITERAL_4(N,a,m,e);
 306     static const XMLCh password[] =         UNICODE_LITERAL_8(p,a,s,s,w,o,r,d);
 307     static const XMLCh Path[] =             UNICODE_LITERAL_4(P,a,t,h);
 308     static const XMLCh _reloadChanges[] =   UNICODE_LITERAL_13(r,e,l,o,a,d,C,h,a,n,g,e,s);
 309     static const XMLCh _reloadInterval[] =  UNICODE_LITERAL_14(r,e,l,o,a,d,I,n,t,e,r,v,a,l);
 310     static const XMLCh _URL[] =             UNICODE_LITERAL_3(U,R,L);
 311     static const XMLCh _use[] =             UNICODE_LITERAL_3(u,s,e);
 312 };
 313
 314 FilesystemCredentialResolver::FilesystemCredentialResolver(const DOMElement* e)
 315     : m_lock(nullptr), m_credential(nullptr), m_keyinfomask(XMLHelper::getAttrInt(e, 0, keyInfoMask)),
 316         m_usage(Credential::UNSPECIFIED_CREDENTIAL), m_extractNames(true)
 317 {
 318 #ifdef _DEBUG
 319     NDC ndc("FilesystemCredentialResolver");
 320 #endif
 321     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".CredentialResolver."FILESYSTEM_CREDENTIAL_RESOLVER);
 322
 323     if (e && (e->hasAttributeNS(nullptr,_certificate) || e->hasAttributeNS(nullptr,_key))) {
 324         // Dummy up a simple file resolver config using these attributes.
 325         DOMElement* dummy = e->getOwnerDocument()->createElementNS(nullptr,_CredentialResolver);
 326         DOMElement* child;
 327         DOMElement* path;
 328         if (e->hasAttributeNS(nullptr,_key)) {
 329             child = e->getOwnerDocument()->createElementNS(nullptr,Key);
 330             dummy->appendChild(child);
 331             path = e->getOwnerDocument()->createElementNS(nullptr,Path);
 332             child->appendChild(path);
 333             path->appendChild(e->getOwnerDocument()->createTextNode(e->getAttributeNS(nullptr,_key)));
 334             if (e->hasAttributeNS(nullptr,password))
 335                 child->setAttributeNS(nullptr,password,e->getAttributeNS(nullptr,password));
 336             if (e->hasAttributeNS(nullptr,keyName)) {
 337                 path = e->getOwnerDocument()->createElementNS(nullptr,Name);
 338                 child->appendChild(path);
 339                 path->appendChild(e->getOwnerDocument()->createTextNode(e->getAttributeNS(nullptr,keyName)));
 340             }
 341         }
 342         if (e->hasAttributeNS(nullptr,_certificate)) {
 343             child = e->getOwnerDocument()->createElementNS(nullptr,Certificate);
 344             dummy->appendChild(child);
 345             path = e->getOwnerDocument()->createElementNS(nullptr,Path);
 346             child->appendChild(path);
 347             path->appendChild(e->getOwnerDocument()->createTextNode(e->getAttributeNS(nullptr,_certificate)));
 348             if (e->hasAttributeNS(nullptr, extractNames))
 349                 child->setAttributeNS(nullptr, extractNames, e->getAttributeNS(nullptr, extractNames));
 350         }
 351         e = dummy;  // reset "root" to the dummy config element
 352     }
 353
 354     const XMLCh* prop;
 355     const DOMElement* root = e;
 356
 357     // Save off usage bits.
 358     string usage = XMLHelper::getAttrString(root, nullptr, _use);
 359     if (usage == "signing")
 360         m_usage = Credential::SIGNING_CREDENTIAL | Credential::TLS_CREDENTIAL;
 361     else if (usage == "TLS")
 362         m_usage = Credential::TLS_CREDENTIAL;
 363     else if (usage == "encryption")
 364         m_usage = Credential::ENCRYPTION_CREDENTIAL;
 365
 366     // Move to Key.
 367     const DOMElement* keynode = XMLHelper::getFirstChildElement(root,Key);
 368     if (keynode) {
 369         m_key.format = XMLHelper::getAttrString(keynode, nullptr, _format);
 370         m_keypass = XMLHelper::getAttrString(keynode, nullptr, password);
 371
 372         if ((e=XMLHelper::getFirstChildElement(keynode,Path)) && e->hasChildNodes()) {
 373             prop = e->getFirstChild()->getNodeValue();
 374             auto_ptr_char kpath(prop);
 375             m_key.source = kpath.get();
 376             XMLToolingConfig::getConfig().getPathResolver()->resolve(m_key.source, PathResolver::XMLTOOLING_CFG_FILE);
 377             m_key.local = true;
 378             m_key.reloadChanges = XMLHelper::getAttrBool(e, true, _reloadChanges);
 379         }
 380         else if ((e=XMLHelper::getFirstChildElement(keynode,_URL)) && e->hasChildNodes()) {
 381             prop = e->getFirstChild()->getNodeValue();
 382             auto_ptr_char kpath(prop);
 383             m_key.source = kpath.get();
 384             m_key.local = false;
 385             m_key.backing = XMLHelper::getAttrString(e, nullptr, backingFilePath);
 386             if (m_key.backing.empty())
 387                 throw XMLSecurityException("FilesystemCredentialResolver can't access key, backingFilePath missing from URL element.");
 388             XMLToolingConfig::getConfig().getPathResolver()->resolve(m_key.backing, PathResolver::XMLTOOLING_RUN_FILE);
 389             m_key.reloadInterval = XMLHelper::getAttrInt(e, 0, _reloadInterval);
 390         }
 391         else {
 392             log.error("Path/URL element missing inside Key element");
 393             throw XMLSecurityException("FilesystemCredentialResolver can't access key, no Path or URL element specified.");
 394         }
 395
 396         e = XMLHelper::getFirstChildElement(keynode, Name);
 397         while (e) {
 398             if (e->hasChildNodes()) {
 399                 auto_ptr_char n(e->getFirstChild()->getNodeValue());
 400                 if (n.get() && *n.get())
 401                     m_keynames.push_back(n.get());
 402             }
 403             e = XMLHelper::getNextSiblingElement(e, Name);
 404         }
 405     }
 406
 407     // Check for CRL.
 408     const DOMElement* crlnode = XMLHelper::getFirstChildElement(root, CRL);
 409     if (crlnode) {
 410         string crlformat = XMLHelper::getAttrString(crlnode, nullptr, _format);
 411         e = XMLHelper::getFirstChildElement(crlnode, Path);
 412         while (e) {
 413             if (e->hasChildNodes()) {
 414                 m_crls.push_back(ManagedCRL());
 415                 ManagedResource& crl = m_crls.back();
 416                 crl.format = crlformat;
 417                 prop = e->getFirstChild()->getNodeValue();
 418                 auto_ptr_char crlpath(prop);
 419                 crl.source = crlpath.get();
 420                 XMLToolingConfig::getConfig().getPathResolver()->resolve(crl.source, PathResolver::XMLTOOLING_CFG_FILE);
 421                 crl.local = true;
 422                 crl.reloadChanges = XMLHelper::getAttrBool(e, true, _reloadChanges);
 423             }
 424             e = XMLHelper::getNextSiblingElement(e, Path);
 425         }
 426
 427         e = XMLHelper::getFirstChildElement(crlnode, _URL);
 428         while (e) {
 429             if (e->hasChildNodes()) {
 430                 m_crls.push_back(ManagedCRL());
 431                 ManagedResource& crl = m_crls.back();
 432                 crl.format = crlformat;
 433                 prop = e->getFirstChild()->getNodeValue();
 434                 auto_ptr_char crlpath(prop);
 435                 crl.source = crlpath.get();
 436                 crl.local = false;
 437                 crl.backing = XMLHelper::getAttrString(e, nullptr, backingFilePath);
 438                 if (crl.backing.empty())
 439                     throw XMLSecurityException("FilesystemCredentialResolver can't access CRL, backingFilePath missing from URL element.");
 440                 XMLToolingConfig::getConfig().getPathResolver()->resolve(crl.backing, PathResolver::XMLTOOLING_RUN_FILE);
 441                 crl.reloadInterval = XMLHelper::getAttrInt(e, 0, _reloadInterval);
 442             }
 443             e = XMLHelper::getNextSiblingElement(e, _URL);
 444         }
 445         if (m_crls.empty()) {
 446             log.error("Path/URL element missing inside CRL element");
 447             throw XMLSecurityException("FilesystemCredentialResolver can't access CRL, no Path or URL element specified.");
 448         }
 449     }
 450
 451     // Check for Certificate
 452     DOMElement* certnode = XMLHelper::getFirstChildElement(root,Certificate);
 453     if (certnode) {
 454         m_certpass = XMLHelper::getAttrString(certnode, nullptr, password);
 455         string certformat = XMLHelper::getAttrString(certnode, nullptr, _format);
 456         m_extractNames = XMLHelper::getAttrBool(certnode, true, extractNames);
 457
 458         e = XMLHelper::getFirstChildElement(certnode);
 459         while (e) {
 460             if (e->hasChildNodes() && (XMLString::equals(e->getLocalName(), Path) || XMLString::equals(e->getLocalName(), CAPath))) {
 461                 m_certs.push_back(ManagedCert());
 462                 ManagedResource& cert = m_certs.back();
 463                 cert.format = certformat;
 464                 prop = e->getFirstChild()->getNodeValue();
 465                 auto_ptr_char certpath(prop);
 466                 cert.source = certpath.get();
 467                 XMLToolingConfig::getConfig().getPathResolver()->resolve(cert.source, PathResolver::XMLTOOLING_CFG_FILE);
 468                 cert.local = true;
 469                 cert.reloadChanges = XMLHelper::getAttrBool(e, true, _reloadChanges);
 470             }
 471             else if (e->hasChildNodes() && XMLString::equals(e->getLocalName(), _URL)) {
 472                 m_certs.push_back(ManagedCert());
 473                 ManagedResource& cert = m_certs.back();
 474                 cert.format = certformat;
 475                 prop = e->getFirstChild()->getNodeValue();
 476                 auto_ptr_char certpath(prop);
 477                 cert.source = certpath.get();
 478                 cert.local = false;
 479                 cert.backing = XMLHelper::getAttrString(e, nullptr, backingFilePath);
 480                 if (cert.backing.empty())
 481                     throw XMLSecurityException("FilesystemCredentialResolver can't access certificate, backingFilePath missing from URL element.");
 482                 XMLToolingConfig::getConfig().getPathResolver()->resolve(cert.backing, PathResolver::XMLTOOLING_RUN_FILE);
 483                 cert.reloadInterval = XMLHelper::getAttrInt(e, 0, _reloadInterval);
 484             }
 485             e = XMLHelper::getNextSiblingElement(e);
 486         }
 487         if (m_certs.empty()) {
 488             log.error("Path/URL element missing inside Certificate element");
 489             throw XMLSecurityException("FilesystemCredentialResolver can't access certificate, no Path or URL element specified.");
 490         }
 491     }
 492
 493     // Do an initial load of all the objects. If anything blows up here, whatever's
 494     // been loaded should be freed during teardown of the embedded objects.
 495     time_t now = time(nullptr);
 496     m_key.filestamp = now;
 497     m_key.load(log, m_keypass.c_str());
 498     for (vector<ManagedCert>::iterator i = m_certs.begin(); i != m_certs.end(); ++i) {
 499         i->load(log, (i==m_certs.begin()) ? m_certpass.c_str() : nullptr);
 500         i->filestamp = now;
 501     }
 502     for (vector<ManagedCRL>::iterator j = m_crls.begin(); j != m_crls.end(); ++j) {
 503         j->load(log);
 504         j->filestamp = now;
 505     }
 506
 507     // Load it all into a credential object and then create the lock.
 508     auto_ptr<Credential> credential(getCredential());
 509     m_lock = RWLock::create();
 510     m_credential = credential.release();
 511 }
 512
 513 FilesystemCredentialResolver::~FilesystemCredentialResolver()
 514 {
 515     delete m_credential;
 516     delete m_lock;
 517 }
 518
 519 Credential* FilesystemCredentialResolver::getCredential()
 520 {
 521     // First, verify that the key and certificate match.
 522     if (m_key.key && !m_certs.empty()) {
 523         auto_ptr<XSECCryptoKey> temp(m_certs.front().certs.front()->clonePublicKey());
 524         if (!SecurityHelper::matches(*m_key.key, *temp.get()))
 525             throw XMLSecurityException("FilesystemCredentialResolver given mismatched key/certificate, check for consistency.");
 526     }
 527
 528     // We (unfortunately) need to duplicate all the objects and put them in one set of arrays
 529     // in order to create the credential wrapper.
 530     FilesystemCredential* credential=nullptr;
 531     auto_ptr<XSECCryptoKey> xseckey(m_key.key ? m_key.key->clone() : nullptr);
 532     vector<XSECCryptoX509*> xseccerts;
 533     vector<XSECCryptoX509CRL*> xseccrls;
 534     try {
 535         for (vector<ManagedCert>::iterator i = m_certs.begin(); i != m_certs.end(); ++i) {
 536             for (vector<XSECCryptoX509*>::const_iterator y = i->certs.begin(); y != i->certs.end(); ++y)
 537                 xseccerts.push_back(new OpenSSLCryptoX509(static_cast<OpenSSLCryptoX509*>(*y)->getOpenSSLX509()));
 538         }
 539         for (vector<ManagedCRL>::iterator j = m_crls.begin(); j != m_crls.end(); ++j) {
 540             for (vector<XSECCryptoX509CRL*>::const_iterator z = j->crls.begin(); z != j->crls.end(); ++z)
 541                 xseccrls.push_back((*z)->clone());
 542         }
 543         credential = new FilesystemCredential(this, xseckey.get(), xseccerts, xseccrls);
 544         xseckey.release();
 545     }
 546     catch (exception&) {
 547         for_each(xseccerts.begin(), xseccerts.end(), xmltooling::cleanup<XSECCryptoX509>());
 548         for_each(xseccrls.begin(), xseccrls.end(), xmltooling::cleanup<XSECCryptoX509CRL>());
 549         throw;
 550     }
 551
 552     // At this point the copies are owned by the credential.
 553     try {
 554         credential->initKeyInfo(m_keyinfomask);
 555     }
 556     catch (exception&) {
 557         delete credential;
 558         throw;
 559     }
 560
 561     return credential;
 562 }
 563
 564 Lockable* FilesystemCredentialResolver::lock()
 565 {
 566 #ifdef _DEBUG
 567     NDC ndc("lock");
 568 #endif
 569     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".CredentialResolver."FILESYSTEM_CREDENTIAL_RESOLVER);
 570
 571     m_lock->rdlock();
 572
 573     // Check each managed resource while holding a read lock for staleness.
 574     // If it comes back false, the lock is left as is, and the resource was stable.
 575     // If it comes back true, the lock was elevated to a write lock, and the resource
 576     // needs to be reloaded, and the credential replaced.
 577     // Once a stale check comes back true, further checks leave the lock alone.
 578
 579     bool writelock = false, updated = false;
 580
 581     if (m_key.stale(log, m_lock)) {
 582         writelock = true;
 583         try {
 584             m_key.load(log, m_keypass.c_str());
 585             updated = true;
 586         }
 587         catch (long& ex) {
 588             if (ex == HTTPResponse::XMLTOOLING_HTTP_STATUS_NOTMODIFIED) {
 589                 log.info("remote key (%s) unchanged from cached version", m_key.source.c_str());
 590             }
 591             else {
 592                 // Shouldn't happen, we should only get codes intended to be gracefully handled.
 593                 log.crit("maintaining existing key, remote fetch returned atypical status code (%d)", ex);
 594             }
 595         }
 596         catch (exception& ex) {
 597             log.crit("maintaining existing key: %s", ex.what());
 598         }
 599     }
 600
 601     for (vector<ManagedCert>::iterator i = m_certs.begin(); i != m_certs.end(); ++i) {
 602         if (i->stale(log, writelock ? nullptr : m_lock)) {
 603             writelock = true;
 604             try {
 605                 i->load(log, (i==m_certs.begin()) ? m_certpass.c_str() : nullptr);
 606                 updated = true;
 607             }
 608             catch (long& ex) {
 609                 if (ex == HTTPResponse::XMLTOOLING_HTTP_STATUS_NOTMODIFIED) {
 610                     log.info("remote certificate(s) (%s) unchanged from cached version", i->source.c_str());
 611                 }
 612                 else {
 613                     // Shouldn't happen, we should only get codes intended to be gracefully handled.
 614                     log.crit("maintaining existing certificate(s), remote fetch returned atypical status code (%d)", ex);
 615                 }
 616             }
 617             catch (exception& ex) {
 618                 log.crit("maintaining existing certificate(s): %s", ex.what());
 619             }
 620         }
 621     }
 622
 623     for (vector<ManagedCRL>::iterator j = m_crls.begin(); j != m_crls.end(); ++j) {
 624         if (j->stale(log, writelock ? nullptr : m_lock)) {
 625             writelock = true;
 626             try {
 627                 j->load(log);
 628                 updated = true;
 629             }
 630             catch (long& ex) {
 631                 if (ex == HTTPResponse::XMLTOOLING_HTTP_STATUS_NOTMODIFIED) {
 632                     log.info("remote CRL(s) (%s) unchanged from cached version", j->source.c_str());
 633                 }
 634                 else {
 635                     // Shouldn't happen, we should only get codes intended to be gracefully handled.
 636                     log.crit("maintaining existing CRL(s), remote fetch returned atypical status code (%d)", ex);
 637                 }
 638             }
 639             catch (exception& ex) {
 640                 log.crit("maintaining existing CRL(s): %s", ex.what());
 641             }
 642         }
 643     }
 644
 645     if (updated) {
 646         try {
 647             auto_ptr<Credential> credential(getCredential());
 648             delete m_credential;
 649             m_credential = credential.release();
 650         }
 651         catch (exception& ex) {
 652             log.crit("maintaining existing credentials, error reloading: %s", ex.what());
 653         }
 654     }
 655
 656     if (writelock) {
 657         m_lock->unlock();
 658         m_lock->rdlock();
 659     }
 660     return this;
 661 }
 662
 663 const Credential* FilesystemCredentialResolver::resolve(const CredentialCriteria* criteria) const
 664 {
 665     return (criteria ? (criteria->matches(*m_credential) ? m_credential : nullptr) : m_credential);
 666 }
 667
 668 vector<const Credential*>::size_type FilesystemCredentialResolver::resolve(
 669     vector<const Credential*>& results, const CredentialCriteria* criteria
 670     ) const
 671 {
 672     if (!criteria || criteria->matches(*m_credential)) {
 673         results.push_back(m_credential);
 674         return 1;
 675     }
 676     return 0;
 677 }
 678
 679 // OpenSSL password callback...
 680 static int passwd_callback(char* buf, int len, int verify, void* passwd)
 681 {
 682     if(!verify)
 683     {
 684         if(passwd && len > strlen(reinterpret_cast<char*>(passwd)))
 685         {
 686             strcpy(buf,reinterpret_cast<char*>(passwd));
 687             return strlen(buf);
 688         }
 689     }
 690     return 0;
 691 }
 692
 693 void FilesystemCredential::attach(SSL_CTX* ctx) const
 694 {
 695 #ifdef _DEBUG
 696     NDC ndc("attach");
 697 #endif
 698
 699     int ret=0;
 700     const char* path = m_resolver->m_key.local ? m_resolver->m_key.source.c_str() : m_resolver->m_key.backing.c_str();
 701     if (!path || !*path)
 702         throw XMLSecurityException("No key available, unable to attach private key to SSL context.");
 703
 704     if (!m_resolver->m_keypass.empty()) {
 705         SSL_CTX_set_default_passwd_cb(ctx, passwd_callback);
 706         SSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char*>(m_resolver->m_keypass.c_str()));
 707     }
 708
 709     if (m_resolver->m_key.format == "PEM") {
 710         ret=SSL_CTX_use_PrivateKey_file(ctx, path, SSL_FILETYPE_PEM);
 711     }
 712     else if (m_resolver->m_key.format == "DER") {
 713         ret=SSL_CTX_use_RSAPrivateKey_file(ctx, path, SSL_FILETYPE_ASN1);
 714     }
 715     else if (m_resolver->m_key.format == "PKCS12") {
 716         BIO* in=BIO_new(BIO_s_file_internal());
 717         if (in && BIO_read_filename(in,path)>0) {
 718             PKCS12* p12 = d2i_PKCS12_bio(in, nullptr);
 719             if (p12) {
 720                 EVP_PKEY* pkey=nullptr;
 721                 X509* x=nullptr;
 722                 PKCS12_parse(p12, const_cast<char*>(m_resolver->m_keypass.c_str()), &pkey, &x, nullptr);
 723                 PKCS12_free(p12);
 724                 if (x)
 725                     X509_free(x);
 726                 if (pkey) {
 727                     ret=SSL_CTX_use_PrivateKey(ctx, pkey);
 728                     EVP_PKEY_free(pkey);
 729                 }
 730             }
 731         }
 732         if (in)
 733             BIO_free(in);
 734     }
 735
 736     if (ret!=1) {
 737         log_openssl();
 738         throw XMLSecurityException("Unable to attach private key to SSL context.");
 739     }
 740
 741     // Attach certs.
 742     for (vector<XSECCryptoX509*>::const_iterator i=m_xseccerts.begin(); i!=m_xseccerts.end(); i++) {
 743         if (i==m_xseccerts.begin()) {
 744             if (SSL_CTX_use_certificate(ctx, static_cast<OpenSSLCryptoX509*>(*i)->getOpenSSLX509()) != 1) {
 745                 log_openssl();
 746                 throw XMLSecurityException("Unable to attach client certificate to SSL context.");
 747             }
 748         }
 749         else {
 750             // When we add certs, they don't get ref counted, so we need to duplicate them.
 751             X509* dup = X509_dup(static_cast<OpenSSLCryptoX509*>(*i)->getOpenSSLX509());
 752             if (SSL_CTX_add_extra_chain_cert(ctx, dup) != 1) {
 753                 X509_free(dup);
 754                 log_openssl();
 755                 throw XMLSecurityException("Unable to attach CA certificate to SSL context.");
 756             }
 757         }
 758     }
 759 }