-
Notifications
You must be signed in to change notification settings - Fork 154
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Added recommendation badges #619
Conversation
The badge takes too much space in my opinion. I think it's better to use something like the hashes security column. Also, I don't think we not use githubusercontent links in README. |
Hi, sorry for the long response. I changed it into a similar style. Is this okay? |
| 💛 | Theoretical break: security lower than claimed | | ||
| 💔 | Attack demonstrated in practice: avoid if at all possible | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if these are useful if they aren't in the table
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They might be useful for a later date if any of them are attacked.
| [`chacha20poly1305`] | [(X)ChaCha20Poly1305] | [![crates.io](https://img.shields.io/crates/v/chacha20poly1305.svg)](https://crates.io/crates/chacha20poly1305) | [![Documentation](https://docs.rs/chacha20poly1305/badge.svg)](https://docs.rs/chacha20poly1305) | 1.56 | 💚 | | ||
| [`deoxys`] | [Deoxys-I/II] | [![crates.io](https://img.shields.io/crates/v/deoxys.svg)](https://crates.io/crates/deoxys) | [![Documentation](https://docs.rs/deoxys/badge.svg)](https://docs.rs/deoxys) | 1.51 | 💚 | | ||
| [`eax`] | [EAX] | [![crates.io](https://img.shields.io/crates/v/eax.svg)](https://crates.io/crates/eax) | [![Documentation](https://docs.rs/eax/badge.svg)](https://docs.rs/eax) | 1.41 | 💚 | | ||
| [`mgm`] | [MGM] | [![crates.io](https://img.shields.io/crates/v/mgm.svg)](https://crates.io/crates/mgm) | [![Documentation](https://docs.rs/mgm/badge.svg)](https://docs.rs/mgm) | 1.41 | 🤍 | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why it's marked by 🤍? AFAIK it's the only AEAD algorithm standardized in Russia.
Overall, I am not sure about usefulness of this column in the current form. Right now it only indicates that CCM is an obsolete algorithm. Meanwhile, I personally would "recommend" to use SIV instead of GCM. |
Closing this for now. We need to develop a proper policy for recommending AEAD algorithms first. |
Added recommendation badges as per #272.