2 * Copyright 2001-2007 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * FilesystemCredentialResolver.cpp
20 * Supplies credentials from local files
25 #include "security/BasicX509Credential.h"
26 #include "security/CredentialCriteria.h"
27 #include "security/CredentialResolver.h"
28 #include "security/KeyInfoResolver.h"
29 #include "security/OpenSSLCredential.h"
30 #include "security/OpenSSLCryptoX509CRL.h"
32 #include "util/PathResolver.h"
33 #include "util/XMLHelper.h"
35 #include <sys/types.h>
37 #include <openssl/pkcs12.h>
38 #include <xercesc/util/XMLUniDefs.hpp>
39 #include <xsec/enc/OpenSSL/OpenSSLCryptoX509.hpp>
40 #include <xsec/enc/OpenSSL/OpenSSLCryptoKeyRSA.hpp>
41 #include <xsec/enc/OpenSSL/OpenSSLCryptoKeyDSA.hpp>
43 using namespace xmlsignature;
44 using namespace xmltooling::logging;
45 using namespace xmltooling;
48 // OpenSSL password callback...
49 static int passwd_callback(char* buf, int len, int verify, void* passwd)
53 if(passwd && len > strlen(reinterpret_cast<char*>(passwd)))
55 strcpy(buf,reinterpret_cast<char*>(passwd));
62 namespace xmltooling {
64 #if defined (_MSC_VER)
65 #pragma warning( push )
66 #pragma warning( disable : 4250 )
69 class XMLTOOL_DLLLOCAL FilesystemCredentialResolver;
70 class XMLTOOL_DLLLOCAL FilesystemCredential : public OpenSSLCredential, public BasicX509Credential
74 FilesystemCredentialResolver* resolver, XSECCryptoKey* key, const std::vector<XSECCryptoX509*>& xseccerts, XSECCryptoX509CRL* crl=NULL
75 ) : BasicX509Credential(key, xseccerts, crl), m_resolver(resolver), m_usage(UNSPECIFIED_CREDENTIAL) {
76 if (!m_xseccerts.empty())
77 extractNames(m_xseccerts.front(), m_keyNames);
80 virtual ~FilesystemCredential() {
83 unsigned int getUsage() const {
87 void setUsage(const XMLCh* usage) {
88 if (usage && *usage) {
89 auto_ptr_char u(usage);
90 if (!strcmp(u.get(), "signing"))
91 m_usage = SIGNING_CREDENTIAL | TLS_CREDENTIAL;
92 else if (!strcmp(u.get(), "TLS"))
93 m_usage = TLS_CREDENTIAL;
94 else if (!strcmp(u.get(), "encryption"))
95 m_usage = ENCRYPTION_CREDENTIAL;
99 void addKeyNames(const DOMElement* e);
101 void attach(SSL_CTX* ctx) const;
104 FilesystemCredentialResolver* m_resolver;
105 unsigned int m_usage;
108 #if defined (_MSC_VER)
109 #pragma warning( pop )
112 class XMLTOOL_DLLLOCAL FilesystemCredentialResolver : public CredentialResolver
115 FilesystemCredentialResolver(const DOMElement* e);
116 virtual ~FilesystemCredentialResolver() {
118 for_each(m_certs.begin(),m_certs.end(),X509_free);
121 Lockable* lock() { return this; }
124 const Credential* resolve(const CredentialCriteria* criteria=NULL) const {
125 return (criteria ? (criteria->matches(*m_credential) ? m_credential : NULL) : m_credential);
128 virtual vector<const Credential*>::size_type resolve(
129 vector<const Credential*>& results, const CredentialCriteria* criteria=NULL
131 if (!criteria || criteria->matches(*m_credential)) {
132 results.push_back(m_credential);
138 void attach(SSL_CTX* ctx) const;
141 XSECCryptoKey* loadKey();
142 XSECCryptoX509CRL* loadCRL();
144 enum format_t { PEM=SSL_FILETYPE_PEM, DER=SSL_FILETYPE_ASN1, _PKCS12, UNKNOWN };
146 format_t getEncodingFormat(BIO* in) const;
147 string formatToString(format_t format) const;
148 format_t xmlFormatToFormat(const XMLCh* format_xml) const;
150 format_t m_keyformat,m_crlformat;
151 string m_keypath,m_keypass,m_crlpath;
152 vector<X509*> m_certs;
153 FilesystemCredential* m_credential;
156 CredentialResolver* XMLTOOL_DLLLOCAL FilesystemCredentialResolverFactory(const DOMElement* const & e)
158 return new FilesystemCredentialResolver(e);
161 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);
162 static const XMLCh CAPath[] = UNICODE_LITERAL_6(C,A,P,a,t,h);
163 static const XMLCh Certificate[] = UNICODE_LITERAL_11(C,e,r,t,i,f,i,c,a,t,e);
164 static const XMLCh _certificate[] = UNICODE_LITERAL_11(c,e,r,t,i,f,i,c,a,t,e);
165 static const XMLCh CRL[] = UNICODE_LITERAL_3(C,R,L);
166 static const XMLCh format[] = UNICODE_LITERAL_6(f,o,r,m,a,t);
167 static const XMLCh Key[] = UNICODE_LITERAL_3(K,e,y);
168 static const XMLCh _key[] = UNICODE_LITERAL_3(k,e,y);
169 static const XMLCh Name[] = UNICODE_LITERAL_4(N,a,m,e);
170 static const XMLCh password[] = UNICODE_LITERAL_8(p,a,s,s,w,o,r,d);
171 static const XMLCh Path[] = UNICODE_LITERAL_4(P,a,t,h);
172 static const XMLCh _use[] = UNICODE_LITERAL_3(u,s,e);
175 FilesystemCredentialResolver::FilesystemCredentialResolver(const DOMElement* e) : m_credential(NULL)
178 NDC ndc("FilesystemCredentialResolver");
180 Category& log=Category::getInstance(XMLTOOLING_LOGCAT".CredentialResolver."FILESYSTEM_CREDENTIAL_RESOLVER);
182 if (e && (e->hasAttributeNS(NULL,_certificate) || e->hasAttributeNS(NULL,_key))) {
183 // Dummy up a simple file resolver config using these attributes.
184 DOMElement* dummy = e->getOwnerDocument()->createElementNS(NULL,_CredentialResolver);
187 if (e->hasAttributeNS(NULL,_key)) {
188 child = e->getOwnerDocument()->createElementNS(NULL,Key);
189 dummy->appendChild(child);
190 path = e->getOwnerDocument()->createElementNS(NULL,Path);
191 child->appendChild(path);
192 path->appendChild(e->getOwnerDocument()->createTextNode(e->getAttributeNS(NULL,_key)));
193 if (e->hasAttributeNS(NULL,password))
194 child->setAttributeNS(NULL,password,e->getAttributeNS(NULL,password));
196 if (e->hasAttributeNS(NULL,_certificate)) {
197 child = e->getOwnerDocument()->createElementNS(NULL,Certificate);
198 dummy->appendChild(child);
199 path = e->getOwnerDocument()->createElementNS(NULL,Path);
200 child->appendChild(path);
201 path->appendChild(e->getOwnerDocument()->createTextNode(e->getAttributeNS(NULL,_certificate)));
203 e = dummy; // reset "root" to the dummy config element
206 const DOMElement* root=e;
207 const XMLCh* usage = root->getAttributeNS(NULL,_use);
209 XSECCryptoKey* key=NULL;
210 vector<XSECCryptoX509*> xseccerts;
211 XSECCryptoX509CRL* crl=NULL;
214 const XMLCh* format_xml=NULL;
218 const DOMElement* keynode=XMLHelper::getFirstChildElement(root,Key);
220 // Get raw format attrib value, but defer processing til later since may need to
221 // determine format dynamically, and we need the Path for that.
222 format_xml=keynode->getAttributeNS(NULL,format);
224 const XMLCh* password_xml=keynode->getAttributeNS(NULL,password);
226 auto_ptr_char kp(password_xml);
230 e=XMLHelper::getFirstChildElement(keynode,Path);
231 if (e && e->hasChildNodes()) {
232 const XMLCh* s=e->getFirstChild()->getNodeValue();
233 auto_ptr_char kpath(s);
234 m_keypath = kpath.get();
235 XMLToolingConfig::getConfig().getPathResolver()->resolve(m_keypath, PathResolver::XMLTOOLING_CFG_FILE);
237 struct _stat stat_buf;
238 if (_stat(kpath.get(), &stat_buf) != 0)
240 struct stat stat_buf;
241 if (stat(kpath.get(), &stat_buf) != 0)
244 log.error("key file (%s) can't be opened", kpath.get());
245 throw XMLSecurityException("FilesystemCredentialResolver can't access key file ($1)",params(1,kpath.get()));
249 log.error("Path element missing inside Key element");
250 throw XMLSecurityException("FilesystemCredentialResolver can't access key file, no Path element specified.");
253 // Determine the key encoding format dynamically, if not explicitly specified
254 if (format_xml && *format_xml) {
255 fformat = xmlFormatToFormat(format_xml);
256 if (fformat != UNKNOWN) {
257 m_keyformat = fformat;
260 auto_ptr_char unknown(format_xml);
261 log.error("configuration specifies unknown key encoding format (%s)", unknown.get());
262 throw XMLSecurityException("FilesystemCredentialResolver configuration contains unknown key encoding format ($1)",params(1,unknown.get()));
266 in=BIO_new(BIO_s_file_internal());
267 if (in && BIO_read_filename(in,m_keypath.c_str())>0) {
268 m_keyformat = getEncodingFormat(in);
269 log.debug("key encoding format for (%s) dynamically resolved as (%s)", m_keypath.c_str(), formatToString(m_keyformat).c_str());
272 log.error("key file (%s) can't be read to determine encoding format", m_keypath.c_str());
273 throw XMLSecurityException("FilesystemCredentialResolver can't read key file ($1) to determine encoding format",params(1,m_keypath.c_str()));
285 const DOMElement* crlnode=XMLHelper::getFirstChildElement(root,CRL);
287 // Get raw format attrib value, but defer processing til later since may need to
288 // determine format dynamically, and we need the Path for that.
289 format_xml=crlnode->getAttributeNS(NULL,format);
291 e=XMLHelper::getFirstChildElement(crlnode,Path);
292 if (e && e->hasChildNodes()) {
293 const XMLCh* s=e->getFirstChild()->getNodeValue();
294 auto_ptr_char kpath(s);
295 m_crlpath=kpath.get();
296 XMLToolingConfig::getConfig().getPathResolver()->resolve(m_crlpath, PathResolver::XMLTOOLING_CFG_FILE);
298 struct _stat stat_buf;
299 if (_stat(kpath.get(), &stat_buf) != 0)
301 struct stat stat_buf;
302 if (stat(kpath.get(), &stat_buf) != 0)
305 log.error("CRL file (%s) can't be opened", kpath.get());
306 throw XMLSecurityException("FilesystemCredentialResolver can't access CRL file ($1)",params(1,kpath.get()));
310 log.error("Path element missing inside CRL element");
311 throw XMLSecurityException("FilesystemCredentialResolver can't access CRL file, no Path element specified.");
314 // Determine the CRL encoding format dynamically, if not explicitly specified
315 if (format_xml && *format_xml) {
316 fformat = xmlFormatToFormat(format_xml);
317 if (fformat != UNKNOWN) {
318 m_crlformat = fformat;
321 auto_ptr_char unknown(format_xml);
322 log.error("configuration specifies unknown CRL encoding format (%s)", unknown.get());
323 throw XMLSecurityException("FilesystemCredentialResolver configuration contains unknown CRL encoding format ($1)",params(1,unknown.get()));
327 in=BIO_new(BIO_s_file_internal());
328 if (in && BIO_read_filename(in,m_crlpath.c_str())>0) {
329 m_crlformat = getEncodingFormat(in);
330 log.debug("CRL encoding format for (%s) dynamically resolved as (%s)", m_crlpath.c_str(), formatToString(m_crlformat).c_str());
333 log.error("CRL file (%s) can't be read to determine encoding format", m_crlpath.c_str());
334 throw XMLSecurityException("FilesystemCredentialResolver can't read CRL file ($1) to determine encoding format",params(1,m_crlpath.c_str()));
345 // Check for Certificate
346 e=XMLHelper::getFirstChildElement(root,Certificate);
348 m_credential = new FilesystemCredential(this,key,xseccerts,crl);
349 m_credential->addKeyNames(keynode);
350 m_credential->setUsage(usage);
353 auto_ptr_char certpass(e->getAttributeNS(NULL,password));
355 const DOMElement* ep=XMLHelper::getFirstChildElement(e,Path);
356 if (!ep || !ep->hasChildNodes()) {
357 log.error("Path element missing inside Certificate element or is empty");
360 throw XMLSecurityException("FilesystemCredentialResolver can't access certificate file, missing or empty Path element.");
363 auto_ptr_char certpath2(ep->getFirstChild()->getNodeValue());
364 string certpath(certpath2.get());
365 XMLToolingConfig::getConfig().getPathResolver()->resolve(certpath, PathResolver::XMLTOOLING_CFG_FILE);
367 format_xml=e->getAttributeNS(NULL,format);
368 if (format_xml && *format_xml) {
369 fformat = xmlFormatToFormat(format_xml);
370 if (fformat == UNKNOWN) {
371 auto_ptr_char unknown(format_xml);
372 log.error("configuration specifies unknown certificate encoding format (%s)", unknown.get());
375 throw XMLSecurityException("FilesystemCredentialResolver configuration contains unknown certificate encoding format ($1)",params(1,unknown.get()));
382 in=BIO_new(BIO_s_file_internal());
383 if (in && BIO_read_filename(in,certpath.c_str())>0) {
384 if (!format_xml || !*format_xml) {
385 // Determine the cert encoding format dynamically, if not explicitly specified
386 fformat = getEncodingFormat(in);
387 log.debug("certificate encoding format for (%s) dynamically resolved as (%s)", certpath.c_str(), formatToString(fformat).c_str());
392 while (x=PEM_read_bio_X509(in,NULL,passwd_callback,const_cast<char*>(certpass.get())))
393 m_certs.push_back(x);
397 x=d2i_X509_bio(in,NULL);
399 m_certs.push_back(x);
403 throw XMLSecurityException("FilesystemCredentialResolver unable to load DER certificate from file ($1)",params(1,certpath.c_str()));
408 p12=d2i_PKCS12_bio(in,NULL);
410 PKCS12_parse(p12, certpass.get(), NULL, &x, NULL);
414 m_certs.push_back(x);
419 throw XMLSecurityException("FilesystemCredentialResolver unable to load PKCS12 certificate from file ($1)",params(1,certpath.c_str()));
430 throw XMLSecurityException("FilesystemCredentialResolver unable to load certificate(s) from file ($1)",params(1,certpath.c_str()));
438 throw XMLSecurityException("FilesystemCredentialResolver unable to load any certificate(s)");
440 // Load any extra CA files.
441 const DOMElement* extra=XMLHelper::getFirstChildElement(e,CAPath);
443 if (!extra->hasChildNodes()) {
444 log.warn("skipping empty CAPath element");
445 extra = XMLHelper::getNextSiblingElement(extra,CAPath);
448 auto_ptr_char capath2(extra->getFirstChild()->getNodeValue());
449 string capath(capath2.get());
450 XMLToolingConfig::getConfig().getPathResolver()->resolve(capath, PathResolver::XMLTOOLING_CFG_FILE);
453 in=BIO_new(BIO_s_file_internal());
454 if (in && BIO_read_filename(in,capath.c_str())>0) {
455 if (!format_xml || !*format_xml) {
456 // Determine the cert encoding format dynamically, if not explicitly specified
457 fformat = getEncodingFormat(in);
458 log.debug("CA certificate encoding format for (%s) dynamically resolved as (%s)", capath.c_str(), formatToString(fformat).c_str());
463 while (x=PEM_read_bio_X509(in,NULL,NULL,NULL))
464 m_certs.push_back(x);
468 x=d2i_X509_bio(in,NULL);
470 m_certs.push_back(x);
474 throw XMLSecurityException("FilesystemCredentialResolver unable to load DER CA certificate from file ($1)",params(1,capath.c_str()));
479 p12 = d2i_PKCS12_bio(in, NULL);
481 PKCS12_parse(p12, NULL, NULL, &x, NULL);
485 m_certs.push_back(x);
491 throw XMLSecurityException("FilesystemCredentialResolver unable to load PKCS12 CA certificate from file ($1)",params(1,capath.c_str()));
502 log.error("CA file (%s) can't be opened", capath.c_str());
503 throw XMLSecurityException("FilesystemCredentialResolver can't open CA file ($1)",params(1,capath.c_str()));
506 extra = XMLHelper::getNextSiblingElement(extra,CAPath);
509 catch (XMLToolingException&) {
512 for_each(m_certs.begin(), m_certs.end(), X509_free);
516 // Reflect certs over to XSEC form and wrap with credential object.
517 for (vector<X509*>::iterator j=m_certs.begin(); j!=m_certs.end(); j++)
518 xseccerts.push_back(new OpenSSLCryptoX509(*j));
519 if (!key && !xseccerts.empty())
520 key = xseccerts.front()->clonePublicKey();
521 m_credential = new FilesystemCredential(this, key, xseccerts, crl);
522 m_credential->addKeyNames(keynode);
523 m_credential->setUsage(usage);
526 XSECCryptoKey* FilesystemCredentialResolver::loadKey()
534 BIO* in=BIO_new(BIO_s_file_internal());
535 if (in && BIO_read_filename(in,m_keypath.c_str())>0) {
536 switch (m_keyformat) {
538 pkey=PEM_read_bio_PrivateKey(in, NULL, passwd_callback, const_cast<char*>(m_keypass.c_str()));
542 pkey=d2i_PrivateKey_bio(in, NULL);
546 PKCS12* p12 = d2i_PKCS12_bio(in, NULL);
548 PKCS12_parse(p12, const_cast<char*>(m_keypass.c_str()), &pkey, NULL, NULL);
557 // Now map it to an XSEC wrapper.
559 XSECCryptoKey* ret=NULL;
560 switch (pkey->type) {
562 ret=new OpenSSLCryptoKeyRSA(pkey);
566 ret=new OpenSSLCryptoKeyDSA(pkey);
570 Category::getInstance(XMLTOOLING_LOGCAT".CredentialResolver."FILESYSTEM_CREDENTIAL_RESOLVER).error("unsupported private key type");
578 throw XMLSecurityException("FilesystemCredentialResolver unable to load private key from file.");
581 XSECCryptoX509CRL* FilesystemCredentialResolver::loadCRL()
588 BIO* in=BIO_new(BIO_s_file_internal());
589 if (in && BIO_read_filename(in,m_crlpath.c_str())>0) {
590 switch (m_crlformat) {
592 crl=PEM_read_bio_X509_CRL(in, NULL, NULL, NULL);
596 crl=d2i_X509_CRL_bio(in, NULL);
603 // Now map it to an XSEC wrapper.
605 XSECCryptoX509CRL* ret=new OpenSSLCryptoX509CRL(crl);
611 throw XMLSecurityException("FilesystemCredentialResolver unable to load CRL from file.");
614 // Used to determine the encoding format of credentials files
615 // dynamically. Supports: PEM, DER, PKCS12.
616 FilesystemCredentialResolver::format_t FilesystemCredentialResolver::getEncodingFormat(BIO* in) const
621 const int READSIZE = 1;
627 if ( (mark = BIO_tell(in)) < 0 )
628 throw XMLSecurityException("getEncodingFormat: BIO_tell() can't get the file position");
629 if ( BIO_read(in, buf, READSIZE) <= 0 )
630 throw XMLSecurityException("getEncodingFormat: BIO_read() can't read from the stream");
631 if ( BIO_seek(in, mark) < 0 )
632 throw XMLSecurityException("getEncodingFormat: BIO_seek() can't reset the file position");
641 // This is a slight variation of the Java code by Chad La Joie.
643 // Check the first byte of the file. If it's some kind of
644 // DER-encoded structure (including PKCS12), it will begin with ASCII 048.
645 // Otherwise, assume it's PEM.
649 // Here we know it's DER-encoded, now try to parse it as a PKCS12
650 // ASN.1 structure. If it fails, must be another kind of DER-encoded
651 // key/cert structure. A little inefficient...but it works.
652 if ( (p12=d2i_PKCS12_bio(in,NULL)) == NULL ) {
659 if ( BIO_seek(in, mark) < 0 ) {
661 throw XMLSecurityException("getEncodingFormat: BIO_seek() can't reset the file position");
668 // Convert key/cert format_t types to a human-meaningful string for debug output
669 string FilesystemCredentialResolver::formatToString(format_t format) const
683 // Convert key/cert raw XML format attribute (XMLCh[]) to format_t type
684 FilesystemCredentialResolver::format_t FilesystemCredentialResolver::xmlFormatToFormat(const XMLCh* format_xml) const
686 static const XMLCh cPEM[] = UNICODE_LITERAL_3(P,E,M);
687 static const XMLCh cDER[] = UNICODE_LITERAL_3(D,E,R);
688 static const XMLCh cPKCS12[] = { chLatin_P, chLatin_K, chLatin_C, chLatin_S, chDigit_1, chDigit_2, chNull };
691 if (!XMLString::compareString(format_xml,cPEM))
693 else if (!XMLString::compareString(format_xml,cDER))
695 else if (!XMLString::compareString(format_xml,cPKCS12))
703 void FilesystemCredentialResolver::attach(SSL_CTX* ctx) const
709 if (m_keypath.empty())
710 throw XMLSecurityException("No key available, unable to attach private key to SSL context.");
713 SSL_CTX_set_default_passwd_cb(ctx, passwd_callback);
714 SSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char*>(m_keypass.c_str()));
717 switch (m_keyformat) {
719 ret=SSL_CTX_use_PrivateKey_file(ctx, m_keypath.c_str(), m_keyformat);
723 ret=SSL_CTX_use_RSAPrivateKey_file(ctx, m_keypath.c_str(), m_keyformat);
727 BIO* in=BIO_new(BIO_s_file_internal());
728 if (in && BIO_read_filename(in,m_keypath.c_str())>0) {
730 PKCS12* p12 = d2i_PKCS12_bio(in, NULL);
732 PKCS12_parse(p12, const_cast<char*>(m_keypass.c_str()), &pkey, NULL, NULL);
735 ret=SSL_CTX_use_PrivateKey(ctx, pkey);
747 throw XMLSecurityException("Unable to attach private key to SSL context.");
751 for (vector<X509*>::const_iterator i=m_certs.begin(); i!=m_certs.end(); i++) {
752 if (i==m_certs.begin()) {
753 if (SSL_CTX_use_certificate(ctx, *i) != 1) {
755 throw XMLSecurityException("Unable to attach client certificate to SSL context.");
759 // When we add certs, they don't get ref counted, so we need to duplicate them.
760 X509* dup = X509_dup(*i);
761 if (SSL_CTX_add_extra_chain_cert(ctx, dup) != 1) {
764 throw XMLSecurityException("Unable to attach CA certificate to SSL context.");
770 void FilesystemCredential::addKeyNames(const DOMElement* e)
772 e = e ? XMLHelper::getFirstChildElement(e, Name) : NULL;
774 if (e->hasChildNodes()) {
775 auto_ptr_char n(e->getFirstChild()->getNodeValue());
776 if (n.get() && *n.get())
777 m_keyNames.insert(n.get());
779 e = XMLHelper::getNextSiblingElement(e, Name);
783 void FilesystemCredential::attach(SSL_CTX* ctx) const
785 return m_resolver->attach(ctx);