Crypto++  8.5
Free C++ class library of cryptographic schemes
Public Member Functions | Static Public Member Functions | List of all members
SHA512 Class Reference

SHA-512 message digest. More...

+ Inheritance diagram for SHA512:

Public Member Functions

std::string AlgorithmProvider () const
 Retrieve the provider of this algorithm. More...
 
- Public Member Functions inherited from IteratedHashWithStaticTransform< word64, BigEndian, 128, 64, SHA512, 64, true >
unsigned int DigestSize () const
 Provides the digest size of the hash. More...
 
- Public Member Functions inherited from ClonableImpl< SHA512, AlgorithmImpl< IteratedHash< word64, BigEndian, T_BlockSize >, SHA512 > >
ClonableClone () const
 Create a copy of this object. More...
 
- Public Member Functions inherited from AlgorithmImpl< IteratedHash< word64, BigEndian, T_BlockSize >, SHA512 >
std::string AlgorithmName () const
 The algorithm name. More...
 
- Public Member Functions inherited from IteratedHash< word64, BigEndian, T_BlockSize >
unsigned int BlockSize () const
 Provides the block size of the hash. More...
 
ByteOrder GetByteOrder () const
 Provides the byte order of the hash. More...
 
void CorrectEndianess (HashWordType *out, const HashWordType *in, size_t byteCount)
 Adjusts the byte ordering of the hash. More...
 
- Public Member Functions inherited from IteratedHashBase< word64, HashTransformation >
 IteratedHashBase ()
 Construct an IteratedHashBase.
 
unsigned int OptimalBlockSize () const
 Provides the input block size most efficient for this cipher. More...
 
unsigned int OptimalDataAlignment () const
 Provides input and output data alignment for optimal performance. More...
 
void Update (const byte *input, size_t length)
 Updates a hash with additional input. More...
 
byteCreateUpdateSpace (size_t &size)
 Requests space which can be written into by the caller. More...
 
void Restart ()
 Restart the hash. More...
 
void TruncatedFinal (byte *digest, size_t digestSize)
 Computes the hash of the current message. More...
 
virtual std::string AlgorithmProvider () const
 Retrieve the provider of this algorithm. More...
 
- Public Member Functions inherited from HashTransformation
HashTransformationRef ()
 Provides a reference to this object. More...
 
virtual void Final (byte *digest)
 Computes the hash of the current message. More...
 
virtual unsigned int DigestSize () const =0
 Provides the digest size of the hash. More...
 
unsigned int TagSize () const
 Provides the tag size of the hash. More...
 
virtual unsigned int BlockSize () const
 Provides the block size of the compression function. More...
 
virtual unsigned int OptimalBlockSize () const
 Provides the input block size most efficient for this hash. More...
 
virtual unsigned int OptimalDataAlignment () const
 Provides input and output data alignment for optimal performance. More...
 
virtual void CalculateDigest (byte *digest, const byte *input, size_t length)
 Updates the hash with additional input and computes the hash of the current message. More...
 
virtual bool Verify (const byte *digest)
 Verifies the hash of the current message. More...
 
virtual bool VerifyDigest (const byte *digest, const byte *input, size_t length)
 Updates the hash with additional input and verifies the hash of the current message. More...
 
virtual void CalculateTruncatedDigest (byte *digest, size_t digestSize, const byte *input, size_t length)
 Updates the hash with additional input and computes the hash of the current message. More...
 
virtual bool TruncatedVerify (const byte *digest, size_t digestLength)
 Verifies the hash of the current message. More...
 
virtual bool VerifyTruncatedDigest (const byte *digest, size_t digestLength, const byte *input, size_t length)
 Updates the hash with additional input and verifies the hash of the current message. More...
 
- Public Member Functions inherited from Algorithm
 Algorithm (bool checkSelfTestStatus=true)
 Interface for all crypto algorithms. More...
 
virtual std::string AlgorithmName () const
 Provides the name of this algorithm. More...
 
- Public Member Functions inherited from Clonable
virtual ClonableClone () const
 Copies this object. More...
 

Static Public Member Functions

static void InitState (HashWordType *state)
 Initialize state array. More...
 
static void Transform (HashWordType *digest, const HashWordType *data)
 Operate the hash. More...
 
static const char * StaticAlgorithmName ()
 The algorithm name. More...
 
- Static Public Member Functions inherited from AlgorithmImpl< IteratedHash< word64, BigEndian, T_BlockSize >, SHA512 >
static std::string StaticAlgorithmName ()
 The algorithm name. More...
 

Additional Inherited Members

- Public Types inherited from IteratedHash< word64, BigEndian, T_BlockSize >
typedef BigEndian ByteOrderClass
 
typedef word64 HashWordType
 
- Public Types inherited from IteratedHashBase< word64, HashTransformation >
typedef word64 HashWordType
 
- Static Public Attributes inherited from IteratedHashWithStaticTransform< word64, BigEndian, 128, 64, SHA512, 64, true >
static const int DIGESTSIZE
 
- Static Public Attributes inherited from IteratedHash< word64, BigEndian, T_BlockSize >
static const int BLOCKSIZE
 

Detailed Description

SHA-512 message digest.

See also
SHA-512
Since
SHA2 since Crypto++ 4.0, Power8 SHA since Crypto++ 6.1

Definition at line 141 of file sha.h.

Member Function Documentation

◆ InitState()

static void SHA512::InitState ( HashWordType *  state)
static

Initialize state array.

Parameters
statethe state of the hash

InitState sets a state array to SHA512 initial values

Hashes which derive from IteratedHashWithStaticTransform provide static member functions InitState and Transform. External classes, like SEAL and MDC, can initialize state with a user provided key and operate the hash on the data with the user supplied state.

Note
On Intel platforms the state array must be 16-byte aligned for SSE2.

◆ Transform()

static void SHA512::Transform ( HashWordType *  digest,
const HashWordType *  data 
)
static

Operate the hash.

Parameters
digestthe state of the hash
datathe data to be digested

Transform operates the hash on data. When the call is invoked digest holds initial state. Upon return digest holds the hash or updated state.

Hashes which derive from IteratedHashWithStaticTransform provide static member functions InitState and Transform. External classes, like SEAL and MDC, can initialize state with a user provided key and operate the hash on the data with the user supplied state.

Note
On Intel platforms the state array and data must be 16-byte aligned for SSE2.

◆ StaticAlgorithmName()

static const char* SHA512::StaticAlgorithmName ( )
inlinestatic

The algorithm name.

Returns
C-style string "SHA-512"

Definition at line 167 of file sha.h.

◆ AlgorithmProvider()

std::string SHA512::AlgorithmProvider ( ) const
virtual

Retrieve the provider of this algorithm.

Returns
the algorithm provider

The algorithm provider can be a name like "C++", "SSE", "NEON", "AESNI", "ARMv8" and "Power8". C++ is standard C++ code. Other labels, like SSE, usually indicate a specialized implementation using instructions from a higher instruction set architecture (ISA). Future labels may include external hardware like a hardware security module (HSM).

Generally speaking Wei Dai's original IA-32 ASM code falls under "SSE2". Labels like "SSSE3" and "SSE4.1" follow after Wei's code and use intrinsics instead of ASM.

Algorithms which combine different instructions or ISAs provide the dominant one. For example on x86 AES/GCM returns "AESNI" rather than "CLMUL" or "AES+SSE4.1" or "AES+CLMUL" or "AES+SSE4.1+CLMUL".

Note
Provider is not universally implemented yet.
Since
Crypto++ 8.0

Reimplemented from Algorithm.


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