EnvelopedData.h

Go to the documentation of this file.

#ifndef __ENVELOPEDDATA_H__
#define __ENVELOPEDDATA_H__

#include "PKIFCMSDLL.h"
#include "PKIFMediators.h"
#include "IPKIFHasAttributes.h"
#include "PKIFCMSUtils.h" // for enumerated constants
#include "components.h"
#include "OID.h"
#include "ContentType.h"

FD_LIST_PTR(CPKIFCertificate);
FD_LIST_PTR(CPKIFCRL);
FD_LIST_PTR(CPKIFRecipientInfo);
FD_SMART_PTR(CPKIFCertificatePath);
FD_SMART_PTR(CPKIFKEKRecipInfoDetails);
FD_SMART_PTR(CPKIFPathValidationResults);
FD_SMART_PTR(CPKIFEncryptedContentInfo);
FD_SMART_PTR(CPKIFPathSettings);
FD_SMART_PTR(CPKIFCredential);
FD_SMART_PTR(CPKIFKARIDetails);
template<class T> class CPKIFASNWrapper;

class PKIFCMS_API CPKIFEnvelopedData  : public IPKIFHasAttributes,  public CPKIFContentType
{
    friend struct CPKIFEnvelopedDataImpl;
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
    //*****************************************************************************
    CPKIFEnvelopedData();
    virtual ~CPKIFEnvelopedData();

    //*****************************************************************************
    //  field manipulation functions
    //  EnvelopedData ::= SEQUENCE 
    //  {
    //      version CMSVersion,
    //      originatorInfo [0] IMPLICIT OriginatorInfo OPTIONAL,
    //      recipientInfos RecipientInfos,
    //      encryptedContentInfo EncryptedContentInfo,
    //      unprotectedAttrs [1] IMPLICIT UnprotectedAttributes OPTIONAL 
    //  }
    //  OriginatorInfo ::= SEQUENCE 
    //  {
    //      certs [0] IMPLICIT CertificateSet OPTIONAL,
    //      crls [1] IMPLICIT CertificateRevocationLists OPTIONAL 
    //  }
    //  RecipientInfos ::= SET SIZE (1..MAX) OF RecipientInfo
    //  EncryptedContentInfo ::= SEQUENCE 
    //  {
    //      contentType ContentType,
    //      contentEncryptionAlgorithm ContentEncryptionAlgorithmIdentifier,
    //      encryptedContent [0] IMPLICIT EncryptedContent OPTIONAL 
    //  }
    //  EncryptedContent ::= OCTET STRING
    //  UnprotectedAttributes ::= SET SIZE (1..MAX) OF Attribute
    //  RecipientInfo ::= CHOICE 
    //  {
    //      ktri KeyTransRecipientInfo,
    //      kari [1] KeyAgreeRecipientInfo,
    //      kekri [2] KEKRecipientInfo,
    //      pwri [3] PasswordRecipientinfo,
    //      ori [4] OtherRecipientInfo 
    //  }
    //  EncryptedKey ::= OCTET STRING

    //*****************************************************************************
    //version (required) - automatically set based on message contents
    //                      (see private CalculateAndSetVersion function)
    CMSVersion GetVersion() const;

    //originatorInfo (optional)
    void AddOriginatorCertificate(CPKIFCertificatePtr& cert);
    void AddOriginatorCRL(CPKIFCRLPtr& crl);

    void SetOriginatorCredential(CPKIFCredentialPtr & cred);

    void GetOriginatorCertificates(CPKIFCertificateList& certs);
    void GetOriginatorCRLs(CPKIFCRLList& crls);             

    void GetRecipientInfos(CPKIFRecipientInfoList& recipInfos) const;

    //recipientInfos (required)
    void AddRecipient(CPKIFCertificatePtr& cert, CMSPathValidationStatus minStatus = PVS_REV_STATUS_VERIFIED);
    void AddRecipient(CPKIFCertificatePtr& cert, CPKIFCertificatePathPtr& path, CPKIFPathValidationResultsPtr& valResults, CMSPathValidationStatus minStatus = PVS_REV_STATUS_VERIFIED);
    void AddRecipient(CPKIFKEKRecipInfoDetailsPtr& kek);
    //void AddRecipient(CPKIFKARIDetailsPtr& kari);

