Security Scol plugin
Public Member Functions | List of all members
Adler32 Class Reference

ADLER-32 checksum calculations. More...

#include <adler32.h>

Inheritance diagram for Adler32:
HashTransformation Algorithm Clonable

Public Member Functions

 CRYPTOPP_CONSTANT (DIGESTSIZE=4)
 
void Update (const byte *input, size_t length)
 Updates a hash with additional input.
 
void TruncatedFinal (byte *hash, size_t size)
 Computes the hash of the current message.
 
unsigned int DigestSize () const
 
CRYPTOPP_STATIC_CONSTEXPR const char * StaticAlgorithmName ()
 
std::string AlgorithmName () const
 Provides the name of this algorithm.
 
- Public Member Functions inherited from HashTransformation
HashTransformationRef ()
 Provides a reference to this object.
 
virtual byteCreateUpdateSpace (size_t &size)
 Request space which can be written into by the caller.
 
virtual void Final (byte *digest)
 Computes the hash of the current message.
 
virtual void Restart ()
 Restart the hash.
 
unsigned int TagSize () const
 
virtual unsigned int BlockSize () const
 Provides the block size of the compression function.
 
virtual unsigned int OptimalBlockSize () const
 Provides the input block size most efficient for this hash.
 
virtual unsigned int OptimalDataAlignment () const
 Provides input and output data alignment for optimal performance.
 
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.
 
virtual bool Verify (const byte *digest)
 Verifies the hash of the current message.
 
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.
 
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.
 
virtual bool TruncatedVerify (const byte *digest, size_t digestLength)
 Verifies the hash of the current message.
 
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.
 
- Public Member Functions inherited from Algorithm
 Algorithm (bool checkSelfTestStatus=true)
 Interface for all crypto algorithms.
 
virtual std::string AlgorithmProvider () const
 Retrieve the provider of this algorithm.
 
- Public Member Functions inherited from Clonable
virtual ClonableClone () const
 Copies this object.
 

Additional Inherited Members

- Protected Member Functions inherited from HashTransformation
void ThrowIfInvalidTruncatedSize (size_t size) const
 Validates a truncated digest size.
 

Detailed Description

ADLER-32 checksum calculations.

Definition at line 14 of file adler32.h.

Constructor & Destructor Documentation

◆ Adler32()

Adler32::Adler32 ( )
inline

Definition at line 18 of file adler32.h.

Member Function Documentation

◆ AlgorithmName()

std::string Adler32::AlgorithmName ( ) const
inlinevirtual

Provides the name of this algorithm.

Returns
the standard algorithm name

The standard algorithm name can be a name like AES or AES/GCM. Some algorithms do not have standard names yet. For example, there is no standard algorithm name for Shoup's ECIES.

Note
AlgorithmName is not universally implemented yet.

Reimplemented from Algorithm.

Definition at line 23 of file adler32.h.

◆ DigestSize()

unsigned int Adler32::DigestSize ( ) const
inlinevirtual

Provides the digest size of the hash

Returns
the digest size of the hash.

Implements HashTransformation.

Definition at line 21 of file adler32.h.

◆ StaticAlgorithmName()

CRYPTOPP_STATIC_CONSTEXPR const char * Adler32::StaticAlgorithmName ( )
inline

Definition at line 22 of file adler32.h.

◆ TruncatedFinal()

void Adler32::TruncatedFinal ( byte digest,
size_t  digestSize 
)
virtual

Computes the hash of the current message.

Parameters
digesta pointer to the buffer to receive the hash
digestSizethe size of the truncated digest, in bytes

TruncatedFinal() calls Final() and then copies digestSize bytes to digest. The hash is restarted the hash for the next message.

Precondition
COUNTOF(digest) <= DigestSize() or COUNTOF(digest) <= HASH::DIGESTSIZE ensures the output byte buffer is a valid size.

Implements HashTransformation.

Definition at line 56 of file adler32.cpp.

◆ Update()

void Adler32::Update ( const byte input,
size_t  length 
)
virtual

Updates a hash with additional input.

Parameters
inputthe additional input as a buffer
lengththe size of the buffer, in bytes

Implements HashTransformation.

Definition at line 8 of file adler32.cpp.


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