CPKIFValidationPolicy Class Reference

#include <ValidationPolicy.h>

Collaboration diagram for CPKIFValidationPolicy:

Collaboration graph
[legend]

List of all members.

Detailed Description

The CPKIFValidationPolicy class provides an interface to SCVP validation policy object. 
ValidationPolicy ::= SEQUENCE 
{
	validationPolRef          ValidationPolRef,
	validationAlg         [0] ValidationAlg OPTIONAL,
	userPolicySet         [1] SEQUENCE SIZE (1..MAX) OF OBJECT
							   IDENTIFIER OPTIONAL,
	inhibitPolicyMapping  [2] BOOLEAN OPTIONAL,
	requireExplicitPolicy [3] BOOLEAN OPTIONAL,
	inhibitAnyPolicy      [4] BOOLEAN OPTIONAL,
	trustAnchors          [5] TrustAnchors OPTIONAL,
	keyUsages             [6] SEQUENCE OF KeyUsage OPTIONAL,
	extendedKeyUsages     [7] SEQUENCE OF KeyPurposeId OPTIONAL,
	specifiedKeyUsages    [8] SEQUENCE OF KeyPurposeId OPTIONAL 
}

TSP-enforcing: No

Definition at line 57 of file ValidationPolicy.h.


Public Types

enum  { EXPLICIT_POLICY, POLICY_MAPPING, ANY_POLICY }

Public Member Functions

 CPKIFValidationPolicy ()
 CPKIFValidationPolicy (const CPKIFBufferPtr &valPol)
virtual ~CPKIFValidationPolicy (void)
void SetValidationPolRef (CPKIFValidationPolRefPtr &valPolRef)
CPKIFValidationPolRefPtr GetValidationPolRef () const
void SetInitialExplicitPolicyIndicator ()
bool GetInitialExplicitPolicyIndicator ()
void SetInitialPolicyMappingInhibitIndicator ()
bool GetInitialPolicyMappingInhibitIndicator ()
void SetInitialInhibitAnyPolicyIndicator ()
bool GetInitialInhibitAnyPolicyIndicator ()
void SetInitialPolicySet (CPKIFPolicyInformationListPtr &initPolSet)
void GetInitialPolicySet (CPKIFPolicyInformationListPtr &initPolSet) const
void SetValidationAlg (CPKIFValidationAlgPtr &valAlg)
CPKIFValidationAlgPtr GetValidationAlg () const
void SetKeyUsages (CPKIFKeyUsageListPtr &keyUsages)
void GetKeyUsages (CPKIFKeyUsageListPtr &keyUsages) const
void SetEKUs (CPKIFOIDListPtr &ekus)
void GetEKUs (CPKIFOIDListPtr &ekus) const
void SetSKUs (CPKIFOIDListPtr &skus)
void GetSKUs (CPKIFOIDListPtr &skus) const
void SetTAs (CPKIFPKCReferenceListPtr &tas)
void GetTAs (CPKIFPKCReferenceListPtr &tas) const

Member Enumeration Documentation

anonymous enum

Enumerator:
EXPLICIT_POLICY 
POLICY_MAPPING 
ANY_POLICY 

Definition at line 64 of file ValidationPolicy.h.

Constructor & Destructor Documentation

CPKIFValidationPolicy::CPKIFValidationPolicy (  ) 

Interface: External

This function is used to create and initialize CPKIFQuery object.

Returns:
None

Definition at line 56 of file ValidationPolicy.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SCVP_ASN.

CPKIFValidationPolicy::CPKIFValidationPolicy ( const CPKIFBufferPtr &  valPol  ) 

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:
valPol  [in] A reference to a smart pointer to CPKIFBuffer object containing der encoded validation policy

Definition at line 71 of file ValidationPolicy.cpp.

References ANY_POLICY, CACASNWRAPPER_CREATE, COMMON_INVALID_INPUT, EXPLICIT_POLICY, POLICY_MAPPING, PopulatePKIFOIDList(), and TOOLKIT_SCVP_ASN.

CPKIFValidationPolicy::~CPKIFValidationPolicy ( void   )  [virtual]

Interface: External

This function destroys instances of CPKIFValidationPolicy.

Returns:
None

