Enum MACFactory 

pub enum MACFactory {
    HMAC_SHA224(HMAC<SHA224>),
    HMAC_SHA256(HMAC<SHA256>),
    HMAC_SHA384(HMAC<SHA384>),
    HMAC_SHA512(HMAC<SHA512>),
    HMAC_SHA3_224(HMAC<SHA3_224>),
    HMAC_SHA3_256(HMAC<SHA3_256>),
    HMAC_SHA3_384(HMAC<SHA3_384>),
    HMAC_SHA3_512(HMAC<SHA3_512>),
}

Wrapper object for all algorithms that impl MAC. MACFactory deviates from the usual AlgorithmFactory trait because MAC objects do not have a no-arg constructor; instead they have a constructor that takes a KeyMaterialTrait and can return an error.

Variants

HMAC_SHA224(HMAC<SHA224>)

HMAC_SHA256(HMAC<SHA256>)

HMAC_SHA384(HMAC<SHA384>)

HMAC_SHA512(HMAC<SHA512>)

HMAC_SHA3_224(HMAC<SHA3_224>)

HMAC_SHA3_256(HMAC<SHA3_256>)

HMAC_SHA3_384(HMAC<SHA3_384>)

HMAC_SHA3_512(HMAC<SHA3_512>)

Implementations

impl MACFactory

pub fn default(key: &impl KeyMaterialTrait) -> Result<Self, FactoryError>

Get the default MAC algorithm.

pub fn default_128_bit( key: &impl KeyMaterialTrait, ) -> Result<Self, FactoryError>

Get the default 128-bit MAC algorithm.

pub fn default_256_bit( key: &impl KeyMaterialTrait, ) -> Result<Self, FactoryError>

Get the default 256-bit MAC algorithm.

pub fn new( alg_name: &str, key: &impl KeyMaterialTrait, ) -> Result<Self, FactoryError>

Get an instance of the algorithm by name.

Trait Implementations

impl MAC for MACFactory

fn new(_key: &impl KeyMaterialTrait) -> Result<Self, MACError>

This is a dummy function, required by the MAC trait. DO NOT call it, it does not do anything.

fn new_allow_weak_key(_key: &impl KeyMaterialTrait) -> Result<Self, MACError>

This is a dummy function, required by the MAC trait. DO NOT call it, it does not do anything.

fn output_len(&self) -> usize

The size of the output in bytes.

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

One-shot API that computes a MAC for the provided data. data can be of any length, including zero bytes.

fn mac_out(self, data: &[u8], out: &mut [u8]) -> Result<usize, MACError>

One-shot API that computes a MAC for the provided data and writes it into the provided output slice. data can be of any length, including zero bytes.

fn verify(self, data: &[u8], mac: &[u8]) -> bool

One-shot API that verifies a MAC for the provided data. data can be of any length, including zero bytes.

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

Provide a chunk of data to be absorbed into the MAC. 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 MAC value.

fn do_final_out(self, out: &mut [u8]) -> Result<usize, MACError>

Depending on the underlying MAC implementation, NIST may require that the library enforce a minimum length on the mac output value. See documentation for the underlying implementation to see conditions under which it throws MACError::InvalidLength.

fn do_verify_final(self, mac: &[u8]) -> bool

Internally, this will re-compute the MAC value and then compare it to the provided mac value using constant-time comparison. It is highly encouraged to use this utility function instead of comparing mac values for equality yourself.

fn max_security_strength(&self) -> SecurityStrength

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