IPKIFCertRepository Class Reference

#include <IPKIFCertRepository.h>

Inheritance diagram for IPKIFCertRepository:

Detailed Description

The IPKIFCertRepository interface defines the means by which certificates are retrieved from various sources of PKI information. This most commonly occurs in support of path development. PKIF provides one mediator and three colleague classes that implement this interface: CPKIFCacheMediator2, CPKIFCAPIRepository2, SimpleCertCache and CPKIFLDAPRepository.

TSP-enforcing: No

Definition at line 32 of file IPKIFCertRepository.h.


Public Member Functions
	IPKIFCertRepository ()
virtual void	GetCertificates (const CPKIFNamePtr &subDN, CPKIFCertificateList &certList, PKIInfoSource source=ALL)=0
virtual void	GetCertificates (const CPKIFCertificatePtr &cert, CPKIFCertificateList &certList, PKIInfoSource source=ALL, PathBuildingDirection pbd=PBD_FORWARD)
virtual void	GetCertificates (const CPKIFCertificatePtr &cert, CPKIFCertificateNodeList &certNodeList, PKIInfoSource source=ALL, PathBuildingDirection pbd=PBD_FORWARD)
virtual void	GetCertificates (const CPKIFNamePtr &subDN, CPKIFCertificateNodeList &certNodeList, PKIInfoSource source=ALL)
virtual void	GetCertificates (const CPKIFNamePtr &subDN, CPKIFCertificateList &certList, PKIInfoSource source, CPKIFPathSettingsPtr &ps)
virtual void	GetCertificates (const CPKIFCertificatePtr &cert, CPKIFCertificateList &certList, PKIInfoSource source, PathBuildingDirection pbd, CPKIFPathSettingsPtr &ps)
virtual void	GetCertificates (const CPKIFCertificatePtr &cert, CPKIFCertificateNodeList &certNodeList, PKIInfoSource source, PathBuildingDirection pbd, CPKIFPathSettingsPtr &ps)
virtual void	GetCertificates (const CPKIFNamePtr &subDN, CPKIFCertificateNodeList &certNodeList, PKIInfoSource source, CPKIFPathSettingsPtr &ps)
virtual PKIInfoSource	GetSourceType ()=0

Constructor & Destructor Documentation

IPKIFCertRepository::IPKIFCertRepository ( )

Interface: External

Default constructor

Returns:: None

Definition at line 28 of file IPKIFCertRepository.cpp.

Member Function Documentation

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

This function provides a means of retrieving certificates issued to an entity with a specific subject name. This function is invoked during forward-direction path development (i.e. building from the target certificate to a trust anchor) using the issuer name of from a certificate for which the issuer is sought as the subDN parameter.

Certificates (or certificate node objects) are added to the list passed via the certList (or certNodeList) parameter. The list should not be emptied upon entry because a mediator may query a number of sources before returning the list to the caller. Thus, the list may contain certificates that do not match the name specified by subDN upon return. Implementations of this function may raise an exception if the target store cannot be opened for reading. Implementations may throw an exception if ASN.1 decoding errors occur or may fail silently, possibly with a log entry indicating the error.

Implemented in CPKIFAiaOrSiaRetrieval, CPKIFCacheMediator2, CPKIFCAPIRepository2, CPKIFLDAPRepository, CPKIFNSSRepository, and SimpleCertCache.

Referenced by _GetCRLIssuersCert(), and GetCertificates().

void IPKIFCertRepository::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

Parameters:

cert	[in] Certificate containing information that can be used to discover additional certificates
certList	[out] Certificates discovered using information gleened from cert parameter
source	[in] Enumerated value indicating the type of sources to consult for certificates
pbd	[in] Enumerated value indicating the direction in which certificates are sought

Reimplemented in CPKIFAiaOrSiaRetrieval, CPKIFCacheMediator2, CPKIFCAPIRepository2, CPKIFLDAPRepository, and SimpleCertCache.

Definition at line 92 of file IPKIFCertRepository.cpp.

References GetCertificates(), and PKIFENUMS::PBD_FORWARD.

