DSIGReference.hpp

Go to the documentation of this file.

/*
 * Copyright 2002-2005 The Apache Software Foundation.
 *
 * Licensed 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.
 */

/*
 * XSEC
 *
 * DSIG_Reference := Class for checking and setting up reference nodes in a DSIG signature
 *
 * $Id: DSIGReference.hpp,v 1.17 2005/06/04 11:30:25 blautenb Exp $
 *                   
 */

// 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 DSIGTransformXPathFilter;
class DSIGTransformXSL;
class DSIGSignature;

class TXFMBase;
class TXFMChain;
class XSECBinTXFMInputStream;
class XSECURIResolver;
class XSECEnv;

class DSIG_EXPORT DSIGReference {

public:

    
    DSIGReference(const XSECEnv * env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *dom);

    DSIGReference(const XSECEnv * env);

    ~DSIGReference();



    void load();

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

    DSIGTransformEnvelope *  appendEnvelopedSignatureTransform();
    
    DSIGTransformBase64 * appendBase64Transform();
    
    DSIGTransformXPath * appendXPathTransform(const char * expr);
    
    DSIGTransformXPathFilter * appendXPathFilterTransform(void);

    DSIGTransformXSL * appendXSLTransform(XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *stylesheet);
    
    DSIGTransformC14n * appendCanonicalizationTransform(canonicalizationMethod cm);

    void setPreHashTXFM(TXFMBase * t);




    XSECBinTXFMInputStream * makeBinInputStream(void) const;

    const XMLCh * getURI();

    hashMethod getHashMethod(void) {
        return me_hashMethod;
    }

    DSIGTransformList * getTransforms(void) {
        return mp_transformList;
    }

    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 TXFMChain * DSIGReference::createTXFMChainFromList(TXFMBase * input, 
                            DSIGTransformList * lst);

    static DSIGTransformList * loadTransforms(
                            XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *transformsNode,
                            XSECSafeBufferFormatter * formatter,
                            const XSECEnv * env);

    static TXFMBase * getURIBaseTXFM(XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument * doc, 
                                    const XMLCh * URI, 
                                    const XSECEnv * env);

    static DSIGReferenceList *loadReferenceListFromXML(const XSECEnv * env, 
                                                       XERCES_CPP_NAMESPACE_QUALIFIER 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, 
        XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * txfmElt
    );


    XSECSafeBufferFormatter     * mp_formatter;
    bool formatterLocal;
    XERCES_CPP_NAMESPACE_QUALIFIER 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
    const XMLCh                 * mp_URI;               // The URI String
    bool                        m_isManifest;           // Does this reference a manifest?
    XERCES_CPP_NAMESPACE_QUALIFIER DOMNode                      
                                * mp_transformsNode;
    hashMethod                  me_hashMethod;          // What form of digest?
    XERCES_CPP_NAMESPACE_QUALIFIER DOMNode                      
                                * mp_hashValueNode;     // Node where the Hash value is stored
    const XSECEnv               * mp_env;
    DSIGTransformList           * mp_transformList;     // List of transforms
    
    bool                        m_loaded;

    DSIGReference();

    /*\@}*/
};

---