Definition at line 217 of file ValidationPolicy.cpp.

References LOG_STRING_DEBUG, and TOOLKIT_SCVP_ASN.

Member Function Documentation

void CPKIFValidationPolicy::SetValidationPolRef ( CPKIFValidationPolRefPtr &  valPolRef  ) 

Interface: External

This function sets validation policy reference for CPKIFValidationPolicy object

Returns:
None
Parameters:
valPolRef  [in] Smart pointer to CPKIFValidationPolRef object which contains validation policy reference

Definition at line 326 of file ValidationPolicy.cpp.

CPKIFValidationPolRefPtr CPKIFValidationPolicy::GetValidationPolRef (  )  const

Interface: External

This function retrives validation policy reference from CPKIFValidationPolicy object

Returns:
Smart pointer to CPKIFValidationPolRef object containing validation policy reference

Definition at line 339 of file ValidationPolicy.cpp.

void CPKIFValidationPolicy::SetInitialExplicitPolicyIndicator (  ) 

Interface: External

This function sets the value of the initial require explicit policy indicator to true.

Returns:
None

Definition at line 233 of file ValidationPolicy.cpp.

References EXPLICIT_POLICY.

bool CPKIFValidationPolicy::GetInitialExplicitPolicyIndicator (  ) 

Interface: External

This function is used to retrieve the Boolean value of the initial require explicit policy indicator during path validation. The default value is false (i.e. an explicit policy is not required).

Returns:
True if initial require explicit policy indicator set to true.

Definition at line 242 of file ValidationPolicy.cpp.

References EXPLICIT_POLICY.

void CPKIFValidationPolicy::SetInitialPolicyMappingInhibitIndicator (  ) 

Interface: External

This function sets the value of the initial inhibit policy mapping indicator to true.

Returns:
None

Definition at line 250 of file ValidationPolicy.cpp.

References POLICY_MAPPING.

bool CPKIFValidationPolicy::GetInitialPolicyMappingInhibitIndicator (  ) 

Interface: External

This function is used to retrieve a Boolean value that serves as the initial inhibit policy mapping indicator for path validation operations. The default value is false (i.e. policy mapping is not inhibited).

Returns:
True if initial inhibit policy mapping indicator set to true.

Definition at line 261 of file ValidationPolicy.cpp.

References POLICY_MAPPING.

void CPKIFValidationPolicy::SetInitialInhibitAnyPolicyIndicator (  ) 

Interface: External

This function is used to set a Boolean value that serves as the initial inhibit any policy indicator for path validation operations. The default value is false (i.e. any policy is not inhibited). The parameter-less SetInitialInhibitAnyPolicyIndicator function sets the value of the initial inhibit any policy indicator to true.

Returns:
None

Definition at line 273 of file ValidationPolicy.cpp.

References ANY_POLICY.

bool CPKIFValidationPolicy::GetInitialInhibitAnyPolicyIndicator (  ) 

Interface: External

This function is used to retrieve a Boolean value that serves as the initial inhibit any policy indicator for path validation operations. The default value is false (i.e. any policy is not inhibited). The parameter-less SetInitialInhibitAnyPolicyIndicator function sets the value of the initial inhibit any policy indicator to true.

Returns:
The GetInitialInhibitAnyPolicyIndicator function returns true if initial inhibit any policy indicator set to true.

Definition at line 285 of file ValidationPolicy.cpp.

References ANY_POLICY.

void CPKIFValidationPolicy::SetInitialPolicySet ( CPKIFPolicyInformationListPtr &  initPolSet  ) 

Interface: External

This function is used to set the set of policies that comprise the initial policy set used for path validation operations. The initPolSet parameter should contain the policies that comprise the initial policy set to use during path validation operations.

Returns:
None
Parameters:
initPolSet  [in or out] Reference to a smart pointer to a CPKIFPolicyInformationList object. This parameter serves as input to SetInitialPolicySet and as output for GetInitialPolicySet.

Definition at line 295 of file ValidationPolicy.cpp.

void CPKIFValidationPolicy::GetInitialPolicySet ( CPKIFPolicyInformationListPtr &  initPolSet  )  const

Interface: External

