2 * Copyright 2001-2006 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 * XMLSecSignatureImpl.cpp
20 * Signature class for XMLSec-based signature-handling
24 #include "exceptions.h"
25 #include "impl/UnknownElement.h"
26 #include "signature/KeyInfo.h"
27 #include "signature/Signature.h"
29 #include "util/XMLConstants.h"
30 #include "util/XMLHelper.h"
32 #include <log4cpp/Category.hh>
33 #include <xercesc/framework/MemBufInputSource.hpp>
34 #include <xercesc/framework/Wrapper4InputSource.hpp>
35 #include <xercesc/util/XMLUniDefs.hpp>
36 #include <xsec/dsig/DSIGKeyInfoX509.hpp>
37 #include <xsec/dsig/DSIGReference.hpp>
38 #include <xsec/enc/XSECCryptoException.hpp>
39 #include <xsec/framework/XSECException.hpp>
41 using namespace xmlsignature;
42 using namespace xmltooling;
43 using namespace log4cpp;
46 #if defined (_MSC_VER)
47 #pragma warning( push )
48 #pragma warning( disable : 4250 4251 )
51 namespace xmlsignature {
53 class XMLTOOL_DLLLOCAL XMLSecSignatureImpl : public UnknownElementImpl, public virtual Signature
56 XMLSecSignatureImpl() : UnknownElementImpl(XMLConstants::XMLSIG_NS, Signature::LOCAL_NAME, XMLConstants::XMLSIG_PREFIX),
57 m_signature(NULL), m_c14n(NULL), m_sm(NULL), m_key(NULL), m_keyInfo(NULL), m_reference(NULL) {}
58 virtual ~XMLSecSignatureImpl();
60 void releaseDOM() const;
61 void releaseChildrenDOM(bool propagateRelease=true) const {
63 m_keyInfo->releaseDOM();
65 m_keyInfo->releaseChildrenDOM();
68 XMLObject* clone() const;
69 Signature* cloneSignature() const;
71 DOMElement* marshall(DOMDocument* document=NULL, const vector<Signature*>* sigs=NULL) const;
72 DOMElement* marshall(DOMElement* parentElement, const vector<Signature*>* sigs=NULL) const;
73 XMLObject* unmarshall(DOMElement* element, bool bindDocument=false);
76 const XMLCh* getCanonicalizationMethod() const { return m_c14n ? m_c14n : DSIGConstants::s_unicodeStrURIEXC_C14N_NOC; }
77 const XMLCh* getSignatureAlgorithm() const { return m_sm ? m_sm : DSIGConstants::s_unicodeStrURIRSA_SHA1; }
78 KeyInfo* getKeyInfo() const { return m_keyInfo; }
79 ContentReference* getContentReference() const { return m_reference; }
80 DSIGSignature* getXMLSignature() const { return m_signature; }
83 void setCanonicalizationMethod(const XMLCh* c14n) { m_c14n = prepareForAssignment(m_c14n,c14n); }
84 void setSignatureAlgorithm(const XMLCh* sm) { m_sm = prepareForAssignment(m_sm,sm); }
85 void setSigningKey(XSECCryptoKey* signingKey) {
89 void setKeyInfo(KeyInfo* keyInfo) {
90 prepareForAssignment(m_keyInfo, keyInfo);
93 void setContentReference(ContentReference* reference) {
95 m_reference=reference;
101 mutable DSIGSignature* m_signature;
104 XSECCryptoKey* m_key;
106 ContentReference* m_reference;
111 #if defined (_MSC_VER)
112 #pragma warning( pop )
115 XMLSecSignatureImpl::~XMLSecSignatureImpl()
117 // Release the associated signature.
119 XMLToolingInternalConfig::getInternalConfig().m_xsecProvider->releaseSignature(m_signature);
121 XMLString::release(&m_c14n);
122 XMLString::release(&m_sm);
128 void XMLSecSignatureImpl::releaseDOM() const
131 // This should save off the DOM
132 UnknownElementImpl::releaseDOM();
134 // Release the associated signature.
136 XMLToolingInternalConfig::getInternalConfig().m_xsecProvider->releaseSignature(m_signature);
142 XMLObject* XMLSecSignatureImpl::clone() const
144 return cloneSignature();
147 Signature* XMLSecSignatureImpl::cloneSignature() const
149 XMLSecSignatureImpl* ret=new XMLSecSignatureImpl();
151 ret->m_c14n=XMLString::replicate(m_c14n);
152 ret->m_sm=XMLString::replicate(m_sm);
154 ret->m_key=m_key->clone();
156 ret->m_keyInfo=m_keyInfo->cloneKeyInfo();
158 // If there's no XML locally, serialize this object into the new one, otherwise just copy it over.
160 serialize(ret->m_xml);
167 void XMLSecSignatureImpl::sign()
169 Category& log=Category::getInstance(XMLTOOLING_LOGCAT".Signature");
170 log.debug("applying signature");
173 throw SignatureException("Only a marshalled Signature object can be signed.");
175 throw SignatureException("No signing key available for signature creation.");
176 else if (!m_reference)
177 throw SignatureException("No ContentReference object set for signature creation.");
180 log.debug("creating signature reference(s)");
181 DSIGReferenceList* refs = m_signature->getReferenceList();
182 while (refs && refs->getSize())
183 delete refs->removeReference(0);
184 m_reference->createReferences(m_signature);
186 log.debug("computing signature");
187 m_signature->setSigningKey(m_key->clone());
190 catch(XSECException& e) {
191 auto_ptr_char temp(e.getMsg());
192 throw SignatureException(string("Caught an XMLSecurity exception while signing: ") + temp.get());
194 catch(XSECCryptoException& e) {
195 throw SignatureException(string("Caught an XMLSecurity exception while signing: ") + e.getMsg());
199 DOMElement* XMLSecSignatureImpl::marshall(DOMDocument* document, const vector<Signature*>* sigs) const
202 xmltooling::NDC ndc("marshall");
205 Category& log=Category::getInstance(XMLTOOLING_LOGCAT".Signature");
206 log.debug("marshalling ds:Signature");
208 DOMElement* cachedDOM=getDOM();
210 if (!document || document==cachedDOM->getOwnerDocument()) {
211 log.debug("Signature has a usable cached DOM, reusing it");
213 setDocumentElement(cachedDOM->getOwnerDocument(),cachedDOM);
214 releaseParentDOM(true);
218 // We have a DOM but it doesn't match the document we were given. This both sucks and blows.
219 // Without an adoptNode option to maintain the child pointers, we have to either import the
220 // DOM while somehow reassigning all the nested references (which amounts to a complete
221 // *unmarshall* operation), or we just release the existing DOM and hope that we can get
222 // it back. This depends on all objects being able to preserve their DOM at all costs.
223 releaseChildrenDOM(true);
227 // If we get here, we didn't have a usable DOM.
228 bool bindDocument=false;
230 // Fresh signature, so we just create an empty one.
231 log.debug("creating empty Signature element");
233 document=DOMImplementationRegistry::getDOMImplementation(NULL)->createDocument();
236 m_signature=XMLToolingInternalConfig::getInternalConfig().m_xsecProvider->newSignature();
237 m_signature->setDSIGNSPrefix(XMLConstants::XMLSIG_PREFIX);
238 cachedDOM=m_signature->createBlankSignature(document, getCanonicalizationMethod(), getSignatureAlgorithm());
241 // We need to reparse the XML we saved off into a new DOM.
242 MemBufInputSource src(reinterpret_cast<const XMLByte*>(m_xml.c_str()),m_xml.length(),"XMLSecSignatureImpl");
243 Wrapper4InputSource dsrc(&src,false);
244 log.debug("parsing Signature XML back into DOM tree");
245 DOMDocument* internalDoc=XMLToolingConfig::getConfig().getParser().parse(dsrc);
247 // The caller insists on using his own document, so we now have to import the thing
248 // into it. Then we're just dumping the one we built.
249 log.debug("reimporting new DOM into caller-supplied document");
250 cachedDOM=static_cast<DOMElement*>(document->importNode(internalDoc->getDocumentElement(), true));
251 internalDoc->release();
254 // We just bind the document we built to the object as the result.
255 cachedDOM=static_cast<DOMElement*>(internalDoc->getDocumentElement());
256 document=internalDoc;
260 // Now reload the signature from the DOM.
262 m_signature=XMLToolingInternalConfig::getInternalConfig().m_xsecProvider->newSignatureFromDOM(
267 catch(XSECException& e) {
270 auto_ptr_char temp(e.getMsg());
271 throw MarshallingException(string("Caught an XMLSecurity exception while loading signature: ") + temp.get());
273 catch(XSECCryptoException& e) {
276 throw MarshallingException(string("Caught an XMLSecurity exception while loading signature: ") + e.getMsg());
280 // Marshall KeyInfo data.
281 if (m_keyInfo && (!m_signature->getKeyInfoList() || m_signature->getKeyInfoList()->isEmpty())) {
282 m_keyInfo->marshall(cachedDOM);
285 // Recache the DOM and clear the serialized copy.
286 setDocumentElement(document, cachedDOM);
287 log.debug("caching DOM for Signature (document is %sbound)", bindDocument ? "" : "not ");
288 setDOM(cachedDOM, bindDocument);
289 releaseParentDOM(true);
294 DOMElement* XMLSecSignatureImpl::marshall(DOMElement* parentElement, const vector<Signature*>* sigs) const
297 xmltooling::NDC ndc("marshall");
300 Category& log=Category::getInstance(XMLTOOLING_LOGCAT".Signature");
301 log.debug("marshalling ds:Signature");
303 DOMElement* cachedDOM=getDOM();
305 if (parentElement->getOwnerDocument()==cachedDOM->getOwnerDocument()) {
306 log.debug("Signature has a usable cached DOM, reusing it");
307 if (parentElement!=cachedDOM->getParentNode()) {
308 parentElement->appendChild(cachedDOM);
309 releaseParentDOM(true);
314 // We have a DOM but it doesn't match the document we were given. This both sucks and blows.
315 // Without an adoptNode option to maintain the child pointers, we have to either import the
316 // DOM while somehow reassigning all the nested references (which amounts to a complete
317 // *unmarshall* operation), or we just release the existing DOM and hope that we can get
318 // it back. This depends on all objects being able to preserve their DOM at all costs.
319 releaseChildrenDOM(true);
323 // If we get here, we didn't have a usable DOM.
325 // Fresh signature, so we just create an empty one.
326 log.debug("creating empty Signature element");
327 m_signature=XMLToolingInternalConfig::getInternalConfig().m_xsecProvider->newSignature();
328 m_signature->setDSIGNSPrefix(XMLConstants::XMLSIG_PREFIX);
329 cachedDOM=m_signature->createBlankSignature(
330 parentElement->getOwnerDocument(), getCanonicalizationMethod(), getSignatureAlgorithm()
334 MemBufInputSource src(reinterpret_cast<const XMLByte*>(m_xml.c_str()),m_xml.length(),"XMLSecSignatureImpl");
335 Wrapper4InputSource dsrc(&src,false);
336 log.debug("parsing XML back into DOM tree");
337 DOMDocument* internalDoc=XMLToolingConfig::getConfig().getParser().parse(dsrc);
339 log.debug("reimporting new DOM into caller-supplied document");
340 cachedDOM=static_cast<DOMElement*>(parentElement->getOwnerDocument()->importNode(internalDoc->getDocumentElement(),true));
341 internalDoc->release();
343 // Now reload the signature from the DOM.
345 m_signature=XMLToolingInternalConfig::getInternalConfig().m_xsecProvider->newSignatureFromDOM(
346 parentElement->getOwnerDocument(), cachedDOM
350 catch(XSECException& e) {
351 auto_ptr_char temp(e.getMsg());
352 throw MarshallingException(string("Caught an XMLSecurity exception while loading signature: ") + temp.get());
354 catch(XSECCryptoException& e) {
355 throw MarshallingException(string("Caught an XMLSecurity exception while loading signature: ") + e.getMsg());
359 // Marshall KeyInfo data.
360 if (m_keyInfo && (!m_signature->getKeyInfoList() || m_signature->getKeyInfoList()->isEmpty())) {
361 m_keyInfo->marshall(cachedDOM);
364 // Recache the DOM and clear the serialized copy.
365 parentElement->appendChild(cachedDOM);
366 log.debug("caching DOM for Signature");
367 setDOM(cachedDOM, false);
368 releaseParentDOM(true);
373 XMLObject* XMLSecSignatureImpl::unmarshall(DOMElement* element, bool bindDocument)
375 Category::getInstance(XMLTOOLING_LOGCAT".Signature").debug("unmarshalling ds:Signature");
378 m_signature=XMLToolingInternalConfig::getInternalConfig().m_xsecProvider->newSignatureFromDOM(
379 element->getOwnerDocument(), element
383 catch(XSECException& e) {
384 auto_ptr_char temp(e.getMsg());
385 throw UnmarshallingException(string("Caught an XMLSecurity exception while loading signature: ") + temp.get());
387 catch(XSECCryptoException& e) {
388 throw UnmarshallingException(string("Caught an XMLSecurity exception while loading signature: ") + e.getMsg());
391 setDOM(element, bindDocument);
395 Signature* SignatureBuilder::buildObject(
396 const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix, const QName* schemaType
399 if (!XMLString::equals(nsURI,XMLConstants::XMLSIG_NS) || !XMLString::equals(localName,Signature::LOCAL_NAME))
400 throw XMLObjectException("XMLSecSignatureBuilder requires standard Signature element name.");
401 return buildObject();
404 Signature* SignatureBuilder::buildObject() const
406 return new XMLSecSignatureImpl();
409 const XMLCh Signature::LOCAL_NAME[] = UNICODE_LITERAL_9(S,i,g,n,a,t,u,r,e);