CPKIFBasicOCSPResponse Class Reference
#include <BasicOCSPResponse.h>
Detailed Description
The CPKIFBasicOCSPResponse class provides an interface to BasicOCSPResponse objects.TSP-enforcing: No
Definition at line 26 of file BasicOCSPResponse.h.
Public Member Functions | |
| CPKIFBasicOCSPResponse (void) | |
| ~CPKIFBasicOCSPResponse (void) | |
| CPKIFResponseDataPtr | GetResponseData () const |
| void | SetResponseData (CPKIFResponseDataPtr &rd) |
| CPKIFAlgorithmIdentifierPtr | GetSignatureAlg () const |
| void | SetSignatureAlg (CPKIFAlgorithmIdentifierPtr &sa) |
| CPKIFBufferPtr | GetSignature () const |
| void | SetSignature (CPKIFBufferPtr &sig) |
| void | GetCerts (CPKIFCertificateList &certs) |
| void | AddCert (CPKIFCertificatePtr &cert) |
| void | Decode (const CPKIFBufferPtr &bp) |
Friends | |
| struct | CPKIFBasicOCSPResponseImpl |
Constructor & Destructor Documentation
| CPKIFBasicOCSPResponse::CPKIFBasicOCSPResponse | ( | void | ) |
Interface: External
This function creates and initializes CPKIFBasicOCSPReponse objects.
- Returns:
- None
Definition at line 58 of file BasicOCSPResponse.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.
| CPKIFBasicOCSPResponse::~CPKIFBasicOCSPResponse | ( | void | ) |
Interface: External
This function is the default constructor for CPKIFBasicOCSPReponse objects.
- Returns:
- None
Definition at line 72 of file BasicOCSPResponse.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.
Member Function Documentation
| CPKIFResponseDataPtr CPKIFBasicOCSPResponse::GetResponseData | ( | ) | const |
Interface: External
This function is used to get the response data contained by the basic OCSP response object. Only the get function is used in practice, as PKIF OCSP objects are used to generate requests and process responses.
- Returns:
- A smart pointer to CPKIFResponseData object
Definition at line 92 of file BasicOCSPResponse.cpp.
References LOG_STRING_DEBUG, m_impl, and TOOLKIT_OCSP_ASN.
Referenced by _MatchSignersCertAndResponderID(), AddOcspDetailsToManifest(), and CPKIFPathLogger::LogPath().
| void CPKIFBasicOCSPResponse::SetResponseData | ( | CPKIFResponseDataPtr & | rd | ) |
Interface: External
This function is used to set the response data contained by the basic OCSP response object. Only the get function is used in practice, as PKIF OCSP objects are used to generate requests and process responses.
- Returns:
- None
- Parameters:
-
rd [in] Reference to a smart pointer to a CPKIFResponseData object
Definition at line 116 of file BasicOCSPResponse.cpp.
| CPKIFAlgorithmIdentifierPtr CPKIFBasicOCSPResponse::GetSignatureAlg | ( | ) | const |
Interface: External
This function is used to get the signature algorithm used to calculate the signature over the basic OCSP response object. Only the get function is used in practice, as PKIF OCSP objects are used to generate requests and process responses.
- Returns:
- A smart pointer to CPKIFAlgorithmIdentifier object
Definition at line 133 of file BasicOCSPResponse.cpp.
References LOG_STRING_DEBUG, m_impl, and TOOLKIT_OCSP_ASN.
| void CPKIFBasicOCSPResponse::SetSignatureAlg | ( | CPKIFAlgorithmIdentifierPtr & | sa | ) |
Interface: External
This function is used to set the signature algorithm used to calculate the signature over the basic OCSP response object. Only the get function is used in practice, as PKIF OCSP objects are used to generate requests and process responses.
- Returns:
- None
- Parameters:
-
sa [in] Reference to a smart pointer to a CPKIFAlgorithmIdentifier object
Definition at line 168 of file BasicOCSPResponse.cpp.
| CPKIFBufferPtr CPKIFBasicOCSPResponse::GetSignature | ( | ) | const |
Interface: External
This function is used to get the signature calculated over the basic OCSP response object. Only the get function is used in practice, as PKIF OCSP objects are used to generate requests and process responses.
- Returns:
- A smart pointer to CPKIFBuffer object
Definition at line 184 of file BasicOCSPResponse.cpp.
References LOG_STRING_DEBUG, m_impl, and TOOLKIT_OCSP_ASN.
| void CPKIFBasicOCSPResponse::SetSignature | ( | CPKIFBufferPtr & | sig | ) |
Interface: External
This function is used to set the signature calculated over the basic OCSP response object. Only the get function is used in practice, as PKIF OCSP objects are used to generate requests and process responses.
- Returns:
- None
- Parameters:
-
sig [in] Reference to a CPKIFBuffer object containing the signature for a basic OCSP response object
Definition at line 206 of file BasicOCSPResponse.cpp.
| void CPKIFBasicOCSPResponse::GetCerts | ( | CPKIFCertificateList & | certs | ) |
Interface: External
This function is used to get the certificates stored in a basic OCSP response object.
- Returns:
- None
- Parameters:
-
certs [out] Reference to a CPKIFCertificateList to receive certificates stored in the basic OCSP response object
Definition at line 221 of file BasicOCSPResponse.cpp.
| void CPKIFBasicOCSPResponse::AddCert | ( | CPKIFCertificatePtr & | cert | ) |
Interface: External
This function is used to add a certificate to the set of certificates contained by the basic OCSP response object. While this function can be used to add certificates to the collection of certificates associated with a basic OCSP response object, there is currently no means provided for encoding an OCSP response object, thus this function is not currently used in practice.
- Returns:
- None
- Parameters:
-
cert [in] Reference to a CPKIFCertificate object
Definition at line 238 of file BasicOCSPResponse.cpp.
| void CPKIFBasicOCSPResponse::Decode | ( | const CPKIFBufferPtr & | msg | ) |
Interface: External
This function is used to decode an encoded basic OCSP response object. The value passed to decode is generally retrieved from a CPKIFResponseBytes object via a call to GetResponseBytes.
- Returns:
- None
- Exceptions:
-
CPKIFOCSPException(ASN1_DECODE_ERROR) CPKIFOCSPException(COMMON_INVALID_INPUT)
- Parameters:
-
msg [in] Reference to a smart pointer to a CPKIFBuffer object containing a binary encoded BasicOCSPResponse
Definition at line 255 of file BasicOCSPResponse.cpp.
References ASN1_DECODE_ERROR, COMMON_INVALID_INPUT, LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.
Referenced by AddOcspDetailsToManifest(), and CPKIFPathLogger::LogPath().
Friends And Related Function Documentation
friend struct CPKIFBasicOCSPResponseImpl [friend] |
Definition at line 28 of file BasicOCSPResponse.h.
The documentation for this class was generated from the following files:
