fcdd747541e1781246992b6a42f77979a8a0a861
[shibboleth/cpp-xmltooling.git] / 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_usage(Credential::UNSPECIFIED_CREDENTIAL), m_extractNames(true)
316 {
317 #ifdef _DEBUG
318     NDC ndc("FilesystemCredentialResolver");
319 #endif
320     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".CredentialResolver."FILESYSTEM_CREDENTIAL_RESOLVER);
321
322     // Default to disable X509IssuerSerial due to schema validation issues.
323     m_keyinfomask = XMLHelper::getAttrInt(e,
324         Credential::KEYINFO_KEY_NAME |
325         Credential::KEYINFO_KEY_VALUE |
326         X509Credential::KEYINFO_X509_CERTIFICATE |
327         X509Credential::KEYINFO_X509_SUBJECTNAME,
328         keyInfoMask
329         );
330
331     if (e && (e->hasAttributeNS(nullptr,_certificate) || e->hasAttributeNS(nullptr,_key))) {
332         // Dummy up a simple file resolver config using these attributes.
333         DOMElement* dummy = e->getOwnerDocument()->createElementNS(nullptr,_CredentialResolver);
334         DOMElement* child;
335         DOMElement* path;
336         if (e->hasAttributeNS(nullptr,_key)) {
337             child = e->getOwnerDocument()->createElementNS(nullptr,Key);
338             dummy->appendChild(child);
339             path = e->getOwnerDocument()->createElementNS(nullptr,Path);
340             child->appendChild(path);
341             path->appendChild(e->getOwnerDocument()->createTextNode(e->getAttributeNS(nullptr,_key)));
342             if (e->hasAttributeNS(nullptr,password))
343                 child->setAttributeNS(nullptr,password,e->getAttributeNS(nullptr,password));
344             if (e->hasAttributeNS(nullptr,keyName)) {
345                 path = e->getOwnerDocument()->createElementNS(nullptr,Name);
346                 child->appendChild(path);
347                 path->appendChild(e->getOwnerDocument()->createTextNode(e->getAttributeNS(nullptr,keyName)));
348             }
349         }
350         if (e->hasAttributeNS(nullptr,_certificate)) {
351             child = e->getOwnerDocument()->createElementNS(nullptr,Certificate);
352             dummy->appendChild(child);
353             path = e->getOwnerDocument()->createElementNS(nullptr,Path);
354             child->appendChild(path);
355             path->appendChild(e->getOwnerDocument()->createTextNode(e->getAttributeNS(nullptr,_certificate)));
356             if (e->hasAttributeNS(nullptr, extractNames))
357                 child->setAttributeNS(nullptr, extractNames, e->getAttributeNS(nullptr, extractNames));
358         }
359         e = dummy;  // reset "root" to the dummy config element
360     }
361
362     const XMLCh* prop;
363     const DOMElement* root = e;
364
365     // Save off usage bits.
366     string usage = XMLHelper::getAttrString(root, nullptr, _use);
367     if (usage == "signing")
368         m_usage = Credential::SIGNING_CREDENTIAL | Credential::TLS_CREDENTIAL;
369     else if (usage == "TLS")
370         m_usage = Credential::TLS_CREDENTIAL;
371     else if (usage == "encryption")
372         m_usage = Credential::ENCRYPTION_CREDENTIAL;
373
374     // Move to Key.
375     const DOMElement* keynode = XMLHelper::getFirstChildElement(root,Key);
376     if (keynode) {
377         m_key.format = XMLHelper::getAttrString(keynode, nullptr, _format);
378         m_keypass = XMLHelper::getAttrString(keynode, nullptr, password);
379
380         if ((e=XMLHelper::getFirstChildElement(keynode,Path)) && e->hasChildNodes()) {
381             prop = e->getFirstChild()->getNodeValue();
382             auto_ptr_char kpath(prop);
383             m_key.source = kpath.get();
384             XMLToolingConfig::getConfig().getPathResolver()->resolve(m_key.source, PathResolver::XMLTOOLING_CFG_FILE);
385             m_key.local = true;
386             m_key.reloadChanges = XMLHelper::getAttrBool(e, true, _reloadChanges);
387         }
388         else if ((e=XMLHelper::getFirstChildElement(keynode,_URL)) && e->hasChildNodes()) {
389             prop = e->getFirstChild()->getNodeValue();
390             auto_ptr_char kpath(prop);
391             m_key.source = kpath.get();
392             m_key.local = false;
393             m_key.backing = XMLHelper::getAttrString(e, nullptr, backingFilePath);
394             if (m_key.backing.empty())
395                 throw XMLSecurityException("FilesystemCredentialResolver can't access key, backingFilePath missing from URL element.");
396             XMLToolingConfig::getConfig().getPathResolver()->resolve(m_key.backing, PathResolver::XMLTOOLING_RUN_FILE);
397             m_key.reloadInterval = XMLHelper::getAttrInt(e, 0, _reloadInterval);
398         }
399         else {
400             log.error("Path/URL element missing inside Key element");
401             throw XMLSecurityException("FilesystemCredentialResolver can't access key, no Path or URL element specified.");
402         }
403
404         e = XMLHelper::getFirstChildElement(keynode, Name);
405         while (e) {
406             if (e->hasChildNodes()) {
407                 auto_ptr_char n(e->getFirstChild()->getNodeValue());
408                 if (n.get() && *n.get())
409                     m_keynames.push_back(n.get());
410             }
411             e = XMLHelper::getNextSiblingElement(e, Name);
412         }
413     }
414
415     // Check for CRL.
416     const DOMElement* crlnode = XMLHelper::getFirstChildElement(root, CRL);
417     if (crlnode) {
418         string crlformat = XMLHelper::getAttrString(crlnode, nullptr, _format);
419         e = XMLHelper::getFirstChildElement(crlnode, Path);
420         while (e) {
421             if (e->hasChildNodes()) {
422                 m_crls.push_back(ManagedCRL());
423                 ManagedResource& crl = m_crls.back();
424                 crl.format = crlformat;
425                 prop = e->getFirstChild()->getNodeValue();
426                 auto_ptr_char crlpath(prop);
427                 crl.source = crlpath.get();
428                 XMLToolingConfig::getConfig().getPathResolver()->resolve(crl.source, PathResolver::XMLTOOLING_CFG_FILE);
429                 crl.local = true;
430                 crl.reloadChanges = XMLHelper::getAttrBool(e, true, _reloadChanges);
431             }
432             e = XMLHelper::getNextSiblingElement(e, Path);
433         }
434
435         e = XMLHelper::getFirstChildElement(crlnode, _URL);
436         while (e) {
437             if (e->hasChildNodes()) {
438                 m_crls.push_back(ManagedCRL());
439                 ManagedResource& crl = m_crls.back();
440                 crl.format = crlformat;
441                 prop = e->getFirstChild()->getNodeValue();
442                 auto_ptr_char crlpath(prop);
443                 crl.source = crlpath.get();
444                 crl.local = false;
445                 crl.backing = XMLHelper::getAttrString(e, nullptr, backingFilePath);
446                 if (crl.backing.empty())
447                     throw XMLSecurityException("FilesystemCredentialResolver can't access CRL, backingFilePath missing from URL element.");
448                 XMLToolingConfig::getConfig().getPathResolver()->resolve(crl.backing, PathResolver::XMLTOOLING_RUN_FILE);
449                 crl.reloadInterval = XMLHelper::getAttrInt(e, 0, _reloadInterval);
450             }
451             e = XMLHelper::getNextSiblingElement(e, _URL);
452         }
453         if (m_crls.empty()) {
454             log.error("Path/URL element missing inside CRL element");
455             throw XMLSecurityException("FilesystemCredentialResolver can't access CRL, no Path or URL element specified.");
456         }
457     }
458
459     // Check for Certificate
460     DOMElement* certnode = XMLHelper::getFirstChildElement(root,Certificate);
461     if (certnode) {
462         m_certpass = XMLHelper::getAttrString(certnode, nullptr, password);
463         string certformat = XMLHelper::getAttrString(certnode, nullptr, _format);
464         m_extractNames = XMLHelper::getAttrBool(certnode, true, extractNames);
465
466         e = XMLHelper::getFirstChildElement(certnode);
467         while (e) {
468             if (e->hasChildNodes() && (XMLString::equals(e->getLocalName(), Path) || XMLString::equals(e->getLocalName(), CAPath))) {
469                 m_certs.push_back(ManagedCert());
470                 ManagedResource& cert = m_certs.back();
471                 cert.format = certformat;
472                 prop = e->getFirstChild()->getNodeValue();
473                 auto_ptr_char certpath(prop);
474                 cert.source = certpath.get();
475                 XMLToolingConfig::getConfig().getPathResolver()->resolve(cert.source, PathResolver::XMLTOOLING_CFG_FILE);
476                 cert.local = true;
477                 cert.reloadChanges = XMLHelper::getAttrBool(e, true, _reloadChanges);
478             }
479             else if (e->hasChildNodes() && XMLString::equals(e->getLocalName(), _URL)) {
480                 m_certs.push_back(ManagedCert());
481                 ManagedResource& cert = m_certs.back();
482                 cert.format = certformat;
483                 prop = e->getFirstChild()->getNodeValue();
484                 auto_ptr_char certpath(prop);
485                 cert.source = certpath.get();
486                 cert.local = false;
487                 cert.backing = XMLHelper::getAttrString(e, nullptr, backingFilePath);
488                 if (cert.backing.empty())
489                     throw XMLSecurityException("FilesystemCredentialResolver can't access certificate, backingFilePath missing from URL element.");
490                 XMLToolingConfig::getConfig().getPathResolver()->resolve(cert.backing, PathResolver::XMLTOOLING_RUN_FILE);
491                 cert.reloadInterval = XMLHelper::getAttrInt(e, 0, _reloadInterval);
492             }
493             e = XMLHelper::getNextSiblingElement(e);
494         }
495         if (m_certs.empty()) {
496             log.error("Path/URL element missing inside Certificate element");
497             throw XMLSecurityException("FilesystemCredentialResolver can't access certificate, no Path or URL element specified.");
498         }
499     }
500
501     // Do an initial load of all the objects. If anything blows up here, whatever's
502     // been loaded should be freed during teardown of the embedded objects.
503     time_t now = time(nullptr);
504     m_key.filestamp = now;
505     m_key.load(log, m_keypass.c_str());
506     for (vector<ManagedCert>::iterator i = m_certs.begin(); i != m_certs.end(); ++i) {
507         i->load(log, (i==m_certs.begin()) ? m_certpass.c_str() : nullptr);
508         i->filestamp = now;
509     }
510     for (vector<ManagedCRL>::iterator j = m_crls.begin(); j != m_crls.end(); ++j) {
511         j->load(log);
512         j->filestamp = now;
513     }
514
515     // Load it all into a credential object and then create the lock.
516     auto_ptr<Credential> credential(getCredential());
517     m_lock = RWLock::create();
518     m_credential = credential.release();
519 }
520
521 FilesystemCredentialResolver::~FilesystemCredentialResolver()
522 {
523     delete m_credential;
524     delete m_lock;
525 }
526
527 Credential* FilesystemCredentialResolver::getCredential()
528 {
529     // First, verify that the key and certificate match.
530     if (m_key.key && !m_certs.empty()) {
531         auto_ptr<XSECCryptoKey> temp(m_certs.front().certs.front()->clonePublicKey());
532         if (!SecurityHelper::matches(*m_key.key, *temp.get()))
533             throw XMLSecurityException("FilesystemCredentialResolver given mismatched key/certificate, check for consistency.");
534     }
535
536     // We (unfortunately) need to duplicate all the objects and put them in one set of arrays
537     // in order to create the credential wrapper.
538     FilesystemCredential* credential=nullptr;
539     auto_ptr<XSECCryptoKey> xseckey(m_key.key ? m_key.key->clone() : nullptr);
540     vector<XSECCryptoX509*> xseccerts;
541     vector<XSECCryptoX509CRL*> xseccrls;
542     try {
543         for (vector<ManagedCert>::iterator i = m_certs.begin(); i != m_certs.end(); ++i) {
544             for (vector<XSECCryptoX509*>::const_iterator y = i->certs.begin(); y != i->certs.end(); ++y)
545                 xseccerts.push_back(new OpenSSLCryptoX509(static_cast<OpenSSLCryptoX509*>(*y)->getOpenSSLX509()));
546         }
547         for (vector<ManagedCRL>::iterator j = m_crls.begin(); j != m_crls.end(); ++j) {
548             for (vector<XSECCryptoX509CRL*>::const_iterator z = j->crls.begin(); z != j->crls.end(); ++z)
549                 xseccrls.push_back((*z)->clone());
550         }
551         credential = new FilesystemCredential(this, xseckey.get(), xseccerts, xseccrls);
552         xseckey.release();
553     }
554     catch (exception&) {
555         for_each(xseccerts.begin(), xseccerts.end(), xmltooling::cleanup<XSECCryptoX509>());
556         for_each(xseccrls.begin(), xseccrls.end(), xmltooling::cleanup<XSECCryptoX509CRL>());
557         throw;
558     }
559
560     // At this point the copies are owned by the credential.
561     try {
562         credential->initKeyInfo(m_keyinfomask);
563     }
564     catch (exception&) {
565         delete credential;
566         throw;
567     }
568
569     return credential;
570 }
571
572 Lockable* FilesystemCredentialResolver::lock()
573 {
574 #ifdef _DEBUG
575     NDC ndc("lock");
576 #endif
577     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".CredentialResolver."FILESYSTEM_CREDENTIAL_RESOLVER);
578
579     m_lock->rdlock();
580
581     // Check each managed resource while holding a read lock for staleness.
582     // If it comes back false, the lock is left as is, and the resource was stable.
583     // If it comes back true, the lock was elevated to a write lock, and the resource
584     // needs to be reloaded, and the credential replaced.
585     // Once a stale check comes back true, further checks leave the lock alone.
586
587     bool writelock = false, updated = false;
588
589     if (m_key.stale(log, m_lock)) {
590         writelock = true;
591         try {
592             m_key.load(log, m_keypass.c_str());
593             updated = true;
594         }
595         catch (long& ex) {
596             if (ex == HTTPResponse::XMLTOOLING_HTTP_STATUS_NOTMODIFIED) {
597                 log.info("remote key (%s) unchanged from cached version", m_key.source.c_str());
598             }
599             else {
600                 // Shouldn't happen, we should only get codes intended to be gracefully handled.
601                 log.crit("maintaining existing key, remote fetch returned atypical status code (%d)", ex);
602             }
603         }
604         catch (exception& ex) {
605             log.crit("maintaining existing key: %s", ex.what());
606         }
607     }
608
609     for (vector<ManagedCert>::iterator i = m_certs.begin(); i != m_certs.end(); ++i) {
610         if (i->stale(log, writelock ? nullptr : m_lock)) {
611             writelock = true;
612             try {
613                 i->load(log, (i==m_certs.begin()) ? m_certpass.c_str() : nullptr);
614                 updated = true;
615             }
616             catch (long& ex) {
617                 if (ex == HTTPResponse::XMLTOOLING_HTTP_STATUS_NOTMODIFIED) {
618                     log.info("remote certificate(s) (%s) unchanged from cached version", i->source.c_str());
619                 }
620                 else {
621                     // Shouldn't happen, we should only get codes intended to be gracefully handled.
622                     log.crit("maintaining existing certificate(s), remote fetch returned atypical status code (%d)", ex);
623                 }
624             }
625             catch (exception& ex) {
626                 log.crit("maintaining existing certificate(s): %s", ex.what());
627             }
628         }
629     }
630
631     for (vector<ManagedCRL>::iterator j = m_crls.begin(); j != m_crls.end(); ++j) {
632         if (j->stale(log, writelock ? nullptr : m_lock)) {
633             writelock = true;
634             try {
635                 j->load(log);
636                 updated = true;
637             }
638             catch (long& ex) {
639                 if (ex == HTTPResponse::XMLTOOLING_HTTP_STATUS_NOTMODIFIED) {
640                     log.info("remote CRL(s) (%s) unchanged from cached version", j->source.c_str());
641                 }
642                 else {
643                     // Shouldn't happen, we should only get codes intended to be gracefully handled.
644                     log.crit("maintaining existing CRL(s), remote fetch returned atypical status code (%d)", ex);
645                 }
646             }
647             catch (exception& ex) {
648                 log.crit("maintaining existing CRL(s): %s", ex.what());
649             }
650         }
651     }
652
653     if (updated) {
654         try {
655             auto_ptr<Credential> credential(getCredential());
656             delete m_credential;
657             m_credential = credential.release();
658         }
659         catch (exception& ex) {
660             log.crit("maintaining existing credentials, error reloading: %s", ex.what());
661         }
662     }
663
664     if (writelock) {
665         m_lock->unlock();
666         m_lock->rdlock();
667     }
668     return this;
669 }
670
671 const Credential* FilesystemCredentialResolver::resolve(const CredentialCriteria* criteria) const
672 {
673     return (criteria ? (criteria->matches(*m_credential) ? m_credential : nullptr) : m_credential);
674 }
675
676 vector<const Credential*>::size_type FilesystemCredentialResolver::resolve(
677     vector<const Credential*>& results, const CredentialCriteria* criteria
678     ) const
679 {
680     if (!criteria || criteria->matches(*m_credential)) {
681         results.push_back(m_credential);
682         return 1;
683     }
684     return 0;
685 }
686
687 // OpenSSL password callback...
688 static int passwd_callback(char* buf, int len, int verify, void* passwd)
689 {
690     if(!verify)
691     {
692         if(passwd && len > strlen(reinterpret_cast<char*>(passwd)))
693         {
694             strcpy(buf,reinterpret_cast<char*>(passwd));
695             return strlen(buf);
696         }
697     }
698     return 0;
699 }
700
701 void FilesystemCredential::attach(SSL_CTX* ctx) const
702 {
703 #ifdef _DEBUG
704     NDC ndc("attach");
705 #endif
706
707     int ret=0;
708     const char* path = m_resolver->m_key.local ? m_resolver->m_key.source.c_str() : m_resolver->m_key.backing.c_str();
709     if (!path || !*path)
710         throw XMLSecurityException("No key available, unable to attach private key to SSL context.");
711
712     if (!m_resolver->m_keypass.empty()) {
713         SSL_CTX_set_default_passwd_cb(ctx, passwd_callback);
714         SSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char*>(m_resolver->m_keypass.c_str()));
715     }
716
717     if (m_resolver->m_key.format == "PEM") {
718         ret=SSL_CTX_use_PrivateKey_file(ctx, path, SSL_FILETYPE_PEM);
719     }
720     else if (m_resolver->m_key.format == "DER") {
721         ret=SSL_CTX_use_RSAPrivateKey_file(ctx, path, SSL_FILETYPE_ASN1);
722     }
723     else if (m_resolver->m_key.format == "PKCS12") {
724         BIO* in=BIO_new(BIO_s_file_internal());
725         if (in && BIO_read_filename(in,path)>0) {
726             PKCS12* p12 = d2i_PKCS12_bio(in, nullptr);
727             if (p12) {
728                 EVP_PKEY* pkey=nullptr;
729                 X509* x=nullptr;
730                 PKCS12_parse(p12, const_cast<char*>(m_resolver->m_keypass.c_str()), &pkey, &x, nullptr);
731                 PKCS12_free(p12);
732                 if (x)
733                     X509_free(x);
734                 if (pkey) {
735                     ret=SSL_CTX_use_PrivateKey(ctx, pkey);
736                     EVP_PKEY_free(pkey);
737                 }
738             }
739         }
740         if (in)
741             BIO_free(in);
742     }
743
744     if (ret!=1) {
745         log_openssl();
746         throw XMLSecurityException("Unable to attach private key to SSL context.");
747     }
748
749     // Attach certs.
750     for (vector<XSECCryptoX509*>::const_iterator i=m_xseccerts.begin(); i!=m_xseccerts.end(); i++) {
751         if (i==m_xseccerts.begin()) {
752             if (SSL_CTX_use_certificate(ctx, static_cast<OpenSSLCryptoX509*>(*i)->getOpenSSLX509()) != 1) {
753                 log_openssl();
754                 throw XMLSecurityException("Unable to attach client certificate to SSL context.");
755             }
756         }
757         else {
758             // When we add certs, they don't get ref counted, so we need to duplicate them.
759             X509* dup = X509_dup(static_cast<OpenSSLCryptoX509*>(*i)->getOpenSSLX509());
760             if (SSL_CTX_add_extra_chain_cert(ctx, dup) != 1) {
761                 X509_free(dup);
762                 log_openssl();
763                 throw XMLSecurityException("Unable to attach CA certificate to SSL context.");
764             }
765         }
766     }
767 }