CryptoSpi::MPluginSelector Class Reference

#include <cryptospi/pluginselectorbase.h>

Link against: cryptospi.lib

class CryptoSpi::MPluginSelector

Public Member Functions
pure virtual	~MPluginSelector()
pure virtual void	CreateAsymmetricCipherL(CAsymmetricCipher &, TUid, const CKey &, TUid, TUid, const CCryptoParams )
pure virtual void	CreateAsyncAsymmetricCipherL(CAsyncAsymmetricCipher &, TUid, const CKey &, TUid, TUid, const CCryptoParams )
pure virtual void	CreateAsyncHashL(CAsyncHash &, TUid, TUid, const CKey , const CCryptoParams *)
pure virtual void	CreateAsyncKeyAgreementL(CAsyncKeyAgreement &, TUid, const CKey &, const CCryptoParams )
pure virtual void	CreateAsyncKeyPairGeneratorL(CAsyncKeyPairGenerator &, TUid, const CCryptoParams )
pure virtual void	CreateAsyncRandomL(CAsyncRandom &, TUid, const CCryptoParams )
pure virtual void	CreateAsyncSignerL(CAsyncSigner &, TUid, const CKey &, TUid, const CCryptoParams )
pure virtual void	CreateAsyncSymmetricCipherL(CAsyncSymmetricCipher &, TUid, const CKey &, TUid, TUid, TUid, const CCryptoParams )
pure virtual void	CreateAsyncVerifierL(CAsyncVerifier &, TUid, const CKey &, TUid, const CCryptoParams )
pure virtual void	CreateHashL(CHash &, TUid, TUid, const CKey , const CCryptoParams *)
pure virtual void	CreateKeyAgreementL(CKeyAgreement &, TUid, const CKey &, const CCryptoParams )
pure virtual void	CreateKeyPairGeneratorL(CKeyPairGenerator &, TUid, const CCryptoParams )
pure virtual void	CreateRandomL(CRandom &, TUid, const CCryptoParams )
pure virtual void	CreateSignerL(CSigner &, TUid, const CKey &, TUid, const CCryptoParams )
pure virtual void	CreateSymmetricCipherL(CSymmetricCipher &, TUid, const CKey &, TUid, TUid, TUid, const CCryptoParams )
pure virtual void	CreateVerifierL(CVerifier &, TUid, const CKey &, TUid, const CCryptoParams )

Detailed Description

Base class for the selectors

Constructor & Destructor Documentation

~MPluginSelector ( )

~MPluginSelector

(

)

[inline, pure virtual]

Destructor

Member Function Documentation

CreateAsymmetricCipherL ( CAsymmetricCipher &, TUid, const CKey &, TUid, TUid, const CCryptoParams )

void	CreateAsymmetricCipherL	(	CAsymmetricCipher *&	aCipher,
			TUid	aAlgorithmUid,
			const CKey &	aKey,
			TUid	aCryptoMode,
			TUid	aPaddingMode,
			const CCryptoParams *	aAlgorithmParams
		)	[pure virtual]

Creates a new instance of an asymmetric cipher

leave: KErrNone if successful; otherwise, a system wide error code.

Parameter	Description
aCipher	A reference to a pointer that should be set to point to the new asymmetric cipher object.
aAlgorithmUid	The asymmetric cipher algorithm to use (e.g. KRsaCipherUid)
aKey	The encryption/decryption key.
aCryptoMode	whether to encrypt or decrypt
aPaddingMode	The padding mode to use
aAlgorithmParams	Parameters that are specific to a particular algorithm. This is for extendibility and will normally be null.

CreateAsyncAsymmetricCipherL ( CAsyncAsymmetricCipher &, TUid, const CKey &, TUid, TUid, const CCryptoParams )

void	CreateAsyncAsymmetricCipherL	(	CAsyncAsymmetricCipher *&	aCipher,
			TUid	aAlgorithmUid,
			const CKey &	aKey,
			TUid	aCryptoMode,
			TUid	aPaddingMode,
			const CCryptoParams *	aAlgorithmParams
		)	[pure virtual]

Creates a new instance of an asynchronous asymmetric cipher

leave: KErrNone if successful; otherwise, a system wide error code.

Parameter	Description
aCipher	A reference to a pointer that should be set to point to the new asymmetric cipher object.
aAlgorithmUid	The asymmetric cipher algorithm to use (e.g. KRsaCipherUid)
aKey	The encryption/decryption key.
aCryptoMode	whether to encrypt or decrypt
aPaddingMode	The padding mode to use
aAlgorithmParams	Parameters that are specific to a particular algorithm. This is for extendibility and will normally be null.

