Lib.rs

Software development kit for a distributed, local-first, encrypted database that can be used to build password managers, cryptocurrency wallets or other applications that require storing secrets securely.

See the Save Our Secrets website for the app, more documentation and information.

Backends

There are two storage backends, a file system backend which uses append-only files for event logs and a newer SQLite database backend. The sos-backend crate is an abstraction for multiple storage backends and should be used to create a backend target.

The file system backend is now considered legacy and may be removed in a future version.

Crates

A higher-level account management API is described in sos_account::Account which is implemented by sos_account::LocalAccount. For a network aware account with sync capability use sos_net::NetworkAccount.

For lower-level access use the types in the sos-vault crate.

This crate exports a prelude of common types for low-level access but we encourage using the appropriate crate directly.

API

The public API is not considered stable and may be changed at any time prior to a 1.0.0 release.

MSRV

We track the latest stable Rust toolchain (currently 1.85.0) so we can use new features as they are stabilized the code may compile on older versions.

License

The client code is either MIT or Apache-2.0, you choose; the server is released under the AGPL-3.0 license.