Struct nimue::Safe

pub struct Safe<H, U = u8>
where
    U: Unit,
    H: DuplexHash<U>,
{ /* private fields */ }

A (slightly modified) SAFE API for sponge functions.

Operations in the SAFE API provide a secure interface for using sponges.

Implementations

impl<U: Unit, H: DuplexHash<U>> Safe<H, U>

pub fn new(io_pattern: &IOPattern<H, U>) -> Self

Initialise a SAFE sponge, setting up the state of the sponge function and parsing the tag string.

pub fn ratchet(&mut self) -> Result<(), IOPatternError>

Finish the block and compress the state.

pub fn preprocess(self) -> Result<&'static [U], IOPatternError>

Ratchet and return the sponge state.

pub fn absorb(&mut self, input: &[U]) -> Result<(), IOPatternError>

Perform secure absorption of the elements in input.

Absorb calls can be batched together, or provided separately for streaming-friendly protocols.

pub fn squeeze(&mut self, output: &mut [U]) -> Result<(), IOPatternError>

Perform a secure squeeze operation, filling the output buffer with uniformly random bytes.

For byte-oriented sponges, this operation is equivalent to the squeeze operation. However, for algebraic hashes, this operation is non-trivial. This function provides no guarantee of streaming-friendliness.

Trait Implementations

impl<H, U> Clone for Safe<H, U>

where U: Unit + Clone, H: DuplexHash<U> + Clone,

fn clone(&self) -> Safe<H, U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<U: Unit, H: DuplexHash<U>> Debug for Safe<H, U>

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

Formats the value using the given formatter.

impl<U: Unit, H: DuplexHash<U>> Drop for Safe<H, U>

fn drop(&mut self)

Destroy the sponge state.

impl<U: Unit, H: DuplexHash<U>, B: Borrow<IOPattern<H, U>>> From<B> for Safe<H, U>

fn from(value: B) -> Self

Converts to this type from the input type.