Skip to main content

EncryptionKey

Struct EncryptionKey 

Source
pub struct EncryptionKey { /* private fields */ }
Expand description

Encryption key with secure memory handling.

The key bytes are wrapped in Zeroizing to ensure they are zeroed from memory when dropped.

Implementations§

Source§

impl EncryptionKey

Source

pub fn derive_from_password(password: &str, salt: &[u8]) -> Result<Self>

Derives an encryption key from a password using Argon2id.

§Arguments
  • password - The password to derive the key from
  • salt - Salt bytes (should be at least 16 bytes, randomly generated per-key)
§Errors

Returns SecretsError::Encryption if key derivation fails.

Source

pub fn generate() -> Self

Generates a random 32-byte encryption key.

Uses the operating system’s cryptographically secure random number generator.

§Panics

Panics if the OS random number generator fails.

Source

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Creates an encryption key from raw bytes.

§Arguments
  • bytes - The key bytes (must be exactly 32 bytes)
§Errors

Returns SecretsError::Encryption if the byte slice is not exactly 32 bytes.

Source

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

Returns the raw key bytes.

Use with caution - only for persisting the key securely.

Source

pub fn encrypt(&self, plaintext: &[u8]) -> Result<Vec<u8>>

Encrypts plaintext using XChaCha20-Poly1305.

The returned ciphertext has the 24-byte nonce prepended: [nonce (24 bytes)][ciphertext + auth tag]

§Arguments
  • plaintext - The data to encrypt
§Errors

Returns SecretsError::Encryption if encryption fails.

§Panics

Panics if the OS random number generator fails to produce nonce bytes.

Source

pub fn decrypt(&self, data: &[u8]) -> Result<Vec<u8>>

Decrypts data that was encrypted with Self::encrypt.

Expects the input format: [nonce (24 bytes)][ciphertext + auth tag]

§Arguments
  • data - The encrypted data with prepended nonce
§Errors

Returns SecretsError::Decryption if:

  • The data is too short (less than nonce size)
  • Decryption or authentication fails

Trait Implementations§

Source§

impl Clone for EncryptionKey

Source§

fn clone(&self) -> EncryptionKey

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more