Symbian
 Developer Library

DEVELOPER LIBRARY

[Index] [Glossary] [Previous] [Next]



Location: pkixcertchain.h
Link against: x500.lib

Class CPKIXCertChain

CPKIXCertChain

Support

Supported from 6.0

Description

Interface to certificate management.

Given a set of certificates supplied by a third party, and a local store of trusted root certificates, this component will attempt to validate the identity of the third party.

Derivation

CBaseBase class for all classes to be instantiated on the heap
CPKIXCertChainInterface to certificate management
CX509CertChainAbstract base class for x509 certificate chain validation

Defined in CPKIXCertChain:
AddCertL(), BuildChainL(), BuildChainL(), ChainHasRoot(), NewL(), NewL(), NewL(), NewLC(), NewLC(), NewLC(), ValidateL(), ValidateL(), ValidateL(), ValidateL(), ValidateL(), ~CPKIXCertChain()

Inherited from CBase:
operator new()

Inherited from CX509CertChain:
Cert(), Count(), DecodeCertsL()


Construction and destruction


NewL()

static CPKIXCertChain* NewL();

Support

Supported from 6.1

Description

Constructs a new CPKIX Certificate chain object.

Return value

CPKIXCertChain*

The new CPKIX Certificate chain object.


NewL()

static CPKIXCertChain* NewL(const TPtrC8& aEncodedCerts, const TUid aClient);

Support

Withdrawn in 6.1

Description

Constructs a new CPKIX Certificate chain object.

Parameters

const TPtrC8& aEncodedCerts

The local store of trusted roots.

const TUid aClient

The client Uid.

Return value

CPKIXCertChain*

The new CPKIX Certificate chain object.


NewL()

static CPKIXCertChain* NewL(const TPtrC8& aEncodedCerts, const CArrayPtr<CX509Certificate>& aRootCerts);

Support

Withdrawn in 6.1

Description

Constructs a new CPKIX Certificate chain object.

Parameters

constTPtrC8& aEncodedCerts

The local store of trusted roots.

constCArrayPtr<CX509Certificate>& aRootCerts

The trusted root certificate.

Return value

CPKIXCertChain*

The new CPKIX Certificate chain object.


NewLC()

static CPKIXCertChain* NewLC();

Support

Supported from 6.1

Description

Constructs a new CPKIX Certificate chain object, and puts a pointer to it onto the cleanup stack.

Return value

CPKIXCertChain*

The new CPKIX Certificate chain object.


NewLC()

static CPKIXCertChain* NewLC(const TPtrC8& aEncodedCerts, const CArrayPtr<CX509Certificate>& aRootCerts);

Support

Withdrawn in 6.1

Description

Constructs a new CPKIX Certificate chain object, and puts a pointer to it onto the cleanup stack.

Parameters

const TPtrC8& aEncodedCerts

The local store of trusted roots.

const CArrayPtr<CX509Certificate>& aRootCerts

The trusted root certificate.

Return value

CPKIXCertChain*

The new CPKIX Certificate chain object.


NewLC()

static CPKIXCertChain* NewLC(const TPtrC8& aEncodedCerts, const TUid aClient);

Support

Withdrawn in 6.1

Description

Constructs a new CPKIX Certificate chain object, and puts a pointer to it onto the cleanup stack.

Parameters

const TPtrC8& aEncodedCerts

The local store of trusted roots.

const TUid aClient

The client Uid.

Return value

CPKIXCertChain*

The new CPKIX Certificate chain object.


~CPKIXCertChain()

~CPKIXCertChain();

Description

Destructor.

Frees all resources owned by the object, prior to its destruction.

[Top]


Validation


ValidateL()

CPKIXValidationResult* ValidateL(const TPtrC8& aEncodedCerts,const TTime& aValidationTime,const TUid aClient);

Support

Supported from 6.1

Description

Constructs a certificate chain, which it attempts to complete with a trusted root certificate from the local store of trusted roots.

Parameters

constTPtrC8& aEncodedCerts

The encoded certificates.

const TTime& aValidationTime

The time taken to perform validation.

const TUid aClient

The client.

Return value

CPKIXValidationResult*

The result of the validation.


ValidateL()

CPKIXValidationResult* ValidateL(const TPtrC8& aEncodedCerts,const TTime& aValidationTime,const TUid aClient,const CArrayPtr<HBufC>& aInitialPolicies);

Support

Supported from 6.1

Description

Constructs a certificate chain, which it attempts to complete with a trusted root certificate from the local store of trusted roots.

Parameters

constTPtrC8& aEncodedCerts

The encoded certificates.

const TTime& aValidationTime

The time taken to perform validation.

const TUid aClient

The client.

const CArrayPtr<HBufC>& aInitialPolicies

Specified set of required certificate policies that constrain the construction and validation of the chain.

Return value

CPKIXValidationResult*

The result of the validation.


ValidateL()

CPKIXValidationResult* ValidateL(const TPtrC8& aEncodedCerts,const TTime& aValidationTime,const CArrayPtr<CX509Certificate>& aRootCerts,const CArrayPtr<HBufC>& aInitialPolicies);

Support

Supported from 6.1

Description

Constructs a certificate chain, which it attempts to complete with a trusted root certificate from the local store of trusted roots.

Parameters

constTPtrC8& aEncodedCerts

The encoded certificates.

const TTime& aValidationTime

The time taken to perform validation.

const CArrayPtr<CX509Certificate>& aRootCerts

The root certificates.

const CArrayPtr<HBufC>& aInitialPolicies

Specified set of required certificate policies that constrain the construction and validation of the chain.

Return value

CPKIXValidationResult*

The result of the validation.


ValidateL()

CPKIXValidationResult* ValidateL(const TTime& aValidationTime);

Support

Withdrawn in 6.1

Description

Constructs a certificate chain, which it attempts to complete with a trusted root certificate from the local store of trusted roots.

Must consist of the concatenation of the DER encoded form of the certificates which make up the chain. The first certificate must be the end entity certificate subsequent certificates may be in any order. The chain object will attempt to construct a valid chain ending in a trusted root from the certificates supplied and those encountered in the local store.

Parameters

const TTime& aValidationTime

The time taken to perform validation.

Return value

CPKIXValidationResult*

The result of the validation.


ValidateL()

CPKIXValidationResult* ValidateL(const TTime& aValidationTime,  const CArrayPtr<HBufC>& aInitialPolicies);

Support

Withdrawn in 6.1

Description

Constructs a certificate chain, which it attempts to complete with a trusted root certificate from the local store of trusted roots.

Parameters

constTTime& aValidationTime

The time taken to perform validation.

constCArrayPtr<HBufC>& aInitialPolicies

Specified set of required certificate policies that constrain the construction and validation of the chain.

Return value

CPKIXValidationResult*

The result of the validation.

[Top]


Member functions


BuildChainL()

void BuildChainL(const TPtrC8& aEncodedCerts, const TUid aClient);

Support

Supported from 6.1

Description

Builds the certificate chain.

Parameters

const TPtrC8& aEncodedCerts

The encoded certificates.

const TUid aClient

The client.


BuildChainL()

void BuildChainL(const TPtrC8& aEncodedCerts, const CArrayPtr<CX509Certificate>& aRootCerts);

Support

Supported from 6.1

Description

Builds the certificate chain.

Parameters

const TPtrC8& aEncodedCerts

The encoded certificates.

constCArrayPtr<CX509Certificate>& aRootCerts

The root certificates.


AddCertL()

void AddCertL(const TPtrC8& aEncodedCerts);

Support

Withdrawn in 6.1

Description

Adds a certificate to the chain.

Parameters

const TPtrC8& aEncodedCerts

The local store of trusted roots.


ChainHasRoot()

TBool ChainHasRoot() const;

Support

Withdrawn in 6.1

Description

Gets the root certificate of the chain.

Return value

TBool

True, if there is a root certificate in the chain; false, otherwise.