Collapse all Symbian^3 Product Developer Library

MSecurityDialog Class Reference

class MSecurityDialog

Definition of the security dialog interface

Since: 7.0

Public Member Functions
void	Cancel()
void	ChangePIN(const TPINParams &, TBool, TPINValue &, TPINValue &, TRequestStatus &)
void	DisablePIN(const TPINParams &, TBool, TPINValue &, TRequestStatus &)
void	EnablePIN(const TPINParams &, TBool, TPINValue &, TRequestStatus &)
void	EnterPIN(const TPINParams &, TBool, TPINValue &, TRequestStatus &)
void	EstablishSecureConnection(const TDesC8 &, const RArray< TCTTokenObjectHandle > &, MSecurityDialog::TConnectionType, TBool &, TCTTokenObjectHandle &, TRequestStatus &)
void	PINBlocked(const TPINParams &, TRequestStatus &)
void	Release()
void	ServerAuthenticationFailure(const TDesC8 &, const TValidationError &, const TDesC8 &, TRequestStatus &)
void	SignText(const TDesC &, const RArray< TCTTokenObjectHandle > &, TCTTokenObjectHandle &, TRequestStatus &)
void	TotalBlocked(const TPINParams &, TRequestStatus &)
void	UnblockPIN(const TPINParams &, const TPINParams &, TBool, TPINValue &, TPINValue &, TRequestStatus &)
void	UnblockPINInClear(const TPINParams &, const TPINParams &, TBool, TUnblockPINValue &, TPINValue &, TRequestStatus &)

Protected Member Functions
	~MSecurityDialog()

Public Member Enumerations
enum	TConnectionType { EWTLS, ETLS }

Constructor & Destructor Documentation

~MSecurityDialog()

~MSecurityDialog

(

)

[protected, inline, pure virtual]

Destructor for the MSecurityDialog class

Member Functions Documentation

Cancel()

void

Cancel

(

)

[pure virtual]

Cancels an ongoing dialog.

ChangePIN(const TPINParams &, TBool, TPINValue &, TPINValue &, TRequestStatus &)

void	ChangePIN	(	const TPINParams &	aPINParams,
			TBool	aRetry,
			TPINValue &	aOldPINValue,
			TPINValue &	aNewPINValue,
			TRequestStatus &	aStatus
		)	[pure virtual]

Prompts the user to change a PIN.

Parameters

const TPINParams & aPINParams	Information about the PIN to change
TBool aRetry	Indicates whether the user is retrying
TPINValue & aOldPINValue	On return, the old PIN the user entered
TPINValue & aNewPINValue	On return, the new PIN the user entered
TRequestStatus & aStatus	This will be set to KErrNotFound if no certificates could be presented to the user.

DisablePIN(const TPINParams &, TBool, TPINValue &, TRequestStatus &)

void	DisablePIN	(	const TPINParams &	aPINParams,
			TBool	aRetry,
			TPINValue &	aPINValue,
			TRequestStatus &	aStatus
		)	[pure virtual]

Prompts the user to disable a PIN.

Parameters

const TPINParams & aPINParams	Information about the PIN to disable.
TBool aRetry	Indicates whether the user is retrying.
TPINValue & aPINValue	On return, the PIN the user entered:
TRequestStatus & aStatus	This will be set to KErrNotFound if no certificates could be presented to the user.

EnablePIN(const TPINParams &, TBool, TPINValue &, TRequestStatus &)

void	EnablePIN	(	const TPINParams &	aPINParams,
			TBool	aRetry,
			TPINValue &	aPINValue,
			TRequestStatus &	aStatus
		)	[pure virtual]

Prompts the user to enable a PIN.

Parameters

const TPINParams & aPINParams	Information about the PIN to enable.
TBool aRetry	Indicates whether the user is retrying.
TPINValue & aPINValue	On return, the PIN the user entered:
TRequestStatus & aStatus	This will be set to KErrNotFound if no certificates could be presented to the user.

EnterPIN(const TPINParams &, TBool, TPINValue &, TRequestStatus &)

void	EnterPIN	(	const TPINParams &	aPINParams,
			TBool	aRetry,
			TPINValue &	aPINValue,
			TRequestStatus &	aStatus
		)	[pure virtual]

Prompts the user to enter a PIN.

Parameters

const TPINParams & aPINParams	Information about the PIN to enter.
TBool aRetry	Indicates whether the user is retrying.
TPINValue & aPINValue	On return, the PIN the user entered:
TRequestStatus & aStatus	This will be set to KErrNotFound if no certificates could be presented to the user.

EstablishSecureConnection(const TDesC8 &, const RArray< TCTTokenObjectHandle > &, MSecurityDialog::TConnectionType, TBool &, TCTTokenObjectHandle &, TRequestStatus &)

void	EstablishSecureConnection	(	const TDesC8 &	aCertData,
			const RArray< TCTTokenObjectHandle > &	aCertHandleList,
			MSecurityDialog::TConnectionType	aConnectionType,
			TBool &	aDoClientAuthentication,
			TCTTokenObjectHandle &	aCertHandle,
			TRequestStatus &	aStatus
		)	[pure virtual]

