xref: /dports/devel/xmltooling/xmltooling-3.2.1/xmltooling/signature/impl/XMLSecSignatureImpl.cpp

/**
 * Licensed to the University Corporation for Advanced Internet
 * Development, Inc. (UCAID) under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for
 * additional information regarding copyright ownership.
 *
 * UCAID licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the
 * License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific
 * language governing permissions and limitations under the License.
 */

/**
 * XMLSecSignatureImpl.cpp
 *
 * Signature class for XMLSec-based signature-handling.
 */

#include "internal.h"
#include "exceptions.h"
#include "logging.h"
#include "impl/UnknownElement.h"
#include "security/Credential.h"
#include "signature/ContentReference.h"
#include "signature/KeyInfo.h"
#include "signature/Signature.h"
#include "util/NDC.h"
#include "util/XMLConstants.h"
#include "util/XMLHelper.h"

#include <xercesc/framework/MemBufInputSource.hpp>
#include <xercesc/framework/Wrapper4InputSource.hpp>
#include <xercesc/util/XMLUniDefs.hpp>
#include <xsec/dsig/DSIGKeyInfoX509.hpp>
#include <xsec/dsig/DSIGReference.hpp>
#include <xsec/enc/XSECCryptoException.hpp>
#include <xsec/framework/XSECAlgorithmHandler.hpp>
#include <xsec/framework/XSECAlgorithmMapper.hpp>
#include <xsec/framework/XSECException.hpp>
#include <xsec/transformers/TXFMSB.hpp>
#include <xsec/transformers/TXFMChain.hpp>
#include <xsec/transformers/TXFMOutputFile.hpp>

using namespace xmlsignature;
using namespace xmltooling::logging;
using namespace xmltooling;
using namespace xercesc;
using namespace std;
using xmlconstants::XMLSIG_NS;
using xmlconstants::XMLSIG_PREFIX;

namespace xmlsignature {

#if defined (_MSC_VER)
    #pragma warning( push )
    #pragma warning( disable : 4250 4251 )
#endif

    class XMLTOOL_DLLLOCAL XMLSecSignatureImpl : public UnknownElementImpl, public virtual Signature
    {
    public:
        XMLSecSignatureImpl() : AbstractXMLObject(XMLSIG_NS, Signature::LOCAL_NAME, XMLSIG_PREFIX),
            UnknownElementImpl(XMLSIG_NS, Signature::LOCAL_NAME, XMLSIG_PREFIX),
            m_signature(nullptr), m_c14n(nullptr), m_sm(nullptr), m_key(nullptr), m_keyInfo(nullptr), m_reference(nullptr) {}
        virtual ~XMLSecSignatureImpl();

        void releaseDOM() const;
        void releaseChildrenDOM(bool propagateRelease=true) const {
            if (m_keyInfo) {
                m_keyInfo->releaseDOM();
                if (propagateRelease)
                    m_keyInfo->releaseChildrenDOM();
            }
        }
        XMLObject* clone() const;
        Signature* cloneSignature() const;

        DOMElement* marshall(DOMDocument* document=nullptr, const vector<Signature*>* sigs=nullptr, const Credential* credential=nullptr) const;
        DOMElement* marshall(DOMElement* parentElement, const vector<Signature*>* sigs=nullptr, const Credential* credential=nullptr) const;
        XMLObject* unmarshall(DOMElement* element, bool bindDocument=false);

        // Getters
        const XMLCh* getCanonicalizationMethod() const {
            if (m_signature)
                return m_signature->getCanonicalizationMethod();
            return m_c14n ? m_c14n : DSIGConstants::s_unicodeStrURIEXC_C14N_NOC;
        }
        const XMLCh* getSignatureAlgorithm() const {
            if (!m_sm && m_signature) {
                m_sm = XMLString::replicate(m_signature->getAlgorithmURI());
            }
            return m_sm;
        }

        KeyInfo* getKeyInfo() const { return m_keyInfo; }
        ContentReference* getContentReference() const { return m_reference; }
        DSIGSignature* getXMLSignature() const { return m_signature; }

        // Setters
        void setCanonicalizationMethod(const XMLCh* c14n) { m_c14n = prepareForAssignment(m_c14n,c14n); }
        void setSignatureAlgorithm(const XMLCh* sm) { m_sm = prepareForAssignment(m_sm,sm); }
        void setSigningKey(XSECCryptoKey* signingKey) {
            delete m_key;
            m_key=signingKey;
        }
        void setKeyInfo(KeyInfo* keyInfo) {
            prepareForAssignment(m_keyInfo, keyInfo);
            m_keyInfo=keyInfo;
        }
        void setContentReference(ContentReference* reference) {
            delete m_reference;
            m_reference=reference;
        }