CreateAsyncHashL ( CAsyncHash &, TUid, TUid, const CKey , const CCryptoParams * )

void	CreateAsyncHashL	(	CAsyncHash *&	aHash,
			TUid	aAlgorithmUid,
			TUid	aOperationMode,
			const CKey *	aKey,
			const CCryptoParams *	aAlgorithmParams
		)	[pure virtual]

Deprecated

Create a new instance of a asynchronous hash object

leave: KErrNone if successful; otherwise, a system wide error code.

Parameter	Description
aHash	The pointer to CHash
aAlgorithmUid	The specific hash algorithm e.g. MD2, SHA1
aOperationMode	The operation mode of the hash e.g. Hash mode, Hmac mode
aKey	The key for Hmac mode, which should be NULL in Hash mode
aAlgorithmParams	The parameters that are specific to a particular algorithm. This is for extendibility and will normally be null.

CreateAsyncKeyAgreementL ( CAsyncKeyAgreement &, TUid, const CKey &, const CCryptoParams )

void	CreateAsyncKeyAgreementL	(	CAsyncKeyAgreement *&	aKeyAgreement,
			TUid	aAlgorithmUid,
			const CKey &	aPrivateKey,
			const CCryptoParams *	aAlgorithmParams
		)	[pure virtual]

Creates a new instance of a asynchronous key agreement system.

leave: KErrNone if successful; otherwise, a system wide error code.

Parameter	Description
aKeyAgreement	A reference to a pointer that should be set to point to the new key agreement object.
aAlgorithmUid	The algorithm to use
aPrivateKey	The private key to combine with the other parties public key during the agreement.
aAlgorithmParams	The parameters that are specific to a particular algorithm. This is for extendibility and will normally be null.

CreateAsyncKeyPairGeneratorL ( CAsyncKeyPairGenerator &, TUid, const CCryptoParams )

void	CreateAsyncKeyPairGeneratorL	(	CAsyncKeyPairGenerator *&	aKeyPairGenerator,
			TUid	aAlgorithmUid,
			const CCryptoParams *	aAlgorithmParams
		)	[pure virtual]

Creates a new instance of a asynchronous key pair generator.

leave: KErrNone if successful; otherwise, a system wide error code.

Parameter	Description
aKeyPairGenerator	A reference to a pointer that should be set to point to the new asymmetric key pair generator object.
aAlgorithmParams	The parameters that are specific to a particular algorithm. This is for extendibility and will normally be null.

CreateAsyncRandomL ( CAsyncRandom &, TUid, const CCryptoParams )

void	CreateAsyncRandomL	(	CAsyncRandom *&	aRandom,
			TUid	aAlgorithmUid,
			const CCryptoParams *	aAlgorithmParams
		)	[pure virtual]

Creates a new instance of a asynchronous random object.

leave: KErrNone if successful; otherwise, a system wide error code.

Parameter	Description
aRandom	A reference to a pointer that should be set to point to the new CRandom object.
aAlgorithmUid	The algorithm to use
aAlgorithmParams	Parameters that are specific this algorithm.

CreateAsyncSignerL ( CAsyncSigner &, TUid, const CKey &, TUid, const CCryptoParams )

void	CreateAsyncSignerL	(	CAsyncSigner *&	aSigner,
			TUid	aAlgorithmUid,
			const CKey &	aKey,
			TUid	aPaddingMode,
			const CCryptoParams *	aAlgorithmParams
		)	[pure virtual]

Creates a new instance of a asynchronous signer.

leave: KErrNone if successful; otherwise, a system wide error code.

Parameter	Description
aSigner	A reference to a pointer that should be set to point to the new signer object.
aAlgorithmUid	The algorithm to use.
aKey	The signing key.
aPaddingMode	The padding mode of the signer.
aAlgorithmParams	Parameters that are specific to a particular algorithm. This is for extendibility and will normally be null.

CreateAsyncSymmetricCipherL ( CAsyncSymmetricCipher &, TUid, const CKey &, TUid, TUid, TUid, const CCryptoParams )

void	CreateAsyncSymmetricCipherL	(	CAsyncSymmetricCipher *&	aCipher,
			TUid	aAlgorithmUid,
			const CKey &	aKey,
			TUid	aCryptoMode,
			TUid	aOperationMode,
			TUid	aPaddingMode,
			const CCryptoParams *	aAlgorithmParams
		)	[pure virtual]

