We need to prepare revault documentation.
We will be using git book.
Start by designing a style so that we present a consistent look and feel.
The emphasis is to make the doco as non-technical as possible with links to more technical pages in the cases where uses want to drill down.
We should start with an overview of the vault and lockboxes then provide a page for each major group of commands e.g. forms.
The readme should provide a high level overview with a basic getting started guide focusing on creating/extracting lockboxes, env vars and some sort examples for forms.
Some thoughts on the intro.
ReVault is an reminagination of the archive format providing encryption and compression using language that doesn't require an understanding of cryptography to use safely.
ReVault Features:
Post Quantum hybrid encryption for public/private keys.
256 bit symmetric key for content encryption.
Ability to recover corrupted segments of a corrupted archive even when multiple corrupts occur.
Fast random read/write access to the archive without decrypting other content.
Store environment variables, forms and files in a single archive.
Secrets are stored in lock memory stopping secretes from being written to swap.
On supported desktops an ReVault agent runs holding time limited keys to provide easy access to 'unlocked' archives.
The desktop agent also monitors OS suspend operations and flushes all keys from memory to avoid a suspend operations from
writing secrets to disk.
The agent also terminates in progress decryption runs to ensure that secrets are not written to disk.
On supported platforms (Linux/MacOS) the agent inhibits the desktops ability to suspend whilst decrypt operations are running.
We need to prepare revault documentation.
We will be using git book.
Start by designing a style so that we present a consistent look and feel.
The emphasis is to make the doco as non-technical as possible with links to more technical pages in the cases where uses want to drill down.
We should start with an overview of the vault and lockboxes then provide a page for each major group of commands e.g. forms.
The readme should provide a high level overview with a basic getting started guide focusing on creating/extracting lockboxes, env vars and some sort examples for forms.
Some thoughts on the intro.
ReVault is an reminagination of the archive format providing encryption and compression using language that doesn't require an understanding of cryptography to use safely.
ReVault Features:
Post Quantum hybrid encryption for public/private keys.
256 bit symmetric key for content encryption.
Ability to recover corrupted segments of a corrupted archive even when multiple corrupts occur.
Fast random read/write access to the archive without decrypting other content.
Store environment variables, forms and files in a single archive.
Secrets are stored in lock memory stopping secretes from being written to swap.
On supported desktops an ReVault agent runs holding time limited keys to provide easy access to 'unlocked' archives.
The desktop agent also monitors OS suspend operations and flushes all keys from memory to avoid a suspend operations from
writing secrets to disk.
The agent also terminates in progress decryption runs to ensure that secrets are not written to disk.
On supported platforms (Linux/MacOS) the agent inhibits the desktops ability to suspend whilst decrypt operations are running.