        void sign(const Credential* credential=nullptr);

    private:
        mutable DSIGSignature* m_signature;
        XMLCh* m_c14n;
        mutable XMLCh* m_sm;
        XSECCryptoKey* m_key;
        mutable KeyInfo* m_keyInfo;
        ContentReference* m_reference;
    };

#if defined (_MSC_VER)
    #pragma warning( pop )
#endif
};

ContentReference::ContentReference()
{
}

ContentReference::~ContentReference()
{
}

Signature::Signature()
{
}

Signature::~Signature()
{
}

XMLSecSignatureImpl::~XMLSecSignatureImpl()
{
    // Release the associated signature.
    if (m_signature)
        XMLToolingInternalConfig::getInternalConfig().m_xsecProvider->releaseSignature(m_signature);

    XMLString::release(&m_c14n);
    XMLString::release(&m_sm);
    delete m_key;
    delete m_keyInfo;
    delete m_reference;
}

void XMLSecSignatureImpl::releaseDOM() const
{
    if (getDOM()) {
        // This should save off the DOM
        UnknownElementImpl::releaseDOM();

        // Release the associated signature.
        if (m_signature) {
            XMLToolingInternalConfig::getInternalConfig().m_xsecProvider->releaseSignature(m_signature);
            m_signature=nullptr;
        }
    }
}

XMLObject* XMLSecSignatureImpl::clone() const
{
    return cloneSignature();
}

Signature* XMLSecSignatureImpl::cloneSignature() const
{
    XMLSecSignatureImpl* ret=new XMLSecSignatureImpl();

    ret->m_c14n=XMLString::replicate(m_c14n);
    ret->m_sm=XMLString::replicate(m_sm);
    if (m_key)
        ret->m_key=m_key->clone();
    if (m_keyInfo)
        ret->m_keyInfo=m_keyInfo->cloneKeyInfo();

    // If there's no XML locally, serialize this object into the new one, otherwise just copy it over.
    if (m_xml.empty())
        serialize(ret->m_xml);
    else
        ret->m_xml=m_xml;

    return ret;
}

void XMLSecSignatureImpl::sign(const Credential* credential)
{
    Category& log=Category::getInstance(XMLTOOLING_LOGCAT ".Signature");
    log.debug("applying signature");

    if (!m_signature)
        throw SignatureException("Only a marshalled Signature object can be signed.");
    else if (!m_reference)
        throw SignatureException("No ContentReference object set for signature creation.");

    const XSECCryptoKey* key = credential ? credential->getPrivateKey() : m_key;
    if (!key)
        throw SignatureException("No signing key available for signature creation.");

    try {
        log.debug("creating signature reference(s)");
        DSIGReferenceList* refs = m_signature->getReferenceList();
        while (refs && refs->getSize())
            delete refs->removeReference(0);
        m_reference->createReferences(m_signature);

        log.debug("computing signature");
        m_signature->setSigningKey(key->clone());
        m_signature->sign();
    }
    catch(const XSECException& e) {
        auto_ptr_char temp(e.getMsg());
        throw SignatureException(string("Caught an XMLSecurity exception while signing: ") + temp.get());
    }
    catch(const XSECCryptoException& e) {
        throw SignatureException(string("Caught an XMLSecurity exception while signing: ") + e.getMsg());
    }
}

