56 lines
2.2 KiB
Markdown
56 lines
2.2 KiB
Markdown
|
|
[//]: # (Copyright 2019-2020 Rodolphe Bréard <rodolphe@breard.tf>)
|
|
|
|
[//]: # (Copying and distribution of this file, with or without modification,)
|
|
[//]: # (are permitted in any medium without royalty provided the copyright)
|
|
[//]: # (notice and this notice are preserved. This file is offered as-is,)
|
|
[//]: # (without any warranty.)
|
|
|
|
|
|
# Coffio
|
|
|
|
[](https://github.com/breard-r/coffio/actions/workflows/ci.yml)
|
|
[](https://crates.io/crates/coffio)
|
|
[](https://docs.rs/coffio/)
|
|
|
|
|
|
Abstraction layer for symmetric data encryption, primarily designed for
|
|
database column encryption.
|
|
|
|
|
|
# Disclaimer
|
|
|
|
:warning: DANGER: DRAGONS A(H)EAD! :dragon_face:
|
|
|
|
This crate is experimental and has never been audited by an independent
|
|
security professional. You should therefore NOT use it in production.
|
|
|
|
Although this crate aim to reduce the risk of misuse, it is still possible to
|
|
use it in such a way that the cryptography it uses does not provides all the
|
|
security guaranties you need. Ask your cryptographer if this crate is relevant
|
|
to your use case and if you are using it correctly.
|
|
|
|
|
|
# Frequently Asked Questions
|
|
|
|
## Should I use this crate?
|
|
|
|
Although it may work, some parts are not stabilized yet. Expect breaking change
|
|
that may result in the total loss of previously encrypted data.
|
|
|
|
## Why should I use this crate instead of a symmetric encryption function?
|
|
|
|
1. Strong algorithms only. If you don't know which one to chose, Coffio
|
|
provides strong defaults.
|
|
2. Key management is hard. Coffio largely simplifies it in a way that becomes
|
|
largely accessible.
|
|
|
|
## Why has this crate not been audited by a security professional?
|
|
|
|
Such an audit cost a lot of money. If you really care about this crate being
|
|
audited, you may help financing it.
|
|
|
|
## Where does the name coffio comes from?
|
|
|
|
It is a french slang for a safe or a strongbox. See
|
|
[coffio](https://fr.wiktionary.org/wiki/coffio) on the french Wiktionary.
|