revault_lockbox_api 0.0.1

reVault lockbox API to create and manage lockboxes
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

#![deny(unsafe_op_in_unsafe_fn)]
#![deny(clippy::undocumented_unsafe_blocks)]
//! Core encrypted lockbox storage engine.
//!
//! `revault_lockbox_api` owns the portable `.lbox` file format and the in-memory API
//! for storing files, symlinks, variable values, and key slots. It does not
//! know about a user's local vault or open-cache agent; those are implemented in
//! `revault_vault_api`.

mod checked;
mod compression;
mod constants;
mod error;
mod fast_hash;
mod file_format;
mod index;
mod keys;
mod lockbox;
mod model;
mod paths;
mod scan;
mod security;
mod storage;
mod toc;
#[cfg(feature = "vault-integration")]
pub mod vault_integration;

#[cfg(test)]
mod api_tests;
#[cfg(test)]
mod compression_regression_tests;
#[cfg(test)]
mod fixture_artifact_tests;

pub(crate) use file_format::{
    commit_auth, commit_root, key_directory, page, page_buffer, page_inspection, page_scanner,
    payload,
};
pub(crate) use keys::{crypto, key_derivation, key_slot, key_wrap, secret_vec, signing};
pub(crate) use model::{
    compression_frame_manifest, entry, extract_policy, file_chunk, form, list_options, lockbox_id,
    node_kind, page_object_packer, record, recovery_report, recovery_report_options, variable_name,
    variable_sensitivity,
};
pub(crate) use paths::{host_path, lockbox_path};
pub(crate) use storage::{
    cache_options, file_lock, free_index, free_slot, memory_pressure, page_cache,
};
pub(crate) use toc::{form_btree, page_tree, toc_btree, toc_codec, toc_entry, variable_btree};

pub use cache_options::{CacheLimit, CacheStats, LockboxOptions, WorkerPolicy, WorkloadProfile};
pub use entry::{LockboxEntry, LockboxEntryKind};
pub use error::{Error, Result};
pub use extract_policy::ExtractPolicy;
#[doc(hidden)]
pub use file_lock::{lock_path_for, FileLockScope, ScopedFileLock};
pub use form::{
    FormDefinition, FormFieldDefinition, FormFieldKind, FormFieldValue, FormRecord, FormTypeId,
    FormValue,
};
pub use key_slot::{
    LockboxKeySlot, LockboxKeySlotAlgorithm, LockboxKeySlotProtection, MAX_KEY_SLOT_NAME_BYTES,
};
pub use key_wrap::{ContactKeyPair, ContactPublicKey, ContactWrappedKey};
pub use list_options::ListOptions;
pub use lockbox::{
    ContentChunk, ContentStreamOptions, ContentStreamOrder, ImportStats, Lockbox,
    LockboxFileInspection, LockboxFileMut, LockboxFileReader, LockboxInspector, LockboxOpen,
    LockboxOwnerInspection, LockboxProtection, OpenFileOptions, ReadOnly, RecoveryScanner,
    VariableValueRef, Writable, WritableLockboxState,
};
pub use lockbox_id::LockboxId;
pub use lockbox_path::LockboxPath;
pub use page_inspection::{PageInspection, PageObjectInspection};
pub use recovery_report::RecoveryReport;
pub use recovery_report_options::RecoveryReportOptions;
pub use secret_vec::{SecretString, SecretVec};
pub use signing::{OwnerSigningKeyPair, OwnerSigningPublicKey};
pub use variable_name::{VariableName, VariableNamePattern};
pub use variable_sensitivity::VariableSensitivity;