This function is used to retrieve the set of policies that comprise the initial policy set used for path validation operations. For the SetInitialPolicySet function, the initPolSet parameter should contain the policies that comprise the initial policy set to use during path validation operations.

Returns:
None
Parameters:
initPolSet  [out] Reference to a smart pointer to a CPKIOIDList object. This parameter serves as input to SetInitialPolicySet and as output for GetInitialPolicySet.

Definition at line 312 of file ValidationPolicy.cpp.

void CPKIFValidationPolicy::SetValidationAlg ( CPKIFValidationAlgPtr &  valAlg  ) 

Interface: External

This function sets validation alg for CPKIFValidationPolicy object

Returns:
None
Parameters:
valAlg  [in] Smart pointer to CPKIFValidationAlg object which contains validation algorithm

Definition at line 351 of file ValidationPolicy.cpp.

CPKIFValidationAlgPtr CPKIFValidationPolicy::GetValidationAlg (  )  const

Interface: External

This function retrives validation alg from CPKIFValidationPolicy object

Returns:
Smart pointer to CPKIFValidationAlg object containing validation alg

Definition at line 364 of file ValidationPolicy.cpp.

void CPKIFValidationPolicy::SetKeyUsages ( CPKIFKeyUsageListPtr &  keyUsages  ) 

Interface: External

This function sets the list of key usages for CPKIFValidationPolicy object

Returns:
None
Parameters:
keyUsages  [in] Smart pointer to CPKIFKeyUsageList object containing list of key usages

Definition at line 375 of file ValidationPolicy.cpp.

void CPKIFValidationPolicy::GetKeyUsages ( CPKIFKeyUsageListPtr &  keyUsages  )  const

Interface: External

This function retrives a list of key usages from CPKIFValidationPolicy object

Returns:
None
Parameters:
keyUsages  [in] Smart pointer to CPKIFKeyUsageList object which will contain the list of key usages

Definition at line 388 of file ValidationPolicy.cpp.

void CPKIFValidationPolicy::SetEKUs ( CPKIFOIDListPtr &  ekus  ) 

Interface: External

This function sets the list of EKUs for CPKIFValidationPolicy object

Returns:
None
Parameters:
ekus  [in] Smart pointer to CPKIFOIDList object containing list of EKUs

Definition at line 401 of file ValidationPolicy.cpp.

void CPKIFValidationPolicy::GetEKUs ( CPKIFOIDListPtr &  ekus  )  const

Interface: External

This function retrives a list of EKUs from CPKIFValidationPolicy object

Returns:
None
Parameters:
ekus  [in] Smart pointer to CPKIFOIDList object which will contain the list of eKUs

Definition at line 414 of file ValidationPolicy.cpp.

void CPKIFValidationPolicy::SetSKUs ( CPKIFOIDListPtr &  skus  ) 

Interface: External

This function sets the list of SKUs for CPKIFValidationPolicy object

Returns:
None
Parameters:
skus  [in] Smart pointer to CPKIFOIDList object containing list of SKUs

Definition at line 427 of file ValidationPolicy.cpp.

void CPKIFValidationPolicy::GetSKUs ( CPKIFOIDListPtr &  skus  )  const

Interface: External

This function retrives a list of EKUs from CPKIFValidationPolicy object

Returns:
None
Parameters:
skus  [in] Smart pointer to CPKIFOIDList object which will contain the list of SKUs

Definition at line 440 of file ValidationPolicy.cpp.

void CPKIFValidationPolicy::SetTAs ( CPKIFPKCReferenceListPtr &  tas  ) 

Interface: External

This function sets the list of Trust Anchors for CPKIFValidationPolicy object

Returns:
None
Parameters:
tas  [in] Smart pointer to CPKIFPKCReferenceList object which will contain the list of TAs

Definition at line 453 of file ValidationPolicy.cpp.

void CPKIFValidationPolicy::GetTAs ( CPKIFPKCReferenceListPtr &  tas  )  const

Interface: External

This function retrives a list of Trust Anchors from CPKIFValidationPolicy object

Returns:
None
Parameters:
tas  [in/out] Smart pointer to CPKIFPKCReferenceList object which will contain the list of TAs

Definition at line 466 of file ValidationPolicy.cpp.

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