Enum CloudCipher 

pub enum CloudCipher {
    Encrypted(EncryptionService),
    Plaintext,
}

Protection for payloads assigned to this cipher. Encrypted seals under its keyring; Plaintext preserves the bytes. Protocol domains and blob locators determine which cipher applies.

Variants

Encrypted(EncryptionService)

Plaintext

Implementations

impl CloudCipher

pub fn for_storage( storage: HomeStorage, encryption: Option<EncryptionService>, ) -> Option<Self>

The at-rest cipher a home’s storage mode selects: an opaque home seals under its store key (Encrypted), a browsable home stores in the clear (Plaintext). The sibling of BlobPathScheme::for_storage — together they map a HomeStorage to its (path scheme, at-rest cipher) pair.

encryption is the store master service; it is required for (and only consulted on) an opaque home. None is returned only for an opaque home with no service (a locked store) — a browsable home is always Plaintext regardless. A host streaming a Remote blob opens a BlobRangeReader under this cipher, so a read applies the same protection the upload sealed under.

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

Protect a whole payload assigned to this cipher. Encryption prefixes the selected key’s fingerprint in cleartext; plaintext returns the bytes unchanged. The caller supplies the protection domain’s context.

pub fn open( &self, stored: Vec<u8>, aad_context: &[u8], ) -> Result<Vec<u8>, EncryptionError>

Recover a whole payload read from storage. Inverse of Self::seal.

pub fn seal_scoped( &self, scope: BlobScope, plaintext: Vec<u8>, aad_context: &[u8], ) -> Vec<u8>

Protect a blob under its scope. Encrypted blobs carry the selected audience key’s fingerprint in cleartext; opening uses that key and derives the same scoped key.

pub fn open_scoped( &self, scope: BlobScope, stored: Vec<u8>, aad_context: &[u8], ) -> Result<Vec<u8>, EncryptionError>

Recover a blob under its resolved scope. Inverse of Self::seal_scoped.

pub fn suffix(&self) -> &'static str

A cipher-dependent suffix for auxiliary object names: .enc when encrypted, empty when plaintext. Exact protocol slots and blob locators determine their own paths without this suffix.

pub fn is_plaintext(&self) -> bool

Whether this is a plaintext (unencrypted) home.

pub fn body_len(&self, header: SealedBlobHeader) -> u64

The final object length for a blob framed by header under this cipher: the key tag plus the sealed body for an encrypted home, the plaintext length verbatim for a browsable one. Known before a byte is sealed, so a streaming upload can declare its length up front.

pub async fn open_body( &self, scope: BlobScope, file_path: &Path, aad_context: &[u8], chunk_size: NonZeroU32, ) -> Result<BlobBody, FileError>

Open a streaming BlobBody over the local plaintext file at file_path, sealing each chunk under scope’s key for an encrypted home or passing the plaintext through for a browsable one — without ever reading or sealing the whole blob into memory. The streaming sibling of seal_scoped, used by the upload drain.

pub async fn open_exact_body( &self, scope: BlobScope, file_path: &Path, aad_context: &[u8], chunk_size: NonZeroU32, expected_size: u64, expected_hash: ObjectHash, progress: PreparationProgress, ) -> Result<BlobBody, FileError>

Open a streaming body whose plaintext reader verifies the exact row size/hash while it is consumed and reports each source-buffer advance. This avoids a separate plaintext hashing pass before sealing.

Trait Implementations

impl Clone for CloudCipher

fn clone(&self) -> CloudCipher

Returns a duplicate of the value.

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

Performs copy-assignment from source.