Symbian^3 Product Developer Library >

CHMAC Class Reference

class CHMAC : public CMessageDigest

An HMAC (Hashed Message Authentication Code)

Inherits from

Public Member Functions
~CHMAC(void)
IMPORT_C TIntBlockSize(void)
IMPORT_C CMessageDigest *CopyL(void)
IMPORT_C TPtrC8Final(const TDesC8 &)
IMPORT_C TPtrC8Final()
IMPORT_C TPtrC8Hash(const TDesC8 &)
IMPORT_C TIntHashSize(void)
IMPORT_C CHMAC *NewL(const TDesC8 &, CMessageDigest *)
IMPORT_C CMessageDigest *ReplicateL(void)
IMPORT_C voidReset(void)
voidRestoreState()
voidStoreState()
IMPORT_C voidUpdate(const TDesC8 &)
Protected Member Functions
CHMAC(void)
CHMAC(CMessageDigest *)
CHMAC(const CHMAC &)
voidInitialiseL(const TDesC8 &)
Private Member Functions
voidInitBlockSizeL()
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)
Inherited Enumerations
CMessageDigest:THashId
Private Attributes
TInt iBlockSize
CMessageDigest *iDigest
TBuf8< KMaxBlockSize >iInnerPad
TBuf8< KMaxBlockSize >iInnerPadCopy
TBuf8< KMaxBlockSize >iOuterPad
TBuf8< KMaxBlockSize >iOuterPadCopy

Constructor & Destructor Documentation

CHMAC(void)

CHMAC(void)[protected]

Parameters

void

CHMAC(CMessageDigest *)

CHMAC(CMessageDigest *aDigest)[protected]

Parameters

CMessageDigest * aDigest

CHMAC(const CHMAC &)

CHMAC(const CHMAC &aHMAC)[protected]

Parameters

const CHMAC & aHMAC

~CHMAC(void)

IMPORT_C~CHMAC(void)

Destructor

Parameters

void

Member Functions Documentation

BlockSize(void)

IMPORT_C TIntBlockSize(void)[virtual]

Gets the internal block size of the message digest.

Parameters

void

CopyL(void)

IMPORT_C CMessageDigest *CopyL(void)[virtual]

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().

Parameters

void

Final(const TDesC8 &)

IMPORT_C TPtrC8Final(const TDesC8 &aMessage)[virtual]

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

const TDesC8 & aMessageData to be included in the hash

Final()

IMPORT_C TPtrC8Final()[virtual]

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

Since
v8.0

Hash(const TDesC8 &)

IMPORT_C TPtrC8Hash(const TDesC8 &aMessage)[virtual]

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

const TDesC8 & aMessageData to be included in the hash.

HashSize(void)

IMPORT_C TIntHashSize(void)[virtual]

Gets the size of the message digest output.

Parameters

void

InitBlockSizeL()

voidInitBlockSizeL()[private]

InitialiseL(const TDesC8 &)

voidInitialiseL(const TDesC8 &aKey)[protected]

Parameters

const TDesC8 & aKey

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

const TDesC8 & aKeyAuthentication key.
CMessageDigest * aDigestA message digest to construct the HMAC from.

ReplicateL(void)

IMPORT_C CMessageDigest *ReplicateL(void)[virtual]

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().

Parameters

void

Reset(void)

IMPORT_C voidReset(void)[virtual]

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().

Parameters

void

RestoreState()

voidRestoreState()[virtual]

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

StoreState()

StoreState()

voidStoreState()[virtual]

Stores the internal state of the message digest.

Update(const TDesC8 &)

IMPORT_C voidUpdate(const TDesC8 &aMessage)[virtual]

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

Since
v8.0

Parameters

const TDesC8 & aMessageData to be included in the hash.

Member Data Documentation

TInt iBlockSize

TInt iBlockSize[private]

CMessageDigest * iDigest

CMessageDigest *iDigest[private]

TBuf8< KMaxBlockSize > iInnerPad

TBuf8< KMaxBlockSize >iInnerPad[private]

TBuf8< KMaxBlockSize > iInnerPadCopy

TBuf8< KMaxBlockSize >iInnerPadCopy[private]

TBuf8< KMaxBlockSize > iOuterPad

TBuf8< KMaxBlockSize >iOuterPad[private]

TBuf8< KMaxBlockSize > iOuterPadCopy

TBuf8< KMaxBlockSize >iOuterPadCopy[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.