CHMAC Class Reference

#include <hash.h>

Link against: hash.lib

class CHMAC : public CMessageDigest

Inherits from

CHMAC
- CMessageDigest
  - CBase

Public Member Functions
	~CHMAC(void)
virtual IMPORT_C TInt	BlockSize(void)
virtual IMPORT_C CMessageDigest *	CopyL(void)
virtual IMPORT_C TPtrC8	Final(const TDesC8 &)
virtual IMPORT_C TPtrC8	Final()
virtual IMPORT_C TPtrC8	Hash(const TDesC8 &)
virtual IMPORT_C TInt	HashSize(void)
IMPORT_C CHMAC *	NewL(const TDesC8 &, CMessageDigest *)
virtual IMPORT_C CMessageDigest *	ReplicateL(void)
virtual IMPORT_C void	Reset(void)
virtual void	RestoreState()
virtual void	StoreState()
virtual IMPORT_C void	Update(const TDesC8 &)

Protected Member Functions
	CHMAC(void)
	CHMAC(CMessageDigest *)
	CHMAC(const CHMAC &)
void	InitialiseL(const TDesC8 &)

Inherited Enumerations
	CMessageDigest:THashId

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()
	CMessageDigest::CMessageDigest(const CMessageDigest &)
	CMessageDigest::CMessageDigest(void)
	CMessageDigest::GetExtension(TUint,TAny &,TAny )
	CMessageDigest::~CMessageDigest(void)

Detailed Description

An HMAC (Hashed Message Authentication Code)

Constructor & Destructor Documentation

CHMAC ( void )

CHMAC

(

void

)

[protected]

CHMAC ( CMessageDigest * )

CHMAC

(

CMessageDigest *

aDigest

)

[protected]

CHMAC ( const CHMAC & )

CHMAC

(

const CHMAC &

aHMAC

)

[protected]

~CHMAC ( void )

IMPORT_C

~CHMAC

(

void

)

Destructor

Member Function Documentation

BlockSize ( void )

IMPORT_C TInt

BlockSize

(

void

)

[virtual]

Reimplemented from CMessageDigest::BlockSize(void)

Gets the internal block size of the message digest.

Return Value: Internal block size of message digest in bytes.

CopyL ( void )

IMPORT_C CMessageDigest *

CopyL

(

void

)

[virtual]

Reimplemented from CMessageDigest::CopyL(void)

Creates a new CMessageDigest object with the exact same state as the current object.

This function copies all internal state of the message digest. To create a new CMessageDigest object without the state of the current object, see ReplicateL().

Return Value: A pointer to the new CMessageDigest object

Final ( const TDesC8 & )

IMPORT_C TPtrC8

Final

(

const TDesC8 &

aMessage

)

[virtual]

Reimplemented from CMessageDigest::Final(const TDesC8 &)

Adds aMessage to the internal representation of data to be hashed, returns a TPtrC8 of the finalised hash of all the previously appended messages, and calls Reset().

Since: v8.0

Parameters
aMessage	Data to be included in the hash

Return Value: A descriptor pointer to the buffer containing the resulting hash.

Final ( )

IMPORT_C TPtrC8

Final

(

)

[virtual]

Reimplemented from CMessageDigest::Final(void)

Gets a TPtrC8 of the finalised hash of all the previously appended messages and then calls Reset().

Since: v8.0

Return Value: A descriptor pointer to the buffer containing the resulting hash.

Hash ( const TDesC8 & )

IMPORT_C TPtrC8

Hash

(

const TDesC8 &

aMessage

)

[virtual]

Reimplemented from CMessageDigest::Hash(const TDesC8 &)

Adds aMessage to the internal representation of data to be hashed, then returns a TPtrC8 of the finalised hash of all the previously appended messages.

Parameters
aMessage	Data to be included in the hash.

Return Value: A descriptor pointer to the buffer containing the resulting hash.

HashSize ( void )

IMPORT_C TInt

HashSize

(

void

)

[virtual]

Reimplemented from CMessageDigest::HashSize(void)

Gets the size of the message digest output.

Return Value: Output size of the message digest in bytes.

InitialiseL ( const TDesC8 & )

void

InitialiseL

(

const TDesC8 &

aKey

)

[protected]

NewL ( const TDesC8 &, CMessageDigest * )

IMPORT_C CHMAC *	NewL	(	const TDesC8 &	aKey,
			CMessageDigest *	aDigest
		)	[static]

Creates a new HMAC object from a specified type of message digest and authentication key.

Parameters
aKey	Authentication key.
aDigest	A message digest to construct the HMAC from.

Return Value: A pointer to the new CHMAC object. The resulting HMAC object takes ownership of aDigest and is responsible for its deletion.

ReplicateL ( void )

IMPORT_C CMessageDigest *

ReplicateL

(

void

)

[virtual]

Reimplemented from CMessageDigest::ReplicateL(void)

Creates a brand new reset CMessageDigest object containing no state information from the current object.

To make a copy of a message digest with its internal state intact, see CopyL().

Return Value: A pointer to the new reset CMessageDigest object

Reset ( void )

IMPORT_C void

Reset

(

void

)

[virtual]

Reimplemented from CMessageDigest::Reset(void)

Resets the internal state of the message digest.

A reset hash object loses all internal state representing the hashed data. A reset message digest is suitable to begin a new, distinct hash of different data. Any previously returned TPtrC8 from a call to Final() remains valid until any subsequent call to Update() or Final().

RestoreState ( )

void

RestoreState

(

)

[virtual]

Reimplemented from CMessageDigest::RestoreState()

Restores the internal state of the message digest to a previously stored state.

StoreState ( )

void

StoreState

(

)

[virtual]

Reimplemented from CMessageDigest::StoreState()

Stores the internal state of the message digest.

Update ( const TDesC8 & )

IMPORT_C void

Update

(

const TDesC8 &

aMessage

)

[virtual]

Reimplemented from CMessageDigest::Update(const TDesC8 &)

Adds data to the internal representation of messages to be hashed.

Since: v8.0

Parameters
aMessage	Data to be included in the hash.