ArchiveTimestamp.h

Go to the documentation of this file.

#ifndef __ArchiveTimestamp_H__
#define __ArchiveTimestamp_H__

#include "PKIFdll.h"
#include "PKIFERSLib.h"
#include "PKIFCryptoConstants.h"

FD_SMART_PTR(CPKIFAlgorithmIdentifier);
FD_SMART_PTR(CPKIFBuffer);
FD_SMART_PTR(CPKIFContentInfo);
FD_MC_PTR();

// forward declaration
struct CPKIFArchiveTimestampImpl;

//CPKIFPartialHashtree provides a name for a list of CPKIFBuffer objects that contains
//hashes of objects.  A partial hashtree is a node in a hashtree.  Where the node is a leaf
//node, the object hashes are those of the data objects being archived.  Where the node is an
//interior node, the hashes are those of its children in the hashtree.
typedef std::vector<CPKIFBufferPtr, PKIFAlloc<CPKIFBufferPtr> > CPKIFPartialHashtree;
DECLARE_SMART_POINTERS(CPKIFPartialHashtree);

//CPKIFPartialHashtreeList is a list of CPKIFPartialHashtree objects.  This is used for the reducedHashtree
//field in an EvidenceRecord.
typedef std::vector<CPKIFPartialHashtreePtr, PKIFAlloc<CPKIFPartialHashtreePtr> > CPKIFPartialHashtreeList;
DECLARE_SMART_POINTERS(CPKIFPartialHashtreeList);

enum ArchiveTimeStampType
{
    iATS = 0,   //Initial ArchiveTimeStamp (covers data being archived)
    trATS,      //Timestamp Renewal ArchiveTimeStamp (covers ArchiveTimeStamp that precedes it in an ArchiveTimeStampChain)
    hrATS       //Hashtree Renewal ArchiveTimeStamp (covers ArchiveTimeStampChain that precedes it in an ArchiveTimeStampSequence)
};

class PKIFERS_API CPKIFArchiveTimestamp
{
public:
    CPKIFArchiveTimestamp(void);
    virtual ~CPKIFArchiveTimestamp(void);

    void SetArchiveTimeStampType(ArchiveTimeStampType atst);
    ArchiveTimeStampType GetArchiveTimeStampType() const;

    //XXX***NEED TO IMPLEMENT SUPPORT FOR THE ATTRIBUTES MEMBER

    //get methods
    CPKIFAlgorithmIdentifierPtr GetDigestAlgorithm() const;
    CPKIFAlgorithmIdentifierPtr GetEffectiveDigestAlgorithm() const;
    CPKIFPartialHashtreeListPtr GetReducedHashtree() const;
    CPKIFContentInfoPtr GetTimestamp() const;

    //set methods
    void SetDigestAlgorithm(CPKIFAlgorithmIdentifierPtr& hashtree);
    void SetReducedHashtree(CPKIFPartialHashtreeListPtr& reducedHashtree);
    void SetTimestamp(CPKIFContentInfoPtr& timestamp);

    //encode/decode methods
    CPKIFBufferPtr Encode() const;
    void Decode(CPKIFBufferPtr& msg);

private:
    CPKIFArchiveTimestamp(const CPKIFArchiveTimestamp& copy);
    CPKIFArchiveTimestamp& operator=(const CPKIFArchiveTimestamp& rhs); 

    struct CPKIFArchiveTimestampImpl *m_impl;
};
DECLARE_SMART_POINTERS(CPKIFArchiveTimestamp);

typedef std::vector<CPKIFArchiveTimestampPtr, PKIFAlloc<CPKIFArchiveTimestampPtr> > CPKIFArchiveTimestampChain;
DECLARE_SMART_POINTERS(CPKIFArchiveTimestampChain);

typedef std::vector<CPKIFArchiveTimestampChainPtr, PKIFAlloc<CPKIFArchiveTimestampChainPtr> > CPKIFArchiveTimestampSequence;
DECLARE_SMART_POINTERS(CPKIFArchiveTimestampSequence);

CPKIFBufferPtr PKIFERS_API CalculateHashOfTimestamp(
    CPKIFContentInfoPtr& timestamp, 
    IPKIFMediatorPtr& m, 
    PKIFCRYPTO::HASH_ALG ha);

CPKIFBufferPtr PKIFERS_API CalculateHashOfArchiveTimestampChain(
    CPKIFArchiveTimestampChainPtr& archiveTimestampChain, 
    IPKIFMediatorPtr& m, 
    PKIFCRYPTO::HASH_ALG ha);

#endif