Informs the user that a secure connection is being established with the given server, allowing them to proceed or cancel the operation.

Parameters

const TDesC8 & aCertData	The certificate sent by the server.
const RArray< TCTTokenObjectHandle > & aCertHandleList	A selection of certificates to display to the user. All certificates are displayed if this is empty.
MSecurityDialog::TConnectionType aConnectionType	This allows the type of certificate to be identified.
TBool & aDoClientAuthentication	Determines whether the user is prompted to agree to authenticate themselves to the server. If this was true before the function was called, it will contain the result of the user's decision on return.
TCTTokenObjectHandle & aCertHandle	An identifier for the certificate the user selected.
TRequestStatus & aStatus	This will be set to KErrNotFound if no certificates could be presented to the user.

PINBlocked(const TPINParams &, TRequestStatus &)

void	PINBlocked	(	const TPINParams &	aPINParams,
			TRequestStatus &	aStatus
		)	[pure virtual]

Informs the user that the PIN has become blocked.

Parameters

const TPINParams & aPINParams	Information about the blocked PIN.
TRequestStatus & aStatus	This will be set to KErrNotFound if no certificates could be presented to the user.

Release()

void

Release

(

)

[pure virtual]

Frees resources of the MSecurityDialog class

ServerAuthenticationFailure(const TDesC8 &, const TValidationError &, const TDesC8 &, TRequestStatus &)

void	ServerAuthenticationFailure	(	const TDesC8 &	aServerName,
			const TValidationError &	aFailureReason,
			const TDesC8 &	aEncodedCert,
			TRequestStatus &	aStatus
		)	[pure virtual]

Informs the user that the server authentication has failed.

Parameters

const TDesC8 & aServerName	The name of the server.
const TValidationError & aFailureReason
const TDesC8 & aEncodedCert
TRequestStatus & aStatus	This will be set to KErrNone or KErrAbort depending upon the EContinue or EStop.

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

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

Signs some 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.

TotalBlocked(const TPINParams &, TRequestStatus &)

void	TotalBlocked	(	const TPINParams &	aPINParams,
			TRequestStatus &	aStatus
		)	[pure virtual]

Informs the user that the unblock PIN has been blocked.

Parameters

const TPINParams & aPINParams	Information about the blocked PIN.
TRequestStatus & aStatus	This will be set to KErrNotFound if no certificates could be presented to the user.

UnblockPIN(const TPINParams &, const TPINParams &, TBool, TPINValue &, TPINValue &, TRequestStatus &)

void	UnblockPIN	(	const TPINParams &	aBlockedPINParams,
			const TPINParams &	aUnblockingPINParams,
			TBool	aRetry,
			TPINValue &	aUnblockingPINValue,
			TPINValue &	aNewPINValue,
			TRequestStatus &	aStatus
		)	[pure virtual]

Prompts the user to unblock a PIN.

The unblocking PIN is not displayed as it is entered, and can be a maximum of 32 characters long - hence it is passed back as a TPINValue.

Parameters

const TPINParams & aBlockedPINParams	Information about the PIN to unblock
const TPINParams & aUnblockingPINParams	Information about the unblocking PIN
TBool aRetry	Indicates whether the user is retrying
TPINValue & aUnblockingPINValue	On return, the PIN the user entered
TPINValue & aNewPINValue	On return, the new PIN the user entered
TRequestStatus & aStatus	This will be set to KErrNotFound if no certificates could be presented to the user.

UnblockPINInClear(const TPINParams &, const TPINParams &, TBool, TUnblockPINValue &, TPINValue &, TRequestStatus &)

void	UnblockPINInClear	(	const TPINParams &	aBlockedPINParams,
			const TPINParams &	aUnblockingPINParams,
			TBool	aRetry,
			TUnblockPINValue &	aUnblockingPINValue,
			TPINValue &	aNewPINValue,
			TRequestStatus &	aStatus
		)	[pure virtual]

Prompts the user to unblock a PIN.

The unblocking PIN is displayed to the user in the clear as it is entered, and can be a maximum of 64 characters long - it is passed back as a TUnblockPINValue.

Parameters

const TPINParams & aBlockedPINParams	Information about the PIN to unblock
const TPINParams & aUnblockingPINParams	Information about the unblocking PIN
TBool aRetry	Indicates whether the user is retrying
TUnblockPINValue & aUnblockingPINValue	On return, the PIN the user entered
TPINValue & aNewPINValue	On return, the new PIN the user entered
TRequestStatus & aStatus	This will be set to KErrNotFound if no certificates could be presented to the user.

Member Enumerations Documentation

Enum TConnectionType

TConnectionType defines the possible protocols used in EstablishSecureConnection which allows the type of the certificate to be derived.

Enumerators

EWTLS	WTLS
ETLS	TLS