Expand description
Portable encrypted archive 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.
- 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 - Versioned schema describing the fields accepted by a form record.
- Form
Field Definition - Schema for one named field in a form definition.
- Form
Field Value - One value stored in a form record with captured display metadata.
- Form
Record - Stored form instance tied to a definition revision.
- Form
Type Id - Stable UUID-shaped identifier shared by all revisions of a form definition.
- 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.
- Mirror
Project - Persistent configuration for one host-to-lockbox mirror project.
- Open
File Options - Options used when opening a writable file handle inside a lockbox.
- 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.
- Secret
String - UTF-8 secret stored in guarded, zeroizing memory.
- Secret
Vec - Variable-length byte sequence stored in guarded, zeroizing memory.
- Variable
Name - Validated, case-sensitive variable name stored inside a lockbox.
- Variable
Name Pattern - Validated case-sensitive 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.
- Form
Field Kind - Validation and sensitivity category for a form field.
- Form
Value - Sensitivity-aware payload stored by a form field.
- 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.
- Mirror
Missing File Policy - Controls what an update does with files that exist only in a mirror’s managed lockbox directory.
- 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.
Type Aliases§
- Profile
Signing KeyPair - A profile’s signing identity. The owner role is assigned only when the
key is attached to a
Lockbox. - Profile
Signing Public Key - The shareable verification half of a profile signing identity.
- Result
- Convenient result alias for lockbox operations.
- Wrapped
Contact Key - A contact-encrypted content-key envelope.