Struct Keccak

pub struct Keccak<E, const TYPE: u8, const VARIANT: usize>
where
    E: Environment,
{ /* private fields */ }

The sponge construction Sponge[f, pad, r] is a function that takes a variable-length input and produces a fixed-length output (the hash value).

The permutation f is a function that takes a fixed-length input and produces a fixed-length output, defined as f = Keccak-f[b], where b := 25 * 2^l is the width of the permutation, and l is the log width of the permutation. For our case, l = 6, thus b = 1600.

The padding rule pad is a function that takes a variable-length input and produces a fixed-length output. In Keccak, pad is a multi-rate padding, defined as pad(M) = M || 0x01 || 0x00…0x00 || 0x80, where M is the input data, and 0x01 || 0x00…0x00 || 0x80 is the padding. In SHA-3, pad is a SHAKE, defined as pad(M) = M || 0x06 || 0x00…0x00 || 0x80, where M is the input data, and 0x06 || 0x00…0x00 || 0x80 is the padding.

The bitrate r is the number of bits that are absorbed into the sponge state in each iteration of the absorbing phase.

In addition, the capacity is defined as c := b - r.

Implementations

impl<E, const TYPE: u8, const VARIANT: usize> Keccak<E, TYPE, VARIANT>

where E: Environment,

pub fn new() -> Keccak<E, TYPE, VARIANT>

Initializes a new Keccak hash function.

Trait Implementations

impl<E, const TYPE: u8, const VARIANT: usize> Clone for Keccak<E, TYPE, VARIANT>

where E: Clone + Environment,

fn clone(&self) -> Keccak<E, TYPE, VARIANT>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<E, const TYPE: u8, const VARIANT: usize> Debug for Keccak<E, TYPE, VARIANT>

where E: Debug + Environment,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<E, const TYPE: u8, const VARIANT: usize> Default for Keccak<E, TYPE, VARIANT>

where E: Default + Environment,

fn default() -> Keccak<E, TYPE, VARIANT>

Returns the “default value” for a type.

impl<E, const TYPE: u8, const VARIANT: usize> Hash for Keccak<E, TYPE, VARIANT>

where E: Environment,

fn hash( &self, input: &[<Keccak<E, TYPE, VARIANT> as Hash>::Input], ) -> <Keccak<E, TYPE, VARIANT> as Hash>::Output

Returns the Keccak hash of the given input as bits.

type Input = Boolean<E>

type Output = Vec<Boolean<E>>

impl<E, const TYPE: u8, const VARIANT: usize> LeafHash for Keccak<E, TYPE, VARIANT>

where E: Environment,

fn hash_leaf( &self, leaf: &<Keccak<E, TYPE, VARIANT> as LeafHash>::Leaf, ) -> <Keccak<E, TYPE, VARIANT> as LeafHash>::Hash

Returns the hash of the given leaf node.

type Hash = BooleanHash<E, VARIANT>

type Leaf = Vec<Boolean<E>>

impl<E, const TYPE: u8, const VARIANT: usize> PathHash<E> for Keccak<E, TYPE, VARIANT>

where E: Environment,

fn hash_children( &self, children: &[<Keccak<E, TYPE, VARIANT> as PathHash<E>>::Hash], ) -> <Keccak<E, TYPE, VARIANT> as PathHash<E>>::Hash

Returns the hash of the given child nodes.

type Hash = BooleanHash<E, VARIANT>

type Primitive = Keccak<TYPE, VARIANT>

fn hash_empty<const ARITY: u8>(&self) -> Self::Hash

Returns the empty hash.