Collapse all Symbian^3 Product Developer Library

CPBAuthData Class Reference

class CPBAuthData : public CBase

Contains the password based authentication data. Used to check the passphrase when decrypting.

Since: v7.0s

Inherits from

CPBAuthData
- CBase

Public Member Functions
	~CPBAuthData(void)
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C TInt	Iterations()
IMPORT_C TPtrC8	Key()
IMPORT_C CPBAuthData *	NewL(const TDesC8 &, const TDesC8 &, TUint, TUint)
IMPORT_C CPBAuthData *	NewL(const CPBAuthData &)
IMPORT_C CPBAuthData *	NewL(RReadStream &)
IMPORT_C CPBAuthData *	NewLC(const TDesC8 &, const TDesC8 &, TUint, TUint)
IMPORT_C CPBAuthData *	NewLC(const CPBAuthData &)
IMPORT_C CPBAuthData *	NewLC(RReadStream &)
IMPORT_C TPtrC8	Salt()
IMPORT_C TBool	operator==(const CPBAuthData &)

Protected Member Functions
	CPBAuthData(void)
void	ConstructL(const TDesC8 &, const TDesC8 &, TUint, TUint)
void	ConstructL(const CPBAuthData &)
void	ConstructL(RReadStream &)

Private Member Functions
	CPBAuthData(const CPBAuthData &)
CPBAuthData &	operator=(const CPBAuthData &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
HBufC8 *	iAuthKey
TUint	iIterations
HBufC8 *	iSalt

Constructor & Destructor Documentation

CPBAuthData(void)

IMPORT_C

CPBAuthData

(

void

)

[protected]

Constructor

Parameters

void

CPBAuthData(const CPBAuthData &)

CPBAuthData

(

const CPBAuthData &

)

[private]

Parameters

const CPBAuthData &

~CPBAuthData(void)

~CPBAuthData

(

void

)

[virtual]

Destructor

Parameters

void

Member Functions Documentation

ConstructL(const TDesC8 &, const TDesC8 &, TUint, TUint)

void	ConstructL	(	const TDesC8 &	aPassword,
			const TDesC8 &	aSalt,
			TUint	aKeySize,
			TUint	aIterations
		)	[protected]

Parameters

const TDesC8 & aPassword
const TDesC8 & aSalt
TUint aKeySize
TUint aIterations

ConstructL(const CPBAuthData &)

void

ConstructL

(

const CPBAuthData &

aData

)

[protected]

Parameters

const CPBAuthData & aData

ConstructL(RReadStream &)

void

ConstructL

(

RReadStream &

aStream

)

[protected]

Parameters

RReadStream & aStream

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalizes the encryption parameters into a write stream.

Parameters

RWriteStream & aStream

The stream to write to

Iterations()

IMPORT_C TInt

Iterations

(

)

const

Gets the number of iterations of the hashing algorithm.

Key()

IMPORT_C TPtrC8

Key

(

)

const

Gets the authentication key

NewL(const TDesC8 &, const TDesC8 &, TUint, TUint)

IMPORT_C CPBAuthData *	NewL	(	const TDesC8 &	aPassword,
			const TDesC8 &	aSalt,
			TUint	aKeySize,
			TUint	aIterations
		)	[static]

Derives an authentication key.

Parameters

const TDesC8 & aPassword	The user's initial password
const TDesC8 & aSalt	The salt
TUint aKeySize	The key size
TUint aIterations	The number of iterations of the PBE algorithm

NewL(const CPBAuthData &)

IMPORT_C CPBAuthData *

NewL

(

const CPBAuthData &

aData

)

[static]

Creates a new CPBAuthData object from an existing authentication key.

Parameters

const CPBAuthData & aData

The existing CPBAuthData object

NewL(RReadStream &)

IMPORT_C CPBAuthData *

NewL

(

RReadStream &

aStream

)

[static]

Creates a new CPBAuthData object from an existing authentication key by internalizing the authentication data from a read stream.

Parameters

RReadStream & aStream

The stream to read from

NewLC(const TDesC8 &, const TDesC8 &, TUint, TUint)

IMPORT_C CPBAuthData *	NewLC	(	const TDesC8 &	aPassword,
			const TDesC8 &	aSalt,
			TUint	aKeySize,
			TUint	aIterations
		)	[static]

Derives an authentication key.

The returned pointer is put onto the cleanup stack.

Parameters

const TDesC8 & aPassword	The user's initial password
const TDesC8 & aSalt	The salt
TUint aKeySize	The key size
TUint aIterations	The number of iterations of the PBE algorithm

NewLC(const CPBAuthData &)

IMPORT_C CPBAuthData *

NewLC

(

const CPBAuthData &

aData

)

[static]

Creates a new CPBAuthData object from an existing authentication key.

The returned pointer is put onto the cleanup stack.

Parameters

const CPBAuthData & aData

The existing CPBAuthData object

NewLC(RReadStream &)

IMPORT_C CPBAuthData *

NewLC

(

RReadStream &

aStream

)

[static]

Creates a new CPBAuthData object from an existing authentication key by internalizing the authentication data from a read stream.

The returned pointer is put onto the cleanup stack.

Parameters

RReadStream & aStream

The stream to read from

Salt()

IMPORT_C TPtrC8

Salt

(

)

const

Gets the salt used for the authentication

operator=(const CPBAuthData &)

CPBAuthData &

operator=

(

const CPBAuthData &

)

[private]

Parameters

const CPBAuthData &

operator==(const CPBAuthData &)

IMPORT_C TBool

operator==

(

const CPBAuthData &

aAuth

)

const

Tests whether two authentication keys are identical

Parameters

const CPBAuthData & aAuth

The authentication data object which holds the key to be tested

Member Data Documentation

HBufC8 * iAuthKey

HBufC8 *

iAuthKey

[private]

TUint iIterations

TUint

iIterations

[private]

HBufC8 * iSalt

HBufC8 *

iSalt

[private]