EncryptedData.h

Go to the documentation of this file.

#ifndef __ENCRYPTEDDATA_H__
#define __ENCRYPTEDDATA_H__

#include "PKIFCMSDLL.h"
#include "IPKIFHasAttributes.h"
#include "PKIFMediators.h"
#include "components.h"
#include "OID.h"
#include "ContentType.h"

FD_LIST_PTR(CPKIFAttribute);
FD_SMART_PTR(CPKIFKeyMaterial);
FD_SMART_PTR(CPKIFBuffer);
FD_SMART_PTR(CPKIFEncryptedContentInfo);

class PKIFCMS_API CPKIFEncryptedData  : public IPKIFHasAttributes,  public CPKIFContentType
{
    friend struct CPKIFEncryptedDataImpl;
public:
    //this enum matches the contents of the underlying 
    //objective enum and must continue to do so
    typedef enum {
        CMSv0 = 0,
        CMSv2 = 2,
    } CMSVersion;

    //*****************************************************************************
    //  constructors and destructors
    //*****************************************************************************
    CPKIFEncryptedData();
    virtual ~CPKIFEncryptedData();

    //*****************************************************************************
    //  field manipulation functions
    //  EncryptedData ::= SEQUENCE 
    //  {
    //      version CMSVersion,
    //      encryptedContentInfo EncryptedContentInfo,
    //      unprotectedAttrs [1] IMPLICIT UnprotectedAttributes OPTIONAL 
    //  }
    //  EncryptedContentInfo ::= SEQUENCE 
    //  {
    //      contentType ContentType,
    //      contentEncryptionAlgorithm ContentEncryptionAlgorithmIdentifier,
    //      encryptedContent [0] IMPLICIT EncryptedContent OPTIONAL 
    //  }
    //  EncryptedContent ::= OCTET STRING
    //  UnprotectedAttributes ::= SET SIZE (1..MAX) OF Attribute

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

    //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(bool removeMediatorAssociations = true);

    void SetKeyMaterial(CPKIFKeyMaterialPtr& key);

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

    //*****************************************************************************
    //  miscellaneous functions
    //*****************************************************************************
    CPKIFBufferPtr Decrypt();
    void GetAddedUnprotectedAttributes(std::vector<CPKIFAttributePtr>& attr);

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

private:
    
    CPKIFEncryptedData(const CPKIFEncryptedData& ext);//added 8/21/2004
    CPKIFEncryptedData& operator=(const CPKIFEncryptedData& rhs); //added 8/21/2004

    enum {thisComponent=TOOLKIT_MESSAGE_ENVELOPED_DATA};

    struct CPKIFEncryptedDataImpl *m_impl;
};
DECLARE_SMART_POINTERS(CPKIFEncryptedData);

template <class T> boost::shared_ptr<T> CPKIFEncryptedData::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 //__ENCRYPTEDDATA_H__