Functions to compute SHA1 message digest according to the NIST specification FIPS-180-1. More...

#include <SHA1.H>

Public Member Functions
	SHA1 ()
	Default construct.
	SHA1 (const char *str)
	Default construct and append initial string content.
	SHA1 (const std::string &str)
	Default construct and append initial string content.
void	clear () noexcept
	Reset the hashed data before appending more.
void	append (char c)
	Append single character.
void	append (const char *str)
	Append string for processing.
void	append (const char *data, size_t len)
	Append data for processing.
void	append (const std::string &str)
	Append string for processing.
void	append (const std::string &str, size_t pos, size_t len=std::string::npos)
	Append substring for processing.
bool	finalize ()
	Finalized the calculations (normally not needed directly).
SHA1Digest	digest () const
	Calculate digest from current data.
std::string	str (const bool prefixed=false) const
	The digest (40-byte) text representation, optionally with '_' prefix.
Ostream &	write (Ostream &os, const bool prefixed=false) const
	Write digest (40-byte) representation, optionally with '_' prefix.
	operator SHA1Digest () const
	Cast conversion to a SHA1Digest,.
bool	operator== (const SHA1 &rhs) const
	Equality operator, compares digests.
bool	operator== (const SHA1Digest &dig) const
	Compare digest.
bool	operator== (const std::string &hexdigits) const
	Compare digest to (40-byte) text representation (eg, from sha1sum).
bool	operator== (const char *hexdigits) const
	Compare digest to (40-byte) text representation (eg, from sha1sum).
bool	operator!= (const SHA1 &) const
	Inequality operator, compares digests.
bool	operator!= (const SHA1Digest &) const
	Inequality operator, compare digest.
bool	operator!= (const std::string &hexdigits) const
	Inequality operator, compares digests.
bool	operator!= (const char *hexdigits) const
	Inequality operator, compare digest.

Detailed Description

Functions to compute SHA1 message digest according to the NIST specification FIPS-180-1.

Adapted from the gnulib implementation.

See also: Foam::SHA1Digest

Source files

Definition at line 56 of file SHA1.H.

Constructor & Destructor Documentation

◆ SHA1() [1/3]

SHA1 ( )

inline

Default construct.

Definition at line 24 of file SHA1I.H.

References clear().

Referenced by digest(), operator SHA1Digest(), operator!=(), and operator==().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SHA1() [2/3]

SHA1 ( const char * str )

inlineexplicit

Default construct and append initial string content.

Definition at line 30 of file SHA1I.H.

References append(), clear(), and str().

Here is the call graph for this function:

◆ SHA1() [3/3]

SHA1 ( const std::string & str )

inlineexplicit

Default construct and append initial string content.

Definition at line 37 of file SHA1I.H.

References append(), clear(), and str().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

void clear ( )

noexcept

Reset the hashed data before appending more.

Definition at line 314 of file SHA1.C.

References Foam::noexcept.

Referenced by SHA1().

Here is the caller graph for this function:

◆ append() [1/5]

void append ( char c )

inline

Append single character.

Definition at line 46 of file SHA1I.H.

◆ append() [2/5]

void append ( const char * str )

inline

Append string for processing.

Definition at line 58 of file SHA1I.H.

References str().

Here is the call graph for this function:

◆ append() [3/5]

void append	(	const char *	data,
		size_t	len )

inline

Append data for processing.

Definition at line 52 of file SHA1I.H.

◆ append() [4/5]

void append ( const std::string & str )

inline

Append string for processing.

Definition at line 67 of file SHA1I.H.

References str().

Here is the call graph for this function:

◆ append() [5/5]

void append	(	const std::string &	str,
		size_t	pos,
		size_t	len = std::string::npos )

inline

Append substring for processing.

Definition at line 73 of file SHA1I.H.

References Foam::pos(), and str().

Here is the call graph for this function:

◆ finalize()

bool finalize ( )

Finalized the calculations (normally not needed directly).

Returns false if no bytes were passed for processing

Definition at line 329 of file SHA1.C.

Referenced by digest().

Here is the caller graph for this function:

