Struct keynesis::SharedSecret

pub struct SharedSecret(_);

A Shared Secret that can be used to generate a symmetric key

Implementations

impl SharedSecret

pub const SIZE: usize

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

create a shared secret from the given bytes

To use only as a constructor if receiving the shared secret from a HSM or a secure enclave. Otherwise use the exchange function on the associate private/secret keys

Trait Implementations

impl AsRef<[u8]> for SharedSecret

pub fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Clone for SharedSecret

pub fn clone(&self) -> SharedSecret

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SharedSecret

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

Formats the value using the given formatter.

impl Drop for SharedSecret

custom implementation of Drop so we can have more certainty that the shared secret raw data will be scrubbed (zeroed) before releasing the memory

pub fn drop(&mut self)

Executes the destructor for this type.

impl Eq for SharedSecret

impl Hash for SharedSecret

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for SharedSecret

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<SharedSecret> for SharedSecret

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<SharedSecret> for SharedSecret

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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