Struct CommitReader 

pub struct CommitReader { /* private fields */ }

Encapsulates the key derivation chain for reading a commit’s objects.

Created by decrypting a commit blob, which extracts the envelope nonce and derives the content key. The content key is then used to decrypt metadata and shards.

Implementations

impl CommitReader

pub fn from_share_key(key: ShareKey) -> Self

Create a CommitReader from a share key (for share-based unseal).

In share-based unseal the derived key serves directly as the content key — there is no commit envelope involved.

pub fn from_content_key(content_key: ContentKey) -> Self

Create a CommitReader from a content key directly (for scoped-key clone).

Used when cloning from a published repo with --content-key. The content key is the only key available – no root key exists in scoped mode.

pub fn open_with_vault( vault: &KeyVault, commit_blob: &EncryptedCommit, ) -> Result<(CommitPlaintext, Self)>

Decrypt a commit blob using a KeyVault, routing key material through the vault rather than accepting raw bytes.

This is the preferred constructor. The vault decrypts the commit and produces a crypto-layer CommitReader, whose parts are transferred into this core-layer reader. Callers never handle raw key bytes.

pub fn decrypt_metadata<T>(&self, blob: &EncryptedMetadata) -> Result<T>

where T: DeserializeOwned,

Decrypt a metadata bundle blob and deserialize from CBOR.

pub fn decrypt_shard( &self, blob: &EncryptedShard, wrapped_key: Option<&WrappedKey>, ancestor_keys: &[ContentKey], ) -> Result<DecryptedShard>

Decrypt a shard blob. Handles wrapped keys, content key, and optional ancestor key fallback.

Fallback chain:

1. If wrapped_key is Some, try unwrapping with content_key, then each ancestor key
2. Try content_key directly
3. Try each ancestor key directly

pub fn decrypt_repo_manifest( &self, blob: &EncryptedRepoManifest, ) -> Result<Manifest>

Decrypt a repo manifest blob into a typed Manifest.

pub fn decrypt_envelope_body( &self, blob: &EncryptedCommit, ) -> Result<(CommitPlaintext, KeyNonce)>

Decrypt a VD01 envelope body of a commit blob using the content key.

Returns the commit plaintext and the envelope nonce. Used by share-based unseal where the share key IS the content key.

pub fn content_key(&self) -> &ContentKey

Get the content key (derived key for envelope commits).