Expand description
Portable encrypted archive API.
Modules§
- vault_
integration - Narrow integration surface used by
revault_vault_api.
Structs§
- Cache
Stats - Snapshot of decoded-page cache usage.
- Contact
KeyPair - Hybrid X25519 + ML-KEM-768 contact keypair.
- Contact
Public Key - Public hybrid X25519 + ML-KEM-768 contact key.
- Contact
Wrapped Key - Content key wrapped to a hybrid X25519 + ML-KEM-768 contact.
- Content
Chunk - Metadata for one streamed content range.
- Content
Stream Options - Options for streaming lockbox file content without extracting to disk.
- Extract
Policy - Safety and behavior limits for extracting lockbox contents.
- Form
Definition - Form
Field Definition - Form
Field Value - Form
Record - Form
Type Id - Import
Stats - Coarse import pipeline timing counters.
- List
Options - Options for listing lockbox entries.
- Lockbox
- Open encrypted lockbox container.
- Lockbox
Entry - Metadata returned by lockbox listing and stat APIs.
- Lockbox
File Inspection - Public metadata read from a lockbox file without decrypting its contents.
- Lockbox
File Mut - Seekable read/write handle over a file inside a writable lockbox.
- Lockbox
File Reader - Seekable read handle over a file inside a lockbox.
- Lockbox
Id - Stable UUID-style identifier embedded in each lockbox.
- Lockbox
Inspector - Read-only diagnostics for an opened lockbox.
- Lockbox
KeySlot - Public metadata for one key slot.
- Lockbox
Options - Options used when creating or opening a lockbox.
- Lockbox
Owner Inspection - Owner-signing metadata verified from an opened lockbox.
- Lockbox
Path - Canonical path for an directory, file or symlink entry inside a lockbox.
- Open
File Options - Options used when opening a writable file handle inside a lockbox.
- Owner
Signing KeyPair - Owner
Signing Public Key - Page
Inspection - Public diagnostic view of one physical lockbox page.
- Page
Object Inspection - Public diagnostic view of one object inside a page.
- Read
Only - Marker for lockbox handles that can read but cannot be committed.
- Recovery
Report - Summary produced by lockbox recovery and salvage scans.
- Recovery
Report Options - Rendering options for
RecoveryReport. - Recovery
Scanner - Scans damaged lockbox storage and reports or salvages recoverable content.
- Scoped
File Lock - Secret
String - Secret
Vec - Variable
Name - Validated variable name stored inside a lockbox.
- Variable
Name Pattern - Validated variable-name filter.
- Writable
- Marker for lockbox handles that can be mutated and committed.
Enums§
- Artifact
Kind - Native persisted artifact whose format version was rejected.
- Cache
Limit - Decoded-page cache size policy.
- Content
Stream Order - Ordering used by
Lockbox::stream_content. - Error
- Error type returned by lockbox operations.
- File
Lock Scope - Form
Field Kind - Form
Value - Lockbox
Entry Kind - Kind of logical node returned by lockbox listing and stat APIs.
- Lockbox
KeySlot Algorithm - Algorithm used by a key slot to wrap the lockbox content key.
- Lockbox
KeySlot Protection - User-facing protection type represented by a key slot.
- Lockbox
Open - Key material used to open an existing lockbox file.
- Lockbox
Protection - Key material used when creating a new lockbox file.
- Variable
Sensitivity - Sensitivity marker for variables stored in a lockbox.
- Variable
Value Ref - Borrowed variable value yielded by
Lockbox::visit_variables. - Worker
Policy - Worker policy for CPU-heavy lockbox work.
- Workload
Profile - High-level access pattern hint for cache and write behavior.
Constants§
- LOCKBOX_
FORMAT_ VERSION - MAX_
KEY_ SLOT_ NAME_ BYTES - Maximum UTF-8 byte length for a user-facing key slot name.
Functions§
- lock_
path_ for - Returns the hidden sidecar path used to coordinate writes to
target. - probe_
lockbox_ format_ version - Reads the stable native archive format discriminator from a complete, authenticated public header without attempting to parse that format.
Type Aliases§
- Result
- Convenient result alias for lockbox operations.