Struct lock_keeper::crypto::generic::Secret

pub(super) struct Secret {
    material: Vec<u8>,
    context: AssociatedData,
}

A generic secret.

This type isn’t public – it holds generic secret material and associated data, but does not enforce any properties on the key material.

Fields

material: Vec<u8>

The actual bytes of secret material.

context: AssociatedData

Additional context about the secret.

Implementations

impl Secret

pub(super) fn generate( rng: &mut (impl CryptoRng + RngCore), len: usize, context: AssociatedData ) -> Self

Generate a new secret of length len (in bytes).

pub(super) fn from_parts( secret_material: Vec<u8>, context: AssociatedData ) -> Self

Create a new secret from its constituent parts. This is unchecked; use with care.

pub(super) fn context(&self) -> &AssociatedData

Retrieve the context for this secret.

This is currently only used in testing, but it is fine to make it publicly accessible if necessary.

pub(super) fn borrow_material(&self) -> &[u8]

Retrieve key material.

Return a reference to the underlying bytes of the secret. This should only be used to print the secret.

Trait Implementations

impl Clone for Secret

fn clone(&self) -> Secret

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Secret

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Secret

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for Secret

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for Secret

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

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

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

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

impl Serialize for Secret

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Secret> for Vec<u8>

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(secret: Secret) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for Secret

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Secret

impl StructuralPartialEq for Secret