Struct lock_keeper::crypto::CryptorKey

pub struct CryptorKey {
    pub(super) key_material: Box<Key>,
    config: SensitiveInfoConfig,
}

The CryptorKey type is a default-length symmetric encryption key for an AEAD scheme. It can be used to securely encrypt data.

Fields

key_material: Box<Key>

config: SensitiveInfoConfig

Implementations

impl CryptorKey

Implementation for CryptorKey

const CRYPTOR_KEY_LENGTH: usize = 32usize

Length of the encryption key in bytes

pub fn new(rng: &mut (impl CryptoRng + RngCore)) -> Self

Constructs a new instance of the CryptorKey type.

Arguments

• rng - A mutable reference to an object implementing both the CryptoRng and RngCore traits. This is used to generate the cryptographic key for the ChaCha20Poly1305 algorithm.

Returns

Returns a new instance of the CryptorKey type with a fresh cryptographic key generated via the provided random number generator (rng) and a new SensitiveInfoConfig object.

A CryptorKey is generated uniformly at random. It is a 32-byte pseudorandom key for use in the ChaCha20Poly1305 scheme for authenticated encryption with associated data (AEAD).

pub fn from_file(path: impl AsRef<Path>) -> Result<Self, CryptoError>

Returns the CryptorKey stored in a file.

pub fn from_bytes(cryptor_key: &[u8]) -> Result<Self, CryptoError>

Returns the CryptorKey key based on key material in the caller’s byte array.

pub fn into_bytes(self) -> [u8; 32]

Converts CryptorKey to a byte array.

Warning

This method gives direct access to the key material bytes. The caller should be careful to manually zeroize them after use to prevent unintended exposure of sensitive information. Consider using the zeroize crate to securely zero the data.

Example

use zeroize::Zeroize;
use lock_keeper::crypto::CryptorKey;///

let mut rng = rand::thread_rng();
let encryption_key = CryptorKey::new(&mut rng);
let mut key_bytes = encryption_key.into_bytes();

// Use the key bytes...

// When done, zeroize the key bytes
key_bytes.zeroize();

Trait Implementations

impl Clone for CryptorKey

fn clone(&self) -> CryptorKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CryptorKey

An implementation of the std::fmt::Debug trait for CryptorKey

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

Formats the value using the given formatter.

impl Display for CryptorKey

An implementation of the std::fmt::Display trait for CryptorKey

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

Formats the value using the given formatter.

impl Drop for CryptorKey

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for CryptorKey

Implement the PartialEq trait for the CryptorKey type.

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

Determines if two CryptorKey instances are equal.

This function compares the key_material fields of two CryptorKey instances. It does not compare the config fields because the config field does not affect the functional equivalence of two CryptorKey instances.

Arguments

• other - The other CryptorKey instance to compare with.

Returns

Returns true if the data and context fields are equal between the two CryptorKey instances, Otherwise returns false.

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 CryptorKey

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 CryptorKey