Polyval

Struct Polyval 

Source
pub struct Polyval(/* private fields */);
Expand description

An implementation of POLYVAL.

POLYVAL is similar to GHASH. It operates in GF(2¹²⁸) defined by the irreducible polynomial

x^128 + x^127 + x^126 + x^121 + 1

The field has characteristic 2, so addition is performed with XOR. Multiplication is polynomial multiplication reduced modulo the polynomial.

For more information on POLYVAL, see RFC 8452.

Implementations§

Source§

impl Polyval

Source

pub fn new(key: &[u8; 16]) -> Option<Self>

Creates a new hash instance.

It returns None if key is all zeroes.

Source

pub fn new_unchecked(key: &[u8; 16]) -> Self

Creates a hash instance from a known non-zero key.

§Warning

Only use this method if key is known to be non-zero. Using an all zero key fixes the output to zero, regardless of the input.

Source

pub fn update_block(&mut self, block: &[u8; 16])

Writes a single block to the running hash.

Source

pub fn update_blocks(&mut self, blocks: &[[u8; 16]])

Writes one or more blocks to the running hash.

Source

pub fn update_padded(&mut self, blocks: &[u8])

Writes one or more blocks to the running hash.

If the length of blocks is non-zero, it’s padded to the lowest multiple of BLOCK_SIZE.

Source

pub fn tag(self) -> Tag

Returns the current authentication tag.

Source

pub fn verify(self, expected_tag: &Tag) -> Choice

Reports whether the current authentication tag matches expected_tag.

Source

pub fn export(&self) -> PolyvalState

Available on crate feature experimental only.

Exports the current state.

Source

pub fn reset(&mut self, state: &PolyvalState)

Available on crate feature experimental only.

Resets the hash to state.

Source

pub fn current_tag(&self) -> Tag

Available on crate feature experimental only.

Returns the current authentication tag without consuming the hash.

Trait Implementations§

Source§

impl Clone for Polyval

Source§

fn clone(&self) -> Polyval

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Polyval

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for Polyval

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl ZeroizeOnDrop for Polyval

Available on crate feature zeroize only.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.