rodolphe/coffio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Enforce word wrapping in the README

Browse source
This commit is contained in:
Rodolphe Bréard 2024-04-20 18:26:21 +02:00
parent d7ee6667f9
commit 1b95ba7edd
1 changed files with 18 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -11,33 +11,43 @@
![License MIT OR Apache 2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue) ![License MIT OR Apache 2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue)
Abstraction layer for symmetric data encryption, primarily designed for database column encryption. Abstraction layer for symmetric data encryption, primarily designed for
database column encryption.
# Disclaimer # Disclaimer
:warning: DANGER: DRAGONS A(H)EAD! :dragon_face: :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. 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. 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 # Frequently Asked Questions
## Should I use this crate? ## 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. 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? ## 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. 1. Strong algorithms only. If you don't know which one to chose, Coffio
2. Key management is hard. Coffio largely simplifies it in a way it becomes largely accessible. 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? ## 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. 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? ## 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. It is a french slang for a safe or a strongbox. See
[coffio](https://fr.wiktionary.org/wiki/coffio) on the french Wiktionary.