CPKIFMessageDigestAttribute Class Reference

#include <MessageDigestAttribute.h>

Inheritance diagram for CPKIFMessageDigestAttribute:

Inheritance graph
[legend]
Collaboration diagram for CPKIFMessageDigestAttribute:

Collaboration graph
[legend]

List of all members.


Detailed Description

This class provides support for the CMS Message Digest attribute. PKIF automatically generates and includes a Message Digest attribute where appropriate.

TSP-enforcing: No

Definition at line 25 of file MessageDigestAttribute.h.


Public Member Functions

 CPKIFMessageDigestAttribute ()
 CPKIFMessageDigestAttribute (const CPKIFBufferPtr &buf)
 ~CPKIFMessageDigestAttribute ()
CPKIFOIDPtr GetOID () const
void GetValues (CPKIFBufferList &values) const
void SetMessageDigest (CPKIFBufferPtr &md)
CPKIFBufferPtr GetMessageDigest ()

Static Public Attributes

static char extOID [] = "1.2.840.113549.1.9.4"

Constructor & Destructor Documentation

CPKIFMessageDigestAttribute::CPKIFMessageDigestAttribute (  ) 

Interface: External

This constructor creates a default instance of CPKIFMessageDigestAttribute.

Returns:
None

Definition at line 93 of file MessageDigestAttribute.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_MESSAGE_ASN.

CPKIFMessageDigestAttribute::CPKIFMessageDigestAttribute ( const CPKIFBufferPtr &  buf  ) 

Interface: External

This constructor is called from CPKIFMessageDigestAttributeFactory::create().

Returns:
None
Exceptions:
CPKIFException(ASN1_DECODE_ERROR) Interface: External
This constructor is called from CPKIFMessageDigestAttributeFactory::create().

Returns:
None
Exceptions:
CPKIFException(ASN1_DECODE_ERROR) 
Parameters:
buf  [in] The objective structure to parse into a message digest attribute.

Definition at line 130 of file MessageDigestAttribute.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_MESSAGE_ASN.

CPKIFMessageDigestAttribute::~CPKIFMessageDigestAttribute (  ) 

Interface: External

Destroys an instance of CPKIFMessageDigestAttribute object.

Returns:
None

Definition at line 148 of file MessageDigestAttribute.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_MESSAGE_ASN.


Member Function Documentation

CPKIFOIDPtr CPKIFMessageDigestAttribute::GetOID (  )  const [virtual]

Interface: External

This function is used to get the OID associated with message digest attribute.

Returns:
The OID associated with this type of CMS attribute.

Reimplemented from CPKIFAttribute.

Definition at line 164 of file MessageDigestAttribute.cpp.

References g_messageDigestAttribute.

void CPKIFMessageDigestAttribute::GetValues ( CPKIFBufferList values  )  const [virtual]

Interface: External

This function returns the raw, encoded message digest attribute value.

Returns:
None
Exceptions:
CPKIFException(ASN1_ENCODE_ERROR) 
Parameters:
values  [out] The list of values stored by the attribute.

Reimplemented from CPKIFAttribute.

Definition at line 177 of file MessageDigestAttribute.cpp.

References ASN1_ENCODE_ERROR, LOG_STRING_DEBUG, TOOLKIT_MESSAGE, and TOOLKIT_MESSAGE_ASN.

void CPKIFMessageDigestAttribute::SetMessageDigest ( CPKIFBufferPtr &  md  ) 

Interface: External

This function is used to set the message digest value associated with a Message Digest attribute.

Returns:
None
Exceptions:
CPKIFMessageException(COMMON_INVALID_INPUT) 
Parameters:
md  [in] The message digest to set.

Definition at line 234 of file MessageDigestAttribute.cpp.

References COMMON_INVALID_INPUT, LOG_STRING_DEBUG, TOOLKIT_MESSAGE, and TOOLKIT_MESSAGE_ASN.

CPKIFBufferPtr CPKIFMessageDigestAttribute::GetMessageDigest (  ) 

Interface: External

This function is used to get the message digest value associated with a Message Digest attribute.

Returns:
A smart poiter to CPKIFBuffer object

Definition at line 253 of file MessageDigestAttribute.cpp.


Member Data Documentation

char CPKIFMessageDigestAttribute::extOID = "1.2.840.113549.1.9.4" [static]

Definition at line 32 of file MessageDigestAttribute.h.

Referenced by CPKIFMessageDigestAttributeFactory::refOID().


The documentation for this class was generated from the following files:

Generated on Mon Nov 15 11:20:25 2010 for PublicKeyInfrastructureFramework(PKIF) by  doxygen 1.5.6