Skip to main content

WalEncryptionKey

Struct WalEncryptionKey 

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

AES-256-GCM key with a random per-lifetime epoch for nonce disambiguation.

The epoch is generated randomly at construction time. Each WAL lifetime (process start, snapshot restore, segment creation) gets a fresh epoch, ensuring that nonces are never reused even if LSNs restart from 1.

Implementations§

Source§

impl WalEncryptionKey

Source

pub fn from_bytes(key: &[u8; 32]) -> Result<Self>

Create from a 32-byte key with a fresh random epoch.

Returns an error if the OS RNG (getrandom) is unavailable. Without a fresh epoch we cannot guarantee nonce uniqueness across WAL lifetimes, so panicking would silently risk nonce reuse on RNG failure — better to surface it.

Source

pub fn with_epoch(key: &[u8; 32], epoch: [u8; 4]) -> Self

Create from a 32-byte key with a caller-supplied epoch.

Use this when reopening a WAL segment whose epoch was read from the on-disk preamble, so that the nonce is reconstructed identically to the nonce used at encryption time.

Source

pub fn with_fresh_epoch(&self) -> Result<Self>

Produce a new key instance with the same key material but a fresh random epoch. Used when rolling to a new WAL segment — each segment gets its own epoch so the per-segment nonce space is independent.

Source

pub fn from_file(path: &Path) -> Result<Self>

Load key from a file (must contain exactly 32 bytes).

Before reading, the file is checked for:

  • No symlinks (TOCTOU / path-traversal risk).
  • Regular file (not a device, FIFO, or directory).
  • Unix: no group or world access bits (mode & 0o077 == 0).
  • Unix: file owner matches the current process UID.
Source

pub fn encrypt( &self, lsn: u64, header_bytes: &[u8; 54], plaintext: &[u8], ) -> Result<Vec<u8>>

Encrypt a payload. Returns ciphertext + auth_tag (16 bytes appended).

  • lsn: used to derive a deterministic nonce
  • header_bytes: used as AAD (additional authenticated data)
  • plaintext: the payload to encrypt
Source

pub fn encrypt_aad( &self, lsn: u64, aad: &[u8], plaintext: &[u8], ) -> Result<Vec<u8>>

Encrypt with a caller-provided AAD slice (may be longer than HEADER_SIZE, e.g. preamble bytes prepended to the header).

Source

pub fn epoch(&self) -> &[u8; 4]

The random epoch for this key instance.

Source

pub fn decrypt( &self, epoch: &[u8; 4], lsn: u64, header_bytes: &[u8; 54], ciphertext: &[u8], ) -> Result<Vec<u8>>

Decrypt a payload. Input is ciphertext + auth_tag (16 bytes at end).

  • epoch: must be the epoch that was used during encryption, read from the on-disk segment preamble — not self.epoch, which reflects the current in-memory lifetime and may differ after a restart.
  • lsn: must match the LSN used during encryption
  • header_bytes: must match the header used during encryption (AAD)
  • ciphertext: the encrypted payload (includes 16-byte auth tag)
Source

pub fn decrypt_aad( &self, epoch: &[u8; 4], lsn: u64, aad: &[u8], ciphertext: &[u8], ) -> Result<Vec<u8>>

Decrypt with a caller-provided AAD slice.

Trait Implementations§

Source§

impl Clone for WalEncryptionKey

Source§

fn clone(&self) -> WalEncryptionKey

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<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> 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<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