CPKIFOCSPRequest Class Reference

#include <OCSPRequest.h>

Collaboration diagram for CPKIFOCSPRequest:

Collaboration graph
[legend]

List of all members.


Detailed Description

The CPKIFOCSPRequest class provides an interface to OCSPRequest objects. The ASN.1 definition for OCSPRequest objects is given below:

OCSPRequest ::= SEQUENCE 
{
	tbsRequest ANY,
	optionalSignature [0] EXPLICIT Signature OPTIONAL 
}

TSP-enforcing: No

Definition at line 37 of file OCSPRequest.h.


Public Member Functions

 CPKIFOCSPRequest ()
 ~CPKIFOCSPRequest ()
void SetRequest (CPKIFTBSRequestPtr &request, CPKIFCredentialPtr &cred, IPKIFMediator *cm=NULL)
CPKIFTBSRequestPtr GetRequest () const
CPKIFBufferPtr Encode ()
void Decode (CPKIFBufferPtr &msg)

Friends

struct CPKIFOCSPRequestImpl

Constructor & Destructor Documentation

CPKIFOCSPRequest::CPKIFOCSPRequest (  ) 

Interface: External

This function creates and initializes CPKIFOCSPRequest objects.

Returns:
None

Definition at line 84 of file OCSPRequest.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.

CPKIFOCSPRequest::~CPKIFOCSPRequest (  ) 

Interface: External

This function destroys CPKIFOCSPRequest objects.

Returns:
None

Definition at line 100 of file OCSPRequest.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.


Member Function Documentation

void CPKIFOCSPRequest::SetRequest ( CPKIFTBSRequestPtr &  request,
CPKIFCredentialPtr &  cred,
IPKIFMediator m = NULL 
)

Interface: External

This function is used to set the request associated with an OCSPRequest object. The CPKIFCredential pointer passed to SetRequest is used to pass in a credential that will be used to sign the OCSP request. If cm parameter is not NULL it must contain IPKIFCryptoKeyIDOperations and IPKIFCryptoMisc colleagues. These colleagues will be used to sign OCSP requests.

Returns:
None
Parameters:
request  [in] Reference to a smart pointer to a CPKIFTBSRequest object containing the to-be-signed request information
cred  [in] Reference to a credential object that is used to sign the DER encoded to-be-signed request information.
m  [in] A pointer to a mediator, which will be used to obtain cryptographic colleagues

Definition at line 212 of file OCSPRequest.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.

Referenced by _CreateComplexOCSPRequest(), and _CreateSimpleOCSPRequest().

CPKIFTBSRequestPtr CPKIFOCSPRequest::GetRequest (  )  const

Interface: External

This function is used to get the request associated with an OCSPRequest object.If cm parameter is not NULL it must contain IPKIFCryptoKeyIDOperations and IPKIFCryptoMisc colleagues. These colleagues will be used to sign OCSP requests.

Returns:
A smart pointer to CPKIFTBSRequestPtr

Definition at line 180 of file OCSPRequest.cpp.

References CPKIFASNWrapper< T >::Decode(), LOG_STRING_DEBUG, m_impl, and TOOLKIT_OCSP_ASN.

CPKIFBufferPtr CPKIFOCSPRequest::Encode (  ) 

void CPKIFOCSPRequest::Decode ( CPKIFBufferPtr &  msg  ) 

Interface: External

This function is used to decode an encoded OCSPRequest object.

Returns:
None
Exceptions:
CPKIFOCSPException(COMMON_INVALID_INPUT) 
CPKIFOCSPException(ASN1_DECODE_ERROR) 
Parameters:
msg  [in] Reference to a smart pointer to a CPKIFBuffer object containing an encoded OCSPRequest object

Definition at line 353 of file OCSPRequest.cpp.

References ASN1_DECODE_ERROR, COMMON_INVALID_INPUT, LOG_STRING_DEBUG, and TOOLKIT_OCSP_ASN.


Friends And Related Function Documentation

friend struct CPKIFOCSPRequestImpl [friend]

Definition at line 39 of file OCSPRequest.h.


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

Generated on Mon Nov 15 11:20:31 2010 for PublicKeyInfrastructureFramework(PKIF) by  doxygen 1.5.6