Creates a new synchronous instance of a asynchronous symmetric cipher

leave: KErrNone if successful; otherwise, a system wide error code.

Parameter	Description
aCipher	A reference to a pointer that should be set to point to the new symmetric object.
aAlgorithmUid	The algorithm to use
aKey	The encryption/decryption key.
aCryptoMode	The Symmetric cipher mode.
aOperationMode	The Symmetric cipher operation mode.
aPaddingMode	The Symmetric cipher padding mode.
aAlgorithmParams	Parameters that are specific to a particular algorithm. This is for extendibility and will normally be null.

CreateAsyncVerifierL ( CAsyncVerifier &, TUid, const CKey &, TUid, const CCryptoParams )

void	CreateAsyncVerifierL	(	CAsyncVerifier *&	aVerifier,
			TUid	aAlgorithmUid,
			const CKey &	aKey,
			TUid	aPaddingMode,
			const CCryptoParams *	aAlgorithmParams
		)	[pure virtual]

Creates a new instance of a asynchronous verifier.

leave: KErrNone if successful; otherwise, a system wide error code.

Parameter	Description
aVerifier	A reference to a pointer that should be set to point to the new verifier object.
aAlgorithmUid	The algorithm to use
aKey	The key to verify the signature with.
aPaddingMode	The padding mode of the signer.
aAlgorithmParams	Parameters that are specific to a particular algorithm. This is for extendibility and will normally be null.

CreateHashL ( CHash &, TUid, TUid, const CKey , const CCryptoParams * )

void	CreateHashL	(	CHash *&	aHash,
			TUid	aAlgorithmUid,
			TUid	aOperationMode,
			const CKey *	aKey,
			const CCryptoParams *	aAlgorithmParams
		)	[pure virtual]

Deprecated

Create a new instance of a hash object

leave: KErrNone if successful; otherwise, a system wide error code.

Parameter	Description
aHash	The pointer to CHash
aAlgorithmUid	The specific hash algorithm e.g. MD2, SHA1
aOperationMode	The operation mode of the hash e.g. Hash mode, Hmac mode
aKey	The key for Hmac mode, which should be NULL in Hash mode
aAlgorithmParams	The parameters that are specific to a particular algorithm. This is for extendibility and will normally be null.

CreateKeyAgreementL ( CKeyAgreement &, TUid, const CKey &, const CCryptoParams )

void	CreateKeyAgreementL	(	CKeyAgreement *&	aKeyAgreement,
			TUid	aAlgorithmUid,
			const CKey &	aPrivateKey,
			const CCryptoParams *	aAlgorithmParams
		)	[pure virtual]

Creates a new instance of a key agreement system.

leave: KErrNone if successful; otherwise, a system wide error code.

Parameter	Description
aKeyAgreement	A reference to a pointer that should be set to point to the new key agreement object.
aAlgorithmUid	The algorithm to use
aPrivateKey	The private key to combine with the other parties public key during the agreement.
aAlgorithmParams	The parameters that are specific to a particular algorithm. This is for extendibility and will normally be null.

CreateKeyPairGeneratorL ( CKeyPairGenerator &, TUid, const CCryptoParams )

void	CreateKeyPairGeneratorL	(	CKeyPairGenerator *&	aKeyPairGenerator,
			TUid	aKeyAlgorithmUid,
			const CCryptoParams *	aAlgorithmParams
		)	[pure virtual]

Creates a new instance of a key pair generator.

leave: KErrNone if successful; otherwise, a system wide error code.

Parameter	Description
aKeyPairGenerator	A reference to a pointer that should be set to point to the new asymmetric key pair generator object.
aKeyAlgorithmUid	The algorithm UID
aAlgorithmParams	The parameters that are specific to a particular algorithm. This is for extendibility and will normally be null.

CreateRandomL ( CRandom &, TUid, const CCryptoParams )

void	CreateRandomL	(	CRandom *&	aRandom,
			TUid	aAlgorithmUid,
			const CCryptoParams *	aAlgorithmParams
		)	[pure virtual]

Creates a new instance of a Random object.

leave: KErrNone if successful; otherwise, a system wide error code.

Parameter	Description
aRandom	A reference to a pointer that should be set to point to the new CRandom object.
aAlgorithmUid	The algorithm to use
aAlgorithmParams	Parameters that are specific this algorithm.

CreateSignerL ( CSigner &, TUid, const CKey &, TUid, const CCryptoParams )

