fc::sha3 Class Reference

#include <sha3.hpp>

Classes
class	encoder

Public Member Functions
	sha3 ()
	~sha3 ()
	sha3 (const string &hex_str)
	sha3 (const char *data, size_t size)
string	str () const
	operator string () const
const char *	data () const
char *	data ()
size_t	data_size () const

Static Public Member Functions
static sha3	hash (const char *d, uint32_t dlen, bool is_nist=true)
static sha3	hash (const string &s, bool is_nist=true)
static sha3	hash (const sha3 &s, bool is_nist=true)
template<typename T >
static sha3	hash (const T &t, bool is_nist=true)

Public Attributes
uint64_t	_hash [4]

Friends
template<typename T >
T &	operator<< (T &ds, const sha3 &ep)
template<typename T >
T &	operator>> (T &ds, sha3 &ep)
sha3	operator<< (const sha3 &h1, uint32_t i)
sha3	operator>> (const sha3 &h1, uint32_t i)
bool	operator== (const sha3 &h1, const sha3 &h2)
bool	operator!= (const sha3 &h1, const sha3 &h2)
sha3	operator^ (const sha3 &h1, const sha3 &h2)
bool	operator>= (const sha3 &h1, const sha3 &h2)
bool	operator> (const sha3 &h1, const sha3 &h2)
bool	operator< (const sha3 &h1, const sha3 &h2)

Detailed Description

Definition at line 10 of file sha3.hpp.

Constructor & Destructor Documentation

sha3() [1/3]

fc::sha3::sha3

(

)

Definition at line 176 of file sha3.cpp.

{
    memset(_hash, 0, sizeof(_hash));
}

Here is the call graph for this function:

~sha3()

fc::sha3::~sha3 ( )

inline

Definition at line 14 of file sha3.hpp.

{}

sha3() [2/3]

fc::sha3::sha3 ( const string & hex_str )

explicit

Definition at line 186 of file sha3.cpp.

{
    auto bytes_written = fc::from_hex(hex_str, (char *)_hash, sizeof(_hash));
    if (bytes_written < sizeof(_hash))
        memset((char *)_hash + bytes_written, 0, (sizeof(_hash) - bytes_written));
}

Here is the call graph for this function:

sha3() [3/3]

fc::sha3::sha3 ( const char * data, size_t size )

explicit

Definition at line 180 of file sha3.cpp.

{
    if (size != sizeof(_hash))
        FC_THROW_EXCEPTION(exception, "sha3: size mismatch");
    memcpy(_hash, data, size);
}

Here is the call graph for this function:

Member Function Documentation

data() [1/2]

char * fc::sha3::data

(

)

Definition at line 200 of file sha3.cpp.

{ return (char *)&_hash[0]; }

data() [2/2]

const char * fc::sha3::data

(

)

const

Definition at line 199 of file sha3.cpp.

{ return (const char *)&_hash[0]; }

Here is the caller graph for this function:

data_size()

size_t fc::sha3::data_size ( ) const

inline

Definition at line 23 of file sha3.hpp.

{ return 256 / 8; }

hash() [1/4]

static sha3 fc::sha3::hash ( const char * d, uint32_t dlen, bool is_nist = true )

inlinestatic

