Crate sos_sdk

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, 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.
• files Store external encrypted files.
• recovery Primitives for social recovery.
• search In-memory search index.

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.

Re-exports

• pub use encoding::decode;
• pub use encoding::encode;
• pub use age;
• pub use argon2;
• pub use hex;
• pub use k256;
• pub use pem;
• pub use secrecy;
• pub use sha2;
• pub use sha3;
• pub use sos_vfs as vfs;
• pub use time;
• pub use totp_rs as totp;
• pub use url;
• pub use urn;
• pub use uuid;
• pub use vcard4;
• pub use zxcvbn;

Modules

• accountaccount
  Create and manage local accounts.
• auditaudit
  Audit logging.
• commit
  Create and compare commits in an underlying merkle tree.
• constants
  Constants for file formats, folder names etc.
• crypto
  Cryptographic routines and types.
• device
  Types for device support.
• encoding
  Binary encoding implementation.
• events
  Events represent changes to accounts, folders and files.
• formats
  Iterate and inspect file formats.
• identity
  Account identity management.
• integrity
  Integrity checks for vaults, event logs and external files.
• logslogs
  Log tracing output to disc.
• migratemigrate
  Export and import unencrypted data.
• passwd
  Generate passwords.
• prelude
  Prelude re-exports common types.
• signer
  Traits and types for signing messages.
• storage
  Folder storage backed by the file system.
• vault
  Vault encrypted storage and access.

Structs

• Paths
  File system paths.
• UtcDateTime
  Date and time with binary encoding support.

Enums

• Error
  Error thrown by the core library.

Type Aliases

• Result
  Result type for the core library.