CPKIFCRLReason Class Reference

#include <CRLReason.h>

Inheritance diagram for CPKIFCRLReason:

Inheritance graph
[legend]
Collaboration diagram for CPKIFCRLReason:

Collaboration graph
[legend]

List of all members.


Detailed Description

CPKIFCRLReason provides access to information found in a CRL reason extension. The ASN.1 definition used by PKIF is given below:
  CRLReason ::= ENUMERATED 
  {
    unspecified                  (0),
    keyCompromise                (1), 
    cACompromise                 (2), 
    affiliationChanged           (3), 
    superseded                   (4),
    cessationOfOperation         (5),
    certificateHold              (6),
    removeFromCRL                (8)
  } 

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 50 of file CRLReason.h.


Public Member Functions

 CPKIFCRLReason ()
 CPKIFCRLReason (const int reason)
 CPKIFCRLReason (const bool &criticality, const CPKIFBufferPtr &ext)
virtual ~CPKIFCRLReason ()
const CPKIFOIDPtr oid () const
bool Unspecified () const
bool KeyCompromise () const
bool CACompromise () const
bool AffiliationChanged () const
bool Superseded () const
bool CessationOfOperation () const
bool CertificateHold () const
bool RemoveFromCRL () const
CPKIFBufferPtr value () const

Static Public Attributes

static char extOID [] = "2.5.29.21"

Constructor & Destructor Documentation

CPKIFCRLReason::CPKIFCRLReason (  ) 

Interface: External

Default constructor

Returns:
None

Definition at line 40 of file CRLReason.cpp.

CPKIFCRLReason::CPKIFCRLReason ( const int  reason  ) 

Interface: External

The constructor can also accept CACX509V3CRLReason_Root as a parameter because CACX509V3CRLReason_Root is a typedef of CACX509V3CRLReason.

Returns:
None
Parameters:
reason  [in] An integer which indicates CRL reason

Definition at line 52 of file CRLReason.cpp.

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

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 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 

Definition at line 250 of file CRLReason.cpp.

References CACASNWRAPPER_CREATE.

CPKIFCRLReason::~CPKIFCRLReason (  )  [virtual]

Interface: External

The function destroys an instance of CPKIFCRLReason.

Returns:
None

Definition at line 298 of file CRLReason.cpp.


Member Function Documentation

const CPKIFOIDPtr CPKIFCRLReason::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 314 of file CRLReason.cpp.

References extOID.

bool CPKIFCRLReason::Unspecified (  )  const

Interface: External

The constructor can also accept CACX509V3CRLReason_Root as a parameter because CACX509V3CRLReason_Root is a typedef of CACX509V3CRLReason.

Returns:
None Interface: External
A bool indicating whether the Unspecified reason was indicated in the CRLReason extension.

Returns:
A bool indicating whether the Unspecified reason was indicated in the CRLReason extension.

Definition at line 134 of file CRLReason.cpp.

Referenced by CPKIFGeneralCRLDetailsPanel::PopulateListExtensions().

bool CPKIFCRLReason::KeyCompromise (  )  const

Interface: External

A bool indicating whether the KeyCompromise reason was indicated in the CRLReason extension.

Returns:
A bool indicating whether the KeyCompromise reason was indicated in the CRLReason extension.

Definition at line 142 of file CRLReason.cpp.

Referenced by CPKIFGeneralCRLDetailsPanel::PopulateListExtensions().

bool CPKIFCRLReason::CACompromise (  )  const

Interface: External

A bool indicating whether the CACompromise reason was indicated in the CRLReason extension.

Returns:
A bool indicating whether the CACompromise reason was indicated in the CRLReason extension.

Definition at line 150 of file CRLReason.cpp.

Referenced by CPKIFGeneralCRLDetailsPanel::PopulateListExtensions().

bool CPKIFCRLReason::AffiliationChanged (  )  const

Interface: External

A bool indicating whether the AffliationChanged reason was indicated in the CRLReason extension.

Returns:
A bool indicating whether the AffliationChanged reason was indicated in the CRLReason extension.

Definition at line 158 of file CRLReason.cpp.

Referenced by CPKIFGeneralCRLDetailsPanel::PopulateListExtensions().

bool CPKIFCRLReason::Superseded (  )  const

Interface: External

A bool indicating whether the Superseded reason was indicated in the CRLReason extension.

Returns:
A bool indicating whether the Superseded reason was indicated in the CRLReason extension.

Definition at line 166 of file CRLReason.cpp.

Referenced by CPKIFGeneralCRLDetailsPanel::PopulateListExtensions().

bool CPKIFCRLReason::CessationOfOperation (  )  const

Interface: External

A bool indicating whether the CessationOfOperation reason was indicated in the CRLReason extension.

Returns:
A bool indicating whether the Superseded reason was indicated in the CRLReason extension.

Definition at line 174 of file CRLReason.cpp.

Referenced by CPKIFGeneralCRLDetailsPanel::PopulateListExtensions().

bool CPKIFCRLReason::CertificateHold (  )  const

Interface: External

A bool indicating whether the CertificateHold reason was indicated in the CRLReason extension.

Returns:
A bool indicating whether the CertificateHold reason was indicated in the CRLReason extension.

Definition at line 182 of file CRLReason.cpp.

Referenced by CPKIFGeneralCRLDetailsPanel::PopulateListExtensions().

bool CPKIFCRLReason::RemoveFromCRL (  )  const

Interface: External

A bool indicating whether the RemoveFromCRL reason was indicated in the CRLReason extension.

Returns:
A bool indicating whether the RemoveFromCRL reason was indicated in the CRLReason extension.

Definition at line 190 of file CRLReason.cpp.

Referenced by CPKIFGeneralCRLDetailsPanel::PopulateListExtensions().

CPKIFBufferPtr CPKIFCRLReason::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 329 of file CRLReason.cpp.


Member Data Documentation

char CPKIFCRLReason::extOID = "2.5.29.21" [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.21".

Definition at line 64 of file CRLReason.h.

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


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

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