Driver::Crypto::Hash Class Reference

This class defines an abstract interface for a Hashing Algorithms. More...

Detailed Description

This class defines an abstract interface for a Hashing Algorithms.

How to generate a Hash result:

1. Call reset() initialize the Hash
2. Call accumulate() method for every byte being hash'd
3. Call finalize() to get the Hashed value.

#include <Hash.h>

Inheritance diagram for Driver::Crypto::Hash:

Public Member Functions
virtual DriverCryptoStatus_T	reset (void) noexcept=0
	Used to re-use/restart the hash object. Returns DRIVER_CRYPTO_SUCCESS when successful.
virtual DriverCryptoStatus_T	accumulate (const void *bytes, size_t numbytes=1) noexcept=0
	Call the method for every byte being hash'd.
virtual DriverCryptoStatus_T	finalize (void *dstHashDigest, size_t dstHashDigestSize) noexcept=0
	Call this method to finalize the Hash.
virtual size_t	digestSize () const noexcept=0
	Returns the number of bytes in the digest.
	~Hash ()
	Virtual destructor.

Constructor & Destructor Documentation

~Hash()

Driver::Crypto::Hash::~Hash ( )

inline

Virtual destructor.

Member Function Documentation

accumulate()

virtual DriverCryptoStatus_T Driver::Crypto::Hash::accumulate ( const void *  bytes, size_t  numbytes = 1  )

pure virtualnoexcept

Call the method for every byte being hash'd.

Returns DRIVER_CRYPTO_SUCCESS when successful.

Implemented in Driver::Crypto::Orlp::SHA512.

digestSize()

virtual size_t Driver::Crypto::Hash::digestSize ( ) const

pure virtualnoexcept

Returns the number of bytes in the digest.

Implemented in Driver::Crypto::Orlp::SHA512.

finalize()

virtual DriverCryptoStatus_T Driver::Crypto::Hash::finalize ( void *  dstHashDigest, size_t  dstHashDigestSize  )

pure virtualnoexcept

Call this method to finalize the Hash.

The calculated hash value is returned.

Implemented in Driver::Crypto::Orlp::SHA512.

reset()

virtual DriverCryptoStatus_T Driver::Crypto::Hash::reset ( void  )

pure virtualnoexcept

Used to re-use/restart the hash object. Returns DRIVER_CRYPTO_SUCCESS when successful.

Implemented in Driver::Crypto::Orlp::SHA512.

---

The documentation for this class was generated from the following file:

• Driver/Crypto/Hash.h