Collapse all Symbian^3 Application Developer Library

MCertStore Class Reference

class MCertStore

Defines the interface for a read-only certificate store.

This documentation describes the security policy that must be enforced by implementations of the interface.

Public Member Functions
void	Applications (const CCTCertInfo &, RArray < TUid > &, TRequestStatus &)
void	CancelApplications ()
void	CancelGetCert ()
void	CancelIsApplicable ()
void	CancelList ()
void	CancelRetrieve ()
void	CancelTrusted ()
void	GetCert ( CCTCertInfo *&, const TCTTokenObjectHandle &, TRequestStatus &)
void	IsApplicable (const CCTCertInfo &, TUid , TBool &, TRequestStatus &)
void	List ( RMPointerArray < CCTCertInfo > &, const CCertAttributeFilter &, TRequestStatus &)
void	Retrieve (const CCTCertInfo &, TDes8 &, TRequestStatus &)
void	Trusted (const CCTCertInfo &, TBool &, TRequestStatus &)

Member Functions Documentation

Applications(const CCTCertInfo &, RArray< TUid > &, TRequestStatus &)

void	Applications	(	const CCTCertInfo &	aCertInfo,
			RArray < TUid > &	aAplications,
			TRequestStatus &	aStatus
		)	[pure virtual]

Querying the applications of a certificate. Get the list of the applications associcated with certificate.

Applications are represented by UIDs. Examples would be Software Install, TLS, WTLS, WMLScript, SignText, etc..

Parameters

const CCTCertInfo & aCertInfo	The certificate to return applications for.
RArray < TUid > & aAplications	An array to save the applications in.
TRequestStatus & aStatus	The request status object; contains the result of the Applications() request when complete. Set to KErrCancel if any outstanding request is cancelled.

CancelApplications()

void

CancelApplications

(

)

[pure virtual]

Cancels an ongoing Applications() operation.

CancelGetCert()

void

CancelGetCert

(

)

[pure virtual]

Cancel an ongoing GetCert() operation.

CancelIsApplicable()

void

CancelIsApplicable

(

)

[pure virtual]

Cancels an ongoing IsApplicable() operation.

CancelList()

void

CancelList

(

)

[pure virtual]

Cancels an ongoing List() operation.

CancelRetrieve()

void

CancelRetrieve

(

)

[pure virtual]

Cancels an ongoing Retrieve() operation.

CancelTrusted()

void

CancelTrusted

(

)

[pure virtual]

Cancels an ongoing Trusted() operation.

GetCert(CCTCertInfo *&, const TCTTokenObjectHandle &, TRequestStatus &)

void	GetCert	(	CCTCertInfo *&	aCertInfo,
			const TCTTokenObjectHandle &	aHandle,
			TRequestStatus &	aStatus
		)	[pure virtual]

Getting a certificate given a handle. Get a certificate given its handle.

Parameters

CCTCertInfo *& aCertInfo	The returned certificate.
const TCTTokenObjectHandle & aHandle	The handle of the certificate to return.
TRequestStatus & aStatus	The request status object; contains the result of the GetCert() request when complete. Set to KErrCancel if any outstanding request is cancelled.

IsApplicable(const CCTCertInfo &, TUid, TBool &, TRequestStatus &)

void	IsApplicable	(	const CCTCertInfo &	aCertInfo,
			TUid	aApplication,
			TBool &	aIsApplicable,
			TRequestStatus &	aStatus
		)	[pure virtual]

Tests if a certificate is applicable to a particular application.

Parameters

const CCTCertInfo & aCertInfo	The certificate in question.
TUid aApplication	The application.
TBool & aIsApplicable	Set to ETrue or EFalse by the function to return the result.
TRequestStatus & aStatus	The request status object; contains the result of the IsApplicable() request when complete. Set to KErrCancel if any outstanding request is cancelled.

List(RMPointerArray< CCTCertInfo > &, const CCertAttributeFilter &, TRequestStatus &)

void	List	(	RMPointerArray < CCTCertInfo > &	aCerts,
			const CCertAttributeFilter &	aFilter,
			TRequestStatus &	aStatus
		)	[pure virtual]

Listing Certificates Get a list of all certificates that satisfy the supplied filter.

This is an async function; all errors are reported by completing aStatus with the error value, and it can be cancelled with CancelList() .

Parameters

RMPointerArray < CCTCertInfo > & aCerts	An array into which the returned certificates are placed.
const CCertAttributeFilter & aFilter	A filter to select which certificates should be included.
TRequestStatus & aStatus	A request status that will be completed when the operation completes.

Retrieve(const CCTCertInfo &, TDes8 &, TRequestStatus &)

void	Retrieve	(	const CCTCertInfo &	aCertInfo,
			TDes8 &	aEncodedCert,
			TRequestStatus &	aStatus
		)	[pure virtual]

Retrieving the actual certificate Retrieves the actual data of the certificate.

capability: ReadUserData This requires the ReadUserData capability when applied to user certificates, as these may contain sensitive user data.

leave: KErrPermissionDenied If called for a user certificate when the caller doesn't have the ReadUserData capability.

Parameters

const CCTCertInfo & aCertInfo	The certificate to retrieve.
TDes8 & aEncodedCert	A buffer to put the certificate in. It must be big enough; the size is stored in aCertInfo.
TRequestStatus & aStatus	The request status object; contains the result of the Retrieve()request when complete. Set to KErrCancel if any outstanding request is cancelled.

Trusted(const CCTCertInfo &, TBool &, TRequestStatus &)

void	Trusted	(	const CCTCertInfo &	aCertInfo,
			TBool &	aTrusted,
			TRequestStatus &	aStatus
		)	[pure virtual]

Trust querying Tests whether a certificate is trusted.

Trust is only meaningful for CA certificates where it means that the certificate can be used as a trust root for the purposes of certificate validation.

Parameters

const CCTCertInfo & aCertInfo	The certificate we are interested in.
TBool & aTrusted	Used to return the trust status.
TRequestStatus & aStatus	The request status object; contains the result of the Trusted() request when complete. Set to KErrCancel if any outstanding request is cancelled.