2 * Licensed to the University Corporation for Advanced Internet
3 * Development, Inc. (UCAID) under one or more contributor license
4 * agreements. See the NOTICE file distributed with this work for
5 * additional information regarding copyright ownership.
7 * UCAID licenses this file to you under the Apache License,
8 * Version 2.0 (the "License"); you may not use this file except
9 * in compliance with the License. You may obtain a copy of the
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
17 * either express or implied. See the License for the specific
18 * language governing permissions and limitations under the License.
22 * InlineKeyResolver.cpp
24 * Resolves key information directly from recognized KeyInfo structures.
29 #include "security/BasicX509Credential.h"
30 #include "security/KeyInfoCredentialContext.h"
31 #include "security/KeyInfoResolver.h"
32 #include "security/SecurityHelper.h"
33 #include "security/XSECCryptoX509CRL.h"
34 #include "signature/KeyInfo.h"
35 #include "signature/Signature.h"
37 #include "util/Threads.h"
38 #include "util/XMLConstants.h"
39 #include "validation/ValidatorSuite.h"
41 #include <boost/iterator/indirect_iterator.hpp>
42 #include <xercesc/util/XMLUniDefs.hpp>
43 #include <xsec/dsig/DSIGKeyInfoX509.hpp>
44 #include <xsec/enc/XSECKeyInfoResolverDefault.hpp>
45 #include <xsec/enc/XSECCryptoX509.hpp>
46 #include <xsec/enc/XSECCryptoKeyRSA.hpp>
47 #include <xsec/enc/XSECCryptoKeyDSA.hpp>
48 #ifdef XMLTOOLING_XMLSEC_ECC
49 # include <xsec/enc/XSECCryptoKeyEC.hpp>
51 #include <xsec/enc/XSECCryptoException.hpp>
52 #include <xsec/framework/XSECException.hpp>
54 using namespace xmlsignature;
55 using namespace xmltooling::logging;
56 using namespace xmltooling;
57 using namespace xercesc;
58 using namespace boost;
61 namespace xmltooling {
63 class XMLTOOL_DLLLOCAL InlineCredential : public BasicX509Credential
66 InlineCredential(const KeyInfo* keyInfo=nullptr) : BasicX509Credential(keyInfo!=nullptr), m_credctx(new KeyInfoCredentialContext(keyInfo)) {}
67 InlineCredential(DSIGKeyInfoList* keyInfo) : BasicX509Credential(false), m_credctx(new KeyInfoCredentialContext(keyInfo)) {}
68 InlineCredential(KeyInfoCredentialContext* context) : BasicX509Credential(context->getKeyInfo()!=nullptr) {}
69 virtual ~InlineCredential() {}
71 XSECCryptoKey* getPrivateKey() const {
75 KeyInfo* getKeyInfo(bool compact=false) const {
76 KeyInfo* ret = m_credctx->getKeyInfo() ? m_credctx->getKeyInfo()->cloneKeyInfo() : nullptr;
79 ret->getRetrievalMethods().clear();
80 ret->getKeyInfoReferences().clear();
82 ret->getKeyValues().clear();
83 ret->getDEREncodedKeyValues().clear();
84 ret->getSPKIDatas().clear();
85 ret->getPGPDatas().clear();
86 ret->getUnknownXMLObjects().clear();
87 VectorOf(X509Data) x509Datas=ret->getX509Datas();
88 for (VectorOf(X509Data)::size_type pos = 0; pos < x509Datas.size();) {
89 x509Datas[pos]->getX509Certificates().clear();
90 x509Datas[pos]->getX509CRLs().clear();
91 x509Datas[pos]->getOCSPResponses().clear();
92 x509Datas[pos]->getUnknownXMLObjects().clear();
93 if (x509Datas[pos]->hasChildren())
96 x509Datas.erase(x509Datas.begin() + pos);
100 if (!ret->hasChildren()) {
107 const CredentialContext* getCredentalContext() const {
108 return m_credctx.get();
111 void setCredentialContext(KeyInfoCredentialContext* context) {
112 m_credctx.reset(context);
115 void resolve(const KeyInfo* keyInfo, int types=0, bool followRefs=false);
116 void resolve(DSIGKeyInfoList* keyInfo, int types=0, bool followRefs=false);
119 bool resolveCerts(const KeyInfo* keyInfo, bool followRefs=false);
120 bool resolveKey(const KeyInfo* keyInfo, bool followRefs=false);
121 bool resolveCRLs(const KeyInfo* keyInfo, bool followRefs=false);
123 auto_ptr<KeyInfoCredentialContext> m_credctx;
126 static const XMLCh keyInfoReferences[] = UNICODE_LITERAL_17(k,e,y,I,n,f,o,R,e,f,e,r,e,n,c,e,s);
128 class XMLTOOL_DLLLOCAL InlineKeyResolver : public KeyInfoResolver
131 InlineKeyResolver(const DOMElement* e)
132 : m_followRefs(XMLHelper::getAttrBool(e, false, keyInfoReferences)) {
135 virtual ~InlineKeyResolver() {}
137 Credential* resolve(const KeyInfo* keyInfo, int types=0) const {
141 types = Credential::RESOLVE_KEYS|X509Credential::RESOLVE_CERTS|X509Credential::RESOLVE_CRLS;
142 auto_ptr<InlineCredential> credential(new InlineCredential(keyInfo));
143 credential->resolve(keyInfo, types, m_followRefs);
144 return credential.release();
146 Credential* resolve(DSIGKeyInfoList* keyInfo, int types=0) const {
150 types = Credential::RESOLVE_KEYS|X509Credential::RESOLVE_CERTS|X509Credential::RESOLVE_CRLS;
151 auto_ptr<InlineCredential> credential(new InlineCredential(keyInfo));
152 credential->resolve(keyInfo, types, m_followRefs);
153 return credential.release();
155 Credential* resolve(KeyInfoCredentialContext* context, int types=0) const {
159 types = Credential::RESOLVE_KEYS|X509Credential::RESOLVE_CERTS|X509Credential::RESOLVE_CRLS;
160 auto_ptr<InlineCredential> credential(new InlineCredential(context));
161 if (context->getKeyInfo())
162 credential->resolve(context->getKeyInfo(), types, m_followRefs);
163 else if (context->getNativeKeyInfo())
164 credential->resolve(context->getNativeKeyInfo(), types, m_followRefs);
165 credential->setCredentialContext(context);
166 return credential.release();
173 KeyInfoResolver* XMLTOOL_DLLLOCAL InlineKeyInfoResolverFactory(const DOMElement* const & e)
175 return new InlineKeyResolver(e);
179 void InlineCredential::resolve(const KeyInfo* keyInfo, int types, bool followRefs)
185 if (types & X509Credential::RESOLVE_CERTS)
186 resolveCerts(keyInfo, followRefs);
188 if (types & Credential::RESOLVE_KEYS) {
189 if (types & X509Credential::RESOLVE_CERTS) {
190 // If we have a cert, just use it.
191 if (!m_xseccerts.empty())
192 m_key = m_xseccerts.front()->clonePublicKey();
194 resolveKey(keyInfo, followRefs);
196 // Otherwise try directly for a key and then go for certs if none is found.
197 else if (!resolveKey(keyInfo, followRefs) && resolveCerts(keyInfo, followRefs)) {
198 m_key = m_xseccerts.front()->clonePublicKey();
202 if (types & X509Credential::RESOLVE_CRLS)
203 resolveCRLs(keyInfo, followRefs);
207 const vector<KeyName*>& knames=keyInfo->getKeyNames();
208 for (indirect_iterator<vector<KeyName*>::const_iterator> kn_i = make_indirect_iterator(knames.begin());
209 kn_i != make_indirect_iterator(knames.end()); ++kn_i) {
213 m_keyNames.insert(kn);
217 const vector<X509Data*> datas=keyInfo->getX509Datas();
218 for (vector<X509Data*>::const_iterator x_i=datas.begin(); x_i!=datas.end(); ++x_i) {
219 const vector<X509SubjectName*> snames = const_cast<const X509Data*>(*x_i)->getX509SubjectNames();
220 for (vector<X509SubjectName*>::const_iterator sn_i = snames.begin(); sn_i!=snames.end(); ++sn_i) {
221 n = (*sn_i)->getName();
224 m_keyNames.insert(kn);
230 const vector<X509IssuerSerial*> inames = const_cast<const X509Data*>(*x_i)->getX509IssuerSerials();
231 if (!inames.empty()) {
232 const X509IssuerName* iname = inames.front()->getX509IssuerName();
234 kn = toUTF8(iname->getName());
240 const X509SerialNumber* ser = inames.front()->getX509SerialNumber();
242 auto_ptr_char sn(ser->getSerialNumber());
249 bool InlineCredential::resolveKey(const KeyInfo* keyInfo, bool followRefs)
251 Category& log = Category::getInstance(XMLTOOLING_LOGCAT".KeyInfoResolver."INLINE_KEYINFO_RESOLVER);
253 // Check for ds:KeyValue
254 const vector<KeyValue*>& keyValues = keyInfo->getKeyValues();
255 for (indirect_iterator<vector<KeyValue*>::const_iterator> i = make_indirect_iterator(keyValues.begin());
256 i != make_indirect_iterator(keyValues.end()); ++i) {
258 SchemaValidators.validate(*(i.base())); // see if it's a "valid" key
259 RSAKeyValue* rsakv = i->getRSAKeyValue();
261 log.debug("resolving ds:RSAKeyValue");
262 auto_ptr_char mod(rsakv->getModulus()->getValue());
263 auto_ptr_char exp(rsakv->getExponent()->getValue());
264 auto_ptr<XSECCryptoKeyRSA> rsa(XSECPlatformUtils::g_cryptoProvider->keyRSA());
265 rsa->loadPublicModulusBase64BigNums(mod.get(), strlen(mod.get()));
266 rsa->loadPublicExponentBase64BigNums(exp.get(), strlen(exp.get()));
267 m_key = rsa.release();
270 DSAKeyValue* dsakv = i->getDSAKeyValue();
272 log.debug("resolving ds:DSAKeyValue");
273 auto_ptr<XSECCryptoKeyDSA> dsa(XSECPlatformUtils::g_cryptoProvider->keyDSA());
274 auto_ptr_char y(dsakv->getY()->getValue());
275 dsa->loadYBase64BigNums(y.get(), strlen(y.get()));
277 auto_ptr_char p(dsakv->getP()->getValue());
278 dsa->loadPBase64BigNums(p.get(), strlen(p.get()));
281 auto_ptr_char q(dsakv->getQ()->getValue());
282 dsa->loadQBase64BigNums(q.get(), strlen(q.get()));
285 auto_ptr_char g(dsakv->getG()->getValue());
286 dsa->loadGBase64BigNums(g.get(), strlen(g.get()));
288 m_key = dsa.release();
291 #ifdef XMLTOOLING_XMLSEC_ECC
292 ECKeyValue* eckv = i->getECKeyValue();
293 if (eckv && eckv->getNamedCurve() && eckv->getPublicKey()) {
294 log.warn("resolving ds11:ECKeyValue");
295 auto_ptr<XSECCryptoKeyEC> ec(XSECPlatformUtils::g_cryptoProvider->keyEC());
296 auto_ptr_char uri(eckv->getNamedCurve()->getURI());
297 auto_ptr_char val(eckv->getPublicKey()->getValue());
298 if (uri.get() && val.get()) {
299 ec->loadPublicKeyBase64(uri.get(), val.get(), XMLString::stringLen(val.get()));
300 m_key = ec.release();
306 catch (ValidationException& ex) {
307 log.warn("skipping invalid ds:KeyValue (%s)", ex.what());
309 catch(XSECException& e) {
310 auto_ptr_char temp(e.getMsg());
311 log.error("caught XML-Security exception loading key: %s", temp.get());
313 catch(XSECCryptoException& e) {
314 log.error("caught XML-Security exception loading key: %s", e.getMsg());
318 // Check for ds11:DEREncodedKeyValue
319 const vector<DEREncodedKeyValue*>& derValues = keyInfo->getDEREncodedKeyValues();
320 for (indirect_iterator<vector<DEREncodedKeyValue*>::const_iterator> j = make_indirect_iterator(derValues.begin());
321 j != make_indirect_iterator(derValues.end()); ++j) {
322 log.debug("resolving ds11:DEREncodedKeyValue");
323 m_key = SecurityHelper::fromDEREncoding(j->getValue());
326 log.warn("failed to resolve ds11:DEREncodedKeyValue");
331 // Check for KeyInfoReference.
332 const XMLCh* fragID=nullptr;
333 const XMLObject* treeRoot=nullptr;
334 const vector<KeyInfoReference*>& refs = keyInfo->getKeyInfoReferences();
335 for (indirect_iterator<vector<KeyInfoReference*>::const_iterator> ref = make_indirect_iterator(refs.begin());
336 ref != make_indirect_iterator(refs.end()); ++ref) {
337 fragID = ref->getURI();
338 if (!fragID || *fragID != chPound || !*(fragID+1)) {
339 log.warn("skipping ds11:KeyInfoReference with an empty or non-local reference");
344 while (treeRoot->getParent())
345 treeRoot = treeRoot->getParent();
347 keyInfo = dynamic_cast<const KeyInfo*>(XMLHelper::getXMLObjectById(*treeRoot, fragID+1));
349 log.warn("skipping ds11:KeyInfoReference, local reference did not resolve to a ds:KeyInfo");
352 if (resolveKey(keyInfo, false))
360 bool InlineCredential::resolveCerts(const KeyInfo* keyInfo, bool followRefs)
362 Category& log = Category::getInstance(XMLTOOLING_LOGCAT".KeyInfoResolver."INLINE_KEYINFO_RESOLVER);
364 // Check for ds:X509Data
365 const vector<X509Data*>& x509Datas=keyInfo->getX509Datas();
366 for (vector<X509Data*>::const_iterator j = x509Datas.begin(); m_xseccerts.empty() && j != x509Datas.end(); ++j) {
367 const vector<X509Certificate*> x509Certs=const_cast<const X509Data*>(*j)->getX509Certificates();
368 for (indirect_iterator<vector<X509Certificate*>::const_iterator> k = make_indirect_iterator(x509Certs.begin());
369 k != make_indirect_iterator(x509Certs.end()); ++k) {
371 auto_ptr_char x(k->getValue());
373 log.warn("skipping empty ds:X509Certificate");
376 log.debug("resolving ds:X509Certificate");
377 auto_ptr<XSECCryptoX509> x509(XSECPlatformUtils::g_cryptoProvider->X509());
378 x509->loadX509Base64Bin(x.get(), strlen(x.get()));
379 m_xseccerts.push_back(x509.release());
382 catch(XSECException& e) {
383 auto_ptr_char temp(e.getMsg());
384 log.error("caught XML-Security exception loading certificate: %s", temp.get());
386 catch(XSECCryptoException& e) {
387 log.error("caught XML-Security exception loading certificate: %s", e.getMsg());
392 if (followRefs && m_xseccerts.empty()) {
393 // Check for KeyInfoReference.
394 const XMLCh* fragID=NULL;
395 const XMLObject* treeRoot=NULL;
396 const vector<KeyInfoReference*>& refs = keyInfo->getKeyInfoReferences();
397 for (indirect_iterator<vector<KeyInfoReference*>::const_iterator> ref = make_indirect_iterator(refs.begin());
398 ref != make_indirect_iterator(refs.end()); ++ref) {
399 fragID = ref->getURI();
400 if (!fragID || *fragID != chPound || !*(fragID+1)) {
401 log.warn("skipping ds11:KeyInfoReference with an empty or non-local reference");
406 while (treeRoot->getParent())
407 treeRoot = treeRoot->getParent();
409 keyInfo = dynamic_cast<const KeyInfo*>(XMLHelper::getXMLObjectById(*treeRoot, fragID+1));
411 log.warn("skipping ds11:KeyInfoReference, local reference did not resolve to a ds:KeyInfo");
414 if (resolveCerts(keyInfo, false))
420 log.debug("resolved %d certificate(s)", m_xseccerts.size());
421 return !m_xseccerts.empty();
424 bool InlineCredential::resolveCRLs(const KeyInfo* keyInfo, bool followRefs)
426 Category& log = Category::getInstance(XMLTOOLING_LOGCAT".KeyInfoResolver."INLINE_KEYINFO_RESOLVER);
428 // Check for ds:X509Data
429 const vector<X509Data*>& x509Datas=keyInfo->getX509Datas();
430 for (vector<X509Data*>::const_iterator j=x509Datas.begin(); j!=x509Datas.end(); ++j) {
431 const vector<X509CRL*> x509CRLs=const_cast<const X509Data*>(*j)->getX509CRLs();
432 for (indirect_iterator<vector<X509CRL*>::const_iterator> k = make_indirect_iterator(x509CRLs.begin());
433 k != make_indirect_iterator(x509CRLs.end()); ++k) {
435 auto_ptr_char x(k->getValue());
437 log.warn("skipping empty ds:X509CRL");
440 log.debug("resolving ds:X509CRL");
441 auto_ptr<XSECCryptoX509CRL> crl(XMLToolingConfig::getConfig().X509CRL());
442 crl->loadX509CRLBase64Bin(x.get(), strlen(x.get()));
443 m_crls.push_back(crl.release());
446 catch(XSECException& e) {
447 auto_ptr_char temp(e.getMsg());
448 log.error("caught XML-Security exception loading CRL: %s", temp.get());
450 catch(XSECCryptoException& e) {
451 log.error("caught XML-Security exception loading CRL: %s", e.getMsg());
456 if (followRefs && m_crls.empty()) {
457 // Check for KeyInfoReference.
458 const XMLCh* fragID=NULL;
459 const XMLObject* treeRoot=NULL;
460 const vector<KeyInfoReference*>& refs = keyInfo->getKeyInfoReferences();
461 for (indirect_iterator<vector<KeyInfoReference*>::const_iterator> ref = make_indirect_iterator(refs.begin());
462 ref != make_indirect_iterator(refs.end()); ++ref) {
463 fragID = ref->getURI();
464 if (!fragID || *fragID != chPound || !*(fragID+1)) {
465 log.warn("skipping ds11:KeyInfoReference with an empty or non-local reference");
470 while (treeRoot->getParent())
471 treeRoot = treeRoot->getParent();
473 keyInfo = dynamic_cast<const KeyInfo*>(XMLHelper::getXMLObjectById(*treeRoot, fragID+1));
475 log.warn("skipping ds11:KeyInfoReference, local reference did not resolve to a ds:KeyInfo");
478 if (resolveCRLs(keyInfo, false))
484 log.debug("resolved %d CRL(s)", m_crls.size());
485 return !m_crls.empty();
488 void InlineCredential::resolve(DSIGKeyInfoList* keyInfo, int types, bool followRefs)
494 if (types & Credential::RESOLVE_KEYS) {
495 // Default resolver handles RSA/DSAKeyValue and X509Certificate elements.
497 XSECKeyInfoResolverDefault def;
498 m_key = def.resolveKey(keyInfo);
500 catch(XSECException& e) {
501 auto_ptr_char temp(e.getMsg());
502 Category::getInstance(XMLTOOLING_LOGCAT".KeyResolver."INLINE_KEYINFO_RESOLVER).error("caught XML-Security exception loading certificate: %s", temp.get());
504 catch(XSECCryptoException& e) {
505 Category::getInstance(XMLTOOLING_LOGCAT".KeyResolver."INLINE_KEYINFO_RESOLVER).error("caught XML-Security exception loading certificate: %s", e.getMsg());
509 DSIGKeyInfoList::size_type sz = keyInfo->getSize();
511 if (types & X509Credential::RESOLVE_CERTS) {
512 for (DSIGKeyInfoList::size_type i=0; i<sz; ++i) {
513 if (keyInfo->item(i)->getKeyInfoType()==DSIGKeyInfo::KEYINFO_X509) {
514 DSIGKeyInfoX509* x509 = static_cast<DSIGKeyInfoX509*>(keyInfo->item(i));
515 int count = x509->getCertificateListSize();
517 for (int j=0; j<count; ++j)
518 m_xseccerts.push_back(x509->getCertificateCryptoItem(j));
525 if (types & X509Credential::RESOLVE_CRLS) {
526 for (DSIGKeyInfoList::size_type i=0; i<sz; ++i) {
527 if (keyInfo->item(i)->getKeyInfoType()==DSIGKeyInfo::KEYINFO_X509) {
528 #ifdef XMLTOOLING_XMLSEC_MULTIPLECRL
529 DSIGKeyInfoX509* x509 = static_cast<DSIGKeyInfoX509*>(keyInfo->item(i));
530 int count = x509->getX509CRLListSize();
531 for (int j=0; j<count; ++j) {
532 auto_ptr_char buf(x509->getX509CRLItem(j));
535 auto_ptr<XSECCryptoX509CRL> crlobj(XMLToolingConfig::getConfig().X509CRL());
536 crlobj->loadX509CRLBase64Bin(buf.get(), strlen(buf.get()));
537 m_crls.push_back(crlobj.release());
539 catch(XSECException& e) {
540 auto_ptr_char temp(e.getMsg());
541 Category::getInstance(XMLTOOLING_LOGCAT".KeyResolver."INLINE_KEYINFO_RESOLVER).error("caught XML-Security exception loading CRL: %s", temp.get());
543 catch(XSECCryptoException& e) {
544 Category::getInstance(XMLTOOLING_LOGCAT".KeyResolver."INLINE_KEYINFO_RESOLVER).error("caught XML-Security exception loading CRL: %s", e.getMsg());
549 // The current xmlsec API is limited to one CRL per KeyInfo.
550 // For now, I'm going to process the DOM directly.
551 DOMNode* x509Node = keyInfo->item(i)->getKeyInfoDOMNode();
552 DOMElement* crlElement = x509Node ? XMLHelper::getFirstChildElement(x509Node, xmlconstants::XMLSIG_NS, X509CRL::LOCAL_NAME) : nullptr;
554 if (crlElement->hasChildNodes()) {
555 auto_ptr_char buf(crlElement->getFirstChild()->getNodeValue());
558 auto_ptr<XSECCryptoX509CRL> crlobj(XMLToolingConfig::getConfig().X509CRL());
559 crlobj->loadX509CRLBase64Bin(buf.get(), strlen(buf.get()));
560 m_crls.push_back(crlobj.release());
562 catch(XSECException& e) {
563 auto_ptr_char temp(e.getMsg());
564 Category::getInstance(XMLTOOLING_LOGCAT".KeyResolver."INLINE_KEYINFO_RESOLVER).error("caught XML-Security exception loading CRL: %s", temp.get());
566 catch(XSECCryptoException& e) {
567 Category::getInstance(XMLTOOLING_LOGCAT".KeyResolver."INLINE_KEYINFO_RESOLVER).error("caught XML-Security exception loading CRL: %s", e.getMsg());
571 crlElement = XMLHelper::getNextSiblingElement(crlElement, xmlconstants::XMLSIG_NS, X509CRL::LOCAL_NAME);
581 for (size_t s=0; s<keyInfo->getSize(); s++) {
582 DSIGKeyInfo* dki = keyInfo->item(s);
586 m_keyNames.insert(kn);
587 if (dki->getKeyInfoType() == DSIGKeyInfo::KEYINFO_X509)
592 if (dki->getKeyInfoType() == DSIGKeyInfo::KEYINFO_X509) {
593 DSIGKeyInfoX509* kix = static_cast<DSIGKeyInfoX509*>(dki);
594 n = kix->getX509IssuerName();
600 n = kix->getX509IssuerSerialNumber();