microkv 0.3.0

secure minimal key-value store
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

//! __microkv__ is a minimal, security-focused key-value store for sensitive data, with
//! encrypted persistence to disk.
//!
//! Every store is encrypted, with values sealed with
//! ChaCha20-Poly1305 under a key derived from a password (scrypt, or argon2 behind a
//! feature flag) or supplied directly. Data is organized into isolated namespaces
//! ("trees"), persisted atomically, and key material is held in memory-locked,
//! auto-zeroed storage.
//!
//! ```rust
//! use microkv::{MicroKV, Credential};
//!
//! let db = MicroKV::in_memory(Credential::password("p@ssw0rd")).unwrap();
//! db.put("answer", &42u32).unwrap();
//! let answer: u32 = db.require("answer").unwrap();
//! assert_eq!(answer, 42);
//! ```

mod codec;
mod config;
mod crypto;
mod error;
mod format;
mod secret;
mod store;
mod tree;
mod txn;

pub use crate::config::{AutoSave, Config, Credential, KdfParams, LockMode};
pub use crate::error::{Error, Result};
pub use crate::secret::{Secret, SecretString};
pub use crate::store::MicroKV;
pub use crate::tree::Tree;
pub use crate::txn::Txn;