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

#include <sha224_256.hpp>

Inheritance diagram for libxcks::SHA256:

[legend]

Collaboration diagram for libxcks::SHA256:

[legend]

Public Member Functions
	SHA256 ()
	Default constructor. More...

void	reset () override
	Resets the SHA256 hash to initial state of computation. More...

uint8_t *	getValue (uint8_t *buffer) const override
	Returns the SHA256 hash value in the first 32 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...

std::string	getName () const override
	Returns the name of the checksum or the hash algorithm. More...

ArrayString	getAltNames () const override
	Returns the alternative names of the SHA256 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::AbstractSHA256Impl
void	update (const uint8_t *buf, size_t len) override final
	Updates the SHA256 hash with specified array of bytes. 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...

Static Public Member Functions
static std::string	getHashName ()
	Returns the name of the hash algorithm. More...

static ArrayString	getAlternativeNames ()
	Returns the alternative names of the SHA256 hash algorithm. More...

static constexpr ChecksumAlgoId	getIdentifier ()
	Returns an unique identifier for the hash algorithm. More...

static Checksum *	getNewInstance ()
	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...

Additional Inherited Members
Protected Member Functions inherited from libxcks::AbstractSHA256Impl
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...

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

Protected Attributes inherited from libxcks::AbstractSHA256Impl
uint32_t	h0
	First part of the state of computation. More...

uint32_t	h1
	Second part of the state of computation. More...

uint32_t	h2
	Third part of the state of computation. More...

uint32_t	h3
	Fourth part of the state of computation. More...

uint32_t	h4
	Fifth part of the state of computation. More...

uint32_t	h5
	Sixth part of the state of computation. More...

uint32_t	h6
	Seventh part of the state of computation. More...

uint32_t	h7
	Eighth 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...

Detailed Description

Computes the SHA256 hash from a byte stream.

This class is a rewrite in C++ of the sha256 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 SHA256 hash value can be gotten by two ways:

The getValue method which puts the SHA256 hash value in an array of 32 bytes.
The toString method which returns the SHA256 hash value in a string.

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

Definition at line 251 of file sha224_256.hpp.

Constructor & Destructor Documentation

◆ SHA256()

libxcks::SHA256::SHA256 ( )

Default constructor.

Definition at line 356 of file sha224_256.cpp.

Member Function Documentation

◆ getAlternativeNames()

ArrayString libxcks::SHA256::getAlternativeNames ( )

static

Returns the alternative names of the SHA256 hash algorithm.

Returns: The alternative names of the SHA256 hash algorithm.

Definition at line 400 of file sha224_256.cpp.

◆ getAltNames()

ArrayString libxcks::SHA256::getAltNames ( ) const

inlineoverridevirtual

Returns the alternative names of the SHA256 hash algorithm.

Returns: The alternative names of the SHA256 hash algorithm.

Reimplemented from libxcks::Checksum.

Definition at line 298 of file sha224_256.hpp.

◆ getHashName()

static std::string libxcks::SHA256::getHashName ( )

inlinestatic

Returns the name of the hash algorithm.

Returns: The name of the hash algorithm.

Definition at line 322 of file sha224_256.hpp.

◆ getID()

ChecksumAlgoId libxcks::SHA256::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 312 of file sha224_256.hpp.

◆ getIdentifier()

static constexpr ChecksumAlgoId libxcks::SHA256::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 343 of file sha224_256.hpp.

◆ getName()

std::string libxcks::SHA256::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 288 of file sha224_256.hpp.

◆ getNewInstance()

static Checksum* libxcks::SHA256::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 356 of file sha224_256.hpp.

◆ getSize()

size_t libxcks::SHA256::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 281 of file sha224_256.hpp.

◆ getValue()

uint8_t * libxcks::SHA256::getValue ( uint8_t * buffer ) const

overridevirtual

Returns the SHA256 hash value in the first 32 bytes of the given address.

Parameters

buffer The buffer where the SHA256 hash value will be stored.

Returns: The address of the buffer.

Remarks: The memory for the 32 bytes must have been allocated before calling this method.

Implements libxcks::Checksum.

Definition at line 385 of file sha224_256.cpp.

◆ reset()

void libxcks::SHA256::reset ( )

overridevirtual

Resets the SHA256 hash to initial state of computation.

Implements libxcks::AbstractSHA256Impl.

Definition at line 366 of file sha224_256.cpp.

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

src/algos/sha224_256.hpp
src/algos/sha224_256.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SHA256()

Member Function Documentation

◆ getAlternativeNames()

◆ getAltNames()

◆ getHashName()

◆ getID()

◆ getIdentifier()

◆ getName()

◆ getNewInstance()

◆ getSize()

◆ getValue()

◆ reset()