libxcks  0.1.0.1
libxcks::MD4 Class Referencefinal

Computes the MD4 hash from a byte stream. More...

#include <md4.hpp>

Inheritance diagram for libxcks::MD4:
Collaboration diagram for libxcks::MD4:

Public Member Functions

 MD4 ()
 Default constructor. More...
 
void reset () override
 Resets the MD4 hash to initial state of computation. More...
 
uint8_t * getValue (uint8_t *buffer) const override
 Returns the MD4 hash value in the first 16 bytes of the given address. More...
 
size_t getSize () const override
 Returns the minimal size to allocate in memory to store the hash with the getValue(buffer) method. More...
 
void update (const uint8_t *buf, size_t len) override
 Updates the MD4 hash with specified array of bytes. More...
 
std::string getName () const override
 Returns the name of the checksum or the hash algorithm. More...
 
ChecksumAlgoId getID () const override
 Returns an unique identifier for the checksum or the hash algorithm. More...
 
- Public Member Functions inherited from libxcks::ChecksumEx
std::string toString (const bool hexInUpperCase=false) const override
 Returns the hash value has a string. More...
 
- Public Member Functions inherited from libxcks::Checksum
virtual ~Checksum ()
 Destructor. More...
 
virtual ArrayString getAltNames () const
 Returns the alternative name(s) of the checksum or the hash algorithm. More...
 

Static Public Member Functions

static std::string getHashName ()
 Returns the name of the hash algorithm. More...
 
static constexpr ChecksumAlgoId getIdentifier ()
 Returns an unique identifier for the hash algorithm. More...
 
static ChecksumgetNewInstance ()
 Gets a new instance of this class. More...
 
- Static Public Member Functions inherited from libxcks::Checksum
static ArrayString getAlternativeNames ()
 Returns the alternative name(s) of the checksum or the hash algorithm. More...
 

Protected Member Functions

void finish ()
 Process the remaining bytes in the internal buffer and the usual prolog according to the standard. More...
 
void transform (uint8_t *data)
 Transform the message X which consists of 16 32-bit-words. More...
 

Protected Attributes

uint32_t A
 First part of the state of computation. More...
 
uint32_t B
 Second part of the state of computation. More...
 
uint32_t C
 Third part of the state of computation. More...
 
uint32_t D
 Fourth part of the state of computation. More...
 
uint32_t nblocks
 Number of blocks. More...
 
int count
 Current size of the input buffer. More...
 
uint8_t ibuffer [64]
 Input buffer. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from libxcks::LibgcryptHash
static uint32_t rol (uint32_t x, int n)
 Rotate the 32 bit unsigned integer x by n bits left. More...
 
static uint32_t ror (uint32_t x, int n)
 Rotate the 32 bit unsigned integer x by n bits right. More...
 
- Static Protected Member Functions inherited from libxcks::ChecksumEx
static uint32_t swapOnLE (const uint32_t value)
 Swaps bytes on little endian architectures. More...
 
static uint32_t swapOnBE (const uint32_t value)
 Swaps bytes on big endian architectures. More...
 
static uint64_t swapOnLE (const uint64_t value)
 Swaps bytes on little endian architectures. More...
 
static uint64_t swapOnBE (const uint64_t value)
 Swaps bytes on big endian architectures. More...
 

Detailed Description

Computes the MD4 hash from a byte stream.

This class is a rewrite in C++ of the md4 hash computing algorithm present in the Libgcrypt. Please see the GNU Privacy Guard project website for more informations.

Using this class in very simple:
Use the update method to provide to the class the bytes for computing the hash.

The MD4 hash value can be gotten by two ways:

  • The getValue method which puts the MD4 hash value in an array of 16 bytes.
  • The toString method which returns the MD4 hash value in a string.

The MD4 hash computing can be reseted by the reset method.

Definition at line 56 of file md4.hpp.

Constructor & Destructor Documentation

◆ MD4()

libxcks::MD4::MD4 ( )

Default constructor.

Definition at line 64 of file md4.cpp.

Member Function Documentation

◆ finish()

void libxcks::MD4::finish ( )
protected

Process the remaining bytes in the internal buffer and the usual prolog according to the standard.

Definition at line 90 of file md4.cpp.

