Skip to content
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

Closed
wants to merge 2 commits into from

Conversation

somehybrid
Copy link

Added recommendation badges as per #272.

@newpavlov
Copy link
Member

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.

@somehybrid
Copy link
Author

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?

Comment on lines +36 to +37
| 💛 | Theoretical break: security lower than claimed |
| 💔 | Attack demonstrated in practice: avoid if at all possible |
Copy link
Member

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

Copy link
Author

@somehybrid somehybrid Aug 2, 2024

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 | 🤍 |
Copy link
Member

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.

@newpavlov
Copy link
Member

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.

@newpavlov
Copy link
Member

Closing this for now. We need to develop a proper policy for recommending AEAD algorithms first.

@newpavlov newpavlov closed this Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants