CX509CertExtension Class Reference

#include <x509cert.h>

class CX509CertExtension : public CBase

Inherits from

CX509CertExtension
- CBase

Public Member Functions
	~CX509CertExtension()
IMPORT_C TBool	Critical()
IMPORT_C TUint8	CriticalData()
IMPORT_C TPtrC8	Data()
IMPORT_C CASN1EncSequence *	EncodeASN1DERLC()
IMPORT_C TPtrC	Id()
IMPORT_C CX509CertExtension *	NewL(const CX509CertExtension &)
IMPORT_C CX509CertExtension *	NewL(const TDesC8 &)
IMPORT_C CX509CertExtension *	NewL(const TDesC8 &, TInt &)
IMPORT_C CX509CertExtension *	NewL(const TDesC &, const TBool, const TDesC8 &)
IMPORT_C CX509CertExtension *	NewLC(const CX509CertExtension &)
IMPORT_C CX509CertExtension *	NewLC(const TDesC8 &)
IMPORT_C CX509CertExtension *	NewLC(const TDesC8 &, TInt &)
IMPORT_C CX509CertExtension *	NewLC(const TDesC &, const TBool, const TDesC8 &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

A generic X.509 certificate extension.

The creation of a generic extension is the first step in the creation of a specific extension. Client code gets the decoded Object Identifier (OID) encapsulated by an instance of this class and uses it to create the specific extension.

Consists of an any-defined-by structure along with a boolean flag saying whether the extension is critical or not.

Since: v6.0

Constructor & Destructor Documentation

~CX509CertExtension ( )

IMPORT_C

~CX509CertExtension

(

)

Destructor.

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

Member Function Documentation

Critical ( )

IMPORT_C TBool

Critical

(

)

const

Tests whether certificate processing code must process this extension for certificate validation to succeed.

Return Value: ETrue, if this extension must be processed for validation to succeed; EFalse, otherwise.

CriticalData ( )

IMPORT_C TUint8

CriticalData

(

)

const

Gets the actual data of the critical field of the extension.

Return Value: The actual data of the critical field of the extension.

Data ( )

IMPORT_C TPtrC8

Data

(

)

const

Gets the encoded binary representation of the specific extension.

Return Value: A pointer descriptor representing the specific extension.

EncodeASN1DERLC ( )

IMPORT_C CASN1EncSequence *

EncodeASN1DERLC

(

)

const

Creates and returns a DER encoded X.509 certificate extension object in the form of a ASN.1 Sequence and puts it onto the cleanup stack. This method can be called repeatedly to get copies of the sequence.

Return Value: A pointer to a DER encoded ASN.1 sequence

Id ( )

IMPORT_C TPtrC

(

)

const

Gets the Object Identifier (OID) of the certficate extension.

Return Value: The OID of the certficate extension.

NewL ( const CX509CertExtension & )

IMPORT_C CX509CertExtension *

NewL

(

const CX509CertExtension &

aExtension

)

[static]

Creates a new generic X.509 certificate extension object from an existing object.

This is equivalent to a copy constructor.

Parameters
aExtension	The generic certificate extension to be copied.

Return Value: The new generic certificate extension object.

NewL ( const TDesC8 & )

IMPORT_C CX509CertExtension *

NewL

(

const TDesC8 &

aBinaryData

)

[static]

Creates a new generic X.509 certificate extension object from the specified buffer containing the binary coded representation.

Parameters
aBinaryData	The encoded binary representation.

Return Value: The new generic X.509 certificate extension object.

NewL ( const TDesC8 &, TInt & )

IMPORT_C CX509CertExtension *	NewL	(	const TDesC8 &	aBinaryData,
			TInt &	aPos
		)	[static]

Creates a new generic X.509 certificate extension object from the specified buffer containing the binary coded representation, starting at the specified offset.

Parameters
aBinaryData	The encoded binary representation.
aPos	The offset position from which to start decoding.

Return Value: The new generic X.509 certificate extension object.

NewL ( const TDesC &, const TBool, const TDesC8 & )

IMPORT_C CX509CertExtension *	NewL	(	const TDesC &	aCertExtOID,
			const TBool	aCritical,
			const TDesC8 &	aCertExtValue
		)	[static]

Creates a new generic X.509 certificate extension object from the specified extension object id, the critcal flag and the extension data.

Parameters
aCertExtOID	The OID of the certficate extension.
aCritical	Flag to convey criticality of the extension.
aCertExtValue	The data of the specific extension.

Return Value: The new generic X.509 certificate extension object.

NewLC ( const CX509CertExtension & )

IMPORT_C CX509CertExtension *

NewLC

(

const CX509CertExtension &

aExtension

)

[static]

Creates a new generic X.509 certificate extension object from an existing object, and puts a pointer to it onto the cleanup stack.

This is equivalent to a copy constructor.

Parameters
aExtension	The generic certificate extension to be copied.

Return Value: The new generic X.509 certificate extension object.

NewLC ( const TDesC8 & )

IMPORT_C CX509CertExtension *

NewLC

(

const TDesC8 &

aBinaryData

)

[static]

Creates a new generic X.509 certificate extension object from the specified buffer containing the binary coded representation, and puts a pointer to it onto the cleanup stack .

Parameters
aBinaryData	The encoded binary representation.

Return Value: The new generic X.509 certificate extension object.

NewLC ( const TDesC8 &, TInt & )

IMPORT_C CX509CertExtension *	NewLC	(	const TDesC8 &	aBinaryData,
			TInt &	aPos
		)	[static]

Creates a new generic X.509 certificate extension object from the specified buffer containing the binary coded representation, starting at the specified offset, and puts a pointer to it onto the cleanup stack.

Parameters
aBinaryData	The encoded binary representation.
aPos	The offset position from which to start decoding.

Return Value: The new generic X.509 certificate extension object.

NewLC ( const TDesC &, const TBool, const TDesC8 & )

IMPORT_C CX509CertExtension *	NewLC	(	const TDesC &	aCertExtOID,
			const TBool	aCritical,
			const TDesC8 &	aCertExtValue
		)	[static]

Creates a new generic X.509 certificate extension object from the specified extension object id, the critcal flag and the extension data, and puts a pointer to it onto the cleanup stack.

Parameters
aCertExtOID	The OID of the certficate extension.
aCritical	Flag to convey criticality of the extension.
aCertExtValue	The data of the specific extension.

Return Value: The new generic X.509 certificate extension object.