burrito-secrets

Crates.ioburrito-secrets
lib.rsburrito-secrets
version0.0.0-a3
sourcesrc
created_at2024-08-18 11:37:30.069353
updated_at2024-08-20 08:16:41.46933
descriptionA library for storing secrets in BSON format.
homepage
repositoryhttps://github.com/T-O-R-U-S/burrito
max_upload_size
id1342562
size41,748
T•Ø•R•Ü•S (T-O-R-U-S)

documentation

README

Burrito -- Secrets n' Sauce

A simple, monadic, encryption-agnostic schema for secrets.

Why?

After picking up KeePassXC, I decided to have my own go of making a password database format that could rival or even surpass KDBX4.

...and uh... I'm still working on it.

How?

The burrito schema uses BSON.

This is convenient because it's a binary format, and it's easy to parse. This makes it easier to store encrypted data compared to YAML/TOML/JSON, which are all text-based formats.

Monadic!?

Monads! Monads are awesome! They are your Option<T>s and Result<T, E>s, for the uninitiated.

A monad is like a burrito. It's a container that holds a value, and it's also a function that can be used to transform the value inside the burrito.

The burrito database is a monad.

Why not other formats?

Encryption produces binary data, and binary data doesn't work with 100% of human-readable serialization formats, unless I want to use base64, which I do not because it's wack.

BSON has some built-in markers for encrypted and sensitive data, which is a nice plus.

You can use serde to export to any format you want, but I decided upon BSON because it's a binary format that is purpose-made for this.

Documentation

You'll need it to understand how to use the schema, and how to use it securely.

Disclaimer:

THE SOFTWARE (AND ASSOCIATED DOCUMENTATION, RELATED FILES) IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Commit count: 0

cargo fmt