RustCrypto / RustCrypto/block-ciphers
Link to recommended high-level crates in rustdoc.
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 784
- Forks
- 157
- Avg merge
- 15h 24m
- Merged PRs (30d)
- 9
Description
I wanted to encrypt something using AES in my app so I found the aes crate on docs.rs. It mentions the following:
⚠️ Security Warning: Hazmat!
This crate implements only the low-level block cipher function, and is intended for use for implementing higher-level constructions only. It is NOT intended for direct use in applications.USE AT YOUR OWN RISK!
It's good that this warning is here, but it does not point the user to the high-level crate they should use instead. It would be nice if it did, like how the README of this repo does.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the aes crate's rustdoc security warning with the repository README, which already demonstrates the desired high-level recommendation. Identify the rustdoc location for that warning and add an appropriate link to the recommended high-level crate; the warning should guide application users away from direct low-level use.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cryptography, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100