CPKIFResponderID Class Reference
#include <ResponderID.h>
Detailed Description
The CPKIFResponderID class provides an interface to ResponderID objects, which are included in OCSP responses. PKIF does not support the generation of OCSP responses, thus the Setxxx functions of CPKIFResponderID objects are not typically invoked.TSP-enforcing: No
Definition at line 26 of file ResponderID.h.
Public Types | |
| enum | ResponderIDType { NAME, KEYHASH, UNSET } |
Public Member Functions | |
| CPKIFResponderID (void) | |
| CPKIFResponderID (const CPKIFBufferPtr &rid) | |
| ~CPKIFResponderID (void) | |
| ResponderIDType | GetChoice () const |
| CPKIFNamePtr | GetName () const |
| void | SetName (CPKIFNamePtr &name) |
| CPKIFBufferPtr | GetHash () const |
| void | SetHash (CPKIFBufferPtr &hash) |
Member Enumeration Documentation
Constructor & Destructor Documentation
| CPKIFResponderID::CPKIFResponderID | ( | void | ) |
Interface: External
Default constructor
- Returns:
- None
Definition at line 37 of file ResponderID.cpp.
References LOG_STRING_DEBUG, TOOLKIT_OCSP_ASN, and UNSET.
| CPKIFResponderID::CPKIFResponderID | ( | const CPKIFBufferPtr & | rid | ) |
Interface: External
Theis function is used to create and initialize CPKIFResponderID objects. This constructor takes a ResponderID parameter is used internally by PKIF when parsing OCSP objects. It is not used by applications
- Returns:
- None
- Parameters:
-
rid [in] Reference to a ResponderID structure
Definition at line 79 of file ResponderID.cpp.
References CACASNWRAPPER_CREATE, KEYHASH, LOG_STRING_DEBUG, NAME, TOOLKIT_OCSP_ASN, and UNSET.
| CPKIFResponderID::~CPKIFResponderID | ( | void | ) |
Interface: External
This function destroys CPKIFResponderID objects.
- Returns:
- None
Definition at line 125 of file ResponderID.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.
Member Function Documentation
| CPKIFResponderID::ResponderIDType CPKIFResponderID::GetChoice | ( | ) | const |
Interface: External
This function returns an enumerated value indicating the type of responder ID contained in a ResponderID object, e.g. name, key hash or unset.
enum ResponderIDType
{
NAME,
KEYHASH,
UNSET
};
- Returns:
- An enumerated value indicating the type of responder ID contained in a ResponderID object
Definition at line 150 of file ResponderID.cpp.
| CPKIFNamePtr CPKIFResponderID::GetName | ( | ) | const |
Interface: External
This function is used to get the name associated with a ResponderID object.
- Returns:
- The GetName function returns a smart pointer to a CPKIFName object containing the name from a ResponderID object, if present, and NULL otherwise
Definition at line 164 of file ResponderID.cpp.
| void CPKIFResponderID::SetName | ( | CPKIFNamePtr & | name | ) |
Interface: External
This function is used to set the name associated with a ResponderID object.
- Returns:
- None
- Parameters:
-
name [in] Reference to a smart pointer to a CPKIFName object containing the name value to associate with a CPKIFResponderID instance
Definition at line 176 of file ResponderID.cpp.
| CPKIFBufferPtr CPKIFResponderID::GetHash | ( | ) | const |
Interface: External
This function is used to get the hash value associated with a ResponderID object.
- Returns:
- The GetHash function returns a smart pointer to a CPKIFBuffer object containing the key hash value from a ResponderID object, if present, and NULL otherwise.
Definition at line 192 of file ResponderID.cpp.
| void CPKIFResponderID::SetHash | ( | CPKIFBufferPtr & | hash | ) |
Interface: External
This function is used to set the hash value associated with a ResponderID object.
- Returns:
- None
- Parameters:
-
hash [in] Reference to a smart pointer to a CPKIFBuffer object containing a SHA1 hash of an OCSP responder’s public key
Definition at line 203 of file ResponderID.cpp.
The documentation for this class was generated from the following files:
