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
24 #include "signature/KeyResolver.h"
25 #include "signature/OpenSSLCredentialResolver.h"
27 #include "util/XMLHelper.h"
29 #include <sys/types.h>
32 #include <openssl/pkcs12.h>
33 #include <log4cpp/Category.hh>
34 #include <xercesc/util/XMLUniDefs.hpp>
35 #include <xsec/enc/OpenSSL/OpenSSLCryptoX509.hpp>
36 #include <xsec/enc/OpenSSL/OpenSSLCryptoKeyRSA.hpp>
37 #include <xsec/enc/OpenSSL/OpenSSLCryptoKeyDSA.hpp>
39 using namespace xmlsignature;
40 using namespace xmltooling;
41 using namespace log4cpp;
44 // OpenSSL password callback...
45 static int passwd_callback(char* buf, int len, int verify, void* passwd)
49 if(passwd && len > strlen(reinterpret_cast<char*>(passwd)))
51 strcpy(buf,reinterpret_cast<char*>(passwd));
58 namespace xmlsignature {
59 class FilesystemCredentialResolver : public OpenSSLCredentialResolver, public KeyResolver
62 FilesystemCredentialResolver(const DOMElement* e);
63 virtual ~FilesystemCredentialResolver();
65 Lockable* lock() { return this; }
68 XSECCryptoKey* loadKey();
70 XSECCryptoKey* getKey() const { return m_key ? m_key->clone() : NULL; }
71 const vector<XSECCryptoX509*>& getCertificates() const { return m_xseccerts; }
72 void attach(SSL_CTX* ctx) const;
74 XSECCryptoKey* resolveKey(const KeyInfo* keyInfo) const { return m_key ? m_key->clone() : NULL; }
75 XSECCryptoKey* resolveKey(DSIGKeyInfoList* keyInfo) const { return m_key ? m_key->clone() : NULL; }
76 vector<XSECCryptoX509*>::size_type resolveCertificates(const KeyInfo* keyInfo, ResolvedCertificates& certs) const {
77 accessCertificates(certs).assign(m_xseccerts.begin(), m_xseccerts.end());
78 accessOwned(certs) = false;
79 return accessCertificates(certs).size();
81 vector<XSECCryptoX509*>::size_type resolveCertificates(DSIGKeyInfoList* keyInfo, ResolvedCertificates& certs) const {
82 accessCertificates(certs).assign(m_xseccerts.begin(), m_xseccerts.end());
83 accessOwned(certs) = false;
84 return accessCertificates(certs).size();
88 enum format_t { PEM=SSL_FILETYPE_PEM, DER=SSL_FILETYPE_ASN1, _PKCS12, UNKNOWN };
90 format_t getEncodingFormat(BIO* in) const;
91 string formatToString(format_t format) const;
92 format_t xmlFormatToFormat(const XMLCh* format_xml) const;
95 string m_keypath,m_keypass;
96 vector<X509*> m_certs;
97 vector<XSECCryptoX509*> m_xseccerts;
101 CredentialResolver* XMLTOOL_DLLLOCAL FilesystemCredentialResolverFactory(const DOMElement* const & e)
103 return new FilesystemCredentialResolver(e);
106 KeyResolver* XMLTOOL_DLLLOCAL FilesystemKeyResolverFactory(const DOMElement* const & e)
108 return new FilesystemCredentialResolver(e);
112 static const XMLCh CAPath[] = UNICODE_LITERAL_6(C,A,P,a,t,h);
113 static const XMLCh Certificate[] = UNICODE_LITERAL_11(C,e,r,t,i,f,i,c,a,t,e);
114 static const XMLCh format[] = UNICODE_LITERAL_6(f,o,r,m,a,t);
115 static const XMLCh Key[] = UNICODE_LITERAL_3(K,e,y);
116 static const XMLCh password[] = UNICODE_LITERAL_8(p,a,s,s,w,o,r,d);
117 static const XMLCh Path[] = UNICODE_LITERAL_4(P,a,t,h);
119 FilesystemCredentialResolver::FilesystemCredentialResolver(const DOMElement* e) : m_key(NULL)
122 NDC ndc("FilesystemCredentialResolver");
124 Category& log=Category::getInstance(XMLTOOLING_LOGCAT".CredentialResolver");
127 const XMLCh* format_xml=NULL;
131 const DOMElement* root=e;
132 e=XMLHelper::getFirstChildElement(root,Key);
135 // Get raw format attrib value, but defer processing til later since may need to
136 // determine format dynamically, and we need the Path for that.
137 format_xml=e->getAttributeNS(NULL,format);
139 const XMLCh* password_xml=e->getAttributeNS(NULL,password);
141 auto_ptr_char kp(password_xml);
145 e=XMLHelper::getFirstChildElement(e,Path);
146 if (e && e->hasChildNodes()) {
147 const XMLCh* s=e->getFirstChild()->getNodeValue();
148 auto_ptr_char kpath(s);
150 struct _stat stat_buf;
151 if (_stat(kpath.get(), &stat_buf) != 0)
153 struct stat stat_buf;
154 if (stat(kpath.get(), &stat_buf) != 0)
157 log.error("key file (%s) can't be opened", kpath.get());
158 throw XMLSecurityException("FilesystemCredentialResolver can't access key file ($1)",params(1,kpath.get()));
160 m_keypath=kpath.get();
163 log.error("Path element missing inside Key element");
164 throw XMLSecurityException("FilesystemCredentialResolver can't access key file, no Path element specified.");
167 // Determine the key encoding format dynamically, if not explicitly specified
168 if (format_xml && *format_xml) {
169 fformat = xmlFormatToFormat(format_xml);
170 if (fformat != UNKNOWN) {
171 m_keyformat = fformat;
174 auto_ptr_char unknown(format_xml);
175 log.error("configuration specifies unknown key encoding format (%s)", unknown.get());
176 throw XMLSecurityException("FilesystemCredentialResolver configuration contains unknown key encoding format ($1)",params(1,unknown.get()));
180 in=BIO_new(BIO_s_file_internal());
181 if (in && BIO_read_filename(in,m_keypath.c_str())>0) {
182 m_keyformat = getEncodingFormat(in);
183 log.debug("key encoding format for (%s) dynamically resolved as (%s)", m_keypath.c_str(), formatToString(m_keyformat).c_str());
186 log.error("key file (%s) can't be read to determine encoding format", m_keypath.c_str());
187 throw XMLSecurityException("FilesystemCredentialResolver can't read key file ($1) to determine encoding format",params(1,m_keypath.c_str()));
198 // Check for Certificate
199 e=XMLHelper::getFirstChildElement(root,Certificate);
202 auto_ptr_char certpass(e->getAttributeNS(NULL,password));
204 DOMElement* ep=XMLHelper::getFirstChildElement(e,Path);
205 if (!ep || !ep->hasChildNodes()) {
206 log.error("Path element missing inside Certificate element or is empty");
207 throw XMLSecurityException("FilesystemCredentialResolver can't access certificate file, missing or empty Path element.");
210 auto_ptr_char certpath(ep->getFirstChild()->getNodeValue());
211 format_xml=e->getAttributeNS(NULL,format);
212 if (format_xml && *format_xml) {
213 fformat = xmlFormatToFormat(format_xml);
214 if (fformat == UNKNOWN) {
215 auto_ptr_char unknown(format_xml);
216 log.error("configuration specifies unknown certificate encoding format (%s)", unknown.get());
217 throw XMLSecurityException("FilesystemCredentialResolver configuration contains unknown certificate encoding format ($1)",params(1,unknown.get()));
224 in=BIO_new(BIO_s_file_internal());
225 if (in && BIO_read_filename(in,certpath.get())>0) {
226 if (!format_xml || !*format_xml) {
227 // Determine the cert encoding format dynamically, if not explicitly specified
228 fformat = getEncodingFormat(in);
229 log.debug("certificate encoding format for (%s) dynamically resolved as (%s)", certpath.get(), formatToString(fformat).c_str());
234 while (x=PEM_read_bio_X509(in,NULL,passwd_callback,const_cast<char*>(certpass.get())))
235 m_certs.push_back(x);
239 x=d2i_X509_bio(in,NULL);
241 m_certs.push_back(x);
245 throw XMLSecurityException("FilesystemCredentialResolver unable to load DER certificate from file ($1)",params(1,certpath.get()));
250 p12=d2i_PKCS12_bio(in,NULL);
252 PKCS12_parse(p12, certpass.get(), NULL, &x, NULL);
256 m_certs.push_back(x);
261 throw XMLSecurityException("FilesystemCredentialResolver unable to load PKCS12 certificate from file ($1)",params(1,certpath.get()));
272 throw XMLSecurityException("FilesystemCredentialResolver unable to load certificate(s) from file ($1)",params(1,certpath.get()));
279 if (m_certs.empty()) {
280 throw XMLSecurityException("FilesystemCredentialResolver unable to load any certificate(s)");
283 // Load any extra CA files.
284 DOMElement* extra=XMLHelper::getFirstChildElement(e,CAPath);
286 if (!extra->hasChildNodes()) {
287 log.warn("skipping empty CAPath element");
288 extra = XMLHelper::getNextSiblingElement(extra,CAPath);
291 auto_ptr_char capath(extra->getFirstChild()->getNodeValue());
294 in=BIO_new(BIO_s_file_internal());
295 if (in && BIO_read_filename(in,capath.get())>0) {
296 if (!format_xml || !*format_xml) {
297 // Determine the cert encoding format dynamically, if not explicitly specified
298 fformat = getEncodingFormat(in);
299 log.debug("CA certificate encoding format for (%s) dynamically resolved as (%s)", certpath.get(), formatToString(fformat).c_str());
304 while (x=PEM_read_bio_X509(in,NULL,passwd_callback,const_cast<char*>(certpass.get())))
305 m_certs.push_back(x);
309 x=d2i_X509_bio(in,NULL);
311 m_certs.push_back(x);
315 throw XMLSecurityException("FilesystemCredentialResolver unable to load DER CA certificate from file ($1)",params(1,capath.get()));
320 p12 = d2i_PKCS12_bio(in, NULL);
322 PKCS12_parse(p12, certpass.get(), NULL, &x, NULL);
326 m_certs.push_back(x);
332 throw XMLSecurityException("FilesystemCredentialResolver unable to load PKCS12 CA certificate from file ($1)",params(1,capath.get()));
343 log.error("CA file (%s) can't be opened", capath.get());
344 throw XMLSecurityException("FilesystemCredentialResolver can't open CA file ($1)",params(1,capath.get()));
347 extra = XMLHelper::getNextSiblingElement(extra,CAPath);
350 catch (XMLToolingException&) {
351 for (vector<X509*>::iterator j=m_certs.begin(); j!=m_certs.end(); j++)
356 // Reflect certs over to XSEC form.
357 for (vector<X509*>::iterator j=m_certs.begin(); j!=m_certs.end(); j++)
358 m_xseccerts.push_back(new OpenSSLCryptoX509(*j));
361 XSECCryptoKey* FilesystemCredentialResolver::loadKey()
369 BIO* in=BIO_new(BIO_s_file_internal());
370 if (in && BIO_read_filename(in,m_keypath.c_str())>0) {
371 switch (m_keyformat) {
373 pkey=PEM_read_bio_PrivateKey(in, NULL, passwd_callback, const_cast<char*>(m_keypass.c_str()));
377 pkey=d2i_PrivateKey_bio(in, NULL);
381 PKCS12* p12 = d2i_PKCS12_bio(in, NULL);
383 PKCS12_parse(p12, const_cast<char*>(m_keypass.c_str()), &pkey, NULL, NULL);
392 // Now map it to an XSEC wrapper.
394 XSECCryptoKey* ret=NULL;
395 switch (pkey->type) {
397 ret=new OpenSSLCryptoKeyRSA(pkey);
401 ret=new OpenSSLCryptoKeyDSA(pkey);
405 Category::getInstance(XMLTOOLING_LOGCAT".CredentialResolver").error("unsupported private key type");
413 throw XMLSecurityException("FilesystemCredentialResolver unable to load private key from file.");
416 FilesystemCredentialResolver::~FilesystemCredentialResolver()
419 for_each(m_certs.begin(),m_certs.end(),X509_free);
420 for_each(m_xseccerts.begin(),m_xseccerts.end(),xmltooling::cleanup<XSECCryptoX509>());
423 void FilesystemCredentialResolver::attach(SSL_CTX* ctx) const
430 SSL_CTX_set_default_passwd_cb(ctx, passwd_callback);
431 SSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char*>(m_keypass.c_str()));
434 switch (m_keyformat) {
436 ret=SSL_CTX_use_PrivateKey_file(ctx, m_keypath.c_str(), m_keyformat);
440 ret=SSL_CTX_use_RSAPrivateKey_file(ctx, m_keypath.c_str(), m_keyformat);
444 BIO* in=BIO_new(BIO_s_file_internal());
445 if (in && BIO_read_filename(in,m_keypath.c_str())>0) {
447 PKCS12* p12 = d2i_PKCS12_bio(in, NULL);
449 PKCS12_parse(p12, const_cast<char*>(m_keypass.c_str()), &pkey, NULL, NULL);
452 ret=SSL_CTX_use_PrivateKey(ctx, pkey);
464 throw XMLSecurityException("Unable to attach private key to SSL context.");
468 for (vector<X509*>::const_iterator i=m_certs.begin(); i!=m_certs.end(); i++) {
469 if (i==m_certs.begin()) {
470 if (SSL_CTX_use_certificate(ctx, *i) != 1) {
472 throw XMLSecurityException("Unable to attach client certificate to SSL context.");
476 // When we add certs, they don't get ref counted, so we need to duplicate them.
477 X509* dup = X509_dup(*i);
478 if (SSL_CTX_add_extra_chain_cert(ctx, dup) != 1) {
481 throw XMLSecurityException("Unable to attach CA certificate to SSL context.");
487 // Used to determine the encoding format of credentials files
488 // dynamically. Supports: PEM, DER, PKCS12.
489 FilesystemCredentialResolver::format_t FilesystemCredentialResolver::getEncodingFormat(BIO* in) const
494 const int READSIZE = 1;
500 if ( (mark = BIO_tell(in)) < 0 )
501 throw XMLSecurityException("getEncodingFormat: BIO_tell() can't get the file position");
502 if ( BIO_read(in, buf, READSIZE) <= 0 )
503 throw XMLSecurityException("getEncodingFormat: BIO_read() can't read from the stream");
504 if ( BIO_seek(in, mark) < 0 )
505 throw XMLSecurityException("getEncodingFormat: BIO_seek() can't reset the file position");
514 // This is a slight variation of the Java code by Chad La Joie.
516 // Check the first byte of the file. If it's some kind of
517 // DER-encoded structure (including PKCS12), it will begin with ASCII 048.
518 // Otherwise, assume it's PEM.
522 // Here we know it's DER-encoded, now try to parse it as a PKCS12
523 // ASN.1 structure. If it fails, must be another kind of DER-encoded
524 // key/cert structure. A little inefficient...but it works.
525 if ( (p12=d2i_PKCS12_bio(in,NULL)) == NULL ) {
532 if ( BIO_seek(in, mark) < 0 ) {
534 throw XMLSecurityException("getEncodingFormat: BIO_seek() can't reset the file position");
541 // Convert key/cert format_t types to a human-meaningful string for debug output
542 string FilesystemCredentialResolver::formatToString(format_t format) const
556 // Convert key/cert raw XML format attribute (XMLCh[]) to format_t type
557 FilesystemCredentialResolver::format_t FilesystemCredentialResolver::xmlFormatToFormat(const XMLCh* format_xml) const
559 static const XMLCh cPEM[] = UNICODE_LITERAL_3(P,E,M);
560 static const XMLCh cDER[] = UNICODE_LITERAL_3(D,E,R);
561 static const XMLCh cPKCS12[] = { chLatin_P, chLatin_K, chLatin_C, chLatin_S, chDigit_1, chDigit_2, chNull };
564 if (!XMLString::compareString(format_xml,cPEM))
566 else if (!XMLString::compareString(format_xml,cDER))
568 else if (!XMLString::compareString(format_xml,cPKCS12))