CPKIFKeyTransRecipientInfo Class Reference

#include <KeyTransRecipientInfo.h>

Collaboration diagram for CPKIFKeyTransRecipientInfo:

Collaboration graph
[legend]

List of all members.


Detailed Description

CPKIFKeyTransRecipientInfo is used to convey information about a recipient of an enveloped data message. PKIF automatically generates recipient information objects as necessary. As such, this class provides no means for applications to create recipient info objects. See CPKIFEnvelopedData::GetRecipientInfos for additional information.

CMS defines several type of recipient information. PKIF only currently supports the KeyTransRecipientInfo type, as implemented by this class, and the KEKRecipInfoDetails type.

TSP-enforcing: No

Definition at line 30 of file KeyTransRecipientInfo.h.


Public Types

enum  RecipientIdentifierChoice { ISSUERSERIAL, SKID, UNSET }

Public Member Functions

 CPKIFKeyTransRecipientInfo ()
 CPKIFKeyTransRecipientInfo (const CPKIFBufferPtr &ktriBuf)
 ~CPKIFKeyTransRecipientInfo ()
RecipientIdentifierChoice GetRecipientIdentifierChoice () const
CPKIFIssuerAndSerialNumberPtr GetIssuerAndSerialNumber () const
CPKIFBufferPtr GetSKID () const
CPKIFAlgorithmIdentifierPtr GetKeyEncryptionAlgorithm () const
CPKIFBufferPtr GetEncryptedKey () const

Member Enumeration Documentation

Enumerator:
ISSUERSERIAL 
SKID 
UNSET 

Definition at line 38 of file KeyTransRecipientInfo.h.


Constructor & Destructor Documentation

CPKIFKeyTransRecipientInfo::CPKIFKeyTransRecipientInfo (  ) 

Interface: External

Default constructor.

Returns:
None

Definition at line 37 of file KeyTransRecipientInfo.cpp.

CPKIFKeyTransRecipientInfo::CPKIFKeyTransRecipientInfo ( const CPKIFBufferPtr &  ktriBuf  ) 

Interface: External

This constructor creates an instance of CPKIFKeyTransRecipientInfo based on the parameter.

Returns:
None
Parameters:
ktriBuf  [in] The objective structure to parse.

Definition at line 49 of file KeyTransRecipientInfo.cpp.

References CACASNWRAPPER_CREATE, and data.

CPKIFKeyTransRecipientInfo::~CPKIFKeyTransRecipientInfo (  ) 

Interface: External

This constructor creates an instance of CPKIFKeyTransRecipientInfo based on the parameter.

Returns:
None Interface: External
Destroys an instance of CPKIFKeyTransRecipientInfo object.

Returns:
None

Definition at line 136 of file KeyTransRecipientInfo.cpp.


Member Function Documentation

CPKIFKeyTransRecipientInfo::RecipientIdentifierChoice CPKIFKeyTransRecipientInfo::GetRecipientIdentifierChoice (  )  const

Interface: External

This function returns an enum indicating the type of recipient identifier present in the object. The RecipientIdentifierChoice enumeration is defined as follows:

enum RecipientIdentifierChoice 
{
	ISSUERSERIAL,
	SKID, 
	UNSET
};

When ISSUERSERIAL is returned by this function, subsequent calls to GetIssuerAndSerialNumber should not return NULL. When SKID is returned by this function, subsequent calls to GetSKID should not return NULL. When UNSET is returned by this function calls to either function should return NULL.

Returns:
An enum indicating the type of recipient identifier present in the object

Definition at line 164 of file KeyTransRecipientInfo.cpp.

References ISSUERSERIAL, SKID, and UNSET.

CPKIFIssuerAndSerialNumberPtr CPKIFKeyTransRecipientInfo::GetIssuerAndSerialNumber (  )  const

Interface: External

This function returns the issuer distinguished name and certificate serial number specified by the recipient identifier contained by the KeyTransRecipientInfo object.

Returns:
The issuer distinguished name and certificate serial number specified by the recipient identifier

Definition at line 181 of file KeyTransRecipientInfo.cpp.

CPKIFBufferPtr CPKIFKeyTransRecipientInfo::GetSKID (  )  const

Interface: External

This function returns the subject key identifier specified by the recipient identifier contained by the KeyTransRecipientInfo object.

Returns:
The subject key identifier specified by the recipient identifier.

Definition at line 193 of file KeyTransRecipientInfo.cpp.

CPKIFAlgorithmIdentifierPtr CPKIFKeyTransRecipientInfo::GetKeyEncryptionAlgorithm (  )  const

Interface: External

This function returns the algorithm identifier that indicates the key encryption algorithm.

Returns:
The algorithm identifier that indicates the key encryption algorithm.

Definition at line 204 of file KeyTransRecipientInfo.cpp.

CPKIFBufferPtr CPKIFKeyTransRecipientInfo::GetEncryptedKey (  )  const

Interface: External

This function returns the encrypted key.

Returns:
A smart pointer to CPKIFBuffer object

Definition at line 215 of file KeyTransRecipientInfo.cpp.


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

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