CPKIFX509CRLChecker Class Reference

#include <PKIFX509CRLChecker.h>

Inheritance diagram for CPKIFX509CRLChecker:

[legend]

Collaboration diagram for CPKIFX509CRLChecker:

[legend]

List of all members.

Detailed Description

Applications do not typically operate directly on colleague objects. Information provided in this section is intended for developers creating custom colleagues that implement similar functionality. Details of private functions and member variables are not provided.

TSP-enforcing: No

Definition at line 42 of file PKIFX509CRLChecker.h.


Public Types
enum	CERTTYPES { CT_EE_DP, CT_EE, CT_CA_DP, CT_CA, CT_UNSUPPORTED }
	The CERTTYPES enum is used to identify certificate types. More...
enum	CRLSCOPE { CS_COMPLETE, CS_DP, CS_DELTA, CS_DELTA_DP, CS_UNSUPPORTED }
	The CRLSCOPE enum is used to identify CRL scope. More...
enum	CRLCOVERAGE { CC_ALL, CC_EEONLY, CC_CAONLY, CC_UNSUPPORTED }
	The CRLCOVERAGE enum is used to identify CRL coverage. More...
enum	CRLAUTHORITY { CA_DIRECT, CA_INDIRECT, CA_UNSUPPORTED }
	The CRLAUTHORITY enum is used to identify CRL authority. More...
enum	CRLREASONS { CR_ALLREASONS, CR_SOMEREASONS, CR_UNSUPPORTED }
	The CRLREASONS enum is used to identify CRL reasons. More...
Public Member Functions
	CPKIFX509CRLChecker (void)
virtual	~CPKIFX509CRLChecker (void)
void	Initialize ()
bool	CheckStatus (const CPKIFCertificatePtr &targetCert, const CPKIFCertificatePtr &issuersCert, RevocationStatus &status, CPKIFCertStatusPtr &certStatus)
bool	CheckStatusPath (CPKIFCertificatePath &path, RevocationStatus &status)
void	SetReasonCodesOfInterest (CPKIFReasonFlagsPtr &reasons)
CPKIFReasonFlagsPtr	GetReasonCodesOfInterest () const
CPKIFPathSettingsPtr	GetPathSettings () const
void	SetPathSettings (CPKIFPathSettingsPtr &settings)
Friends
struct	CPKIFX509CRLCheckerImpl

Member Enumeration Documentation

enum CPKIFX509CRLChecker::CERTTYPES

The CERTTYPES enum is used to identify certificate types.

Enumerator:

CT_EE_DP
CT_EE
CT_CA_DP
CT_CA
CT_UNSUPPORTED

Definition at line 51 of file PKIFX509CRLChecker.h.

enum CPKIFX509CRLChecker::CRLSCOPE

The CRLSCOPE enum is used to identify CRL scope.

Enumerator:

CS_COMPLETE
CS_DP
CS_DELTA
CS_DELTA_DP
CS_UNSUPPORTED

Definition at line 53 of file PKIFX509CRLChecker.h.

enum CPKIFX509CRLChecker::CRLCOVERAGE

The CRLCOVERAGE enum is used to identify CRL coverage.

Enumerator:

CC_ALL
CC_EEONLY
CC_CAONLY
CC_UNSUPPORTED

Definition at line 55 of file PKIFX509CRLChecker.h.

enum CPKIFX509CRLChecker::CRLAUTHORITY

The CRLAUTHORITY enum is used to identify CRL authority.

Enumerator:

CA_DIRECT
CA_INDIRECT
CA_UNSUPPORTED

Definition at line 57 of file PKIFX509CRLChecker.h.

enum CPKIFX509CRLChecker::CRLREASONS

The CRLREASONS enum is used to identify CRL reasons.

Enumerator:

CR_ALLREASONS
CR_SOMEREASONS
CR_UNSUPPORTED

Definition at line 59 of file PKIFX509CRLChecker.h.

Constructor & Destructor Documentation

CPKIFX509CRLChecker::CPKIFX509CRLChecker ( void )

Interface: External

This function creates and initializes CPKIFX509CRLChecker objects.

Returns:: None

Definition at line 2780 of file CCACX509CRLChecker.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.

CPKIFX509CRLChecker::~CPKIFX509CRLChecker ( void ) [virtual]

Interface: External