DOMElement* XMLSecSignatureImpl::marshall(DOMDocument* document, const vector<Signature*>* sigs, const Credential* credential) const
{
#ifdef _DEBUG
    xmltooling::NDC ndc("marshall");
#endif

    Category& log=Category::getInstance(XMLTOOLING_LOGCAT ".Signature");
    log.debug("marshalling ds:Signature");

    DOMElement* cachedDOM=getDOM();
    if (cachedDOM) {
        if (!document || document==cachedDOM->getOwnerDocument()) {
            log.debug("Signature has a usable cached DOM, reusing it");
            if (document)
                setDocumentElement(cachedDOM->getOwnerDocument(),cachedDOM);
            releaseParentDOM(true);
            return cachedDOM;
        }

        // We have a DOM but it doesn't match the document we were given. This both sucks and blows.
        // Without an adoptNode option to maintain the child pointers, we have to either import the
        // DOM while somehow reassigning all the nested references (which amounts to a complete
        // *unmarshall* operation), or we just release the existing DOM and hope that we can get
        // it back. This depends on all objects being able to preserve their DOM at all costs.
        releaseChildrenDOM(true);
        releaseDOM();
    }

    // If we get here, we didn't have a usable DOM.
    bool bindDocument=false;
    if (m_xml.empty()) {
        // Fresh signature, so we just create an empty one.
        log.debug("creating empty Signature element");
        if (!document) {
            document=DOMImplementationRegistry::getDOMImplementation(nullptr)->createDocument();
            bindDocument=true;
        }
        DSIGSignature* temp=XMLToolingInternalConfig::getInternalConfig().m_xsecProvider->newSignature();
        temp->setDSIGNSPrefix(XMLSIG_PREFIX);
        const XMLCh* alg = getSignatureAlgorithm();
        if (!alg) {
#ifdef XSEC_OPENSSL_HAVE_SHA2
            alg = DSIGConstants::s_unicodeStrURIRSA_SHA256;
#else
            alg = DSIGConstants::s_unicodeStrURIRSA_SHA1;
#endif
        }
        cachedDOM=temp->createBlankSignature(document, getCanonicalizationMethod(), alg);
        m_signature = temp;
    }
    else {
        // We need to reparse the XML we saved off into a new DOM.
        MemBufInputSource src(reinterpret_cast<const XMLByte*>(m_xml.c_str()),m_xml.length(),"XMLSecSignatureImpl");
        Wrapper4InputSource dsrc(&src,false);
        log.debug("parsing Signature XML back into DOM tree");
        DOMDocument* internalDoc=XMLToolingConfig::getConfig().getParser().parse(dsrc);
        if (document) {
            // The caller insists on using his own document, so we now have to import the thing
            // into it. Then we're just dumping the one we built.
            log.debug("reimporting new DOM into caller-supplied document");
            try {
                cachedDOM=static_cast<DOMElement*>(document->importNode(internalDoc->getDocumentElement(), true));
            }
            catch (XMLException& ex) {
                internalDoc->release();
                auto_ptr_char temp(ex.getMessage());
                throw XMLParserException(
                    string("Error importing DOM into caller-supplied document: ") + (temp.get() ? temp.get() : "no message")
                    );
            }
            internalDoc->release();
        }
        else {
            // We just bind the document we built to the object as the result.
            cachedDOM=static_cast<DOMElement*>(internalDoc->getDocumentElement());
            document=internalDoc;
            bindDocument=true;
        }

        // Now reload the signature from the DOM.
        try {
            m_signature=XMLToolingInternalConfig::getInternalConfig().m_xsecProvider->newSignatureFromDOM(
                document, cachedDOM
                );
            m_signature->load();
        }
        catch(const XSECException& e) {
            if (bindDocument)
                document->release();
            auto_ptr_char temp(e.getMsg());
            throw MarshallingException(string("Caught an XMLSecurity exception while loading signature: ") + temp.get());
        }
        catch(const XSECCryptoException& e) {
            if (bindDocument)
                document->release();
            throw MarshallingException(string("Caught an XMLSecurity exception while loading signature: ") + e.getMsg());
        }
    }

    // Marshall KeyInfo data.
    if (credential) {
        delete m_keyInfo;
        m_keyInfo = nullptr;
        m_keyInfo = credential->getKeyInfo();
    }
    if (m_keyInfo && (!m_signature->getKeyInfoList() || m_signature->getKeyInfoList()->isEmpty())) {
        m_keyInfo->marshall(cachedDOM);
    }

    // Recache the DOM and clear the serialized copy.
    setDocumentElement(document, cachedDOM);
    log.debug("caching DOM for Signature (document is %sbound)", bindDocument ? "" : "not ");
    setDOM(cachedDOM, bindDocument);
    releaseParentDOM(true);
    m_xml.erase();
    return cachedDOM;
}

