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

This library provides primitives for syncing when the sync feature flag is enabled but does not perform any networking, for networking support use the sos-net crate.

The high-level account management API is described in account::Account which is implemented by account::LocalAccount for a network aware account use NetworkAccount in sos-net.

For lower-level access use the types in the [vault] module.

Features

Default features enable account management, audit trail, external files, search and backup archives. If you want to just use encrypted vaults without the account management support disable default-features.

• account Local account management.
• audit Audit trail logs.
• device Device signing keys and device management.
• files Store external encrypted files.
• recovery Primitives for social recovery.
• search In-memory search index.
• sync Synchronization primitive definitions.

The following features require that the account feature is enabled:

• archive Create and restore from account backup archives.
• contacts Manage account contacts.
• migrate Import and export unencrypted secrets.
• preferences Account-level preferences.
• security-report Generate a security report.
• system-messages User messages persisted to disc.