◆ digest()

Foam::SHA1Digest digest ( ) const

inline

Calculate digest from current data.

Definition at line 92 of file SHA1I.H.

References finalize(), and SHA1().

Referenced by operator==(), operator==(), operator==(), operator==(), str(), and write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ str()

std::string str ( const bool prefixed = false ) const

inline

The digest (40-byte) text representation, optionally with '_' prefix.

Definition at line 114 of file SHA1I.H.

References digest().

Referenced by append(), append(), append(), codeStream::getFunction(), dynamicCode::setFilterContext(), SHA1(), SHA1(), and codedBase::updateLibrary().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

Foam::Ostream & write	(	Ostream &	os,
		const bool	prefixed = false ) const

inline

Write digest (40-byte) representation, optionally with '_' prefix.

Definition at line 120 of file SHA1I.H.

References digest(), and os().

Referenced by Foam::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator SHA1Digest()

operator SHA1Digest ( ) const

inline

Cast conversion to a SHA1Digest,.

calculates the digest from the current data

References Foam::rhs(), and SHA1().

Here is the call graph for this function:

◆ operator==() [1/4]

bool operator== ( const SHA1 & rhs ) const

inline

Equality operator, compares digests.

Definition at line 134 of file SHA1I.H.

References digest(), Foam::rhs(), and SHA1().

Here is the call graph for this function:

◆ operator==() [2/4]

bool operator== ( const SHA1Digest & dig ) const

inline

Compare digest.

Definition at line 140 of file SHA1I.H.

References digest().

Here is the call graph for this function:

◆ operator==() [3/4]

bool operator== ( const std::string & hexdigits ) const

inline

Compare digest to (40-byte) text representation (eg, from sha1sum).

An empty string is equivalent to "0000000000000000000000000000000000000000"

Definition at line 146 of file SHA1I.H.

References digest().

Here is the call graph for this function:

◆ operator==() [4/4]

bool operator== ( const char * hexdigits ) const

inline

Compare digest to (40-byte) text representation (eg, from sha1sum).

A null or empty string is equivalent to "0000000000000000000000000000000000000000"

Definition at line 152 of file SHA1I.H.

References digest().

Here is the call graph for this function:

◆ operator!=() [1/4]

bool operator!= ( const SHA1 & rhs ) const

inline

Inequality operator, compares digests.

Definition at line 158 of file SHA1I.H.

References Foam::operator==(), Foam::rhs(), and SHA1().

Here is the call graph for this function:

◆ operator!=() [2/4]

bool operator!= ( const SHA1Digest & rhs ) const

inline

Inequality operator, compare digest.

Definition at line 164 of file SHA1I.H.

References Foam::operator==(), and Foam::rhs().

Here is the call graph for this function:

◆ operator!=() [3/4]

bool operator!= ( const std::string & hexdigits ) const

inline

Inequality operator, compares digests.

Definition at line 170 of file SHA1I.H.

References Foam::operator==().

Here is the call graph for this function:

◆ operator!=() [4/4]

bool operator!= ( const char * hexdigits ) const

inline

Inequality operator, compare digest.

Definition at line 176 of file SHA1I.H.

References Foam::operator==().

Here is the call graph for this function:

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

src/OpenFOAM/primitives/hashes/SHA1/SHA1.H
src/OpenFOAM/primitives/hashes/SHA1/SHA1.C
src/OpenFOAM/primitives/hashes/SHA1/SHA1I.H

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SHA1() [1/3]

◆ SHA1() [2/3]

◆ SHA1() [3/3]

Member Function Documentation

◆ clear()

◆ append() [1/5]

◆ append() [2/5]

◆ append() [3/5]

◆ append() [4/5]

◆ append() [5/5]

◆ finalize()

◆ digest()

◆ str()

◆ write()

◆ operator SHA1Digest()

◆ operator==() [1/4]

◆ operator==() [2/4]

◆ operator==() [3/4]

◆ operator==() [4/4]

◆ operator!=() [1/4]

◆ operator!=() [2/4]

◆ operator!=() [3/4]

◆ operator!=() [4/4]