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

Update the readme

Browse source
This commit is contained in:
Rodolphe Bréard 2024-02-25 23:05:22 +01:00
parent 15198f5286
commit 349ed79b4c
1 changed files with 3 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -27,17 +27,12 @@ Although this crate aim to reduce the risk of misuse, it is still possible to us
## Should I use this crate? ## Should I use this crate?
No, absolutely not. It doesn't even work yet. 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?
Cryptography is hard. Even if you have some knowledge about this topic and pay attention not no mess up, you will eventually mess-up anyway. 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 it becomes largely accessible.
Seriously, this crate is designed to prevent some of the most common pitfalls. If you don't see why you need this crate, you probably don't see those pitfalls and you will fall into it.
## Why is the context so important?
When correctly used, it prevents from a confused deputy attack. Chose wisely.
## Why has this crate not been audited by a security professional? ## Why has this crate not been audited by a security professional?