CPKIFValPolResponse Class Reference

#include <ValPolResponse.h>

Collaboration diagram for CPKIFValPolResponse:

Collaboration graph
[legend]

List of all members.

Detailed Description

The CPKIFValPolResponse class provides an interface to SCVP ValPolRequest object.

TSP-enforcing: No

Definition at line 40 of file ValPolResponse.h.


Public Member Functions

 CPKIFValPolResponse ()
 CPKIFValPolResponse (const CPKIFBufferPtr &)
virtual ~CPKIFValPolResponse (void)
int GetVersion () const
void SetVersion (int v)
void SetVpResponseVersion (int vpResponseVersion)
const int GetVpResponseVersion () const
void SetMaxCVRequestVersion (int maxCVRequestVersion)
const int GetMaxCVRequestVersion () const
void SetMaxVPRequestVersion (int maxVPRequestVersion)
const int GetMaxVPRequestVersion () const
void SetServerConfigurationID (int serverConfigurationID)
const int GetServerConfigurationID () const
void SetThisUpdate (const CPKIFTimePtr &thisUpdate)
const CPKIFTimePtr GetThisUpdate () const
void SetSupportedChecks (CPKIFOIDListPtr &supportedChecks)
void GetSupportedChecks (CPKIFOIDListPtr &supportedChecks)
void SetSupportedWantBacks (CPKIFOIDListPtr &supportedWantBacks)
void GetSupportedWantBacks (CPKIFOIDListPtr &supportedWantBacks)
void SetValidationPolicies (CPKIFOIDListPtr &validationPolicies)
void GetValidationPolicies (CPKIFOIDListPtr &validationPolicies)
void SetValidationAlgs (CPKIFOIDListPtr &validationAlgs)
void GetValidationAlgs (CPKIFOIDListPtr &validationAlgs)
void SetAuthPolicies (CPKIFOIDListPtr &authPolicies)
void GetAuthPolicies (CPKIFOIDListPtr &authPolicies)
void SetResponseTypes (SCVPResponseTypes responseTypes)
const SCVPResponseTypes GetResponseTypes () const
void SetRespValidationPolicy (CPKIFValidationPolicyPtr &respValidationPolicy)
const CPKIFValidationPolicyPtr GetRespValidationPolicy () const
void SetRevocationInfoTypes (std::bitset< 4 > revocationInfoTypes)
const std::bitset< 4 > GetRevocationInfoTypes () const
void SetSignatureGeneration (CPKIFAlgorithmIdentifierListPtr &signatureGeneration)
void GetSignatureGeneration (CPKIFAlgorithmIdentifierListPtr &signatureGeneration)
void SetSignatureVerification (CPKIFAlgorithmIdentifierListPtr &signatureVerification)
void GetSignatureVerification (CPKIFAlgorithmIdentifierListPtr &signatureVerification)
void SetHashAlgorithms (CPKIFOIDListPtr &hashAlgorithms)
void GetHashAlgorithms (CPKIFOIDListPtr &hashAlgorithms)
void SetClockSkew (int clockSkew)
const int GetClockSkew () const
void SetNextUpdate (CPKIFTimePtr &NextUpdate)
const CPKIFTimePtr GetNextUpdate () const
void SetRequestNonce (CPKIFBufferPtr &requestNonce)
const CPKIFBufferPtr GetRequestNonce () const
void SetKeyAgreePublicKeys (CPKIFKeyAgreePublicKeyListPtr &keyAgreePublicKey)
void GetKeyAgreePublicKeys (CPKIFKeyAgreePublicKeyListPtr &keyAgreePublicKey)
CPKIFBufferPtr Encode () const
void Decode (CPKIFBufferPtr &encoded) const

Constructor & Destructor Documentation

CPKIFValPolResponse::CPKIFValPolResponse (  ) 

Interface: External

This function is used to create and initialize CPKIFValPolResponse object.

Returns:
None

Definition at line 161 of file ValPolResponse.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SCVP_ASN.

CPKIFValPolResponse::CPKIFValPolResponse ( const CPKIFBufferPtr &  valPolResponse  ) 

Interface: External

This constructor is internally invoked; it will throw a std::bad_alloc exception if allocation of memory fails or ASN.1 decoding errors if the extension cannot be parsed.

