CPKIFCertStatus Class Reference
#include <PKIFCertStatus.h>
Detailed Description
The CPKIFCertStatus class is used to return information about a certificate following a path validation operation. Validation consists of three types of checks: basic validation checks, signature checks and revocation status checks. Basic checks are always performed first, followed by signature checks then revocation status checks. CPKIFCertStatus allows applications to query the status of each type of check as well as review diagnostic information associated with a certificate. Applications typically do not invoke the SetXXX functions on a CPKIFCertStatus object.CPKIFCertStatus objects are associated with certificate objects via CPKIFCertificateNodeEntry objects, i.e. a certificate is associated with a CPKIFCertificateNodeEntry object via a call to SetCert and its status information is associated with the same CPKIFCertificateNodeEntry object via a call to SetStatus.
TSP-enforcing: No
Definition at line 40 of file PKIFCertStatus.h.
Public Member Functions | |
| CPKIFCertStatus () | |
| virtual | ~CPKIFCertStatus () |
| int | GetDiagnosticCode () const |
| void | SetDiagnosticCode (int errorCode) |
| bool | GetSignatureVerified () const |
| void | SetSignatureVerified (bool sigVerified) |
| RevocationStatus | GetRevocationStatus () const |
| void | SetRevocationStatus (RevocationStatus revStatus) |
| bool | GetPassedValidationChecks () const |
| void | SetPassedValidationChecks (bool valChecks) |
| void | AddRevocationSource (int revSourceType, IPKIFRevSourceInfoPtr &revSource, RevocationStatus status, int errorCode=0) |
| void | GetRevocationSources (RevocationSourceList &rsl) |
| bool | GetIsTrustAnchor () const |
| void | SetIsTrustAnchor (bool isTrustAnchor) |
Constructor & Destructor Documentation
| CPKIFCertStatus::CPKIFCertStatus | ( | ) |
Interface: External
This function creates and initializes a CPKIFCertStatus object.
- Returns:
- None
Definition at line 37 of file CACCertStatus.cpp.
References LOG_STRING_DEBUG, NOT_CHECKED, and TOOLKIT_PATH_MISC.
| CPKIFCertStatus::~CPKIFCertStatus | ( | ) | [virtual] |
Interface: External
This function destroys a CPKIFCertStatus object.
- Returns:
- None
Definition at line 54 of file CACCertStatus.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.
Member Function Documentation
| int CPKIFCertStatus::GetDiagnosticCode | ( | ) | const |
Interface: External
This function is used to get the diagnostic (error) code associated with a certificate. The error code can be passed to the GetErrorCodeString utility function to obtain a string representation of the error condition.
- Returns:
- Error code
Definition at line 68 of file CACCertStatus.cpp.
| void CPKIFCertStatus::SetDiagnosticCode | ( | int | errorCode | ) |
Interface: External
This function is used to get the diagnostic (error) code associated with a certificate. The error code can be passed to the GetErrorCodeString utility function to obtain a string representation of the error condition.
- Returns:
- None
- Parameters:
-
errorCode [in] Integer containing the status code for the associated certificate
Definition at line 81 of file CACCertStatus.cpp.
| bool CPKIFCertStatus::GetSignatureVerified | ( | ) | const |
Interface: External
This function is used to get a Boolean value that indicates whether the signature on a certificate has been successfully verified.
- Returns:
- The GetSignatureVerified function returns true if the associated signature verification operation was successful and false otherwise.
Definition at line 94 of file CACCertStatus.cpp.
| void CPKIFCertStatus::SetSignatureVerified | ( | bool | sigVerified | ) |
Interface: External
This function is used to set a Boolean value that indicates whether the signature on a certificate has been successfully verified.
- Returns:
- None
- Parameters:
-
sigVerified [in] Boolean value set to true if the associated signature verification operation was successful and false otherwise
Definition at line 105 of file CACCertStatus.cpp.
| RevocationStatus CPKIFCertStatus::GetRevocationStatus | ( | ) | const |
Interface: External
This function is used to get an enumerated value that indicates whether the revocation status of a certificate has been determined and/or the result of that determination.
- Returns:
- The GetRevocationStatus function returns a RevocationStatus value indicating the outcome of a revocation status determination operation for a given certificate.
Definition at line 119 of file CACCertStatus.cpp.
| void CPKIFCertStatus::SetRevocationStatus | ( | RevocationStatus | revStatus | ) |
Interface: External
This function is used to set an enumerated value that indicates whether the revocation status of a certificate has been determined and/or the result of that determination.
- Returns:
- None
- Parameters:
-
revStatus [in] RevocationStatus value indicating the outcome of a revocation status determination operation for a given certificate
Definition at line 131 of file CACCertStatus.cpp.
| bool CPKIFCertStatus::GetPassedValidationChecks | ( | ) | const |
Interface: External
This function is used to get a Boolean value that indicates whether the certificate has successfully passed basic certificate validation checks.
- Returns:
- The GetSignatureVerified function returns true if the associated certificate has successfully passed basic certificate validation checks.
Definition at line 145 of file CACCertStatus.cpp.
| void CPKIFCertStatus::SetPassedValidationChecks | ( | bool | valChecks | ) |
Interface: External
This function is used to set a Boolean value that indicates whether the certificate has successfully passed basic certificate validation checks.
- Returns:
- None
- Parameters:
-
valChecks [in] Boolean value set to true if the associated certificate has successfully passed basic certificate validation checks
Definition at line 157 of file CACCertStatus.cpp.
| void CPKIFCertStatus::AddRevocationSource | ( | int | revSourceType, | |
| IPKIFRevSourceInfoPtr & | revSource, | |||
| RevocationStatus | status, | |||
| int | errorCode = 0 | |||
| ) |
Interface: External
This function is used to set revocation source information.
- Returns:
- None
- Parameters:
-
revSourceType [in] Integer indicating the type of revocation source, e.g. REVSOURCE_UNKNOWN, REVSOURCE_CRL,REVSOURCE_OCSP revSource [in] Pointer to an IPKIFRevSourceInfo containing information regarding a revocation information source that was consulted in an attempt to determine the revocation status of the associated certificate status [in] RevocationStatus value indicating the certificate status as determined by the revocation source conveyed via the revSource parameter errorCode [in] Integer containing an error code, possibly indicating success, associated with the specified revocation source
Definition at line 198 of file CACCertStatus.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.
| void CPKIFCertStatus::GetRevocationSources | ( | RevocationSourceList & | rsl | ) |
Interface: External
This function is used to get revocation source information.
- Returns:
- None
- Parameters:
-
rsl [out] Reference to a RevocationSourceList object to receive the list of revocation sources consulted during an attempt to determine the revocation status of the associated certificate
Definition at line 227 of file CACCertStatus.cpp.
| bool CPKIFCertStatus::GetIsTrustAnchor | ( | ) | const |
Interface: External
This function is used to get a Boolean value that indicates whether the certificate is a trust anchor. Trust anchor certificates are not subject to the checks performed on non-trust anchor certificates. Thus, a status object may indicate that basic checks were not passed but there is no problem because basic checks need not be performed.
- Returns:
- The GetIsTrustAnchor function returns true if the associated certificate is a trust anchor and set to false otherwise.
Definition at line 172 of file CACCertStatus.cpp.
| void CPKIFCertStatus::SetIsTrustAnchor | ( | bool | isTrustAnchor | ) |
Interface: External
This function is used to set a Boolean value that indicates whether the certificate is a trust anchor. Trust anchor certificates are not subject to the checks performed on non-trust anchor certificates. Thus, a status object may indicate that basic checks were not passed but there is no problem because basic checks need not be performed.
- Returns:
- None
- Parameters:
-
isTrustAnchor [in] Boolean value that is set to true if the associated certificate is a trust anchor and set to false otherwise
Definition at line 185 of file CACCertStatus.cpp.
The documentation for this class was generated from the following files:
