diff --git a/README.md b/README.md index f1ca115..fe1695b 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ This implementation currently only supports Keccak-f\[1600\] (the highest securi Example ------- -A simple [program](examples/basic.rs) that does authenticated encryption and decryption: +A simple [example](https://github.com/rozbb/strobe-rs/blob/master/examples/basic.rs) that does authenticated encryption and decryption: ```rust use strobe_rs::{SecParam, Strobe}; @@ -71,7 +71,7 @@ Default features flags: _none_ Feature flag list: * `std` — Implements `std::error::Error` for `AuthError`. -* `asm` — Enables an optimized assembly implementation of the Keccak permutation, if available. Assembly currently only exists for ARMv8. +* `asm` — Enables optimized assembly for the Keccak permutation, if available. Assembly currently only exists for ARMv8. * `serialize_secret_state` — Implements `serde`'s `Serialize` and `Deserialize` traits for the `Strobe` struct. **SECURITY NOTE**: Serializing Strobe state outputs security sensitive data that MUST be kept private. Treat the data as you would a private encryption/decryption key. For info on how to omit or include feature flags, see the [cargo docs on features](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#choosing-features). diff --git a/src/strobe.rs b/src/strobe.rs index ebcd218..e0d1c4f 100644 --- a/src/strobe.rs +++ b/src/strobe.rs @@ -59,9 +59,9 @@ impl core::fmt::Display for AuthError { } } -/// The main Strobe object. This is currently limited to using Keccak-f\[1600\] as the internal -/// permutation function. For more information on this object, the [protocol specification][spec] -/// is a great resource. +/// The main Strobe object. This is currently limited to using Keccak-f\[1600\] (the highest +/// security level) as the internal permutation function. For more information on this object, the +/// [protocol specification][spec] is a great resource. /// /// [spec]: https://strobe.sourceforge.io/specs/ ///