Returns:
None
Exceptions:
std::bad_alloc 
Parameters:
valPolResponse  [in] A reference to a smart pointer to CPKIFBuffer object containing der encoded ValPolRequest

Definition at line 188 of file ValPolResponse.cpp.

References CACASNWRAPPER_CREATE, COMMON_INVALID_INPUT, and TOOLKIT_SCVP_ASN.

CPKIFValPolResponse::~CPKIFValPolResponse ( void   )  [virtual]

Interface: External

This function destroys instances of CPKIFValPolResponse.

Returns:
None

Definition at line 210 of file ValPolResponse.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SCVP_ASN.

Member Function Documentation

int CPKIFValPolResponse::GetVersion (  )  const

Interface: External

This function is returns the SCVP version of a ValPolResponse. PKIF only supports version 1 responses.

Returns:
The version of SCVP ValPolRequest.

Definition at line 228 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetVersion ( int  v  ) 

Interface: External

This function sets the version. Default version is 1

Returns:
None

Definition at line 240 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetVpResponseVersion ( int  vpResponseVersion  ) 

Interface: External

Sets Validation Policy response version

Returns:
None
Parameters:
vpResponseVersion  [in] Response version to be set

Definition at line 251 of file ValPolResponse.cpp.

const int CPKIFValPolResponse::GetVpResponseVersion (  )  const

Interface: External

Gets Validation Policy response version

Returns:
Response version

Definition at line 264 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetMaxCVRequestVersion ( int  maxCVRequestVersion  ) 

Interface: External

Sets max request version

Returns:
None
Parameters:
maxCVRequestVersion  [in] Max request version to be set

Definition at line 275 of file ValPolResponse.cpp.

const int CPKIFValPolResponse::GetMaxCVRequestVersion (  )  const

Interface: External

Gets max request version

Returns:
Request version

Definition at line 288 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetMaxVPRequestVersion ( int  maxVPRequestVersion  ) 

Interface: External

Sets Max Validation Policy request version

Returns:
None
Parameters:
maxVPRequestVersion  [in] Max Request version to be set

Definition at line 299 of file ValPolResponse.cpp.

const int CPKIFValPolResponse::GetMaxVPRequestVersion (  )  const

Interface: External

Gets Max Validation Policy request version

Returns:
Response version

Definition at line 312 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetServerConfigurationID ( int  serverConfigurationID  ) 

Interface: External

Sets server configuration id

Returns:
None
Parameters:
serverConfigurationID  [in] Server config ID

Definition at line 323 of file ValPolResponse.cpp.

const int CPKIFValPolResponse::GetServerConfigurationID (  )  const

Interface: External

Gets server configuration id

Returns:
Server configuration id

Definition at line 336 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetThisUpdate ( const CPKIFTimePtr &  thisUpdate  ) 

Interface: External

Sets this update

Returns:
None
Parameters:
thisUpdate  [in] This update to be set

Definition at line 347 of file ValPolResponse.cpp.

const CPKIFTimePtr CPKIFValPolResponse::GetThisUpdate (  )  const

Interface: External

Gets this update

Returns:
This update

Definition at line 360 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetSupportedChecks ( CPKIFOIDListPtr &  supportedChecks  ) 

Interface: External

Sets supported checks

Returns:
None
Parameters:
supportedChecks  [in] Supported checks oid list

Definition at line 371 of file ValPolResponse.cpp.

void CPKIFValPolResponse::GetSupportedChecks ( CPKIFOIDListPtr &  supportedChecks  ) 

Interface: External

Gets supported checks

Returns:
None
Parameters:
supportedChecks  [out] Supported checks oid list

Definition at line 384 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetSupportedWantBacks ( CPKIFOIDListPtr &  supportedWantBacks  ) 

Interface: External

Sets supported wantBacks

Returns:
None
Parameters:
supportedWantBacks  [in] Supported wantBacks oid list

Definition at line 397 of file ValPolResponse.cpp.

void CPKIFValPolResponse::GetSupportedWantBacks ( CPKIFOIDListPtr &  supportedWantBacks  ) 

Interface: External

Gets supported wantBacks

Returns:
None
Parameters:
supportedWantBacks  [out] Supported wantBacks oid list

Definition at line 410 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetValidationPolicies ( CPKIFOIDListPtr &  validationPolicies  ) 

Interface: External

Sets validation policies

Returns:
None
Parameters:
validationPolicies  [in] Validation policies oid list

