Struct SHA3Internal 

pub struct SHA3Internal<PARAMS: SHA3Params> { /* private fields */ }

Internal struct for SHA3. This uses a private bound so that you cannot instantiate it directly and have to use the provided and NIST-approved parameters.

Implementations

impl<PARAMS: SHA3Params> SHA3Internal<PARAMS>

pub fn new() -> Self

Get a new SHA3 instance, ready for use.

Trait Implementations

impl<PARAMS: SHA3Params> Algorithm for SHA3Internal<PARAMS>

const ALG_NAME: &'static str = PARAMS::ALG_NAME

String name for the algorithm, used consistently across the library.

const MAX_SECURITY_STRENGTH: SecurityStrength = PARAMS::MAX_SECURITY_STRENGTH

Maximum security strength supported by the algorithm. In other words, this algorithm can produce outputs up to this security strength, but may produce outputs with lower security strength, for example, if asked to truncate.

impl<PARAMS: Clone + SHA3Params> Clone for SHA3Internal<PARAMS>

fn clone(&self) -> SHA3Internal<PARAMS>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<PARAMS: SHA3Params> Default for SHA3Internal<PARAMS>

fn default() -> Self

Returns the “default value” for a type.

impl<PARAMS: SHA3Params> Hash for SHA3Internal<PARAMS>

fn block_bitlen(&self) -> usize

As per FIPS 202 Table 3. Required, for example, to compute the pad lengths in HMAC.

fn output_len(&self) -> usize

The size of the output in bytes.

fn hash(self, data: &[u8]) -> Vec<u8>

A static one-shot API that hashes the provided data. data can be of any length, including zero bytes.

fn hash_out(self, data: &[u8], output: &mut [u8]) -> usize

A static one-shot API that hashes the provided data into the provided output slice. data can be of any length, including zero bytes. The entire output buffer is zeroized before the hash output is written. The return value is the number of bytes written.

fn do_update(&mut self, data: &[u8])

Provide a chunk of data to be absorbed into the hashes. data can be of any length, including zero bytes. do_update() is intended to be used as part of a streaming interface, and so may by called multiple times.

fn do_final(self) -> Vec<u8>

Finish absorbing input and produce the hashes output. Consumes self, so this must be the final call to this object.

fn do_final_out(self, output: &mut [u8]) -> usize

Finish absorbing input and produce the hashes output. Consumes self, so this must be the final call to this object.

fn do_final_partial_bits( self, partial_byte: u8, num_partial_bits: usize, ) -> Result<Vec<u8>, HashError>

The same as Hash::do_final, but allows for supplying a partial byte as the last input. Assumes that the input is in the least significant bits (big endian).

fn do_final_partial_bits_out( self, partial_byte: u8, num_partial_bits: usize, output: &mut [u8], ) -> Result<usize, HashError>

The same as Hash::do_final_out, but allows for supplying a partial byte as the last input. Assumes that the input is in the least significant bits (big endian). will be placed in the first Hash::output_len bytes. The entire output buffer is zeroized before the hash output is written. The return value is the number of bytes written.

fn max_security_strength(&self) -> SecurityStrength

Returns the maximum security strength that this KDF is capable of supporting, based on the underlying primitives.

impl<PARAMS: SHA3Params> KDF for SHA3Internal<PARAMS>

SHA3 is allowed to be used as a KDF in the form HASH(X) as per NIST SP 800-56C.

fn derive_key( self, key: &impl KeyMaterialTrait, additional_input: &[u8], ) -> Result<Box<dyn KeyMaterialTrait>, KDFError>

Returns a KeyMaterial. For the KDF to be considered “fully-seeded” and be capable of outputting full-entropy KeyMaterials, it requires full-entropy input that is at least the bit size (ie 256 bits for SHA3-256, etc).

fn derive_key_out( self, key: &impl KeyMaterialTrait, additional_input: &[u8], output_key: &mut impl KeyMaterialTrait, ) -> Result<usize, KDFError>

Same as KDF::derive_key, but fills the provided output KeyMaterial.

fn derive_key_from_multiple( self, keys: &[&impl KeyMaterialTrait], additional_input: &[u8], ) -> Result<Box<dyn KeyMaterialTrait>, KDFError>

Meant to be used for hybrid key establishment schemes or other spit-key scenarios where multiple keys need to be combined into a single key of the same length.

fn derive_key_from_multiple_out( self, keys: &[&impl KeyMaterialTrait], additional_input: &[u8], output_key: &mut impl KeyMaterialTrait, ) -> Result<usize, KDFError>

Same as KDF::derive_key, but fills the provided output KeyMaterial.

fn max_security_strength(&self) -> SecurityStrength

Returns the maximum security strength that this KDF is capable of supporting, based on the underlying primitives.

impl<PARAMS: SHA3Params> Suspendable<SUSPENDED_SHA3_STATE_LEN> for SHA3Internal<PARAMS>

fn suspend(self) -> [u8; 415]

Suspend operation by serializing out the state of the object.

fn from_suspended(serialized_state: [u8; 415]) -> Result<Self, SuspendableError>

Resume operation from a serialized state.