Class CX509Certificate

class CX509Certificate : public CCertificate;

Description

An X.509 certificate.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CSignedObject - Base class for certificates.

• CCertificate - A data structure that binds a public key to a given individual.

• CX509Certificate - An X.509 certificate.

Members

Defined in CX509Certificate:

• DataElementEncoding(const TUint)constGets the encoded data for the specified encoded data element (in the To Be Signe...
• EAlgorithmId
• EExtensionList
• EIssuerName
• EIssuerUID
• ESerialNumber
• ESubjectName
• ESubjectPublicKeyInfo
• ESubjectUID
• EValidityPeriod
• EVersionNumber
• Extension(const TDesC &)constGets the certificate extension identified by the specified object identifier (OI...
• Extensions()constGets all generic certificate extensions.
• InternalizeL(RReadStream &)Internalises an object of this class from a read stream.
• IsEqualL(const CX509Certificate &)constTests whether the specified X.509 certificate is equal to this X.509 certificate...
• IsSelfSignedL()constTests whether the certificate is self-signed.
• IssuerL()constGets the issuer of the certificate.
• IssuerName()constGets the X.500 Distinguished Name that identifies the issuer.
• KeyIdentifierL()constGets a key identifier for the certificate. This is a unique identifier, calculat...
• NewL(RReadStream &)Creates a new X.509 certificate object from the specified read stream.
• NewL(const CX509Certificate &)Creates a new X.509 certificate object from an existing object.
• NewL(const TDesC8 &)Creates a new X.509 certificate object from the specified buffer containing the ...
• NewL(const TDesC8 &,TInt &)Creates a new X.509 certificate object from the specified buffer containing the ...
• NewLC(RReadStream &)Creates a new X.509 certificate object from the specified read stream, and puts ...
• NewLC(const CX509Certificate &)Creates a new X.509 certificate object from an existing object.
• NewLC(const TDesC8 &)Creates a new X.509 certificate object from the specified buffer containing the ...
• NewLC(const TDesC8 &,TInt &)Creates a new X.509 certificate object from the specified buffer containing the ...
• SignedDataL()constGets the certificate's signed data.
• SubjectKeyIdentifierL()constGets the subject key identifier for the certificate. This identifier is extracte...
• SubjectL()constGets the subject of the certificate.
• SubjectName()constGets the X.500 Distinguished Name that identifies the subject.
• Version()constGets the version number of the certificate.
• anonymousEnumerates values for encoded data element positions in the TBSCertificate data ...
• ~CX509Certificate()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from CCertificate:

• PublicKey()constGets the subject public key information.
• SerialNumber()constGets the serial number.
• ValidityPeriod()constGets the validity period.
• iSerialNumberThe serial number.
• iSubjectPublicKeyInfoThe subject public key information.
• iValidityPeriodThe validity period.

Inherited from CSignedObject:

• Encoding()constGets the entire encoding.
• ExternalizeL(RWriteStream &)constExternalises the encoding of the entire object to a write stream.
• Fingerprint()constGets the fingerprint.
• SetParametersL(const CSigningKeyParameters &)Sets the signing key parameters.
• Signature()constGets the digital signature.
• SigningAlgorithm()constGets the signing algorithm ID used.
• VerifySignatureL(const TDesC8 &)constVerifies a signature using the specified encoded key.
• VerifySignatureL(const TDesC8 &,const TDesC8 &)constVerifies a signature using the specified encoded key and hash.
• iEncodingA heap descriptor representing the entire encoding.
• iFingerprintThe fingerprint.
• iKeyFactoryA pointer to a key factory object.
• iParametersThe signing key parameters
• iSignatureThe digital signature.
• iSigningAlgorithmThe signing algorithm ID.

IMPORT_C static CX509Certificate* NewL(const TDesC8 &aBinaryData);

Description

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

Parameters

Return value

IMPORT_C static CX509Certificate* NewLC(const TDesC8 &aBinaryData);

Description

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

Initialises the object from its encoded binary form into an internal representation.

Parameters

Return value

IMPORT_C static CX509Certificate* NewL(const TDesC8 &aBinaryData, TInt &aPos);

Description

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

Parameters

Return value

IMPORT_C static CX509Certificate* NewLC(const TDesC8 &aBinaryData, TInt &aPos);

Description

Creates a new X.509 certificate 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

Return value

IMPORT_C static CX509Certificate* NewL(RReadStream &aStream);

Description

Creates a new X.509 certificate object from the specified read stream.

Parameters

Return value

IMPORT_C static CX509Certificate* NewLC(RReadStream &aStream);

Description

Creates a new X.509 certificate object from the specified read stream, and puts a pointer to it onto the cleanup stack.

Construction is from the stream.

Parameters

Return value

IMPORT_C static CX509Certificate* NewL(const CX509Certificate &aCert);

Description

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

This is equivalent to a copy constructor.

Parameters

Return value

IMPORT_C static CX509Certificate* NewLC(const CX509Certificate &aCert);

Description

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

This is equivalent to a copy constructor.

Parameters

Return value

IMPORT_C ~CX509Certificate();

Description

Destructor.

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

IMPORT_C TBool IsEqualL(const CX509Certificate &aCert) const;

Description

Tests whether the specified X.509 certificate is equal to this X.509 certificate.

X.509 certificates are equal if both the serial number and the issuer name are the same.

Parameters

Return value

IMPORT_C virtual const TPtrC8 SignedDataL() const;

Description

Gets the certificate's signed data.

Return value

IMPORT_C TInt Version() const;

Description

Gets the version number of the certificate.

Return value

IMPORT_C const CX500DistinguishedName& IssuerName() const;

Description

Gets the X.500 Distinguished Name that identifies the issuer.

Return value

IMPORT_C const CX500DistinguishedName& SubjectName() const;

Description

Gets the X.500 Distinguished Name that identifies the subject.

Return value

IMPORT_C const CArrayPtrFlat< CX509CertExtension >& Extensions() const;

Description

Gets all generic certificate extensions.

Return value

IMPORT_C const CX509CertExtension* Extension(const TDesC &aExtensionName) const;

Description

Gets the certificate extension identified by the specified object identifier (OID).

Parameters

Return value

IMPORT_C virtual void InternalizeL(RReadStream &aStream);

Description

Internalises an object of this class from a read stream.

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

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

Parameters

IMPORT_C virtual const TPtrC8* DataElementEncoding(const TUint aIndex) const;

Description

Gets the encoded data for the specified encoded data element (in the To Be Signed (TBS) certificate data structure) of the signed object.

Parameters

Return value

IMPORT_C virtual HBufC* IssuerL() const;

Description

Gets the issuer of the certificate.

Return value

IMPORT_C virtual HBufC* SubjectL() const;

Description

Gets the subject of the certificate.

Return value

IMPORT_C virtual TBool IsSelfSignedL() const;

Description

Tests whether the certificate is self-signed.

Return value

IMPORT_C virtual TKeyIdentifier KeyIdentifierL() const;

Description

Gets a key identifier for the certificate. This is a unique identifier, calculated according to the recommended method of computing it from RFC3280, section 4.2.1.2. Please note that this method does NOT return the value of the Subject Key Id extension, if it is present.

Return value

IMPORT_C TKeyIdentifier SubjectKeyIdentifierL() const;

Description

Gets the subject key identifier for the certificate. This identifier is extracted from the certificate (if the corresponding extension exists), or calculated (if the extension doesn't exist). If calculated, the recommendation from section 4.2.1.2, RFC3280 is used (hash of the public key). Please note, that for subject key ids extracted from the certificate there is a length limit - if the extension is longer than 160 bits, it is ignored and the value is calculated instead.

Return value

n/a

Description

Enumerates values for encoded data element positions in the TBSCertificate data structure.

These values are to be used as parameters to the CX509Certificate::DataElementEncoding(const TUint)const function.