Skip to content

Commit

Permalink
fix documentation for struct Salt (#1316) (#1317)
Browse files Browse the repository at this point in the history
  • Loading branch information
hendrikboeck committed May 29, 2023
1 parent d6a6786 commit 40a0d2e
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions password-hash/src/salt.rs
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,14 @@ const INVARIANT_VIOLATED_MSG: &str = "salt string invariant violated";
/// guidelines from the spec:
///
/// - Minimum length: **4**-bytes
/// - Maximum length: **64**-bytes
/// - Maximum length: **48**-bytes
///
/// A maximum length is enforced based on the above recommendation for
/// supporting stack-allocated buffers (which this library uses), and the
/// specific determination of 64-bytes is taken as a best practice from the
/// specific determination of 48-bytes is taken as a best practice from the
/// [Argon2 Encoding][3] specification in the same document:
///
/// > The length in bytes of the salt is between 8 and 64 bytes<sup>†</sup>, thus
/// > The length in bytes of the salt is between 8 and 48 bytes<sup>†</sup>, thus
/// > yielding a length in characters between 11 and 64 characters (and that
/// > length is never equal to 1 modulo 4). The default byte length of the salt
/// > is 16 bytes (22 characters in B64 encoding). An encoded UUID, or a
Expand Down

0 comments on commit 40a0d2e

Please sign in to comment.