DOMElement* XMLSecSignatureImpl::marshall(DOMElement* parentElement, const vector<Signature*>* sigs, const Credential* credential) const
{
#ifdef _DEBUG
    xmltooling::NDC ndc("marshall");
#endif

    Category& log=Category::getInstance(XMLTOOLING_LOGCAT ".Signature");
    log.debug("marshalling ds:Signature");

    DOMElement* cachedDOM=getDOM();
    if (cachedDOM) {
        if (parentElement->getOwnerDocument()==cachedDOM->getOwnerDocument()) {
            log.debug("Signature has a usable cached DOM, reusing it");
            if (parentElement!=cachedDOM->getParentNode()) {
                parentElement->appendChild(cachedDOM);
                releaseParentDOM(true);
            }
            return cachedDOM;
        }

        // We have a DOM but it doesn't match the document we were given. This both sucks and blows.
        // Without an adoptNode option to maintain the child pointers, we have to either import the
        // DOM while somehow reassigning all the nested references (which amounts to a complete
        // *unmarshall* operation), or we just release the existing DOM and hope that we can get
        // it back. This depends on all objects being able to preserve their DOM at all costs.
        releaseChildrenDOM(true);
        releaseDOM();
    }

    // If we get here, we didn't have a usable DOM.
    if (m_xml.empty()) {
        // Fresh signature, so we just create an empty one.
        log.debug("creating empty Signature element");
        DSIGSignature* temp=XMLToolingInternalConfig::getInternalConfig().m_xsecProvider->newSignature();
        temp->setDSIGNSPrefix(XMLSIG_PREFIX);
        const XMLCh* alg = getSignatureAlgorithm();
        if (!alg)
            alg = DSIGConstants::s_unicodeStrURIRSA_SHA1;
        cachedDOM=temp->createBlankSignature(parentElement->getOwnerDocument(), getCanonicalizationMethod(), alg);
        m_signature = temp;
    }
    else {
        MemBufInputSource src(reinterpret_cast<const XMLByte*>(m_xml.c_str()),m_xml.length(),"XMLSecSignatureImpl");
        Wrapper4InputSource dsrc(&src,false);
        log.debug("parsing XML back into DOM tree");
        DOMDocument* internalDoc=XMLToolingConfig::getConfig().getParser().parse(dsrc);

        log.debug("reimporting new DOM into caller-supplied document");
        try {
            cachedDOM=static_cast<DOMElement*>(parentElement->getOwnerDocument()->importNode(internalDoc->getDocumentElement(),true));
        }
        catch (const XMLException& ex) {
            internalDoc->release();
            auto_ptr_char temp(ex.getMessage());
            throw XMLParserException(
                string("Error importing DOM into caller-supplied document: ") + (temp.get() ? temp.get() : "no message")
                );
        }
        internalDoc->release();

        // Now reload the signature from the DOM.
        try {
            m_signature=XMLToolingInternalConfig::getInternalConfig().m_xsecProvider->newSignatureFromDOM(
                parentElement->getOwnerDocument(), cachedDOM
                );
            m_signature->load();
        }
        catch(const XSECException& e) {
            auto_ptr_char temp(e.getMsg());
            throw MarshallingException(string("Caught an XMLSecurity exception while loading signature: ") + temp.get());
        }
        catch(const XSECCryptoException& e) {
            throw MarshallingException(string("Caught an XMLSecurity exception while loading signature: ") + e.getMsg());
        }
    }

    // Marshall KeyInfo data.
    if (credential) {
        delete m_keyInfo;
        m_keyInfo = nullptr;
        m_keyInfo = credential->getKeyInfo();
    }
    if (m_keyInfo && (!m_signature->getKeyInfoList() || m_signature->getKeyInfoList()->isEmpty())) {
        m_keyInfo->marshall(cachedDOM);
    }

    // Recache the DOM and clear the serialized copy.
    parentElement->appendChild(cachedDOM);
    log.debug("caching DOM for Signature");
    setDOM(cachedDOM, false);
    releaseParentDOM(true);
    m_xml.erase();
    return cachedDOM;
}

XMLObject* XMLSecSignatureImpl::unmarshall(DOMElement* element, bool bindDocument)
{
    Category::getInstance(XMLTOOLING_LOGCAT ".Signature").debug("unmarshalling ds:Signature");

    try {
        m_signature=XMLToolingInternalConfig::getInternalConfig().m_xsecProvider->newSignatureFromDOM(
            element->getOwnerDocument(), element
            );
        m_signature->load();
    }
    catch(const XSECException& e) {
        auto_ptr_char temp(e.getMsg());
        throw UnmarshallingException(string("Caught an XMLSecurity exception while loading signature: ") + temp.get());
    }
    catch(const XSECCryptoException& e) {
        throw UnmarshallingException(string("Caught an XMLSecurity exception while loading signature: ") + e.getMsg());
    }

    setDOM(element, bindDocument);
    return this;
}

