Skip to main content

EncryptedWal

Struct EncryptedWal 

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

Encrypted Write-Ahead Log.

Encrypts each WAL record before writing it to disk. During replay, records are decrypted and deserialized.

§Security Properties

  • Each record is independently encrypted with a fresh nonce
  • AAD prevents record type confusion
  • Records cannot be read without the encryption key

§Examples

use dbx_core::wal::encrypted_wal::EncryptedWal;
use dbx_core::wal::WalRecord;
use dbx_core::storage::encryption::EncryptionConfig;
use std::path::Path;

let enc = EncryptionConfig::from_password("secret");
let wal = EncryptedWal::open(Path::new("./wal.log"), enc).unwrap();

let record = WalRecord::Insert {
    table: "users".to_string(),
    key: b"user:1".to_vec(),
    value: b"Alice".to_vec(),
    ts: 0,
};
wal.append(&record).unwrap();
wal.sync().unwrap();

Implementations§

Source§

impl EncryptedWal

Source

pub fn open(path: &Path, encryption: EncryptionConfig) -> DbxResult<Self>

Open or create an encrypted WAL file.

Source

pub fn append(&self, record: &WalRecord) -> DbxResult<u64>

Append an encrypted record to the WAL.

The record is serialized to JSON, encrypted, base64-encoded, and written as a single line.

Source

pub fn sync(&self) -> DbxResult<()>

Synchronize WAL to disk (fsync).

Source

pub fn replay(&self) -> DbxResult<Vec<WalRecord>>

Replay all encrypted records from the WAL.

Source

pub fn current_sequence(&self) -> u64

Returns the current sequence number.

Source

pub fn encryption_config(&self) -> &EncryptionConfig

Get a reference to the encryption config.

Source

pub fn rekey(&mut self, new_encryption: EncryptionConfig) -> DbxResult<usize>

Re-key the WAL with a new encryption configuration.

Reads all existing records, decrypts with the current key, then re-writes them encrypted with the new key. The old WAL file is atomically replaced.

§Warning

Callers should ensure no concurrent writes during rekey.

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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,