Skip to main content

EncryptionLayer

Struct EncryptionLayer 

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

Zero-knowledge encryption layer with per-tenant key derivation.

Holds a derived encryption key (zeroized on drop) and the ZeroKnowledgeEncryptor from cachekit-core for AES-256-GCM operations.

L1 stores ciphertext, not plaintext — the zero-knowledge property is preserved across all cache layers.

Implementations§

Source§

impl EncryptionLayer

Source

pub fn new( master_key_bytes: &[u8], tenant_id: &str, ) -> Result<Self, CachekitError>

Create a new encryption layer with HKDF-derived tenant keys.

§Arguments
  • master_key_bytes — Raw master key (minimum 32 bytes for AES-256)
  • tenant_id — Tenant identifier for cryptographic isolation
§Errors
  • Master key too short (< 32 bytes)
  • HKDF derivation failure
  • Encryptor initialization failure
Source

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

Encrypt plaintext with AAD bound to the cache key.

Output format: [nonce(12)][ciphertext + auth_tag(16)]

Source

pub fn decrypt( &self, ciphertext: &[u8], cache_key: &str, ) -> Result<Vec<u8>, CachekitError>

Decrypt ciphertext with AAD bound to the cache key.

Returns the original plaintext. Fails if the cache key does not match the one used during encryption (ciphertext substitution protection).

Source

pub fn tenant_id(&self) -> &str

Return the tenant ID used for key derivation.

Source

pub fn build_aad(&self, cache_key: &str, compressed: bool) -> Vec<u8>

Build AAD v0x03 for a given cache key and compression flag.

Format: [0x03][len][tenant_id][len][cache_key][len]["msgpack"][len]["True"/"False"]

All lengths are 4-byte big-endian u32 to prevent boundary-confusion attacks.

§Invariant: compressed is always false in production

encrypt and decrypt pass the literal false, and that is normative, not a gap: this SDK’s only cross-SDK encrypted surface is interop mode, and protocol/spec/interop-mode.md (“Encryption in Interop Mode”) mandates the AAD components format = "msgpack", compressed = "False" — there is no compression in interop mode.

Why a reader cannot recover from a wrong flag here: in the general flow a reader rebuilds the AAD from the stored cleartext metadata written alongside the ciphertext (protocol/spec/encryption.md, encrypt step 6 / decrypt step 3). cachekit-rs stores no such per-entry metadata — it writes plain nonce ‖ ciphertext ‖ tag with no header — so its readers have nothing to read the flag from and must reconstruct the AAD from the interop-pinned constants alone. Combined with the no-retry rule (a reader MUST NOT retry decryption with any alternative AAD input, protocol/spec/encryption.md), emitting compressed = "True" here would produce ciphertext that no conformant peer can authenticate, and none may probe for.

So do not flip this literal to thread a live compression flag through encrypt/decrypt. If this SDK ever does compress, the flag must be stored per entry and threaded from that stored value — protocol/spec/encryption.md requires compressed to describe the actual plaintext, and claiming "False" over compressed bytes is the cachekit-py#166 conformance bug (round-trips in-process, fails authentication for every correct second reader). A compressed cross-SDK profile is a versioned protocol change (interop/v2, Multica LAB-1135), not an SDK flag.

The "True"/"False" tokens are frozen byte-level protocol constants — normative byte table in protocol/spec/encryption.md, section “compressed tokens”; decided in protocol#12 (resolved 2026-07-19: a spec correction, not a wire change). The true branch stays, exercised by conformance tests, so those bytes remain pinned.

Trait Implementations§

Source§

impl Debug for EncryptionLayer

Source§

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

Formats the value using the given formatter. 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> 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> 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> 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, 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