    //encryptedContentInfo (required)
    void SetDataToEncrypt(CPKIFEncryptedContentInfoPtr& buf);
    CPKIFEncryptedContentInfoPtr GetEncryptedData() const;

    //unprotectedAttrs (optional)
    void AddUnprotectedAttribute(CPKIFAttributePtr& attr);

    void GetUnprotectedAttributes(CPKIFAttributeList& ual);

    // Implementation of virtual IPKIFHasAttributes::GetEncodedUnprotectedAttributes
    void GetEncodedUnprotectedAttributes (CPKIFBufferPtr& buf);

    // The following function is a workaround bc it's not wise to use
    // static members inside of template functions.  This should be revisited
    // after a more "correct" approach has been decided.
    void _GetUnprotectedAttributes(std::vector<CPKIFAttributePtr> attrVector);

    template <class T> boost::shared_ptr<T> GetUnprotectedAttribute();

    void ClearContent();

    void SetAlgorithmAndMode(PKIFCRYPTO::SYMKEY_ALG alg, PKIFCRYPTO::SYMKEY_MODE mode);
    PKIFCRYPTO::SYMKEY_ALG GetAlgorithm() const;
    PKIFCRYPTO::SYMKEY_MODE GetMode() const;

    //*****************************************************************************
    //  encode and decode functions
    //*****************************************************************************
    CPKIFBufferPtr Encode();                                //also performs encryption
    void Decode(CPKIFBufferPtr& buf);                   //does not perform decryption

    //*****************************************************************************
    //  miscellaneous functions
    //*****************************************************************************
    void SetPathSettings(CPKIFPathSettingsPtr& settings);
    CPKIFBufferPtr Decrypt(CPKIFCredentialPtr& cred);
    CPKIFBufferPtr Decrypt(CPKIFKEKRecipInfoDetailsPtr& kek);
    void GetAddedUnprotectedAttributes(std::vector<CPKIFAttributePtr>& attr);

    void SetMediator(IPKIFMediatorPtr& m);
    IPKIFMediatorPtr GetMediator();
private:
    CPKIFEnvelopedData(const CPKIFEnvelopedData& copy);
    CPKIFEnvelopedData& operator=(const CPKIFEnvelopedData& rhs); //added 4/6/2004

    enum {thisComponent=TOOLKIT_MESSAGE_ENVELOPED_DATA};

    struct CPKIFEnvelopedDataImpl *m_impl;


};
DECLARE_SMART_POINTERS(CPKIFEnvelopedData)

//added smart pointer declaration 6/29/2004 AG
template <class T> boost::shared_ptr<T> CPKIFEnvelopedData::GetUnprotectedAttribute()

{
  //XXX*** Read the comments below and fix this please 
  
  std::vector<CPKIFAttributePtr> attrVector;
  // The following function is a workaround bc it's not wise to use
  // static members inside of template functions.  This should be revisited
  // after a more "correct" approach has been decided.
  _GetUnprotectedAttributes(attrVector);
  
  //GetUnprotectedAttributes (IPKIFParseAttributes* m, attrVector);
 
  CPKIFStringPtr oidStr(new std::string(T::extOID));
  CPKIFOID oid(oidStr);

  CPKIFAttribute* p = NULL;
  CPKIFAttributeList::iterator pos;
  CPKIFAttributeList::iterator end = attrVector.end();
  for(pos = attrVector.begin(); pos != end; ++pos)
  {
    p = &(*(*pos));
    if(oid == (*pos)->GetOID() && NULL != dynamic_cast<T*>(p))
    {
      return *((boost::shared_ptr<T>*)&(*pos));
    }
  }     

  boost::shared_ptr<T> nullExt;
  return nullExt;
}

#endif