brndnmtthws / dryoc

Don't Roll Your Own Crypto: pure-Rust, hard to misuse cryptography library
https://docs.rs/dryoc
MIT License
267 stars 14 forks source link

[Bug]: mistake in documentation of DryocSecretBox #31

Closed ocalex86 closed 1 year ago

ocalex86 commented 1 year ago

What happened?

The description of a DryocSecretBox (https://docs.rs/dryoc/0.4.2/dryoc/dryocsecretbox/struct.DryocSecretBox.html) is incorrect. It says that it is a "public-key authenticated encrypted box". However, it is not a public key algorithm but a symmetric key one.

Version

0.4.2

Which OS are you seeing the problem on?

Linux

Test code

No response

brndnmtthws commented 1 year ago

You are correct, it looks like that was a copy/paste mistake :)