Definition at line 423 of file ValPolResponse.cpp.

void CPKIFValPolResponse::GetValidationPolicies ( CPKIFOIDListPtr &  validationPolicies  ) 

Interface: External

Gets validation policies

Returns:
None
Parameters:
validationPolicies  [out] Validation policies oid list

Definition at line 436 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetValidationAlgs ( CPKIFOIDListPtr &  validationAlgs  ) 

Interface: External

Sets validation algorithms

Returns:
None
Parameters:
validationAlgs  [in] Validation algorithms oid list

Definition at line 449 of file ValPolResponse.cpp.

void CPKIFValPolResponse::GetValidationAlgs ( CPKIFOIDListPtr &  validationAlgs  ) 

Interface: External

Gets validation algorithms

Returns:
None
Parameters:
validationAlgs  [out] Validation algorithms oid list

Definition at line 462 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetAuthPolicies ( CPKIFOIDListPtr &  authPolicies  ) 

Interface: External

Sets Auth Policies

Returns:
None
Parameters:
authPolicies  [in] Auth policies oid list

Definition at line 475 of file ValPolResponse.cpp.

void CPKIFValPolResponse::GetAuthPolicies ( CPKIFOIDListPtr &  authPolicies  ) 

Interface: External

Gets Auth Policies

Returns:
None
Parameters:
authPolicies  [out] Auth policies oid list

Definition at line 488 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetResponseTypes ( SCVPResponseTypes  responseTypes  ) 

Interface: External

Sets response types

Returns:
None
Parameters:
responseTypes  [in] SCVP response types to be set

Definition at line 501 of file ValPolResponse.cpp.

const SCVPResponseTypes CPKIFValPolResponse::GetResponseTypes (  )  const

Interface: External

Gets response types

Returns:
response types

Definition at line 514 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetRespValidationPolicy ( CPKIFValidationPolicyPtr &  respValidationPolicy  ) 

Interface: External

Sets response validation policy

Returns:
None
Parameters:
respValidationPolicy  [in] Validation policy to be set

Definition at line 525 of file ValPolResponse.cpp.

const CPKIFValidationPolicyPtr CPKIFValPolResponse::GetRespValidationPolicy (  )  const

Interface: External

Gets response validation policy

Returns:
Smart pointer to CPKIFValidationPolicy class

Definition at line 538 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetRevocationInfoTypes ( std::bitset< 4 >  revocationInfoTypes  ) 

Interface: External

Sets revocation info types

Returns:
None
Parameters:
revocationInfoTypes  [in] Bitset indicating revocation info types

Definition at line 549 of file ValPolResponse.cpp.

const std::bitset< 4 > CPKIFValPolResponse::GetRevocationInfoTypes (  )  const

Interface: External

Gets revocation info types

Returns:
Bitset indicating revocation info types

Definition at line 562 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetSignatureGeneration ( CPKIFAlgorithmIdentifierListPtr &  signatureGeneration  ) 

Interface: External

Sets signature generation algorithm ID

Returns:
None
Parameters:
signatureGeneration  [in] Algorithm ID

Definition at line 573 of file ValPolResponse.cpp.

void CPKIFValPolResponse::GetSignatureGeneration ( CPKIFAlgorithmIdentifierListPtr &  signatureGeneration  ) 

Interface: External

Gets signature generation algorithm ID

Returns:
None
Parameters:
signatureGeneration  [out] Algorithm ID

Definition at line 586 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetSignatureVerification ( CPKIFAlgorithmIdentifierListPtr &  signatureVerification  ) 

Interface: External

Sets signature verification algorithm ID

Returns:
None
Parameters:
signatureVerification  [in] Algorithm ID

Definition at line 599 of file ValPolResponse.cpp.

void CPKIFValPolResponse::GetSignatureVerification ( CPKIFAlgorithmIdentifierListPtr &  signatureVerification  ) 

Interface: External

Gets signature verification algorithm ID

Returns:
None
Parameters:
signatureVerification  [out] Algorithm ID

Definition at line 612 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetHashAlgorithms ( CPKIFOIDListPtr &  hashAlgorithms  ) 

Interface: External

Sets hash algorithms

Returns:
None
Parameters:
hashAlgorithms  [in] Hash algs oid list

Definition at line 625 of file ValPolResponse.cpp.

