Collapse all Symbian^3 Product Developer Library

MPKIDialog Class Reference

class MPKIDialog

PKI Dialog interface

Since: Series60 3,0

Public Member Functions
void	CertificateDetails(const TCTTokenObjectHandle &, TRequestStatus &)
void	CreateCSR(const TDesC &, const TCTTokenObjectHandle &, TRequestStatus &)
void	DeleteCertificate(const TCTTokenObjectHandle &, TRequestStatus &)
void	Note(MPKIDialog::TNoteType, TRequestStatus &)
void	PINBlockedInfo(const TPINLabel &, TRequestStatus &)
void	Release()
void	SaveCertificate(TCertificateFormat, TCertificateOwnerType, const TDesC8 &, TRequestStatus &)
void	SaveSignedText(const TDesC &, TRequestStatus &)
void	UserAuthentication(const RArray< TCTTokenObjectHandle > &, TCTTokenObjectHandle &, TRequestStatus &)
void	UserAuthenticationText(const TDesC &, const RArray< TCTTokenObjectHandle > &, TCTTokenObjectHandle &, TRequestStatus &)

Protected Member Functions
	~MPKIDialog()

Public Member Enumerations
enum	TNoteType { ESignatureRequested = 0xFF00, ESignatureDone, ESigningCancelled, ENoMatchCert, ENoSecurityModule, EInternalError }

Constructor & Destructor Documentation

~MPKIDialog()

~MPKIDialog

(

)

[protected, inline, pure virtual]

Member Functions Documentation

CertificateDetails(const TCTTokenObjectHandle &, TRequestStatus &)

void	CertificateDetails	(	const TCTTokenObjectHandle &	aCertHandle,
			TRequestStatus &	aStatus
		)	[pure virtual]

Shows details of the certificate

Parameters

const TCTTokenObjectHandle & aCertHandle	An identifier of the certificate
TRequestStatus & aStatus	KErrNone or KErrNotSupported KErrNotFound if no certificates could be presented to the user.

CreateCSR(const TDesC &, const TCTTokenObjectHandle &, TRequestStatus &)

void	CreateCSR	(	const TDesC &	aSubject,
			const TCTTokenObjectHandle &	aKeyHandle,
			TRequestStatus &	aStatus
		)	[pure virtual]

Certificate signing request dialog

Parameters

const TDesC & aSubject	Subject of the certificate
const TCTTokenObjectHandle & aKeyHandle	An identifier of the private used in the CSR.
TRequestStatus & aStatus	This will be set to KErrNotFound if no certificates could be presented to the user.

DeleteCertificate(const TCTTokenObjectHandle &, TRequestStatus &)

void	DeleteCertificate	(	const TCTTokenObjectHandle &	aCertHandle,
			TRequestStatus &	aStatus
		)	[pure virtual]

Asks user's approval for certificate deleting.

Parameters

const TCTTokenObjectHandle & aCertHandle	An identifier of the certificate
TRequestStatus & aStatus	KErrNone, KErrCancel or KErrNotSupported, KErrNotFound if no certificates could be presented to the user.

Note(MPKIDialog::TNoteType, TRequestStatus &)

void	Note	(	MPKIDialog::TNoteType	aNoteType,
			TRequestStatus &	aStatus
		)	[pure virtual]

Informs the user during digital signing.

Parameters

MPKIDialog::TNoteType aNoteType	Identifies the note type.
TRequestStatus & aStatus	KErrNone or KErrNotSupported

PINBlockedInfo(const TPINLabel &, TRequestStatus &)

void	PINBlockedInfo	(	const TPINLabel &	aLabel,
			TRequestStatus &	aStatus
		)	[pure virtual]

Shows instructions how to unblock PIN.

Parameters

const TPINLabel & aLabel	Label of the PIN.
TRequestStatus & aStatus	KErrNone or KErrNotSupported

Release()

void

Release

(

)

[pure virtual]

Release is called to free resources of the MDigSigningNote class

SaveCertificate(TCertificateFormat, TCertificateOwnerType, const TDesC8 &, TRequestStatus &)

void	SaveCertificate	(	TCertificateFormat	aFormat,
			TCertificateOwnerType	aCertificateOwnerType,
			const TDesC8 &	aCert,
			TRequestStatus &	aStatus
		)	[pure virtual]

Asks user's approval for certificate saving.

Parameters

TCertificateFormat aFormat	The format of the certificate.
TCertificateOwnerType aCertificateOwnerType	The owner type.
const TDesC8 & aCert	The certificate to be added.
TRequestStatus & aStatus	KErrNone, KErrCancel or KErrNotSupported, KErrArgument if error in certificate parsing

SaveSignedText(const TDesC &, TRequestStatus &)

void	SaveSignedText	(	const TDesC &	aSignedText,
			TRequestStatus &	aStatus
		)	[pure virtual]

Saves receipt to Notepad if receipt saving is on.

Parameters

const TDesC & aSignedText	Signed text in readable form.
TRequestStatus & aStatus	KErrNone or KErrNotSupported

UserAuthentication(const RArray< TCTTokenObjectHandle > &, TCTTokenObjectHandle &, TRequestStatus &)

void	UserAuthentication	(	const RArray< TCTTokenObjectHandle > &	aCertHandleList,
			TCTTokenObjectHandle &	aCertHandle,
			TRequestStatus &	aStatus
		)	[pure virtual]

User authentication dialogs

Parameters

const RArray< TCTTokenObjectHandle > & aCertHandleList	A selection of certificates to display to the user. All certificates are displayed if this is empty.
TCTTokenObjectHandle & aCertHandle	On return, an identifier for the certificate the user selected. aStatus - this will be set to KErrNotFound if no certificates could be presented to the user.
TRequestStatus & aStatus	This will be set to KErrNotFound if no certificates could be presented to the user.

UserAuthenticationText(const TDesC &, const RArray< TCTTokenObjectHandle > &, TCTTokenObjectHandle &, TRequestStatus &)

void	UserAuthenticationText	(	const TDesC &	aTextToSign,
			const RArray< TCTTokenObjectHandle > &	aCertHandleList,
			TCTTokenObjectHandle &	aCertHandle,
			TRequestStatus &	aStatus
		)	[pure virtual]

User authentication dialogs with text

Parameters

const TDesC & aTextToSign	The text to be signed.
const RArray< TCTTokenObjectHandle > & aCertHandleList	A selection of certificates to display to the user. All certificates are displayed if this is empty.
TCTTokenObjectHandle & aCertHandle	On return, an identifier for the certificate the user selected. aStatus - this will be set to KErrNotFound if no certificates could be presented to the user.
TRequestStatus & aStatus	This will be set to KErrNotFound if no certificates could be presented to the user.

Member Enumerations Documentation

Enum TNoteType

TNoteType defines different possible note types.

Enumerators

ESignatureRequested = 0xFF00
ESignatureDone
ESigningCancelled
ENoMatchCert
ENoSecurityModule
EInternalError