CPKIFPathLogger Class Reference

#include <PKIFPathLogger.h>

List of all members.

---

Detailed Description

The CPKIFPathLogger class writes formatted log information to a stream. The stream may be either an application-supplied stream or the default stream created when PKIF loads, as governed by the following registry setting:

HKEY_LOCAL_MACHINE\SOFTWARE\Cygnacom\PKIF\LogFile

The above registry setting, if present, contains the full path and file name of a file to which path information should be logged. The log entries are written automatically following validation operations by CPKIFPathProcessingMediator2.

The auto-log feature should only be used when debugging. The log file grows without bound.

TSP-enforcing: No

Definition at line 36 of file PKIFPathLogger.h.

Public Member Functions
	CPKIFPathLogger ()
	~CPKIFPathLogger ()
Static Public Member Functions
static void	LogValidationResults (CPKIFPathValidationResults &tmpPVR, CPKIFCertificatePath &path, const char *appInfo=NULL, std::ostream *out=NULL)
static void	LogPath (CPKIFCertificatePath &path, const char *appInfo=NULL, std::ostream *out=NULL)

---

Constructor & Destructor Documentation

CPKIFPathLogger::CPKIFPathLogger

(

void

)

Interface: External

This function creates and initializes CPKIFPathLogger objects.

Returns:

None

Definition at line 73 of file PKIFPathLogger.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.

CPKIFPathLogger::~CPKIFPathLogger

(

)

Interface: External

This function destroys CPKIFPathLogger objects.

Returns:

None

Definition at line 85 of file PKIFPathLogger.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.

---

Member Function Documentation

void CPKIFPathLogger::LogValidationResults	(	CPKIFPathValidationResults &	tmpPVR,
		CPKIFCertificatePath &	path,
		const char *	appInfo = NULL,
		std::ostream *	out = NULL
	)			[static]

Interface: External

This function logs validation result and general path information to either the stream indicated by the out parameter or the default stream. If neither stream is available, no log entry is created. The string passed via appInfo will be printed at the top of the log entry, if generated.

Returns:

None

defined _DISABLE_LOG4CXX_PATH_LOGGING

Parameters:

tmpPVR	[in] Reference to a CPKIFPathValidationResults object containing the result information that should be written to the log
path	[in] Reference to a CPKIFCertificatePath object containing the certification path for which information should be written to the log (presumably this is the path associated with the validation results passed via the tmpPVR parameter)
appInfo	[in] Pointer to a NULL-terminated string that will be written to the log along with the path validation results and certification path
out	[in] Optional pointer to a ostream to which log information should be written

Definition at line 607 of file PKIFPathLogger.cpp.

References CPKIFTime::CurrentTime(), CPKIFPathValidationResults::DiagnosticCode(), DumpPolicySet(), DumpPolicyTable(), g_me, g_pathLogFile, CPKIFPathValidationResults::GetAuthorityConstrainedSet(), CPKIFPathValidationResults::GetAuthorityConstrainedSetTable(), CPKIFPathValidationResults::GetBasicChecksSuccessfullyPerformed(), CPKIFPathValidationResults::GetCertificate(), CPKIFPathValidationResults::GetCertSignaturesVerified(), CPKIFPathValidationResults::GetCertStatus(), GetErrorCodeString(), CPKIFPathValidationResults::GetExplicitPolicyIndicator(), CPKIFCertificatePath::GetPathSettings(), CPKIFPathValidationResults::GetRevocationStatusMostSevere(), CPKIFCertificatePath::GetTarget(), CPKIFCertificatePath::GetTrustRoot(), CPKIFPathValidationResults::GetUserConstrainedSet(), LOG_STRING_DEBUG, LogPath(), MAX_ERROR_CODE_STRING_SIZE, NOT_CHECKED, NOT_REVOKED, CPKIFPathValidationResults::PathSuccessfullyValidated(), PrintCertInfo(), REVOKED, SERVER_CHECKED, and TOOLKIT_PATH_MISC.

Referenced by PathDumpDialog::DumpResults(), and CPKIFPathProcessingMediator2::ValidatePath().

void CPKIFPathLogger::LogPath	(	CPKIFCertificatePath &	path,
		const char *	appInfo = NULL,
		std::ostream *	out = NULL
	)			[static]

Interface: External

This function logs general path information to either the stream indicated by the out parameter or the default stream. If neither stream is available, no log entry is created. The string passed via appInfo will be printed at the top of the log entry, if generated.

Returns:

None

Parameters:

path	[in] Reference to a CPKIFCertificatePath object containing the certification path for which information should be written to the log
appInfo	[in] Pointer to a NULL-terminated string that will be written to the log along with the path validation results and certification path
out	[in] Optional pointer to a ostream to which log information should be written

Definition at line 201 of file PKIFPathLogger.cpp.

References PKIFENUMS::ALL, btoa(), CPKIFBasicOCSPResponse::Decode(), g_me, g_pathLogFile, CPKIFCertificatePath::GetBuilderStats(), GetErrorCodeString(), PKIFHTTP::GetHttpServerBlacklist(), CPKIFCertificatePath::GetPath(), CPKIFBasicOCSPResponse::GetResponseData(), PKIFLDAP::GetServerBlacklist(), CPKIFCertificatePath::GetTrustRoot(), CPKIFResponderID::KEYHASH, PKIFENUMS::LOCAL, LOG_STRING_DEBUG, MAX_ERROR_CODE_STRING_SIZE, CPKIFResponderID::NAME, NOT_CHECKED, NOT_REVOKED, PrintCertInfo(), PKIFENUMS::REMOTE, REVOKED, REVSOURCE_CRL, REVSOURCE_OCSP, SERVER_CHECKED, and TOOLKIT_PATH_MISC.

Referenced by CPKIFPathProcessingMediator2::BuildAndValidatePath(), PathDumpDialog::DumpPath(), LogValidationResults(), and CPKIFPathProcessingMediator2::ValidatePath().

---

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

• PKIFPathLogger.h
• PKIFPathLogger.cpp