void CPKIFValPolResponse::GetHashAlgorithms ( CPKIFOIDListPtr &  hashAlgorithms  ) 

Interface: External

Gets hash algorithms

Returns:
None
Parameters:
hashAlgorithms  [out] Hash algs oid list

Definition at line 638 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetClockSkew ( int  clockSkew  ) 

Interface: External

Sets clock skew

Returns:
None
Parameters:
clockSkew  [out] Clock Skew

Definition at line 651 of file ValPolResponse.cpp.

const int CPKIFValPolResponse::GetClockSkew (  )  const

Interface: External

Gets clock skew

Returns:
None

Definition at line 664 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetNextUpdate ( CPKIFTimePtr &  nextUpdate  ) 

Interface: External

Sets next update

Returns:
None
Parameters:
nextUpdate  [out] Next update

Definition at line 677 of file ValPolResponse.cpp.

const CPKIFTimePtr CPKIFValPolResponse::GetNextUpdate (  )  const

Interface: External

Gets next update

Returns:
Smart pointer to CPKIFTime class indicating next update

Definition at line 690 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetRequestNonce ( CPKIFBufferPtr &  requestNonce  ) 

Interface: External

Sets request nonce

Returns:
None
Parameters:
requestNonce  [in] Request nonce value

Definition at line 701 of file ValPolResponse.cpp.

const CPKIFBufferPtr CPKIFValPolResponse::GetRequestNonce (  )  const

Interface: External

Gets request nonce

Returns:
Request nonce value

Definition at line 714 of file ValPolResponse.cpp.

void CPKIFValPolResponse::SetKeyAgreePublicKeys ( CPKIFKeyAgreePublicKeyListPtr &  keyAgreePublicKey  ) 

Interface: External

Sets key agreement public keys

Returns:
None
Parameters:
keyAgreePublicKey  [out] Key agreement public key list

Definition at line 725 of file ValPolResponse.cpp.

void CPKIFValPolResponse::GetKeyAgreePublicKeys ( CPKIFKeyAgreePublicKeyListPtr &  keyAgreePublicKey  ) 

Interface: External

Gets key agreement public keys

Returns:
None
Parameters:
keyAgreePublicKey  [out] Key agreement public key list

Definition at line 738 of file ValPolResponse.cpp.

CPKIFBufferPtr CPKIFValPolResponse::Encode (  )  const

Interface: External

This function is used to generate an encoded a SCVP response.

Returns:
A buffer that contains the encoded CVResponse
Exceptions:
CPKIFSCVPException(SCVP_MISSING_REQUIRED_FIELD) 
CPKIFSCVPException(COMMON_NOT_IMPLEMENTED) 

Definition at line 755 of file ValPolResponse.cpp.

References CACASNWRAPPER_CREATE, DELTACRLS, FULLCRLS, INDIRECTCRLS, LOG_STRING_DEBUG, NEW_NEXT_AND_ADVANCE, NEW_NODE, OCSPRESPONSES, PopulateDListWithASN1OBJID(), PopulateDListWithCACX509V3AlgorithmIdentifier(), PopulateKeyAgreePublicKey(), PopulateValidationPolicy(), PKIFSCVPMemoryHelper::pValPolResponse, SET_HEAD_TAIL_INCREMENT, TOOLKIT_SCVP, and TOOLKIT_SCVP_ASN.

void CPKIFValPolResponse::Decode ( CPKIFBufferPtr &  encoded  )  const

Interface: External

This function is used to generate decode a valPolResponse.

Returns:
None
Exceptions:
CPKIFSCVPException(SCVP_MISSING_REQUIRED_FIELD) 
CPKIFSCVPException(COMMON_NOT_IMPLEMENTED) 

Definition at line 941 of file ValPolResponse.cpp.

References CACASNWRAPPER_CREATE, CACHED_AND_NON_CACHED, CACHED_ONLY, COMMON_INVALID_INPUT, CPKIFTime, DELTACRLS, FULLCRLS, INDIRECTCRLS, MSG_DECODE_FAILED, NON_CACHED_ONLY, OCSPRESPONSES, PopulatePKIFAlgorithmIdentifierList(), PopulatePKIFOIDList(), and TOOLKIT_SCVP_ASN.

The documentation for this class was generated from the following files:
Generated on Mon Nov 15 11:20:49 2010 for PublicKeyInfrastructureFramework(PKIF) by  doxygen 1.5.6