Symbian^3 Application Developer Library >

CMessageDigest Class Reference

class CMessageDigest : public CBase

Base class for message digests.

Inherits from

Public Member Functions
~CMessageDigest (void)
IMPORT_C TInt BlockSize (void)
IMPORT_C CMessageDigest * CopyL (void)
IMPORT_C TPtrC8 Final (const TDesC8 &)
IMPORT_C TPtrC8 Final (void)
TInt GetExtension ( TUint , TAny *&, TAny *)
IMPORT_C TPtrC8 Hash (const TDesC8 &)
IMPORT_C TInt HashSize (void)
IMPORT_C CMessageDigest * ReplicateL (void)
IMPORT_C void Reset (void)
void RestoreState ()
void StoreState ()
IMPORT_C void Update (const TDesC8 &)
Protected Member Functions
CMessageDigest (void)
CMessageDigest (const CMessageDigest &)
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()
Public Member Enumerations
enum THashId {
EMD2 , EMD5 , ESHA1 , HMAC , EMD4 , ESHA224 , ESHA256 , ESHA384 , ESHA512
}

Constructor & Destructor Documentation

CMessageDigest(void)

IMPORT_C CMessageDigest ( void ) [protected]

Constructor

Parameters

void

CMessageDigest(const CMessageDigest &)

IMPORT_C CMessageDigest ( const CMessageDigest & aMD ) [protected]

Copy constructor

Parameters

const CMessageDigest & aMD A CMessageDigest object

~CMessageDigest(void)

IMPORT_C ~CMessageDigest ( void )

Destructor.

Parameters

void

Member Functions Documentation

BlockSize(void)

IMPORT_C TInt BlockSize ( void ) [pure virtual]

Gets the internal block size of the message digest.

Parameters

void

CopyL(void)

IMPORT_C CMessageDigest * CopyL ( void ) [pure 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 TPtrC8 Final ( const TDesC8 & aMessage ) [pure 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 & aMessage Data to be included in the hash

Final(void)

IMPORT_C TPtrC8 Final ( void ) [pure virtual]

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

Since
v8.0

Parameters

void

GetExtension(TUint, TAny *&, TAny *)

TInt GetExtension ( TUint aExtensionId,
TAny *& a0,
TAny * a1
)

Used to retrieve the extended interfaces extension

Parameters

TUint aExtensionId
TAny *& a0
TAny * a1

Hash(const TDesC8 &)

IMPORT_C TPtrC8 Hash ( const TDesC8 & aMessage ) [pure 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 & aMessage Data to be included in the hash.

HashSize(void)

IMPORT_C TInt HashSize ( void ) [pure virtual]

Gets the size of the message digest output.

Parameters

void

ReplicateL(void)

IMPORT_C CMessageDigest * ReplicateL ( void ) [pure 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 void Reset ( void ) [pure 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()

void RestoreState ( ) [pure virtual]

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

StoreState()

StoreState()

void StoreState ( ) [pure virtual]

Stores the internal state of the message digest.

Update(const TDesC8 &)

IMPORT_C void Update ( const TDesC8 & aMessage ) [pure virtual]

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

Since
v8.0

Parameters

const TDesC8 & aMessage Data to be included in the hash.

Member Enumerations Documentation

Enum THashId

Enumeration to identify hash functions (aka message-digest algorithms).

Enumerators

EMD2

Message Digest algorithm developed by Rivest for digital signature applications (and optimized for 8-bit machines).

Takes a message of arbitrary length and produces a 128-bit message digest.

See RFC 1319

EMD5

Message Digest algorithm developed by Rivest for digital signature applications (and optimized for 32-bit machines).

Takes a message of arbitrary length and produces a 128-bit message digest.

See RFC 1321

ESHA1

Secure Hash Algorithm (version 1) is a message digest algorithm developed by NIST, along with the NSA, for use with the Digital Signature Standard (DSS).

It takes a message of less than 2^64 bits in length and produces a 160-bit message digest.

See FIPS 180-1 and RFC 3174

HMAC

HMAC - Hash function based Message Authentication Code is a mechanism for message authentication using cryptographic hash functions. (A checksum.)

It can be used with any iterative cryptographic hash function, e.g., MD5, SHA-1, in combination with a secret shared key to produce a checksum that is appended to the message. The cryptographic strength of HMAC depends on the properties of the underlying hash function.

See RFC 2104

EMD4

Message Digest algorithm developed by Rivest for digital signature applications (and optimized for 32-bit machines).

Takes a message of arbitrary length and produces a 128-bit message digest.

See RFC 1320

ESHA224

Secure Hash Algorithm - 224 (version 2) is a message digest algorithm developed by NIST, along with the NSA, for use with the Digital Signature Standard (DSS).

It takes a message of less than 2^64 bits in length and produces a 224-bit message digest.

See FIPS 180-2 (with change notice), RFC3874 and FIPS 180-3

ESHA256

Secure Hash Algorithm - 256 (version 2) is a message digest algorithm developed by NIST, along with the NSA, for use with the Digital Signature Standard (DSS).

It takes a message of less than 2^64 bits in length and produces a 256-bit message digest.

See FIPS 180-2 and RFC 4634

ESHA384

Secure Hash Algorithm - 384 (version 2) is a message digest algorithm developed by NIST, along with the NSA, for use with the Digital Signature Standard (DSS).

It takes a message of less than 2^128 bits in length and produces a 384-bit message digest.

See FIPS 180-2 and RFC 4634

ESHA512

Secure Hash Algorithm - 512 (version 2) is a message digest algorithm developed by NIST, along with the NSA, for use with the Digital Signature Standard (DSS).

It takes a message of less than 2^128 bits in length and produces a 512-bit message digest.

See FIPS 180-2 and RFC 4634

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.