CPKIFPathValidationResults Class Reference
#include <PathResults.h>
Detailed Description
This class is used to return the results of a certificate validation operation including success/failure indicators (basic certificate checks, signature verification and revocation status determination) and certificate policy information. The following table describes the information available via CPKIFPathValidationResults (all of which except for the first two have corresponding Get and Set methods):TSP-enforcing: Yes
Definition at line 39 of file PathResults.h.
Constructor & Destructor Documentation
| CPKIFPathValidationResults::CPKIFPathValidationResults | ( | ) |
Interface: External
This function creates and initializes CPKIFPathValidationResults objects.
- Returns:
- None
Definition at line 394 of file PathResults.cpp.
References LOG_STRING_DEBUG, NOT_CHECKED, and TOOLKIT_PATH_MISC.
| CPKIFPathValidationResults::~CPKIFPathValidationResults | ( | ) | [virtual] |
Interface: External
This function destroys CPKIFPathValidationResults objects.
- Returns:
- None
Definition at line 429 of file PathResults.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.
Member Function Documentation
| bool CPKIFPathValidationResults::PathSuccessfullyValidated | ( | ) | const |
Interface: External
This function indicates if a path was successfully validated, including successful performance of basic certificate checks, signature verification, revocation status determination and application-provided extension handler checks, if any.
- Returns:
- True if path validation was completely successful and false otherwise
Definition at line 450 of file PathResults.cpp.
References GetBasicChecksSuccessfullyPerformed(), GetCertSignaturesVerified(), GetExtensionHandlerChecksSuccessfullyPerformed(), GetRevocationStatusMostSevere(), GetTargetIsTrustAnchor(), and NOT_REVOKED.
Referenced by CPKIFPathLogger::LogValidationResults().
| bool CPKIFPathValidationResults::GetBasicChecksSuccessfullyPerformed | ( | ) | const |
Interface: External
This functions is used to get the flag that indicates successful performance of basic certificate checks, i.e. the basic path validation checks defined in X.509.
- Returns:
- True if basic checks were successfully performed during a path validation operation and false otherwise.
Definition at line 72 of file PathResults.cpp.
Referenced by CertPathWantBackToResultsAndStores(), CPKIFPathLogger::LogValidationResults(), and PathSuccessfullyValidated().
| void CPKIFPathValidationResults::SetBasicChecksSuccessfullyPerformed | ( | bool | b | ) |
Interface: External
This function is used to set the flag that indicates successful performance of basic certificate checks, i.e. the basic path validation checks defined in X.509.
- Returns:
- None
- Parameters:
-
b [in] Boolean value indicating whether basic checks were successfully performed
Definition at line 85 of file PathResults.cpp.
Referenced by CPKIFScvpPathBuildAndValidate::BuildAndValidatePath(), and CPKIFPathBasicChecks2::DoChecks().
| bool CPKIFPathValidationResults::GetCertSignaturesVerified | ( | ) | const |
Interface: External
This function is used to get the flag that indicates successful verification of all certificate signatures in the path.
- Returns:
- True if all certificate signatures were successfully verified during a path validation operation and false otherwise.
Definition at line 101 of file PathResults.cpp.
Referenced by CPKIFPathBuildAndValidate::BuildAndValidatePath(), CertPathWantBackToResultsAndStores(), CPKIFPathLogger::LogValidationResults(), and PathSuccessfullyValidated().
| void CPKIFPathValidationResults::SetCertSignaturesVerified | ( | bool | b | ) |
Interface: External
This function is used to set the flag that indicates successful verification of all certificate signatures in the path.
- Returns:
- None
- Parameters:
-
b [in] Boolean value indicating whether certificate signatures were successfully validated
Definition at line 114 of file PathResults.cpp.
Referenced by CPKIFScvpPathBuildAndValidate::BuildAndValidatePath(), and PathSigChecker().
| bool CPKIFPathValidationResults::GetTargetIsTrustAnchor | ( | ) | const |
Interface: External
This function is used to get the Boolean value used to indicate cases where the target of a path validation operation was a trust anchor.
- Returns:
- True if the target of a path validation operation was a trust anchor and false otherwise.
Definition at line 128 of file PathResults.cpp.
Referenced by PathSuccessfullyValidated().
| void CPKIFPathValidationResults::SetTargetIsTrustAnchor | ( | bool | b | ) |
Interface: External
This function is used to set the Boolean value used to indicate cases where the target of a path validation operation was a trust anchor.
- Returns:
- None
- Parameters:
-
b [in] Boolean value indicating whether certificate signatures were successfully validated
Definition at line 141 of file PathResults.cpp.
Referenced by CPKIFPathValidator2::ValidatePath().
| RevocationStatus CPKIFPathValidationResults::GetRevocationStatusMostSevere | ( | ) | const |
Interface: External
This function is used to get the flag that indicates successful determination that none of the certificates in the path have been revoked.
- Returns:
- A RevocationStatus value indicating the least successful revocation status determination of all certificates in a certification path
Definition at line 157 of file PathResults.cpp.
Referenced by CPKIFPathBuildAndValidate::BuildAndValidatePath(), FindErrorAndSetOnResults(), CPKIFPathLogger::LogValidationResults(), and PathSuccessfullyValidated().
| void CPKIFPathValidationResults::SetRevocationStatusMostSevere | ( | RevocationStatus | r | ) |
Interface: External
This function is used to set the flag that indicates successful determination that none of the certificates in the path have been revoked.
- Returns:
- None
- Parameters:
-
r [in] RevocationStatus value indicating the least successful revocation status determination operation performed during a path validation operation
Definition at line 169 of file PathResults.cpp.
Referenced by CPKIFScvpPathBuildAndValidate::BuildAndValidatePath(), FindErrorAndSetOnResults(), and CPKIFPathValidator2::ValidatePath().
| CPKIFCertStatusPtr CPKIFPathValidationResults::GetCertStatus | ( | ) | const |
Interface: External
This function is used to get the flag that indicates successful verification of all certificate signatures in the path.
- Returns:
- A smart pointer to a CPKIFCertStatus object containing status information for the certificate that was being processed when path validation terminated or NULL if no certificate status object has been specified.
Definition at line 188 of file PathResults.cpp.
Referenced by CPKIFPathLogger::LogValidationResults().
| void CPKIFPathValidationResults::SetCertStatus | ( | CPKIFCertStatusPtr & | certStatus | ) |
Interface: External
This function is used to set the flag that indicates successful verification of all certificate signatures in the path.
- Returns:
- None
- Parameters:
-
certStatus [in] Reference to a smart pointer to a CPKIFCertStatus object containing status information for the certificate that was being processed when path validation terminated
Definition at line 201 of file PathResults.cpp.
Referenced by FindErrorAndSetOnResults(), and CPKIFPathValidator2::ValidatePath().
| int CPKIFPathValidationResults::DiagnosticCode | ( | ) | const |
Interface: External
This function returns the error code associated with any failure that halted the validation operation or 0 if there were no errors.
- Returns:
- The status code associated with the results of a path validation operation stored in a CPKIFPathValidationResults object.
Definition at line 545 of file PathResults.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.
Referenced by CPKIFPathLogger::LogValidationResults().
| void CPKIFPathValidationResults::SetAuthorityConstrainedSet | ( | std::vector< CPKIFPolicyInformationListPtr > * | authSet | ) |
Interface: External
The SetAuthorityConstrainedSet function initializes the list of certificate policies that comprise the authority-constrained policy set.
- Returns:
- None
- Parameters:
-
authSet [in or out] Reference to a smart pointer to a CPKIFPolicyInformationList object containing the certificate policies that comprised the authority-constrained policy set at the conclusion of the basic certificate checks portion of the validation operation
Definition at line 521 of file PathResults.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.
Referenced by CPKIFPathBasicChecks2::DoChecks().
| const vector< CPKIFPolicyInformationListPtr > * CPKIFPathValidationResults::GetAuthorityConstrainedSetTable | ( | ) |
Interface: External
This function returns a table of certificate policies that comprised the authority-constrained policy set at the conclusion of the basic certificate checks portion of the validation operation. The table may be used to discover any policy mappings that occurred during path validation. The table represents policies using the approach defined in X.509. The pointer returned by this function is const and refers to an object that will be destroyed when the host object is destroyed (or falls out of scope).
- Returns:
- The history of the authority constrained policy set following a path validation operation, including a record of policy mappings
Definition at line 224 of file PathResults.cpp.
Referenced by CPKIFPathLogger::LogValidationResults().
| void CPKIFPathValidationResults::GetAuthorityConstrainedSet | ( | CPKIFPolicyInformationListPtr & | authSet | ) |
Interface: External
The GetAuthorityConstrainedSet function returns a list of certificate policies that comprised the authority-constrained policy set at the conclusion of the basic certificate checks portion of the validation operation.
- Returns:
- None
- Parameters:
-
authSet [in or out] Reference to a smart pointer to a CPKIFPolicyInformationList object containing the certificate policies that comprised the authority-constrained policy set at the conclusion of the basic certificate checks portion of the validation operation
Definition at line 466 of file PathResults.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.
Referenced by CPKIFPathBasicChecks2::DoChecks(), and CPKIFPathLogger::LogValidationResults().
| void CPKIFPathValidationResults::GetUserConstrainedSet | ( | CPKIFPolicyInformationListPtr & | userSet | ) |
Interface: External
This function is used to get the set of certificate policies that comprise the user constrained policy set resulting from a path validation operation. For the GetUserConstrainedSet function, the userSet parameter receives the list of policies collected during a path validation operation. For the SetUserConstrainedSet function, the userSet parameter contains the list of policies collected during a path validation operation.
- Returns:
- None
- Parameters:
-
userSet [in or out] Reference to a CPKIFPolicyInformationList object
Definition at line 239 of file PathResults.cpp.
Referenced by CPKIFPathLogger::LogValidationResults().
| void CPKIFPathValidationResults::SetUserConstrainedSet | ( | CPKIFPolicyInformationListPtr & | userSet | ) |
Interface: External
This function is used to set the set of certificate policies that comprise the user constrained policy set resulting from a path validation operation. For the GetUserConstrainedSet function, the userSet parameter receives the list of policies collected during a path validation operation. For the SetUserConstrainedSet function, the userSet parameter contains the list of policies collected during a path validation operation.
- Returns:
- None
- Parameters:
-
userSet [in or out] Reference to a CPKIFPolicyInformationList object
Definition at line 257 of file PathResults.cpp.
Referenced by CPKIFPathBasicChecks2::DoChecks().
| bool CPKIFPathValidationResults::GetExplicitPolicyIndicator | ( | ) | const |
Interface: External
This function is used to get the flag that indicates if an explicit policy was required during path validation (may have been set by application inputs or by a certificate in the path).
- Returns:
- The Boolean value of the explicit policy indicator as set during a path validation operation.
Definition at line 272 of file PathResults.cpp.
Referenced by CPKIFPathLogger::LogValidationResults().
| void CPKIFPathValidationResults::SetExplicitPolicyIndicator | ( | bool | e | ) |
Interface: External
This function is used to set the flag that indicates if an explicit policy was required during path validation (may have been set by application inputs or by a certificate in the path).
- Returns:
- None
- Parameters:
-
e [in] Boolean value that indicates the value of the explicit policy indicator following a path validation operation
Definition at line 285 of file PathResults.cpp.
Referenced by CPKIFPathBasicChecks2::DoChecks().
| void CPKIFPathValidationResults::SetCertificate | ( | CPKIFCertificateNodeEntryPtr & | cert | ) |
Interface: External
This function is used to set the certificate that was being processed when the validation operation halted.
- Returns:
- None
- Parameters:
-
cert [in] Reference to smart pointer to a CPKIFCertificateNodeEntry object containing the certificate that was being processed when a path validation operation halted
Definition at line 303 of file PathResults.cpp.
Referenced by CPKIFPathBasicChecks2::DoChecks(), FindErrorAndSetOnResults(), PathSigChecker(), and CPKIFPathValidator2::ValidatePath().
| CPKIFCertificateNodeEntryPtr CPKIFPathValidationResults::GetCertificate | ( | ) | const |
Interface: External
This function is used to get the certificate that was being processed when the validation operation halted.
- Returns:
- The GetCertificate function returns a smart pointer to a CPKIFCertificateNodeEntry object containing the certificate that was being processed when a path validation operation halted or NULL if no certificate has been specified.
Definition at line 320 of file PathResults.cpp.
Referenced by CPKIFPathLogger::LogValidationResults().
| void CPKIFPathValidationResults::SetWorkingParams | ( | CPKIFAlgorithmIdentifierPtr & | wp | ) |
Interface: External
This function is used to set a CPKIFAlgorithmIdentifier object containing the working parameters output following a successful path validation operation.
- Returns:
- None
- Parameters:
-
wp [in] Reference to a CPKIFAlgorithmIdentifier object containing the working parameters output from a path validation operation
Definition at line 334 of file PathResults.cpp.
Referenced by PathSigChecker().
| CPKIFAlgorithmIdentifierPtr CPKIFPathValidationResults::GetWorkingParams | ( | ) | const |
Interface: External
This function is used to get a CPKIFAlgorithmIdentifier object containing the working parameters output following a successful path validation operation.
- Returns:
- A smart pointer to a CPKIFAlgorithmIdentifier object containing the working parameters output from a path validation operation or NULL if no working parameters were specified, in which case there are either no parameters or the parameters are as specified in the target certificate.
Definition at line 353 of file PathResults.cpp.
| void CPKIFPathValidationResults::SetExtHandlerData | ( | const std::string & | id, | |
| IPKIFExtHandlerDataPtr & | data | |||
| ) |
Interface: External
SetExtHandlerData creates an association between the string passed as the id parameter and the object passed via the data parameter. The next call to GetExtHandlerData with the same id value will return the object passed via the data parameter.
- Returns:
- None
Definition at line 367 of file PathResults.cpp.
Referenced by CPKIFScvpPathBuildAndValidate::BuildAndValidatePath().
| IPKIFExtHandlerDataPtr CPKIFPathValidationResults::GetExtHandlerData | ( | const std::string & | id | ) | const |
Interface: External
GetExtHandlerData returns the application provided IPKIFExtHandlerDataPtr corresponding to the specified id value. If not IPKIFExtHandlerDataPtr object is found corresponding to the id, a NULL pointer is returned.
- Returns:
- None
Definition at line 381 of file PathResults.cpp.
| bool CPKIFPathValidationResults::GetExtensionHandlerChecksSuccessfullyPerformed | ( | ) | const |
Interface: External
This function is used to get the flag that indicates successful performance of checks performed by application-provided extension handlers.
- Returns:
- True if basic checks were successfully performed during a path validation operation and false otherwise.
Definition at line 569 of file PathResults.cpp.
Referenced by PathSuccessfullyValidated().
| void CPKIFPathValidationResults::SetExtensionHandlerChecksSuccessfullyPerformed | ( | bool | b | ) |
Interface: External
This function is used to set the flag that indicates successful performance of checks performed by an application-provided extension handler. The value passed by the caller is only accepted if the previous value is true, i.e., false indications latch.
- Returns:
- None
- Parameters:
-
b [in] Boolean value indicating whether basic checks were successfully performed
Definition at line 584 of file PathResults.cpp.
| IPKIFTrustAnchorPtr CPKIFPathValidationResults::GetTrustAnchor | ( | ) | const |
Interface: External
This function can be used to retrieve the trust anchor that was used to validate the associated path.
- Returns:
- None
Definition at line 601 of file PathResults.cpp.
| void CPKIFPathValidationResults::SetTrustAnchor | ( | IPKIFTrustAnchorPtr & | ta | ) |
Interface: External
This function can be used to specify the trust anchor that was used to validate the associated path.
- Returns:
- None
Definition at line 614 of file PathResults.cpp.
Referenced by CPKIFScvpPathBuildAndValidate::BuildAndValidatePath(), CPKIFPathBasicChecks2::DoChecks(), and CPKIFPathValidator2::ValidatePath().
| bool CPKIFPathValidationResults::IsPermittedSubtreesSet | ( | ) |
Definition at line 619 of file PathResults.cpp.
| CPKIFGeneralSubtreeListPtr CPKIFPathValidationResults::GetPermittedSubtrees | ( | ) | const |
Definition at line 624 of file PathResults.cpp.
| void CPKIFPathValidationResults::SetPermittedSubtrees | ( | CPKIFGeneralSubtreeListPtr & | subtree | ) |
| bool CPKIFPathValidationResults::IsExcludedSubtreesSet | ( | ) |
Definition at line 634 of file PathResults.cpp.
| CPKIFGeneralSubtreeListPtr CPKIFPathValidationResults::GetExcludedSubtrees | ( | ) | const |
Definition at line 639 of file PathResults.cpp.
| void CPKIFPathValidationResults::SetExcludedSubtrees | ( | CPKIFGeneralSubtreeListPtr & | subtree | ) |
| bool CPKIFPathValidationResults::IsPendingExplicitPolicySet | ( | ) |
Definition at line 650 of file PathResults.cpp.
| int CPKIFPathValidationResults::GetPendingExplicitPolicy | ( | ) | const |
Definition at line 655 of file PathResults.cpp.
| void CPKIFPathValidationResults::SetPendingExplicitPolicy | ( | int | skipCerts | ) |
| bool CPKIFPathValidationResults::IsPendingPolicyMappingSet | ( | ) |
Definition at line 666 of file PathResults.cpp.
| int CPKIFPathValidationResults::GetPendingPolicyMapping | ( | ) | const |
Definition at line 671 of file PathResults.cpp.
| void CPKIFPathValidationResults::SetPendingPolicyMapping | ( | int | skipCerts | ) |
| bool CPKIFPathValidationResults::IsPendingAnyPolicySet | ( | ) |
Definition at line 682 of file PathResults.cpp.
| int CPKIFPathValidationResults::GetPendingAnyPolicy | ( | ) | const |
Definition at line 687 of file PathResults.cpp.
| void CPKIFPathValidationResults::SetPendingAnyPolicy | ( | int | skipCerts | ) |
| bool CPKIFPathValidationResults::IsPendingPathLengthSet | ( | ) |
Definition at line 698 of file PathResults.cpp.
| int CPKIFPathValidationResults::GetPendingPathLength | ( | ) | const |
Definition at line 703 of file PathResults.cpp.
| void CPKIFPathValidationResults::SetPendingPathLength | ( | int | certs | ) |
The documentation for this class was generated from the following files:
