CPKIFKeyAgreePublicKey Class Reference

#include <KeyAgreePublicKey.h>

Collaboration diagram for CPKIFKeyAgreePublicKey:

Collaboration graph
[legend]

List of all members.


Detailed Description

The CPKIFKeyAgreePublicKey class provides an interface to SCVP ValPolRequest object.

TSP-enforcing: No

Definition at line 31 of file KeyAgreePublicKey.h.


Public Member Functions

 CPKIFKeyAgreePublicKey ()
 CPKIFKeyAgreePublicKey (const CPKIFBufferPtr &)
virtual ~CPKIFKeyAgreePublicKey (void)
void SetPublicKey (CPKIFBufferPtr &nonce)
const CPKIFBufferPtr GetPublicKey () const
void SetAlgorithm (CPKIFAlgorithmIdentifierPtr &valAlg)
CPKIFAlgorithmIdentifierPtr GetAlgorithm () const
void SetMACAlgorithm (CPKIFAlgorithmIdentifierPtr &macAlgorithm)
CPKIFAlgorithmIdentifierPtr GetMACAlgorithm () const
void SetKDF (CPKIFAlgorithmIdentifierPtr &kdf)
CPKIFAlgorithmIdentifierPtr GetKDF () const

Constructor & Destructor Documentation

CPKIFKeyAgreePublicKey::CPKIFKeyAgreePublicKey (  ) 

Interface: External

This function is used to create and initialize CPKIFKeyAgreePublicKey object.

Returns:
None

Definition at line 41 of file KeyAgreePublicKey.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SCVP_ASN.

CPKIFKeyAgreePublicKey::CPKIFKeyAgreePublicKey ( const CPKIFBufferPtr &  keyAgreePublicKey  ) 

Interface: External

This constructor is internally invoked; it will throw a std::bad_alloc exception if allocation of memory fails or ASN.1 decoding errors if the extension cannot be parsed.

Returns:
None
Exceptions:
std::bad_alloc 
Parameters:
keyAgreePublicKey  [in] A reference to a smart pointer to CPKIFBuffer object containing der encoded ValPolRequest

Definition at line 56 of file KeyAgreePublicKey.cpp.

References CACASNWRAPPER_CREATE, COMMON_INVALID_INPUT, and TOOLKIT_SCVP_ASN.

CPKIFKeyAgreePublicKey::~CPKIFKeyAgreePublicKey ( void   )  [virtual]

Interface: External

This function destroys instances of CPKIFKeyAgreePublicKey.

Returns:
None

Definition at line 124 of file KeyAgreePublicKey.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SCVP_ASN.


Member Function Documentation

void CPKIFKeyAgreePublicKey::SetPublicKey ( CPKIFBufferPtr &  publicKey  ) 

Interface: External

This function is used to set the publicKey associated with a CPKIFKeyAgreePublicKey instance.

Returns:
None
Parameters:
publicKey  [in] Reference to a CPKIFStringPtr object containing a NULL terminated ASCII Hex representation of a nonce value to include in a TimeStampRequest

Definition at line 139 of file KeyAgreePublicKey.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SCVP_ASN.

const CPKIFBufferPtr CPKIFKeyAgreePublicKey::GetPublicKey (  )  const

Interface: External

This function is used to get the publicKey associated with a CPKIFKeyAgreePublicKey instance.

Returns:
Smart pointer to CPKIFBuffer object containing the nonce

Definition at line 155 of file KeyAgreePublicKey.cpp.

void CPKIFKeyAgreePublicKey::SetAlgorithm ( CPKIFAlgorithmIdentifierPtr &  algorithm  ) 

Interface: External

This function sets validation alg for CPKIFKeyAgreePublicKey object

Returns:
None
Parameters:
algorithm  [in] Smart pointer to CPKIFAlgorithmIdentifier object which contains validation algorithm

Definition at line 173 of file KeyAgreePublicKey.cpp.

CPKIFAlgorithmIdentifierPtr CPKIFKeyAgreePublicKey::GetAlgorithm (  )  const

Interface: External

This function retrives algorithm from CPKIFKeyAgreePublicKey object

Returns:
Smart pointer to CPKIFAlgorithmIdentifier object containing validation alg

Definition at line 186 of file KeyAgreePublicKey.cpp.

void CPKIFKeyAgreePublicKey::SetMACAlgorithm ( CPKIFAlgorithmIdentifierPtr &  macAlgorithm  ) 

Interface: External

This function sets mac alg for CPKIFKeyAgreePublicKey object

Returns:
None
Parameters:
macAlgorithm  [in] Smart pointer to CPKIFAlgorithmIdentifier object which contains validation algorithm

Definition at line 198 of file KeyAgreePublicKey.cpp.

CPKIFAlgorithmIdentifierPtr CPKIFKeyAgreePublicKey::GetMACAlgorithm (  )  const

Interface: External

This function retrives mac alg from CPKIFKeyAgreePublicKey object

Returns:
Smart pointer to CPKIFAlgorithmIdentifier object containing validation alg

Definition at line 211 of file KeyAgreePublicKey.cpp.

void CPKIFKeyAgreePublicKey::SetKDF ( CPKIFAlgorithmIdentifierPtr &  kDF  ) 

Interface: External

This function sets KDF alg for CPKIFKeyAgreePublicKey object

Returns:
None
Parameters:
kDF  [in] Smart pointer to CPKIFAlgorithmIdentifier object which contains validation algorithm

Definition at line 223 of file KeyAgreePublicKey.cpp.

CPKIFAlgorithmIdentifierPtr CPKIFKeyAgreePublicKey::GetKDF (  )  const

Interface: External

This function retrives KDF alg from CPKIFKeyAgreePublicKey object

Returns:
Smart pointer to CPKIFAlgorithmIdentifier object containing validation alg

Definition at line 236 of file KeyAgreePublicKey.cpp.


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

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