Save Our Secrets SDK

Save our Secrets (SOS) is a cross-platform, distributed, encrypted database with a focus on security, integrity and redundancy. It can be used to store private secrets such as account passwords, notes, certificates and encryption keys.

This repository contains the software development kit (SDK) and several command line interface (CLI) tools.

To see the code in action download the app.

See the overview for concepts and terminology, the API documentation for the SDK or the API documentation for the networking library and check out the sync protocol API types for common networking code.

Server

The server can be run using docker; account data is written to the sandbox/accounts directory:

docker compose up

To run a server that uses a certificate issued by the Let's Encrypt ACME service for TLS see the notes in acme.toml.

OpenAPI

Start a development server using the sos-server crate:

cargo run -p sos-server -- start sandbox/config.toml

Then browse the server OpenAPI documentation or download the JSON.

License

The server code is licensed under AGPL-3.0; other crates are licensed under the MIT or Apache-2.0 license at your discretion.

© Copyright Save Our Secrets Pte Ltd 2022-2024; all rights reserved.

lib.rs:

Networking support for the Save Our Secrets SDK.

If the listen feature is enabled the client is compiled with support for sending and listening for change notification over a websocket connection.