Struct EncryptionConfig 

pub struct EncryptionConfig { /* private fields */ }

Configuration for database encryption using SQLCipher.

This struct holds the 32-byte (256-bit) encryption key used to encrypt/decrypt the SQLite database. The key should be generated using a cryptographically secure random number generator and stored securely (e.g., in the platform’s secure storage such as Keychain on iOS/macOS or Keystore on Android).

Security

• Never log or expose the encryption key
• Store keys in platform-specific secure storage
• Use a unique key per database

Implementations

impl EncryptionConfig

pub fn new(key: [u8; 32]) -> Self

Creates a new encryption configuration with the provided key.

Arguments

• key - A 32-byte (256-bit) encryption key.

Example

use mdk_sqlite_storage::encryption::EncryptionConfig;

let key = [0u8; 32]; // In production, use a securely generated key
let config = EncryptionConfig::new(key);

pub fn from_slice(key: &[u8]) -> Result<Self, Error>

Creates a new encryption configuration from a byte slice.

Arguments

• key - A byte slice that must be exactly 32 bytes.

Errors

Returns an error if the key is not exactly 32 bytes.

pub fn generate() -> Result<Self, Error>

Generates a new random encryption key.

This function uses getrandom for cryptographically secure random number generation. The generated key should be stored in secure storage for later use.

Errors

Returns an error if random number generation fails.

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

Returns a reference to the encryption key.

Trait Implementations

impl Clone for EncryptionConfig

fn clone(&self) -> EncryptionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncryptionConfig

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

Formats the value using the given formatter.