CPKIFCertStatusCache Class Reference

#include <CertStatusCache.h>

Inheritance diagram for CPKIFCertStatusCache:

[legend]

Collaboration diagram for CPKIFCertStatusCache:

[legend]

List of all members.

---

Detailed Description

CPKIFCertStatusCache is used internally by CPKIFRevocationStatusMediator2, which checks the cache or contributes to the cache when CheckStatus or CheckStatusPath.

TSP-enforcing: No

Definition at line 27 of file CertStatusCache.h.

Public Member Functions
	CPKIFCertStatusCache ()
	~CPKIFCertStatusCache ()
void	PutObject (const CPKIFCertificatePtr &targetCert, const CPKIFCertificatePtr &issuersCert, RevocationStatus &status, CPKIFCertStatusPtr &certStatus)
void	PutObjectsInPath (CPKIFCertificatePath &path)
void	SetMaxCacheAge (unsigned long maxAgeInMilliseconds)
long	GetMaxCacheAge () const
void	SetMaxCacheSize (int count)
int	GetMaxCacheSize () const
void	SetCacheCaCertsOnly (bool bCacheCaCertsOnly)
bool	GetCacheCaCertsOnly () const
void	SetPurgeFrequency (int minTimeBetweenPurgesInSeconds)
int	GetPurgeFrequency () const
void	Initialize ()
bool	CheckStatus (const CPKIFCertificatePtr &targetCert, const CPKIFCertificatePtr &issuersCert, RevocationStatus &status, CPKIFCertStatusPtr &certStatus)
bool	CheckStatusPath (CPKIFCertificatePath &path, RevocationStatus &status)

---

Constructor & Destructor Documentation

CPKIFCertStatusCache::CPKIFCertStatusCache

(

)

Interface: Subsystem

Default constructor

Returns:

None

Definition at line 368 of file CertStatusCache.cpp.

CPKIFCertStatusCache::~CPKIFCertStatusCache

(

)

Interface: Subsystem

Default destructor

Returns:

None

Definition at line 379 of file CertStatusCache.cpp.

---

Member Function Documentation

void CPKIFCertStatusCache::PutObject	(	const CPKIFCertificatePtr &	targetCert,
		const CPKIFCertificatePtr &	issuersCert,
		RevocationStatus &	status,
		CPKIFCertStatusPtr &	certStatus
	)

Interface: Subsystem

This function adds an entry to the cache

Returns:

None

Parameters:

targetCert	[in] Target certificate
issuersCert	[in] Issuer certificate
status	[in] Revocation status information
certStatus	[in] Certificate status information

Definition at line 436 of file CertStatusCache.cpp.

References CPKIFTime::CurrentTime().

Referenced by PutObjectsInPath().

void CPKIFCertStatusCache::PutObjectsInPath

(

CPKIFCertificatePath &

path

)

Interface: Subsystem

This function adds certificates from cert path into the cache

Returns:

None

Parameters:

path	[in] Certificate path to be added to the cache

Definition at line 730 of file CertStatusCache.cpp.

References CPKIFCertificatePath::GetPath(), CPKIFCertificatePath::GetTrustRoot(), and PutObject().

void CPKIFCertStatusCache::SetMaxCacheAge

(

unsigned long

maxAgeInMilliseconds

)

Interface: Subsystem

Sets max cache age

Returns:

None

Parameters:

maxAgeInMilliseconds

[in] Max cache age in milliseconds

Definition at line 477 of file CertStatusCache.cpp.

long CPKIFCertStatusCache::GetMaxCacheAge

(

)

const

Interface: Subsystem

Gets max cache age

Returns:

Max cache age in milliseconds

Definition at line 490 of file CertStatusCache.cpp.

void CPKIFCertStatusCache::SetMaxCacheSize

(

int

count

)

Interface: Subsystem

Sets max cache size

Returns:

None

Parameters:

count

[in] Max cache size

Definition at line 501 of file CertStatusCache.cpp.

int CPKIFCertStatusCache::GetMaxCacheSize

(

)

const

Interface: Subsystem

Gets max cache size

Returns:

Max cache size

Definition at line 514 of file CertStatusCache.cpp.

void CPKIFCertStatusCache::SetCacheCaCertsOnly

(

bool

bCacheCaCertsOnly

)

Interface: Subsystem

This function sets boolean flag that will restrict cache to CA certificates only

Returns:

None

Parameters:

bCacheCaCertsOnly

[in] True to restrict to CA certificates only

Definition at line 525 of file CertStatusCache.cpp.

bool CPKIFCertStatusCache::GetCacheCaCertsOnly

(

)

const

Interface: Subsystem

This function lets you know if the cache is restricted to CA certificates only

Returns:

True if the cache is restricted to CA certificates only

Definition at line 538 of file CertStatusCache.cpp.

void CPKIFCertStatusCache::SetPurgeFrequency

(

int

minTimeBetweenPurgesInSeconds

)

Interface: Subsystem

This function sets cache purge frequency

Returns:

None

Parameters:

minTimeBetweenPurgesInSeconds

[in] Cache purge frequency in seconds

Definition at line 549 of file CertStatusCache.cpp.

int CPKIFCertStatusCache::GetPurgeFrequency

(

)

const

Interface: Subsystem

This function gets cache purge frequency

Returns:

Cache purge frequency in seconds

Definition at line 562 of file CertStatusCache.cpp.

void CPKIFCertStatusCache::Initialize

(

void

)

[virtual]

Interface: Subsystem

Cache initialization

Returns:

None

Reimplemented from IPKIFColleague.

Definition at line 575 of file CertStatusCache.cpp.

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

Interface: Subsystem

This function returns status information for a cache entry

Returns:

None

Parameters:

targetCert	[in] Target certificate
issuersCert	[in] Issuer certificate
status	[out] Revocation status
certStatus	[out] Certificate status

Implements IPKIFRevocationStatus.

Definition at line 587 of file CertStatusCache.cpp.

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

Interface: Subsystem

This function returns status of a certificate path after checking the cache for certificate status info.

Returns:

True is status could be determined, false otherwise

Parameters:

path	[in] Target path
status	[out] Revocationg status info for the path

Implements IPKIFRevocationStatus.

Definition at line 620 of file CertStatusCache.cpp.

References CPKIFCertificatePath::GetPath(), CPKIFCertificatePath::GetPathSettings(), CPKIFCertificatePath::GetTrustRoot(), NOT_CHECKED, PATH_CERT_REVOCATION_STATUS_NOT_DETERMINED, PATH_CERT_REVOKED, and REVOKED.

---

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

• CertStatusCache.h
• CertStatusCache.cpp