SignedData.h

Go to the documentation of this file.

#ifndef __SIGNEDDATA_H__
#define __SIGNEDDATA_H__

#include "PKIFCMSDLL.h"
#include "components.h"
#include "PKIFMediators.h"
#include "PKIFCMSUtils.h"
#include "ContentType.h"

//FD_LIST_PTR(CPKIFAttribute);
//FD_LIST_PTR(CPKIFCertificate);
//FD_LIST_PTR(CPKIFSignerInfo);
//FD_SMART_PTR(CPKIFBuffer);
//FD_SMART_PTR(CPKIFCertificatePath);
//FD_SMART_PTR(CPKIFOID);
//FD_SMART_PTR(CPKIFPathSettings);
FD_LIST_PTR(CPKIFCRL);
FD_SMART_PTR(CPKIFEncapsulatedContentInfo);
FD_SMART_PTR(CPKIFPathValidationResults);
FD_SMART_PTR(CPKIFFuncStorage);

struct HashInfo;
class IPKIFCryptoMisc;


class PKIFCMS_API CPKIFSignedData : public CPKIFContentType
{ 
    friend struct CPKIFSignedDataImpl;
public:
    //this enum matches the contents of the underlying 
    //objective enum and must continue to do so
    typedef enum {
        CMSv0 = 0,
        CMSv1 = 1,
        CMSv2 = 2,
        CMSv3 = 3,
        CMSv4 = 4
    } CMSVersion;

    //*****************************************************************************
    //  constructors and destructors
    //*****************************************************************************
    CPKIFSignedData(void);
    virtual ~CPKIFSignedData(void);

    //*****************************************************************************
    //  field manipulation functions
    //  SignedData ::= SEQUENCE 
    //  {
    //      version CMSVersion,
    //      digestAlgorithms DigestAlgorithmIdentifiers,
    //      encapContentInfo EncapsulatedContentInfo,
    //      certificates [0] IMPLICIT CertificateSet OPTIONAL,
    //      crls [1] IMPLICIT CertificateRevocationLists OPTIONAL,
    //      signerInfos SignerInfos 
    //  }
    //*****************************************************************************
    //version (required) - automatically set based on message contents
    //                      (see private CalculateAndSetVersion function)
    CMSVersion GetVersion() const;

    //digest algorithms are determined automatically based on SignerInfos (required)

    //encapsulated content info (required)
    void SetEncapsulatedContent(CPKIFEncapsulatedContentInfoPtr& ecip);
    CPKIFEncapsulatedContentInfoPtr GetEncapsulatedContent() const;

    void UpdateMessage(unsigned char* buf, int bufLen); //used to set-up detached messages

    //certificates (optional)
    void AddCertificate(CPKIFCertificatePtr& cert);     //add a single certificate to cert bag
    void GetCertificates(CPKIFCertificateList& certs);  //get list of associated certs
    
    //crls (optional)
    void AddCRL(CPKIFCRLPtr& crl);                      //add a single CRL to CRL bag
    void GetCRLs(CPKIFCRLList& crls);                   //get list of associated CRLs
    
    //SignerInfos (required) -> Note, AddSignerInfo cannot be called after calling UpdateMessage
    void AddSignerInfo(CPKIFSignerInfoPtr& si);         //add a single SignerInfo
    void GetSignerInfos(CPKIFSignerInfoList& sis);          //get collection of SignerInfos

    //*****************************************************************************
    //  encode and decode functions
    //*****************************************************************************
    CPKIFBufferPtr Encode();                //encodes the message (including signature generation as necessary)
    void Decode(CPKIFBufferPtr& buf);   //decodes the message (does not perform verification)

    //*****************************************************************************
    //  message verification (and related) functions
    //*****************************************************************************
    bool Verify(int signerIndex, CMSVerificationStatus& status, CMSPathValidationStatus minStatus = PVS_REV_STATUS_VERIFIED);
    bool Verify(int signerIndex, CMSVerificationStatus& status, CPKIFCertificatePtr& signersCert, CMSPathValidationStatus minStatus = PVS_REV_STATUS_VERIFIED);
    void SetKeyUsageChecker(CPKIFFuncStoragePtr& kuChecker);
    void SetPathSettings(CPKIFPathSettingsPtr& settings);
    CPKIFCertificatePathPtr GetPath() const;
    CPKIFPathValidationResultsPtr GetValidationResults() const;
    void GetSignersCert(int signerIndex, CPKIFCertificatePtr& cert);
    size_t GetNumberOfSigners() const;

    CPKIFSignerInfoPtr GetSignersInfo(int signerIndex);

    //use ClearContent to re-use an object
    void ClearContent(bool removeMediatorAssociations = true);

    //made this private to support countersignature verification (it really shouldn't be) 10/22/2003
    CPKIFBufferPtr GetSignersCert(CPKIFBufferPtr tmpSignerInfoBuf);

    void AddMediator(IPKIFMediatorPtr& m);
    IPKIFMediatorPtr GetMediator();

private:
    CPKIFSignedData(const CPKIFSignedData& copy);
    CPKIFSignedData& operator=(const CPKIFSignedData& rhs); //added 4/6/2004

    enum {thisComponent=TOOLKIT_MESSAGE_SIGNED_DATA};

    struct CPKIFSignedDataImpl *m_impl;

};
DECLARE_SMART_POINTERS(CPKIFSignedData);

#endif