void	CreateSignerL	(	CSigner *&	aSigner,
			TUid	aAlgorithmUid,
			const CKey &	aKey,
			TUid	aPaddingMode,
			const CCryptoParams *	aAlgorithmParams
		)	[pure virtual]

Creates a new instance of a synchronous signer.

leave: KErrNone if successful; otherwise, a system wide error code.

Parameter	Description
aSigner	A reference to a pointer that should be set to point to the new signer object.
aAlgorithmUid	The algorithm to use.
aKey	The signing key.
aPaddingMode	The padding mode of the signer.
aAlgorithmParams	Parameters that are specific to a particular algorithm. This is for extendibility and will normally be null.

CreateSymmetricCipherL ( CSymmetricCipher &, TUid, const CKey &, TUid, TUid, TUid, const CCryptoParams )

void	CreateSymmetricCipherL	(	CSymmetricCipher *&	aCipher,
			TUid	aAlgorithmUid,
			const CKey &	aKey,
			TUid	aCryptoMode,
			TUid	aOperationMode,
			TUid	aPaddingMode,
			const CCryptoParams *	aAlgorithmParams
		)	[pure virtual]

Creates a new synchronous instance of a symmetric cipher

leave: KErrNone if successful; otherwise, a system wide error code.

Parameter	Description
aCipher	A reference to a pointer that should be set to point to the new symmetric object.
aAlgorithmUid	The algorithm to use
aKey	The encryption/decryption key.
aCryptoMode	The Symmetric cipher mode.
aOperationMode	The Symmetric cipher operation mode.
aPaddingMode	The Symmetric cipher padding mode.
aAlgorithmParams	Parameters that are specific to a particular algorithm. This is for extendibility and will normally be null.

CreateVerifierL ( CVerifier &, TUid, const CKey &, TUid, const CCryptoParams )

void	CreateVerifierL	(	CVerifier *&	aVerifier,
			TUid	aAlgorithmUid,
			const CKey &	aKey,
			TUid	aPaddingMode,
			const CCryptoParams *	aAlgorithmParams
		)	[pure virtual]

Creates a new instance of a verifier.

leave: KErrNone if successful; otherwise, a system wide error code.

Parameter	Description
aVerifier	A reference to a pointer that should be set to point to the new verifier object.
aAlgorithmUid	The algorithm to use
aKey	The key to verify the signature with.
aPaddingMode	The padding mode of the signer.
aAlgorithmParams	Parameters that are specific to a particular algorithm. This is for extendibility and will normally be null.

CryptoSpi::MPluginSelector Class Reference

Detailed Description

Constructor & Destructor Documentation

~MPluginSelector ( )

Member Function Documentation

CreateAsymmetricCipherL ( CAsymmetricCipher *&, TUid, const CKey &, TUid, TUid, const CCryptoParams * )

CreateAsyncAsymmetricCipherL ( CAsyncAsymmetricCipher *&, TUid, const CKey &, TUid, TUid, const CCryptoParams * )

CreateAsyncHashL ( CAsyncHash *&, TUid, TUid, const CKey *, const CCryptoParams * )

CreateAsyncKeyAgreementL ( CAsyncKeyAgreement *&, TUid, const CKey &, const CCryptoParams * )

CreateAsyncKeyPairGeneratorL ( CAsyncKeyPairGenerator *&, TUid, const CCryptoParams * )

CreateAsyncRandomL ( CAsyncRandom *&, TUid, const CCryptoParams * )

CreateAsyncSignerL ( CAsyncSigner *&, TUid, const CKey &, TUid, const CCryptoParams * )

CreateAsyncSymmetricCipherL ( CAsyncSymmetricCipher *&, TUid, const CKey &, TUid, TUid, TUid, const CCryptoParams * )

CreateAsyncVerifierL ( CAsyncVerifier *&, TUid, const CKey &, TUid, const CCryptoParams * )

CreateHashL ( CHash *&, TUid, TUid, const CKey *, const CCryptoParams * )

CreateKeyAgreementL ( CKeyAgreement *&, TUid, const CKey &, const CCryptoParams * )

CreateKeyPairGeneratorL ( CKeyPairGenerator *&, TUid, const CCryptoParams * )

CreateRandomL ( CRandom *&, TUid, const CCryptoParams * )

CreateSignerL ( CSigner *&, TUid, const CKey &, TUid, const CCryptoParams * )

CreateSymmetricCipherL ( CSymmetricCipher *&, TUid, const CKey &, TUid, TUid, TUid, const CCryptoParams * )

CreateVerifierL ( CVerifier *&, TUid, const CKey &, TUid, const CCryptoParams * )