Struct NCKey

pub struct NCKey<T: BoxProvider> {
    pub key: NonContiguousMemory,
    /* private fields */
}

A key to the crypto box. NCKey is stored on the heap which makes it easier to erase. Makes use of the NonContiguousMemory type to protect the data.

Fields

key: NonContiguousMemory

the guarded raw bytes that make up the key

Implementations

impl<T: BoxProvider> NCKey<T>

pub fn random() -> Self

generate a random key using secure random bytes

pub fn load(key: Zeroizing<Vec<u8>>) -> Option<Self>

attempts to load a key from inputted data

Return None if the key length doesn’t match BoxProvider::box_key_len.

pub fn encrypt_key<AD: AsRef<[u8]>>( &self, data: &Key<T>, ad: AD, ) -> Result<Vec<u8>, T::Error>

pub fn decrypt_key<AD: AsRef<[u8]>>( &self, data: Vec<u8>, ad: AD, ) -> Result<Key<T>, DecryptError<T::Error>>

Trait Implementations

impl<T: BoxProvider> Clone for NCKey<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: BoxProvider> Debug for NCKey<T>

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

Formats the value using the given formatter.

impl<'de, T: BoxProvider> Deserialize<'de> for NCKey<T>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: BoxProvider> Drop for NCKey<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: BoxProvider> Hash for NCKey<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: BoxProvider> Ord for NCKey<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: BoxProvider> PartialEq for NCKey<T>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: BoxProvider> PartialOrd for NCKey<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: BoxProvider> Serialize for NCKey<T>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: BoxProvider> Eq for NCKey<T>