ndn::util::Sha256 Class Reference

Provides stateful SHA-256 digest calculation. More...

#include <sha256.hpp>

Collaboration diagram for ndn::util::Sha256:

Classes
class	Error

Public Member Functions
	Sha256 ()
	Create an empty SHA-256 digest. More...
	Sha256 (std::istream &is)
	Calculate SHA-256 digest of the input stream is. More...
bool	empty () const
	Check if digest is empty. More...
void	reset ()
	Discard the current state and start a new digest calculation. More...
ConstBufferPtr	computeDigest ()
	Finalize and return the digest based on all previously supplied inputs. More...
bool	operator== (Sha256 &digest)
	Check if the supplied digest is equal to this digest. More...
bool	operator!= (Sha256 &digest)
	Check if the supplied digest is not equal to this digest. More...
Sha256 &	operator<< (Sha256 &src)
	Add existing digest to the digest calculation. More...
Sha256 &	operator<< (const std::string &str)
	Add a string to the digest calculation. More...
Sha256 &	operator<< (uint64_t value)
	Add a uint64_t value to the digest calculation. More...
Sha256 &	operator<< (span< const uint8_t > bytes)
	Add a contiguous range of arbitrary bytes to the digest calculation. More...
void	update (span< const uint8_t > buffer)
	Add a byte buffer to the digest calculation. More...
std::string	toString ()
	Convert digest to std::string. More...

Static Public Member Functions
static ConstBufferPtr	computeDigest (span< const uint8_t > buffer)
	Stateless SHA-256 digest calculation. More...

Static Public Attributes
static const size_t	DIGEST_SIZE = 32
	Length in bytes of a SHA-256 digest. More...

Detailed Description

Provides stateful SHA-256 digest calculation.

Example:

Sha256 digest;
digest.update(buf1, size1);
digest.update(buf2, size2);
...
ConstBufferPtr result = digest.computeDigest();

Definition at line 44 of file sha256.hpp.

Constructor & Destructor Documentation

Sha256() [1/2]

ndn::util::Sha256::Sha256

(

)

Create an empty SHA-256 digest.

Definition at line 34 of file sha256.cpp.

References reset().

Sha256() [2/2]

ndn::util::Sha256::Sha256 ( std::istream &  is )

explicit

Calculate SHA-256 digest of the input stream is.

Definition at line 39 of file sha256.cpp.

References ndn::security::transform::digestFilter(), ndn::SHA256, and ndn::security::transform::streamSink().

Member Function Documentation

empty()

bool ndn::util::Sha256::empty ( ) const

inline

Check if digest is empty.

An empty digest means nothing has been taken into calculation.

Definition at line 75 of file sha256.hpp.

References computeDigest(), operator==(), and reset().

reset()

void ndn::util::Sha256::reset

(

)

Discard the current state and start a new digest calculation.

Definition at line 50 of file sha256.cpp.

References ndn::security::transform::digestFilter(), ndn::SHA256, and ndn::security::transform::streamSink().

Referenced by empty(), and Sha256().

computeDigest() [1/2]

ConstBufferPtr ndn::util::Sha256::computeDigest

(

)

Finalize and return the digest based on all previously supplied inputs.

Definition at line 63 of file sha256.cpp.

Referenced by computeDigest(), empty(), ndn::Data::getFullName(), operator!=(), operator<<(), ndn::util::operator<<(), operator==(), and toString().

operator==()

bool ndn::util::Sha256::operator==

(

Sha256 &

digest

)

Check if the supplied digest is equal to this digest.

Note

This method invokes computeDigest() on both operands, finalizing the digest.

Definition at line 75 of file sha256.cpp.

References computeDigest().

Referenced by empty().

operator!=()

bool ndn::util::Sha256::operator!= ( Sha256 &  digest )

inline

Check if the supplied digest is not equal to this digest.

Note

This method invokes computeDigest() on both operands, finalizing the digest.

Definition at line 104 of file sha256.hpp.

References computeDigest(), operator<<(), toString(), and update().

operator<<() [1/4]

Sha256 & ndn::util::Sha256::operator<<

(

Sha256 &

src

)

Add existing digest to the digest calculation.

Parameters

src	digest to combine with

The result of this combination is sha256(sha256(...))

Note

This method invokes computeDigest() on src, finalizing the digest.

Exceptions

Error

the digest has already been finalized

Definition at line 89 of file sha256.cpp.

References computeDigest(), and update().

Referenced by operator!=().

operator<<() [2/4]

Sha256 & ndn::util::Sha256::operator<<

(

const std::string &

str

)

Add a string to the digest calculation.

Exceptions

Error

the digest has already been finalized

Definition at line 96 of file sha256.cpp.

References update().

operator<<() [3/4]

Sha256 & ndn::util::Sha256::operator<<

(

uint64_t

value

)

Add a uint64_t value to the digest calculation.

Exceptions

Error

the digest has already been finalized

Definition at line 103 of file sha256.cpp.

References update().

operator<<() [4/4]

Sha256 & ndn::util::Sha256::operator<<

(

span< const uint8_t >

bytes

)

Add a contiguous range of arbitrary bytes to the digest calculation.

Exceptions

Error

the digest has already been finalized

Definition at line 110 of file sha256.cpp.

References update().

update()

void ndn::util::Sha256::update

(

span< const uint8_t >

buffer

)

Add a byte buffer to the digest calculation.

Exceptions

Error

the digest has already been finalized

Definition at line 117 of file sha256.cpp.

References NDN_THROW.

Referenced by computeDigest(), operator!=(), and operator<<().

toString()

std::string ndn::util::Sha256::toString

(

)

Convert digest to std::string.

Note

This method invokes computeDigest(), finalizing the digest.

Definition at line 128 of file sha256.cpp.

References computeDigest(), and ndn::toHex().

Referenced by operator!=().

computeDigest() [2/2]

ConstBufferPtr ndn::util::Sha256::computeDigest ( span< const uint8_t >  buffer )

static

Stateless SHA-256 digest calculation.

Returns

SHA-256 digest of the input buffer

Definition at line 135 of file sha256.cpp.

References computeDigest(), and update().

Member Data Documentation

DIGEST_SIZE

const size_t ndn::util::Sha256::DIGEST_SIZE = 32

static

Length in bytes of a SHA-256 digest.

Definition at line 56 of file sha256.hpp.

Referenced by ndn::name::Component::isImplicitSha256Digest(), and ndn::name::Component::isParametersSha256Digest().

---

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

• ndnSIM/ndn-cxx/ndn-cxx/util/sha256.hpp
• ndnSIM/ndn-cxx/ndn-cxx/util/sha256.cpp