Key

Struct Key 

Source
pub struct Key { /* private fields */ }
Available on crate feature allow-non-fips only.
Expand description

Represents a 32-byte secret key for Poly1305 and ChaCha20Poly1305.

This struct ensures that the key material is securely managed and zeroed from memory when dropped.

Implementations§

Source§

impl Key

Source

pub const fn new(inner: [u8; 32]) -> Self

Creates a new Key from a 32-byte array.

§Arguments
  • inner - A 32-byte array containing the key material.
§Example
use wolf_crypto::mac::poly1305::Key;

let key = Key::new([0u8; 32]);
Source

pub const fn as_ref(&self) -> KeyRef<'_>

Returns a reference to the key as a KeyRef.

§Returns
  • KeyRef - A reference to the key material.
§Example
use wolf_crypto::mac::poly1305::{Key, KeyRef};

let key = Key::new([0u8; 32]);
let key_ref: KeyRef = key.as_ref();

Trait Implementations§

Source§

impl Clone for Key

Source§

fn clone(&self) -> Key

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 Key

Source§

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

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

impl Drop for Key

Source§

fn drop(&mut self)

Drops the Key, ensuring that the key material is zeroed from memory.

Source§

impl From<[u8; 32]> for Key

Source§

fn from(value: [u8; 32]) -> Self

Converts a 32-byte array into a Key.

§Arguments
  • value - A 32-byte array containing the key material.
§Example
use wolf_crypto::mac::poly1305::Key;

let key_bytes = [1u8; 32];
let key: Key = key_bytes.into();
Source§

impl Zeroize for Key

Source§

fn zeroize(&mut self)

Zeroes the key material in memory.

This method securely erases the key from memory to prevent leakage.

Source§

impl GenericKey for Key

Auto Trait Implementations§

§

impl Freeze for Key

§

impl RefUnwindSafe for Key

§

impl Send for Key

§

impl Sync for Key

§

impl Unpin for Key

§

impl UnwindSafe for Key

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.