CPKIXValidationResultBase Class Reference

#include <pkixvalidationresult.h>

Link against: pkixcertbase.lib

class CPKIXValidationResultBase : public CBase

Inherits from

  • CPKIXValidationResultBase

Detailed Description

Base class for CPKIXValidationResult.

Constructor & Destructor Documentation

CPKIXValidationResultBase ( )

IMPORT_CCPKIXValidationResultBase()[protected]

~CPKIXValidationResultBase ( )

IMPORT_C~CPKIXValidationResultBase()

The destructor.

Frees all resources owned by the object.

Member Function Documentation

AppendCertificateValidationObjectL ( const CCertificateValidationWarnings & )

IMPORT_C voidAppendCertificateValidationObjectL(const CCertificateValidationWarnings &aCertWarning)

Adds a certificate warning to the validation result.

Parameters
aCertWarningThe warning to be added.

AppendCriticalExtensionWarningL ( TDesC & )

IMPORT_C voidAppendCriticalExtensionWarningL(TDesC &aCriticalExt)

Adds a critical extension OID warning.

Parameters
aCriticalExtThe critical extension OID to be added.

AppendPolicyL ( CX509CertPolicyInfo & )

voidAppendPolicyL(CX509CertPolicyInfo &aPolicy)

Adds a policy to the validation result.

Parameters
aPolicyThe policy to be added.

AppendWarningL ( TValidationStatus )

voidAppendWarningL(TValidationStatusaWarning)

Adds a warning to the validation result.

Parameters
aWarningThe warning to be added.

ConstructL ( )

IMPORT_C voidConstructL()[protected]

Error ( )

IMPORT_C const TValidationStatusError()const

Gets the error status of the operation.

Errors are considered fatal, i.e. validation has failed.

Return Value
The error status of the operation.

ExternalizeL ( RWriteStream & )

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Externalises an object of this class to a write stream.

The presence of this function means that the standard templated operator<<() can be used to externalise objects of this class.

Parameters
aStreamStream to which the object should be externalised.

InternalizeL ( RReadStream & )

IMPORT_C voidInternalizeL(RReadStream &aStream)

Internalises an object of this class from a read stream.

The presence of this function means that the standard templated operator>>() can be used to internalise objects of this class.

Note that this function has assignment semantics: it replaces the old value of the object with a new value read from the read stream.

Parameters
aStreamStream from which the object should be internalised.

NewL ( )

IMPORT_C CPKIXValidationResultBase *NewL()[static]

Creates a new PKIX Validation Result object.

Return Value
The new PKIX Validation Result object.

NewL ( RReadStream & )

IMPORT_C CPKIXValidationResultBase *NewL(RReadStream &aStream)[static]

Creates a new PKIX Validation Result object from a stream.

Return Value
The new PKIX Validation Result object.

NewLC ( )

IMPORT_C CPKIXValidationResultBase *NewLC()[static]

Creates a new PKIX Validation Result object, and puts a pointer to it onto the cleanup stack.

Return Value
The new PKIX Validation Result object.

NewLC ( RReadStream & )

IMPORT_C CPKIXValidationResultBase *NewLC(RReadStream &aStream)[static]

Creates a new PKIX Validation Result object from a stream, and puts a pointer to it onto the cleanup stack.

Return Value
The new PKIX Validation Result object.

Policies ( )

IMPORT_C const CArrayPtrFlat< CX509CertPolicyInfo > &Policies()const

Gets a list of all the certificate policies which have been accepted implicitly in the course of validation.

Return Value
An array of certificate policies.

RemovePolicies ( )

voidRemovePolicies()

Removes all policies from the validation result.

It is used by the validation process to remove policies it has added when the computation cannot complete because of environmental conditions such as out of memory, file access failures, etc..

Reset ( )

voidReset()

Resets the validation result object to its default values.

SetError ( const TValidationError, const TInt )

voidSetError(const TValidationErroraError,
const TIntaCert
)

Sets the error status.

Parameters
aErrorThe error type that occurred when validating the certificate chain.
aCertThe index number identifying the certificate that gave rise to the error.

SetErrorAndLeaveL ( const TValidationError, const TInt )

voidSetErrorAndLeaveL(const TValidationErroraError,
const TIntaCert
)

Sets the error status, and then leaves.

The function uses SetError() to set the error status.

Parameters
aErrorThe error type that occurred when validating the certificate chain.
aCertThe index number identifying the certificate that gave rise to the error.

ValidationWarnings ( )

IMPORT_C const RPointerArray< CCertificateValidationWarnings > &ValidationWarnings()const

Returns a list of critical extensions encountered and warnings generated by certificates during chain validation.

Return Value
An array of certificate warnings.

Warnings ( )

IMPORT_C const CArrayFixFlat< TValidationStatus > &Warnings()const

Gets a list of warnings generated.

The warnings may or may not be fatal, depending on the context, which the client is expected to provide.

Return Value
An array of any warnings generated.