CPKIFAuthorityKeyIdentifier Class Reference

#include <AuthorityKeyIdentifier.h>

Inheritance diagram for CPKIFAuthorityKeyIdentifier:

Inheritance graph
[legend]
Collaboration diagram for CPKIFAuthorityKeyIdentifier:

Collaboration graph
[legend]

List of all members.


Detailed Description

CPKIFAuthorityKeyIdentifier provides access to information found in an authority key identifier extension. The ASN.1 definition used by PKIF is given below:
AuthorityKeyIdentifier ::= SEQUENCE 
{
    keyIdentifier             [0] KeyIdentifier OPTIONAL,
    authorityCertIssuer       [1] GeneralNames OPTIONAL,
    authorityCertSerialNumber [2] CertificateSerialNumber OPTIONAL 
}

For details on accessing extensions in a certificate or CRL, see the sections on CPKIFCertificate and CPKIFCRL. PKIF does not provide a means of encoding extensions. This class is used to parse extensions present in encoded objects, e.g. public-key certificates.

TSP-enforcing: No

Definition at line 49 of file AuthorityKeyIdentifier.h.


Public Member Functions

 CPKIFAuthorityKeyIdentifier ()
 CPKIFAuthorityKeyIdentifier (const bool &criticality, const CPKIFBufferPtr &ext)
virtual ~CPKIFAuthorityKeyIdentifier ()
const CPKIFOIDPtr oid () const
bool IssDNAndSerialNumberPresent () const
bool KeyIDPresent () const
void Issuer (CPKIFGeneralNameList &issuer) const
const char * SerialNumber () const
CPKIFBufferPtr KeyIdentifier () const
CPKIFBufferPtr value () const

Static Public Attributes

static char extOID [] = "2.5.29.35"

Constructor & Destructor Documentation

CPKIFAuthorityKeyIdentifier::CPKIFAuthorityKeyIdentifier (  ) 

Interface: External

Default constructor

Returns:
None

Definition at line 50 of file AuthorityKeyIdentifier.cpp.

CPKIFAuthorityKeyIdentifier::CPKIFAuthorityKeyIdentifier ( const bool &  criticality,
const CPKIFBufferPtr &  ext 
)

Interface: External

This constructor is internally invoked; this version 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 Interface: External
This constructor is internally invoked; this version 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 

Definition at line 109 of file AuthorityKeyIdentifier.cpp.

References CACASNWRAPPER_CREATE.

CPKIFAuthorityKeyIdentifier::~CPKIFAuthorityKeyIdentifier (  )  [virtual]

Interface: External

The function destroys an instance of CPKIFAuthorityKeyIdentifier.

Returns:
None

Definition at line 163 of file AuthorityKeyIdentifier.cpp.


Member Function Documentation

const CPKIFOIDPtr CPKIFAuthorityKeyIdentifier::oid (  )  const [virtual]

Interface: External

This function returns a smart pointer to a CPKIFOID object containing the object identifier associated with this type of extension.

Returns:
A smart pointer to a CPKIFOID object containing the object identifier associated with this type of extension.

Reimplemented from CPKIFX509Extension.

Definition at line 179 of file AuthorityKeyIdentifier.cpp.

References extOID.

bool CPKIFAuthorityKeyIdentifier::IssDNAndSerialNumberPresent (  )  const

Interface: External

This function returns true if the issuer DN and serial number values are present and false otherwise.

Returns:
True if the issuer DN and serial number values are present and false otherwise.

Definition at line 221 of file AuthorityKeyIdentifier.cpp.

Referenced by operator<<(), and CPKIFGeneralCRLDetailsPanel::PopulateListExtensions().

bool CPKIFAuthorityKeyIdentifier::KeyIDPresent (  )  const

Interface: External

This function returns true if a key identifier value is present and false otherwise.

Returns:
True if a key identifier value is present and false otherwise.

Definition at line 235 of file AuthorityKeyIdentifier.cpp.

Referenced by operator<<(), and CPKIFGeneralCRLDetailsPanel::PopulateListExtensions().

void CPKIFAuthorityKeyIdentifier::Issuer ( CPKIFGeneralNameList genNames  )  const

Interface: External

This function returns the issuer name values, if present. If the issuer name is not present or is empty, the issuer list will be empty following a call to this function.

Returns:
The issuer name values
Parameters:
genNames  [out] Reference to a list of smart pointers to CPKIFGeneralName objects to receive the name(s) of the issuer, if present

Definition at line 250 of file AuthorityKeyIdentifier.cpp.

Referenced by operator<<(), and CPKIFGeneralCRLDetailsPanel::PopulateListExtensions().

const char * CPKIFAuthorityKeyIdentifier::SerialNumber (  )  const

Interface: External

This function returns the serial number value, if present. Note that the return value is a pointer to the internal value of serial number, and as such is valid only for the life of the CPKIFAuthorityKeyIdentifier object.

Returns:
The serial number value

Definition at line 195 of file AuthorityKeyIdentifier.cpp.

Referenced by operator<<(), and CPKIFGeneralCRLDetailsPanel::PopulateListExtensions().

CPKIFBufferPtr CPKIFAuthorityKeyIdentifier::KeyIdentifier (  )  const

Interface: External

This function returns a smart pointer to a CPKIFBuffer object containing the key identifier value, if present.

Returns:
A smart pointer to a CPKIFBuffer object containing the key identifier value, if present.

Definition at line 209 of file AuthorityKeyIdentifier.cpp.

Referenced by operator<<(), and CPKIFGeneralCRLDetailsPanel::PopulateListExtensions().

CPKIFBufferPtr CPKIFAuthorityKeyIdentifier::value (  )  const [virtual]

Interface: External

This function returns a smart pointer to a CPKIFBuffer object containing value of the extension.

Returns:
A smart pointer to a CPKIFBuffer object containing value of the extension.

Reimplemented from CPKIFX509Extension.

Definition at line 271 of file AuthorityKeyIdentifier.cpp.


Member Data Documentation

char CPKIFAuthorityKeyIdentifier::extOID = "2.5.29.35" [static]

The extOID member of each extension class provides a NULL terminated string representation of the object identifier that identifies the extension. The value defined for this class is "2.5.29.35".

Definition at line 58 of file AuthorityKeyIdentifier.h.

Referenced by oid(), and CPKIFAuthorityKeyIdentifierFactory::refOID().


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

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