#ifdef HAVE_COVARIANT_RETURNS
Signature*
#else
XMLObject*
#endif
SignatureBuilder::buildObject(
    const XMLCh* nsURI, const XMLCh* localName, const XMLCh* prefix, const xmltooling::QName* schemaType
    ) const
{
    if (!XMLString::equals(nsURI,XMLSIG_NS) || !XMLString::equals(localName,Signature::LOCAL_NAME))
        throw XMLObjectException("XMLSecSignatureBuilder requires standard Signature element name.");
    return buildObject();
}

#ifdef HAVE_COVARIANT_RETURNS
Signature*
#else
XMLObject*
#endif
SignatureBuilder::buildObject() const
{
    return new XMLSecSignatureImpl();
}

Signature* SignatureBuilder::buildSignature() {
    const SignatureBuilder* b = dynamic_cast<const SignatureBuilder*>(
        XMLObjectBuilder::getBuilder(xmltooling::QName(xmlconstants::XMLSIG_NS,Signature::LOCAL_NAME))
        );
    if (b) {
#ifdef HAVE_COVARIANT_RETURNS
        return b->buildObject();
#else
        return dynamic_cast<Signature*>(b->buildObject());
#endif
    }
    throw XMLObjectException("Unable to obtain typed builder for Signature.");
}

const XMLCh Signature::LOCAL_NAME[] = UNICODE_LITERAL_9(S,i,g,n,a,t,u,r,e);

// Raw signature methods.

unsigned int Signature::createRawSignature(
    const XSECCryptoKey* key, const XMLCh* sigAlgorithm, const char* in, unsigned int in_len, char* out, unsigned int out_len
    )
{
    try {
        const XSECAlgorithmHandler* handler = XSECPlatformUtils::g_algorithmMapper->mapURIToHandler(sigAlgorithm);
        if (!handler) {
            auto_ptr_char alg(sigAlgorithm);
            throw SignatureException("Unsupported signature algorithm ($1).", params(1,alg.get()));
        }

        // Move input into a safeBuffer to source the transform chain.
        safeBuffer sb,sbout;
        sb.sbStrncpyIn(in,in_len);
        TXFMSB* sbt = new TXFMSB(nullptr);
        sbt->setInput(sb, in_len);
        TXFMChain tx(sbt);

        // Sign the chain.
        unsigned int siglen = handler->signToSafeBuffer(&tx, sigAlgorithm, key, out_len-1, sbout);
        if (siglen >= out_len)
            throw SignatureException("Signature size exceeded output buffer size.");

        // Push all non-whitespace into buffer.
        unsigned int ret_len = 0;
        const char* source = sbout.rawCharBuffer();
        while (siglen--) {
            if (isspace(*source))
                ++source;
            else {
                *out++ = *source++;
                ++ret_len;
            }
        }
        *out = 0;
        return ret_len;
    }
    catch(const XSECException& e) {
        auto_ptr_char temp(e.getMsg());
        throw SignatureException(string("Caught an XMLSecurity exception while creating raw signature: ") + temp.get());
    }
    catch(const XSECCryptoException& e) {
        throw SignatureException(string("Caught an XMLSecurity exception while creating raw signature: ") + e.getMsg());
    }
}

bool Signature::verifyRawSignature(
    const XSECCryptoKey* key, const XMLCh* sigAlgorithm, const char* signature, const char* in, unsigned int in_len
    )
{
    try {
        const XSECAlgorithmHandler* handler = XSECPlatformUtils::g_algorithmMapper->mapURIToHandler(sigAlgorithm);
        if (!handler) {
            auto_ptr_char alg(sigAlgorithm);
            throw SignatureException("Unsupported signature algorithm ($1).", params(1,alg.get()));
        }

        // Move input into a safeBuffer to source the transform chain.
        safeBuffer sb;
        sb.sbStrncpyIn(in,in_len);
        TXFMSB* sbt = new TXFMSB(nullptr);
        sbt->setInput(sb, in_len);
        TXFMChain tx(sbt);

        // Verify the chain.
        return handler->verifyBase64Signature(&tx, sigAlgorithm, signature, 0, key);
    }
    catch(const XSECException& e) {
        auto_ptr_char temp(e.getMsg());
        throw SignatureException(string("Caught an XMLSecurity exception while verifying raw signature: ") + temp.get());
    }
    catch(const XSECCryptoException& e) {
        throw SignatureException(string("Caught an XMLSecurity exception while verifying raw signature: ") + e.getMsg());
    }
}