CPKIFSubjectPublicKeyInfo Class Reference

#include <SubjectPublicKeyInfo.h>

Collaboration diagram for CPKIFSubjectPublicKeyInfo:

Collaboration graph
[legend]

List of all members.


Detailed Description

The CPKIFSubjectPublicKeyInfo provides access to a subject public key information object.

TSP-enforcing: Yes

Definition at line 31 of file SubjectPublicKeyInfo.h.


Public Member Functions

 CPKIFSubjectPublicKeyInfo ()
 CPKIFSubjectPublicKeyInfo (const CPKIFAlgorithmIdentifierPtr &algID, const CPKIFBufferPtr &key)
virtual ~CPKIFSubjectPublicKeyInfo ()
CPKIFAlgorithmIdentifierPtr alg () const
CPKIFBufferPtr rawKey () const
unsigned long numBits (void) const
bool operator== (const CPKIFSubjectPublicKeyInfo &rhs) const

Constructor & Destructor Documentation

CPKIFSubjectPublicKeyInfo::CPKIFSubjectPublicKeyInfo (  ) 

Interface: External

This function is used to create an instance of CPKIFSubjectPublicKeyInfo. This is a default constructor.

Returns:
None

Definition at line 43 of file SubjectPublicKeyInfo.cpp.

CPKIFSubjectPublicKeyInfo::CPKIFSubjectPublicKeyInfo ( const CPKIFAlgorithmIdentifierPtr &  algID,
const CPKIFBufferPtr &  key 
)

Interface: External

This function is used to create an instance of CPKIFSubjectPublicKeyInfo. It is used internally and is not invoked by applications.

Returns:
None
Parameters:
algID  [in] A reference to a smart pointer to CPKIFAlgorithmIdentifier obejct which contains algorithm ID
key  [in] A reference to a smart pointer to CPKIFBuffer which contains the key data

Definition at line 80 of file SubjectPublicKeyInfo.cpp.

CPKIFSubjectPublicKeyInfo::~CPKIFSubjectPublicKeyInfo (  )  [virtual]

Interface: External

The function destroys an instance of CPKIFSubjectPublicKeyInfo.

Returns:
None

Definition at line 108 of file SubjectPublicKeyInfo.cpp.


Member Function Documentation

CPKIFAlgorithmIdentifierPtr CPKIFSubjectPublicKeyInfo::alg (  )  const

Interface: External

This function returns an algorithm identifier object identifying the algorithm associated with the public key or NULL if no algorithm identifier is specified.

Returns:
An algorithm identifier object identifying the algorithm associated with the public key or NULL if no algorithm identifier is specified.

Definition at line 134 of file SubjectPublicKeyInfo.cpp.

CPKIFBufferPtr CPKIFSubjectPublicKeyInfo::rawKey (  )  const

Interface: External

This function returns the raw encoded public key. This function is not used by applications and is only invoked internally to gain access to key material in an internal structure representation. To get the size of the key multiply the length of the buffer by 8.

Returns:
A smart pointer to CPKIFBuffer object which contains the encoded public key.

Definition at line 147 of file SubjectPublicKeyInfo.cpp.

Referenced by operator==().

unsigned long CPKIFSubjectPublicKeyInfo::numBits ( void   )  const

Interface: External

This function returns the length in bits of the public key.

Returns:
public key length, in bits

Definition at line 164 of file SubjectPublicKeyInfo.cpp.

References COMMON_NOT_INITIALIZED, and TOOLKIT_ASN.

bool CPKIFSubjectPublicKeyInfo::operator== ( const CPKIFSubjectPublicKeyInfo rhs  )  const

This function returns true if the buffers returns by calls to rawKey on the two CPKIFSubjectPublicKeyInfo objects are not NULL and contain the same contents.

Definition at line 176 of file SubjectPublicKeyInfo.cpp.

References rawKey().


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

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