EvidenceRecord.h

Go to the documentation of this file.

#ifndef __EvidenceRecord_H__
#define __EvidenceRecord_H__

//PKIF includes
#include "PKIFdll.h"
#include "components.h"
#include "AlgorithmIdentifier.h"

//PKIFERS includes
#include "PKIFERSLib.h"
#include "IPKIFCryptoInfo.h"
#include "ArchiveTimestamp.h"

//PKIFTSP components
#define TOOLKIT_ERS                         TOOLKIT_TAP                     //reuse TAP value since it is dead and this is the replacement
#define TOOLKIT_ERS_ERROR_BASE              TOOLKIT_TAP_ERROR_BASE
#define TOOLKIT_ERS_SUBCOMPONENT            TOOLKIT_TAP_SUBCOMPONENT
#define TOOLKIT_ERS_ASN                     TOOLKIT_ERS_SUBCOMPONENT + 1    //DER encode/decode wrapper classes

// forward declaration
struct CPKIFEvidenceRecordImpl;

enum PKIFERSv1
{
    PKIFERSv1 = 1
};

class PKIFERS_API CPKIFEvidenceRecord
{
public:
    CPKIFEvidenceRecord(void);

    virtual ~CPKIFEvidenceRecord(void);

    //in the ArchiveTimestampSequence passed to 
    CPKIFBufferPtr Encode() const;

    void Decode(CPKIFBufferPtr& msg);

    int GetVersion() const;

    //When decoding an EvidenceRecord, the list returned by this function may differ from the the list encoded by the evidence record 
    //creator (for example, if the creator omitted a digest algorithm or included an additional algorithm).  When encoding an evidence record
    //the list returned is the list that corresponds to the values collected when SetArchiveTimestampSequence was last invoked.  The list
    //is a copy of the algorithm identifiers included in the evidence records.  Edits to the list or members in the list have no effect
    //on subsequent calls to Encode or GetDigestAlgorithms.
    CPKIFAlgorithmIdentifierListPtr GetDigestAlgorithms() const;

    //in the evidence record.  The pointer is a live pointer to the archive timestamp sequence held by the CPKIFEvidenceRecord instance.  Thus,
    //it can be used to update an evidence record and re-encode a new evidence without call SetArchiveTimestampSequence.
    CPKIFArchiveTimestampSequencePtr GetArchiveTimestampSequence() const;

    //the next call to Encode.
    void SetArchiveTimestampSequence(CPKIFArchiveTimestampSequencePtr& ats);

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

    struct CPKIFEvidenceRecordImpl *m_impl;
};
DECLARE_SMART_POINTERS(CPKIFEvidenceRecord);
typedef std::vector<CPKIFEvidenceRecordPtr, PKIFAlloc<CPKIFEvidenceRecordPtr> > CPKIFEvidenceRecordList;
DECLARE_SMART_POINTERS(CPKIFEvidenceRecordList);

#endif