Struct lock_keeper::crypto::MasterKey

pub struct MasterKey(EncryptionKey);

The master key is a default-length symmetric encryption key for an AEAD scheme.

The master key is used by the client to securely encrypt their StorageKey. It should not be stored or saved beyond the lifetime of a single authentication session. It should never be sent to the server or passed out to the local calling application.

Tuple Fields

0: EncryptionKey

Implementations

impl MasterKey

pub fn derive_master_key( export_key: Output<Sha512> ) -> Result<Self, LockKeeperError>

Derive a uniformly distributed secret MasterKey using the export key as input key material.

Arguments

• export_key - the export_key as returned by opaque-ke library, which has type [Output<Sha512>]

pub fn create_and_encrypt_storage_key( self, rng: &mut (impl CryptoRng + RngCore), user_id: &UserId ) -> Result<Encrypted<StorageKey>, LockKeeperError>

Create an encrypted storage key. This is part of the registration flow and is executed during a registration session with the server. This key should be sent to the server for storage.

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

1. Generate a new StorageKey to encrypt stored data with
2. Derive the decryption key from the master key, using the associated data
3. Encrypt the storage key under the encryption key, using an AEAD scheme
4. Return the encrypted storage key

fn encrypt_storage_key( self, rng: &mut (impl CryptoRng + RngCore), storage_key: StorageKey, user_id: &UserId ) -> Result<Encrypted<StorageKey>, CryptoError>

Encrypt the given StorageKey under a derivation from the MasterKey using an AEAD scheme.

fn derive_key( self, context: AssociatedData ) -> Result<EncryptionKey, CryptoError>

Derive a new key from MasterKey using AssociatedData as the domain separator. MasterKey should not be used directly to encrypt something, instead use this method to derive a key for a specific use-case using a domain separator.

Trait Implementations

impl Clone for MasterKey

fn clone(&self) -> MasterKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MasterKey

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

Formats the value using the given formatter.

impl Drop for MasterKey

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for MasterKey

fn eq(&self, other: &MasterKey) -> 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 Zeroize for MasterKey

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Eq for MasterKey

impl StructuralPartialEq for MasterKey