void IPKIFCertRepository::GetCertificates	(	const CPKIFCertificatePtr &	cert,
		CPKIFCertificateNodeList &	certNodeList,
		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

Parameters:

cert	[in] Certificate containing information that can be used to discover additional certificates
certNodeList	[out] Certificates discovered using information gleened from cert parameter
source	[in] Enumerated value indicating the type of sources to consult for certificates
pbd	[in] Enumerated value indicating the direction in which certificates are sought

Reimplemented in CPKIFAiaOrSiaRetrieval, CPKIFCacheMediator2, and SimpleCertCache.

Definition at line 119 of file IPKIFCertRepository.cpp.

References GetCertificates(), GetSourceType(), LOG_STRING_DEBUG, GottaMatch< T >::SetRHS(), and TOOLKIT_SR_MISC.

void IPKIFCertRepository::GetCertificates	(	const CPKIFNamePtr &	subDN,
		CPKIFCertificateNodeList &	certNodeList,
		PKIInfoSource	source = `ALL`
	)			`[virtual]`

Interface: External

This function provides a means of retrieving certificates issued to an entity with a specific subject name. This function is invoked during forward-direction path development (i.e. building from the target certificate to a trust anchor) using the issuer name of from a certificate for which the issuer is sought as the subDN parameter.

Returns:: None

Parameters:

subDN	[in] Reference to a smart pointer to a CPKIFName object containing the subject distinguished name for which certificates are sought
certNodeList	[out] Reference to a CPKIFCertificateNodeList to receive certificates with subject distinguished name matching the value passed via subDN
source	[in] PKIInfoSource value indicating the types of PKI information sources to search, e.g. local sources or remote sources

Reimplemented in CPKIFCacheMediator2, and SimpleCertCache.

Definition at line 42 of file IPKIFCertRepository.cpp.

References GetCertificates(), GetSourceType(), LOG_STRING_DEBUG, GottaMatch< T >::SetRHS(), and TOOLKIT_SR_MISC.

void IPKIFCertRepository::GetCertificates	(	const CPKIFNamePtr &	subDN,
		CPKIFCertificateList &	certList,
		PKIInfoSource	source,
		CPKIFPathSettingsPtr &	ps
	)			`[virtual]`

Interface: External

This function provides a means of retrieving certificates issued to an entity with a specific subject name. This function is invoked during forward-direction path development (i.e. building from the target certificate to a trust anchor) using the issuer name of from a certificate for which the issuer is sought as the subDN parameter.

Returns:: None

Parameters:

subDN	[in] Reference to a smart pointer to a CPKIFName object containing the subject distinguished name for which certificates are sought
certList	[out] Reference to a CPKIFCertificateNodeList to receive certificates with subject distinguished name matching the value passed via subDN
source	[in] Enumerated value indicating the type of sources to consult for certificates
ps	[in] Path settings

Reimplemented in CPKIFCacheMediator2.

Definition at line 175 of file IPKIFCertRepository.cpp.

References GetCertificates().

void IPKIFCertRepository::GetCertificates	(	const CPKIFCertificatePtr &	cert,
		CPKIFCertificateList &	certList,
		PKIInfoSource	source,
		PathBuildingDirection	pbd,
		CPKIFPathSettingsPtr &	ps
	)			`[virtual]`

Interface: External

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

Returns:: None

Parameters:

cert	[in] Certificate containing information that can be used to discover additional certificates
certList	[out] Certificates discovered using information gleened from cert parameter
source	[in] Enumerated value indicating the type of sources to consult for certificates
pbd	[in] Enumerated value indicating the direction in which certificates are sought
ps	[in] Path settings

Reimplemented in CPKIFCacheMediator2.

Definition at line 195 of file IPKIFCertRepository.cpp.

References GetCertificates().

void IPKIFCertRepository::GetCertificates	(	const CPKIFCertificatePtr &	cert,
		CPKIFCertificateNodeList &	certNodeList,
		PKIInfoSource	source,
		PathBuildingDirection	pbd,
		CPKIFPathSettingsPtr &	ps
	)			`[virtual]`

Interface: External

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

Returns:: None

Parameters:

cert	[in] Certificate containing information that can be used to discover additional certificates
certNodeList	[out] Certificates discovered using information gleened from cert parameter
source	[in] Enumerated value indicating the type of sources to consult for certificates
pbd	[in] Enumerated value indicating the direction in which certificates are sought
ps	[in] Path settings

Reimplemented in CPKIFCacheMediator2.

Definition at line 217 of file IPKIFCertRepository.cpp.

References GetCertificates(), GetSourceType(), and GottaMatch< T >::SetRHS().

void IPKIFCertRepository::GetCertificates	(	const CPKIFNamePtr &	subDN,
		CPKIFCertificateNodeList &	certNodeList,
		PKIInfoSource	source,
		CPKIFPathSettingsPtr &	ps
	)			`[virtual]`

Interface: External

This function provides a means of retrieving certificates issued to an entity with a specific subject name. This function is invoked during forward-direction path development (i.e. building from the target certificate to a trust anchor) using the issuer name of from a certificate for which the issuer is sought as the subDN parameter.

Returns:: None

Parameters:

subDN	[in] Reference to a smart pointer to a CPKIFName object containing the subject distinguished name for which certificates are sought
certNodeList	[out] Reference to a CPKIFCertificateNodeList to receive certificates with subject distinguished name matching the value passed via subDN
source	[in] Enumerated value indicating the type of sources to consult for certificates
ps	[in] Path settings

Reimplemented in CPKIFCacheMediator2.

Definition at line 273 of file IPKIFCertRepository.cpp.

References GetCertificates(), GetSourceType(), and GottaMatch< T >::SetRHS().

virtual PKIInfoSource IPKIFCertRepository::GetSourceType ( ) [pure virtual]

Implemented in CPKIFAiaOrSiaRetrieval, CPKIFCacheMediator2, CPKIFCAPIRepository2, CPKIFLDAPRepository, CPKIFNSSRepository, and SimpleCertCache.

Referenced by GetCertificates().

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

IPKIFCertRepository Class Reference

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation