CCertAttributeFilter Class Reference

class CCertAttributeFilter : public CBase

A filter for specifying which certificates are required.

On construction it will accept everything. The Set... functions can then be used to restrict it.

Inherits from

  • CCertAttributeFilter

Constructor & Destructor Documentation

CCertAttributeFilter()

CCertAttributeFilter()[private]

Member Functions Documentation

ExternalizeL(RWriteStream &)

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Write a certificate attribute filter to a stream.

Parameters

RWriteStream & aStream

InternalizeL(RReadStream &)

voidInternalizeL(RReadStream &aStream)[private]

Parameters

RReadStream & aStream

NewL()

IMPORT_C CCertAttributeFilter *NewL()[static]

Returns a default filter. This filter accepts any certificate. Call the Set... functions to restrict what it accepts.

A pointer to a new CCertAttributeFilter object.

NewL(RReadStream &)

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

Read a certificate attribute filter from a stream.

Parameters

RReadStream & aStream

NewLC()

IMPORT_C CCertAttributeFilter *NewLC()[static]

Returns a default filter. This filter accepts any certificate. It leaves the filter on the cleanup stack.

A pointer to a new CCertAttributeFilter object.

SetFormat(TCertificateFormat)

IMPORT_C voidSetFormat(TCertificateFormataFormat)

Sets the format of the returned certificates

Parameters

TCertificateFormat aFormatThe required format

SetIssuerKeyId(const TKeyIdentifier &)

IMPORT_C voidSetIssuerKeyId(const TKeyIdentifier &aIssuerKeyId)

Sets the issuer key ID that returned certificates must have.

Parameters

const TKeyIdentifier & aIssuerKeyIdThe issuer key ID

SetKeyUsage(TKeyUsageX509)

IMPORT_C voidSetKeyUsage(TKeyUsageX509aKeyUsage)

Sets the usage that returned certs must be used for.

Note that the usage is supplied using X509 scheme - keystore interfaces use the PKCS#15 scheme!

Parameters

TKeyUsageX509 aKeyUsageThe key usage

SetLabel(const TCertLabel &)

IMPORT_C voidSetLabel(const TCertLabel &aLabel)

Sets the label of the cert that the filter will accept.

Parameters

const TCertLabel & aLabelThe new label

SetOwnerType(TCertificateOwnerType)

IMPORT_C voidSetOwnerType(TCertificateOwnerTypeaOwnerType)

Sets the owner type of the returned certificates

Parameters

TCertificateOwnerType aOwnerTypeThe owner type.

SetSubjectKeyId(const TKeyIdentifier &)

IMPORT_C voidSetSubjectKeyId(const TKeyIdentifier &aSubjectKeyId)

Sets the subject key ID that returned certificates must have.

Parameters

const TKeyIdentifier & aSubjectKeyIdThe subject key ID

SetUid(TUid)

IMPORT_C voidSetUid(TUidaUid)

Sets the UID of an application which the certificate must support

Parameters

TUid aUidThe new UID

Member Data Documentation

TCertificateFormat iFormat

TCertificateFormat iFormat

The format of certificates that should be included.

TBool iFormatIsSet

TBool iFormatIsSet

Indicates that iFormat should be used.

TKeyIdentifier iIssuerKeyId

TKeyIdentifier iIssuerKeyId

The issuer key that returned certs should have.

TBool iIssuerKeyIdIsSet

TBool iIssuerKeyIdIsSet

Indicates that iIssuerKeyId should be used.

TKeyUsageX509 iKeyUsage

TKeyUsageX509 iKeyUsage

The usage of keys that should be returned.

TCertLabel iLabel

TCertLabel iLabel

The filter data. Each data item is accompanied by a '..IsSet' boolean which indicates if the item should be used. Unset values (whose ..IsSet variable is EFalse) should be ignored. The label that returned certificates must have.

TBool iLabelIsSet

TBool iLabelIsSet

Indicates that iLabel should be used.

TCertificateOwnerType iOwnerType

TCertificateOwnerType iOwnerType

The owner type of returned certificates.

TBool iOwnerTypeIsSet

TBool iOwnerTypeIsSet

Indicates that iOwnerType should be used.

TKeyIdentifier iSubjectKeyId

TKeyIdentifier iSubjectKeyId

The subject key that returned certs should have.

TBool iSubjectKeyIdIsSet

TBool iSubjectKeyIdIsSet

Indicates that iSubjectKeyId should be used.

TUid iUid

TUid iUid

The application UID that all returned certificates must have.

TBool iUidIsSet

TBool iUidIsSet

Indicates that iUid should be used.