Definition at line 25 of file sha3.hpp.

                                                                      {
        encoder e;
        e.write(d, dlen);
        const auto& sha = e.result(is_nist);
        return sha;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hash() [2/4]

static sha3 fc::sha3::hash ( const sha3 & s, bool is_nist = true )

inlinestatic

Definition at line 32 of file sha3.hpp.

{ return hash(s.data(), sizeof(s._hash), is_nist); }

Here is the call graph for this function:

Here is the caller graph for this function:

hash() [3/4]

static sha3 fc::sha3::hash ( const string & s, bool is_nist = true )

inlinestatic

Definition at line 31 of file sha3.hpp.

{ return hash(s.c_str(), s.size(), is_nist); }

Here is the call graph for this function:

Here is the caller graph for this function:

hash() [4/4]

template<typename T >

static sha3 fc::sha3::hash ( const T & t, bool is_nist = true )

inlinestatic

Definition at line 35 of file sha3.hpp.

    {
        sha3::encoder e;
        fc::raw::pack(e, t);
        return e.result(is_nist);
    }

Here is the call graph for this function:

operator string()

fc::sha3::operator string

(

)

const

Definition at line 197 of file sha3.cpp.

{ return str(); }

str()

string fc::sha3::str

(

)

const

Definition at line 193 of file sha3.cpp.

{
    return fc::to_hex((char *)_hash, sizeof(_hash));
}

Here is the call graph for this function:

Friends And Related Symbol Documentation

operator!=

bool operator!= ( const sha3 & h1, const sha3 & h2 )

friend

Definition at line 262 of file sha3.cpp.

{
    return !(h1 == h2);
}

operator<

bool operator< ( const sha3 & h1, const sha3 & h2 )

friend

Definition at line 258 of file sha3.cpp.

{
    return memcmp(h1._hash, h2._hash, sizeof(h1._hash)) < 0;
}

operator<< [1/2]

sha3 operator<< ( const sha3 & h1, uint32_t i )

friend

Definition at line 229 of file sha3.cpp.

{
    sha3 result;
    fc::detail::shift_l(h1.data(), result.data(), result.data_size(), i);
    return result;
}

operator<< [2/2]

template<typename T >

T & operator<< ( T & ds, const sha3 & ep )

friend

Definition at line 59 of file sha3.hpp.

    {
        ds.write(ep.data(), sizeof(ep));
        return ds;
    }

operator==

bool operator== ( const sha3 & h1, const sha3 & h2 )

friend

Definition at line 266 of file sha3.cpp.

{
    // idea to not use memcmp, from:
    //   https://lemire.me/blog/2018/08/22/avoid-lexicographical-comparisons-when-testing-for-string-equality/
    return h1._hash[0] == h2._hash[0] &&
             h1._hash[1] == h2._hash[1] &&
             h1._hash[2] == h2._hash[2] &&
             h1._hash[3] == h2._hash[3];
}

operator>

bool operator> ( const sha3 & h1, const sha3 & h2 )

friend

Definition at line 254 of file sha3.cpp.

{
    return memcmp(h1._hash, h2._hash, sizeof(h1._hash)) > 0;
}

operator>=

bool operator>= ( const sha3 & h1, const sha3 & h2 )

friend

Definition at line 250 of file sha3.cpp.

{
    return memcmp(h1._hash, h2._hash, sizeof(h1._hash)) >= 0;
}

operator>> [1/2]

sha3 operator>> ( const sha3 & h1, uint32_t i )

friend

Definition at line 235 of file sha3.cpp.

{
    sha3 result;
    fc::detail::shift_r(h1.data(), result.data(), result.data_size(), i);
    return result;
}

operator>> [2/2]

template<typename T >

T & operator>> ( T & ds, sha3 & ep )

friend

Definition at line 66 of file sha3.hpp.

    {
        ds.read(ep.data(), sizeof(ep));
        return ds;
    }

operator^

sha3 operator^ ( const sha3 & h1, const sha3 & h2 )

friend

Definition at line 241 of file sha3.cpp.

{
    sha3 result;
    result._hash[0] = h1._hash[0] ^ h2._hash[0];
    result._hash[1] = h1._hash[1] ^ h2._hash[1];
    result._hash[2] = h1._hash[2] ^ h2._hash[2];
    result._hash[3] = h1._hash[3] ^ h2._hash[3];
    return result;
}

Member Data Documentation

_hash

uint64_t fc::sha3::_hash[4]

Definition at line 80 of file sha3.hpp.

---

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

• libraries/fc/include/fc/crypto/sha3.hpp
• libraries/fc/src/crypto/sha3.cpp