CPKIFAiaOrSiaRetrieval Class Reference

#include <PKIFAiaOrSiaRetrieval.h>

Inheritance diagram for CPKIFAiaOrSiaRetrieval:

[legend]

Collaboration diagram for CPKIFAiaOrSiaRetrieval:

[legend]

List of all members.

---

Detailed Description

This class provides a means of retrieving certificates from locations specified in HTTP and LDAP URL AIA, SIA and IssuerAltName extensions. Typically, this class is not used directly by applications and is intended for as a colleague associated with a cache mediator used by the path builder.

TSP-enforcing: No

Definition at line 27 of file PKIFAiaOrSiaRetrieval.h.

Public Member Functions
	CPKIFAiaOrSiaRetrieval (void)
virtual	~CPKIFAiaOrSiaRetrieval (void)
void	Initialize (void)
void	GetCertificates (const CPKIFCertificatePtr &cert, CPKIFCertificateNodeList &certNodeList, PKIInfoSource source=ALL, PathBuildingDirection pbd=PBD_FORWARD)
void	GetCertificates (const CPKIFCertificatePtr &cert, CPKIFCertificateList &certList, PKIInfoSource source=ALL, PathBuildingDirection pbd=PBD_FORWARD)
void	GetCertificates (const CPKIFNamePtr &subDN, CPKIFCertificateList &certList, PKIInfoSource source=ALL)
void	GetCertificateSources (const CPKIFCertificatePtr &cert, CPKIFCertificateSourceList &certNodeList, PathBuildingDirection pbd=PBD_FORWARD)
PKIInfoSource	GetSourceType ()

---

Constructor & Destructor Documentation

CPKIFAiaOrSiaRetrieval::CPKIFAiaOrSiaRetrieval

(

void

)

Interface: External

This function creates and initializes CPKIFAiaOrSiaRetrieval objects.

Returns:

None

Definition at line 42 of file PKIFAiaOrSiaRetrieval.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SR_MISC.

CPKIFAiaOrSiaRetrieval::~CPKIFAiaOrSiaRetrieval

(

void

)

[virtual]

Interface: External

This function destroys CPKIFAiaOrSiaRetrieval objects

Returns:

None

Definition at line 54 of file PKIFAiaOrSiaRetrieval.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SR_MISC.

---

Member Function Documentation

void CPKIFAiaOrSiaRetrieval::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 69 of file PKIFAiaOrSiaRetrieval.cpp.

void CPKIFAiaOrSiaRetrieval::GetCertificates	(	const CPKIFCertificatePtr &	cert,
		CPKIFCertificateNodeList &	certNodeList,
		PKIInfoSource	source = ALL,
		PathBuildingDirection	pbd = PBD_FORWARD
	)			[virtual]

Interface: External

This function appends pointers to CRLs that may be applicable to the certificate identified by cert to crlList. The CRLs are retrieved from HTTP or LDAP URLs specified in the CRL Distribution Points extension of the certificate passed via the cert parameter. This function does not ensure that the CRLs retrieved are applicable to the specified certificate. The function simply returns without searching when source is equal to LOCAL.

Returns:

None

Parameters:

cert	[in] Pointer to a certificate containing information to use to retrieve additional certificates
certNodeList	[out] Reference to a cert node list to receive certs that may be associated with the specified certificate
pbd	[in] PathBuildingDirection value indicating the direction for which certificates are sought

Reimplemented from IPKIFCertRepository.

Definition at line 84 of file PKIFAiaOrSiaRetrieval.cpp.

References GetCertsFromIssuerAltName(), PKIFENUMS::LOCAL, LOG_STRING_DEBUG, and TOOLKIT_SR_MISC.

void CPKIFAiaOrSiaRetrieval::GetCertificates	(	const CPKIFCertificatePtr &	cert,
		CPKIFCertificateList &	certList,
		PKIInfoSource	source = ALL,
		PathBuildingDirection	pbd = PBD_FORWARD
	)			[virtual]

Interface: External

This function provides a means of retrieving certificates using an input certificate used to discover additional certificates

Returns:

None

Reimplemented from IPKIFCertRepository.

Definition at line 101 of file PKIFAiaOrSiaRetrieval.cpp.

References GetCertsFromIssuerAltName(), PKIFENUMS::LOCAL, LOG_STRING_DEBUG, and TOOLKIT_SR_MISC.

void CPKIFAiaOrSiaRetrieval::GetCertificates	(	const CPKIFNamePtr &	subDN,
		CPKIFCertificateList &	certList,
		PKIInfoSource	source = ALL
	)			[virtual]

Interface: External

This version of GetCertificates does not do anything. Since this class is intended to retrieve certificates from AIA and SIA-based locations, there is nothing for it to do given a subject DN.

Returns:

None

Parameters:

subDN	[in] Pointer to a distinguished name corresponding to the subject distinguished name in the desired certificates
certList	[out] List of pointers to certificates with a subject distinguished name equal to the value passed via the subDN parameter
source	[in] PKIInfoSource value indicating the types of locations that should be searched for certificates

Implements IPKIFCertRepository.

Definition at line 249 of file PKIFAiaOrSiaRetrieval.cpp.

void CPKIFAiaOrSiaRetrieval::GetCertificateSources	(	const CPKIFCertificatePtr &	cert,
		CPKIFCertificateSourceList &	certNodeList,
		PathBuildingDirection	pbd = PBD_FORWARD
	)

Interface: External

This function populates the CPKIFCertificateSourceList list based on the information retrived from the certificate. If certificate contained IssuerAltName, SubjectInfoAccess, AuthorityInfoAccess it will be added to the CPKIFCertificateSourceList

Returns:

None

Parameters:

cert	[in] Pointer to a certificate from which sources will be obtained
certNodeList	[out] A refernce to CPKIFCertificateSourceList object which will contain all the retrived sources
pbd	[in] PathBuildingDirection value indicating the direction of the builder calling this function (indicated whether AIA or SIA should be chased)

Definition at line 127 of file PKIFAiaOrSiaRetrieval.cpp.

References g_aiaCAIssuer, g_aiaCARepository, LOG_STRING_DEBUG, PKIFENUMS::PBD_FORWARD, TOOLKIT_SR_MISC, and UriAlreadyInList().

PKIInfoSource CPKIFAiaOrSiaRetrieval::GetSourceType

(

)

[inline, virtual]

Implements IPKIFCertRepository.

Definition at line 45 of file PKIFAiaOrSiaRetrieval.h.

References PKIFENUMS::REMOTE.

---

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

• PKIFAiaOrSiaRetrieval.h
• PKIFAiaOrSiaRetrieval.cpp