CWTLSCertificate Class Reference

#include <wtlscert.h>

Link against: wtlscert.lib

class CWTLSCertificate : public CCertificate

Inherits from

CWTLSCertificate
- CCertificate
  - CSignedObject
    - CBase

Public Member Enumerations
enum	anonymous { EVersionNumber, EAlgorithmId, EIssuerName, EValidityPeriod, ..., ESubjectPublicKeyInfo }

Public Member Functions
	~CWTLSCertificate()
virtual IMPORT_C const TPtrC8 *	DataElementEncoding(const TUint)
virtual IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C TBool	IsEqualL(const CWTLSCertificate &)
virtual IMPORT_C TBool	IsSelfSignedL()
IMPORT_C TBool	IsTCAL()
virtual IMPORT_C HBufC *	IssuerL()
IMPORT_C const CWTLSName &	IssuerName()
IMPORT_C CWTLSCertificate *	NewL(const TDesC8 &)
IMPORT_C CWTLSCertificate *	NewL(const TDesC8 &, TInt &)
IMPORT_C CWTLSCertificate *	NewL(RReadStream &)
IMPORT_C CWTLSCertificate *	NewL(const CWTLSCertificate &)
IMPORT_C CWTLSCertificate *	NewLC(const TDesC8 &)
IMPORT_C CWTLSCertificate *	NewLC(const TDesC8 &, TInt &)
IMPORT_C CWTLSCertificate *	NewLC(RReadStream &)
IMPORT_C CWTLSCertificate *	NewLC(const CWTLSCertificate &)
virtual IMPORT_C const TPtrC8	SignedDataL()
virtual IMPORT_C HBufC *	SubjectL()
IMPORT_C const CWTLSName &	SubjectName()
IMPORT_C TInt	Version()

Inherited Attributes
	CCertificate::iSerialNumber
	CCertificate::iSubjectPublicKeyInfo
	CCertificate::iValidityPeriod
	CSignedObject::iEncoding
	CSignedObject::iFingerprint
	CSignedObject::iKeyFactory
	CSignedObject::iParameters
	CSignedObject::iSignature
	CSignedObject::iSigningAlgorithm

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()
	CCertificate::KeyIdentifierL()const
	CCertificate::PublicKey()const
	CCertificate::SerialNumber()const
	CCertificate::ValidityPeriod()const
	CCertificate::~CCertificate()
	CSignedObject::Encoding()const
	CSignedObject::ExternalizeL(RWriteStream &)const
	CSignedObject::Fingerprint()const
	CSignedObject::SetParametersL(const CSigningKeyParameters &)
	CSignedObject::Signature()const
	CSignedObject::SigningAlgorithm()const
	CSignedObject::VerifyRSASignatureL(const TDesC8 &)const
	CSignedObject::VerifyRSASignatureL(const TDesC8 &,const TDesC8 &)const
	CSignedObject::VerifySignatureL(const TDesC8 &)const
	CSignedObject::VerifySignatureL(const TDesC8 &,const TDesC8 &)const
	CSignedObject::~CSignedObject()

Member Enumeration Documentation

Enum anonymous

Enumerator	Value	Description
EVersionNumber	0
EAlgorithmId	1
EIssuerName	2
EValidityPeriod	3
ESubjectName	4
ESubjectPublicKeyInfo	5

Constructor & Destructor Documentation

~CWTLSCertificate ( )

IMPORT_C

~CWTLSCertificate

(

)

Destructor.

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

Member Function Documentation

DataElementEncoding ( const TUint )

IMPORT_C const TPtrC8 *

DataElementEncoding

(

const TUint

aIndex

)

const [virtual]

Reimplemented from CSignedObject::DataElementEncoding(const TUint)const

Gets the encoding for a data element at the specified index.

Parameters
aIndex	The position of the encoded data element.

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

[virtual]

Reimplemented from CSignedObject::InternalizeL(RReadStream &)

Initialises the certificate from a stream.

This should not be called by client code; instead the static factory function above should be used. If a client is using the certstore component for storage then it should use CCertStore::AddL() for externalizing and CWTLSCert::NewL(CCertStore& aStore, const CCertStoreEntry& aEntry); for restoring.

IsEqualL ( const CWTLSCertificate & )

IMPORT_C TBool

IsEqualL

(

const CWTLSCertificate &

aCert

)

const

Tests whether this WTLS certificate is the same as the specified WTLS certificate.

This is not a simple as it sounds. For X.509 certificates equality means that the issuer name and serial number fields are the same. This guarantees equality since a CA must ensure that every certificate it issues has a unique serial number. But WTLS certificates do not include serial numbers, so there seems to be no definition of equality. This function uses a byte-for-byte comparison of the signatures on the certificates: this should not result in any false positives, but may give false negatives if CAs do naughty things like recertifying the same key (which they have been known to do).

Parameters
aCert	A WTLS certificate

Return Value: ETrue, if the parameter is the same certificate; EFalse, otherwise.

IsSelfSignedL ( )

IMPORT_C TBool

IsSelfSignedL

(

)

const [virtual]

Reimplemented from CCertificate::IsSelfSignedL()const

Tests whether a certificate is self-signed.

Return Value: ETrue, if it is self-signed; EFalse, otherwise.

IsTCAL ( )

IMPORT_C TBool

IsTCAL

(

)

const

Tests whether a non-selfsigned certificate can be used to sign others.

Currently this only supports structured text variety of WTLS certificates. Other certificate types will return EFalse.

Return Value: ETrue, if the certificate is capable of signing other certificates; otherwise, EFalse.

IssuerL ( )

IMPORT_C HBufC *

IssuerL

(

)

const [virtual]

Reimplemented from CCertificate::IssuerL()const

Gets the issuer.

Return Value: A heap descriptor representing the issuer.

IssuerName ( )

IMPORT_C const CWTLSName &

IssuerName

(

)

const

Gets the name of the WTLS certificate's issuing authority.

Return Value: A WTLS name: If the name is an X.500 DN, then if the name contains a Common name, that will be returned. Otherwise, if the name contains an Organization name, that will be returned. Otherwise an empty string will be returned. If the name is of type text, then if the name is not a 'structured' name the entire string will be returned, otherwise the same procedure will be followed as for X.509 certificates. If the name is null an empty string will be returned.

NewL ( const TDesC8 & )

IMPORT_C CWTLSCertificate *

NewL

(

const TDesC8 &

aBinaryData

)

[static]

Creates a new CWTLSCertificate object from the specified buffer containing the binary coded representation.

Parameters
aBinaryData	The encoded binary representation.

Return Value: The new CWTLSCertificate object.

NewL ( const TDesC8 &, TInt & )

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

Creates a new CWTLSCertificate object from the specified buffer containing the binary coded representation.

Parameters
aBinaryData	The encoded binary representation.
aPos	An offset into the descriptor, and is updated to the position at the end of the object.

Return Value: The new CWTLSCertificate object.

NewL ( RReadStream & )

IMPORT_C CWTLSCertificate *

NewL

(

RReadStream &

aStream

)

[static]

Creates a new CWTLSCertificate object from a stream.

The stream must have been written using the corresponding ExternalizeL() function.

Parameters
aStream	The stream to be used as input.

Return Value: The new CWTLSCertificate object.

NewL ( const CWTLSCertificate & )

IMPORT_C CWTLSCertificate *

NewL

(

const CWTLSCertificate &

aCert

)

[static]

Creates a new CWTLSCertificate object from an existing one in the certificate store.

Parameters
aCert	The certificate to be copied.

Return Value: The new CWTLSCertificate object.

NewLC ( const TDesC8 & )

IMPORT_C CWTLSCertificate *

NewLC

(

const TDesC8 &

aBinaryData

)

[static]

Creates a new CWTLSCertificate 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 CWTLSCertificate object.

NewLC ( const TDesC8 &, TInt & )

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

Creates a new CWTLSCertificate 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.
aPos	An offset into the descriptor, and is updated to the position at the end of the object.

Return Value: The new CWTLSCertificate object.

NewLC ( RReadStream & )

IMPORT_C CWTLSCertificate *

NewLC

(

RReadStream &

aStream

)

[static]

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

The stream must have been written using the corresponding ExternalizeL() function.

Parameters
aStream	The stream to be used as input.

Return Value: The new CWTLSCertificate object.

NewLC ( const CWTLSCertificate & )

IMPORT_C CWTLSCertificate *

NewLC

(

const CWTLSCertificate &

aCert

)

[static]

Creates a new CWTLSCertificate object from an existing one in the certificate store, and puts a pointer to it onto the cleanup stack.

Parameters
aCert	The certificate to be copied.

Return Value: The new CWTLSCertificate object.

SignedDataL ( )

IMPORT_C const TPtrC8

SignedDataL

(

)

const [virtual]

Reimplemented from CSignedObject::SignedDataL()const

Gets the certificate's signed data.

Return Value: A non-modifiable pointer descriptor representing the certificate's signed data.

SubjectL ( )

IMPORT_C HBufC *

SubjectL

(

)

const [virtual]

Reimplemented from CCertificate::SubjectL()const

Gets the subject.

Return Value: A heap descriptor representing the subject.

SubjectName ( )

IMPORT_C const CWTLSName &

SubjectName

(

)

const

Gets the name of the owner of the public key the WTLS certificate contains.

Return Value: A WTLS name.

Version ( )

IMPORT_C TInt

Version

(

)

const

Gets the version number of the WTLS certificate.

Return Value: The version number of the certificate. Always returns 1.