Struct lock_keeper::crypto::arbitrary_secret::Secret

pub struct Secret(pub(super) Secret);

An arbitrary secret.

This is generated by the client and should never be revealed to the server.

Tuple Fields

0: Secret

Implementations

impl Secret

pub fn create_and_encrypt( rng: &mut (impl CryptoRng + RngCore), storage_key: &StorageKey, user_id: &UserId, key_id: &KeyId ) -> Result<(Self, Encrypted<Self>), LockKeeperError>

Create and encrypt a new secret. This is part of the generate a new secret flow.

This must be run by the client. It takes the following steps:

1. Generates a new secret
2. Encrypt it under the StorageKey, using an AEAD scheme

pub fn import_and_encrypt( secret_material: &[u8], rng: &mut (impl CryptoRng + RngCore), storage_key: &StorageKey, user_id: &UserId, key_id: &KeyId ) -> Result<(Self, Encrypted<Self>), LockKeeperError>

Create a Secret from an imported key and encrypt it for storage at a server, under a key known only to the client.

This is part of the local import with remote backup flow and must be run by the client.

fn context(&self) -> &AssociatedData

Retrieve the context for the secret.

This is only used in testing right now, but it would be fine to make it public.

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 Display for Secret

Allow secret to be displayed for demo purposes. Note we do not expose the internal type representation of the secret.

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

Formats the value using the given formatter.

impl Drop for Secret

fn drop(&mut self)

Executes the destructor for this type.

impl From<Secret> for Export

fn from(secret: Secret) -> Self

Converts to this type from the input 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<Export> for Secret

type Error = LockKeeperError

The type returned in the event of a conversion error.

fn try_from(export: Export) -> Result<Self, Self::Error>

Performs the conversion.

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(value: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Secret

impl StructuralPartialEq for Secret