◆ getHashName()

static std::string libxcks::MD4::getHashName ( )
inlinestatic

Returns the name of the hash algorithm.

Returns
The name of the hash algorithm.

Definition at line 153 of file md4.hpp.

◆ getID()

ChecksumAlgoId libxcks::MD4::getID ( ) const
inlineoverridevirtual

Returns an unique identifier for the checksum or the hash algorithm.

Remarks
The unique ID should be the CRC32 checksum of the algorithm's name returned by getName() but it's only a convention.
Returns
An unique identifier for the checksum or the hash algorithm.

Implements libxcks::Checksum.

Definition at line 143 of file md4.hpp.

◆ getIdentifier()

static constexpr ChecksumAlgoId libxcks::MD4::getIdentifier ( )
inlinestaticconstexpr

Returns an unique identifier for the hash algorithm.

Remarks
The unique ID should be the CRC32 checksum of the algorithm's name returned by getHashName() but it's only a convention.
Returns
An unique identifier for the hash algorithm.

Definition at line 167 of file md4.hpp.

◆ getName()

std::string libxcks::MD4::getName ( ) const
inlineoverridevirtual

Returns the name of the checksum or the hash algorithm.

Returns
The name of the checksum or the hash algorithm.

Implements libxcks::Checksum.

Definition at line 129 of file md4.hpp.

◆ getNewInstance()

static Checksum* libxcks::MD4::getNewInstance ( )
inlinestatic

Gets a new instance of this class.

The caller is responsible of the deletion of the instance with the delete operator.

Returns
A new instance of this class.

Definition at line 180 of file md4.hpp.

◆ getSize()

size_t libxcks::MD4::getSize ( ) const
inlineoverridevirtual

Returns the minimal size to allocate in memory to store the hash with the getValue(buffer) method.

Returns
The minimal size to allocate in memory to store the hash with the getValue(buffer) method.

Implements libxcks::Checksum.

Definition at line 97 of file md4.hpp.

◆ getValue()

uint8_t * libxcks::MD4::getValue ( uint8_t *  buffer) const
overridevirtual

Returns the MD4 hash value in the first 16 bytes of the given address.

Parameters
bufferThe buffer where the MD4 hash value will be stored.
Returns
The address of the buffer.
Remarks
The memory for the 16 bytes must have been allocated before calling this method.

Implements libxcks::Checksum.

Definition at line 302 of file md4.cpp.

◆ reset()

void libxcks::MD4::reset ( )
overridevirtual

Resets the MD4 hash to initial state of computation.

Implements libxcks::LibgcryptHash.

Definition at line 74 of file md4.cpp.

◆ transform()

void libxcks::MD4::transform ( uint8_t *  data)
protected

Transform the message X which consists of 16 32-bit-words.

It is assumed that data has the lenght of 16 32-bit-words.

Parameters
dataThe data to process.

Definition at line 197 of file md4.cpp.

◆ update()

void libxcks::MD4::update ( const uint8_t *  buf,
size_t  len 
)
overridevirtual

Updates the MD4 hash with specified array of bytes.

Parameters
bufThe byte array to update the MD4 hash with.
lenThe number of bytes to use for the update.

Implements libxcks::Checksum.

Definition at line 156 of file md4.cpp.

Member Data Documentation

◆ A

uint32_t libxcks::MD4::A
protected

First part of the state of computation.

Definition at line 60 of file md4.hpp.

◆ B

uint32_t libxcks::MD4::B
protected

Second part of the state of computation.

Definition at line 61 of file md4.hpp.

◆ C

uint32_t libxcks::MD4::C
protected

Third part of the state of computation.

Definition at line 62 of file md4.hpp.

◆ count

int libxcks::MD4::count
protected

Current size of the input buffer.

Definition at line 66 of file md4.hpp.

◆ D

uint32_t libxcks::MD4::D
protected

Fourth part of the state of computation.

Definition at line 63 of file md4.hpp.

◆ ibuffer

uint8_t libxcks::MD4::ibuffer[64]
protected

Input buffer.

Definition at line 67 of file md4.hpp.

◆ nblocks

uint32_t libxcks::MD4::nblocks
protected

Number of blocks.

Definition at line 65 of file md4.hpp.


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