---

DSIGReference.hpp

Go to the documentation of this file.

/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2002 Berin Lautenbach.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by
 *                   Berin Lautenbach"
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "XSEC", "xml-security-c" and Berin Lautenbach must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact berin@users.sourceforge.net.
 *
 * 5. Products derived from this software may not be called "xml-security-c",
 *    nor may "xml-security-c" appear in their name, without prior written
 *    permission of Berin Lautenbach.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL BERIN LAUTENBACH OR OTHER
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 */

/*
 * XSEC
 *
 * DSIG_Reference := Class for checking and setting up reference nodes in a DSIG signature
 *                   
 *
 */

// High level include
#include <xsec/framework/XSECDefs.hpp>

// Xerces INcludes

#include <xercesc/dom/DOM.hpp>
#include <xercesc/dom/DOMNamedNodeMap.hpp>

// XSEC Includes
#include <xsec/utils/XSECSafeBufferFormatter.hpp>
#include <xsec/dsig/DSIGTransform.hpp>
#include <xsec/dsig/DSIGReferenceList.hpp>
#include <xsec/dsig/DSIGConstants.hpp>

class DSIGTransformList;
class DSIGTransformBase64;
class DSIGTransformC14n;
class DSIGTransformEnvelope;
class DSIGTransformXPath;
class DSIGTransformXSL;
class DSIGSignature;

class TXFMBase;
class XSECBinTXFMInputStream;
class XSECURIResolver;

class DSIG_EXPORT DSIGReference {

public:

    
    DSIGReference(DSIGSignature * sig, DOMNode *dom);

    DSIGReference(DSIGSignature * sig);

    ~DSIGReference();



    void load();

    DOMElement * createBlankReference(char * URI, hashMethod hm, char * type);

    DSIGTransformEnvelope *  appendEnvelopedSignatureTransform();
    
    DSIGTransformBase64 * appendBase64Transform();
    
    DSIGTransformXPath * appendXPathTransform(char * expr);
    
    DSIGTransformXSL * appendXSLTransform(DOMNode *stylesheet);
    
    DSIGTransformC14n * appendCanonicalizationTransform(canonicalizationMethod cm);

    void setPreHashTXFM(TXFMBase * t);




    XSECBinTXFMInputStream * makeBinInputStream(void) const;

    const safeBuffer &getURISB();

    bool isManifest();

    DSIGReferenceList * getManifestReferenceList();     // Return list of references for a manifest object


    

    unsigned int calculateHash(XMLByte * toFill, 
                            unsigned int maxToFill);

    unsigned int readHash(XMLByte *toFill,          
                            unsigned int maxToFill);

    bool checkHash();

    void setHash();



    static TXFMBase * DSIGReference::createTXFMChainFromList(TXFMBase * input, 
                            DSIGTransformList * lst);

    static DSIGTransformList * loadTransforms(
                            DOMNode *transformsNode,
                            XSECSafeBufferFormatter * formatter,
                            DSIGSignature * sig);

    static TXFMBase * getURIBaseTXFM(DOMDocument * doc, 
                                    safeBuffer URI, 
                                    XSECURIResolver * resolver);

    static DSIGReferenceList *loadReferenceListFromXML(DSIGSignature * sig, 
                                                       DOMNode *firstReference);

    static bool verifyReferenceList(DSIGReferenceList * lst, safeBuffer &errorStr);
    
    static void hashReferenceList(DSIGReferenceList * list, bool interlocking = true);


private:

    // Internal functions
    void createTransformList(void);
    void addTransform(DSIGTransform * txfm, DOMElement * txfmElt);


    XSECSafeBufferFormatter     * mp_formatter;
    bool formatterLocal;
    DOMNode                     * mp_referenceNode;     // Points to start of document where reference node is
    TXFMBase                    * mp_preHash;           // To be used pre-hash
    DSIGReferenceList           * mp_manifestList;      // The list of references in a manifest
    safeBuffer                  m_URI;                  // The URI String
    bool                        m_URISet;               // Has the URI been found?
    bool                        m_isManifest;           // Does this reference a manifest?
    DOMNode                     * mp_transformsNode;
    hashMethod                  me_hashMethod;          // What form of digest?
    DOMNode                     * mp_hashValueNode;     // Node where the Hash value is stored
    DSIGSignature               * mp_parentSignature;   // Owner signature
    DSIGTransformList           * mp_transformList;     // List of transforms

    DSIGReference();

    /*\@}*/
};

---