This function destroys CPKIFX509CRLChecker objects.

Returns:: None

Definition at line 2792 of file CCACX509CRLChecker.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.

Member Function Documentation

void CPKIFX509CRLChecker::Initialize ( void ) [virtual]

Interface: External

This function initializes an instance for use in a collection of IPKIFColleague objects held by a mediator.

Returns:: None

Reimplemented from IPKIFColleague.

Definition at line 2805 of file CCACX509CRLChecker.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.

bool CPKIFX509CRLChecker::CheckStatus	(	const CPKIFCertificatePtr &	targetCert,
		const CPKIFCertificatePtr &	issuersCert,
		RevocationStatus &	status,
		CPKIFCertStatusPtr &	certStatus
	)			`[virtual]`

Interface: External

This function may be used to check the revocation status of a single certificate. It is not typically invoked directly by applications. Instead, applications invoke this function on a mediator object with which an instance of this class has been associated.

Returns:: This function returns true if the revocation status could be determined and false otherwise.

Parameters:

targetCert	[in] Reference to a smart pointer to a CPKIFCertificate object containing the certificate for which revocation status is sought
issuersCert	[in] Reference to a smart pointer to a CPKIFCertificate object containing the certificate of the issuer of the certificate passed via the cert parameter
status	[out] Reference to a RevocationStatus variable to receive the revocation status
certStatus	[out] Reference to a smart pointer to a CPKIFCertStatus object containing status information about target certificate

Implements IPKIFRevocationStatus.

Definition at line 2818 of file CCACX509CRLChecker.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.

bool CPKIFX509CRLChecker::CheckStatusPath	(	CPKIFCertificatePath &	path,
		RevocationStatus &	status
	)			`[virtual]`

Interface: External

This function is used to check the revocation status of each certificate in a certification path. It is invoked during path validation to determine the revocation status of each certificate in a certificate path.

Returns:: None

Parameters:

path	[in/out] Reference to a CPKIFCertificatePath object containing the certificates for which revocation status is sought; status information is directly associated with each entry in the path
status	[out] Reference to a RevocationStatus object to receive the least successful revocation status value assigned to a certificate passed via the path parameter

Implements IPKIFRevocationStatus.

Definition at line 2853 of file CCACX509CRLChecker.cpp.

References g_ocspNoCheck, CPKIFCertificatePath::GetPath(), CPKIFCertificatePath::GetPathSettings(), CPKIFCertificatePath::GetTrustRoot(), LOG_STRING_DEBUG, NOT_CHECKED, NOT_REVOKED, and TOOLKIT_PATH_MISC.

void CPKIFX509CRLChecker::SetReasonCodesOfInterest ( CPKIFReasonFlagsPtr & reasons )

Interface: External

This function is used to specify the values of the reason codes of interest associated with a CPKIFX509CRLChecker instance. Currently, reason-based partitioning is not support so these functions have no effect on processing.

Returns:: None

Parameters:

reasons

[in] Reference to a smart pointer to a CPKIFReasonFlags object containing the reason codes of interest to set

Definition at line 2960 of file CCACX509CRLChecker.cpp.

CPKIFReasonFlagsPtr CPKIFX509CRLChecker::GetReasonCodesOfInterest ( ) const

Interface: External

This function is used to retrieve the values of the reason codes of interest associated with a CPKIFX509CRLChecker instance. Currently, reason-based partitioning is not support so these functions have no effect on processing.

Returns:: The GetReasonCodesOfInterest function returns a smart pointer to a CPKIFReasonFlags object containing the reason codes of interest, if present, and NULL otherwise.

Definition at line 2976 of file CCACX509CRLChecker.cpp.

CPKIFPathSettingsPtr CPKIFX509CRLChecker::GetPathSettings ( ) const

Definition at line 2981 of file CCACX509CRLChecker.cpp.

void CPKIFX509CRLChecker::SetPathSettings ( CPKIFPathSettingsPtr & settings )

Definition at line 2985 of file CCACX509CRLChecker.cpp.

Friends And Related Function Documentation

friend struct CPKIFX509CRLCheckerImpl [friend]

Definition at line 44 of file PKIFX509CRLChecker.h.

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

CPKIFX509CRLChecker Class Reference

Detailed Description

Public Types

Public Member Functions

Friends

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation