From e7a86834eb2217676a7a96db9364c4c1e350d45e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Nie=C3=9Fen?= Date: Tue, 21 Apr 2026 15:10:25 +0200 Subject: [PATCH] doc: fix Argon2 parameter bounds The bounds are supposed to be inclusive, not exclusive. --- doc/api/crypto.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/api/crypto.md b/doc/api/crypto.md index d0d58ea3c99278..27c437ddcf1916 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -3315,14 +3315,14 @@ added: v24.7.0 * `nonce` {string|ArrayBuffer|Buffer|TypedArray|DataView} REQUIRED, must be at least 8 bytes long. This is the salt for password hashing applications of Argon2. * `parallelism` {number} REQUIRED, degree of parallelism determines how many computational chains (lanes) - can be run. Must be greater than 1 and less than `2**24-1`. - * `tagLength` {number} REQUIRED, the length of the key to generate. Must be greater than 4 and - less than `2**32-1`. - * `memory` {number} REQUIRED, memory cost in 1KiB blocks. Must be greater than - `8 * parallelism` and less than `2**32-1`. The actual number of blocks is rounded + can be run. Must be at least `1` and at most `2**24-1`. + * `tagLength` {number} REQUIRED, the length of the key to generate. Must be at least `4` and + at most `2**32-1`. + * `memory` {number} REQUIRED, memory cost in 1KiB blocks. Must be at least + `8 * parallelism` and at most `2**32-1`. The actual number of blocks is rounded down to the nearest multiple of `4 * parallelism`. - * `passes` {number} REQUIRED, number of passes (iterations). Must be greater than 1 and less - than `2**32-1`. + * `passes` {number} REQUIRED, number of passes (iterations). Must be at least `1` and at most + `2**32-1`. * `secret` {string|ArrayBuffer|Buffer|TypedArray|DataView|undefined} OPTIONAL, Random additional input, similar to the salt, that should **NOT** be stored with the derived key. This is known as pepper in password hashing applications. If used, must have a length not greater than `2**32-1` bytes. @@ -3401,14 +3401,14 @@ added: v24.7.0 * `nonce` {string|ArrayBuffer|Buffer|TypedArray|DataView} REQUIRED, must be at least 8 bytes long. This is the salt for password hashing applications of Argon2. * `parallelism` {number} REQUIRED, degree of parallelism determines how many computational chains (lanes) - can be run. Must be greater than 1 and less than `2**24-1`. - * `tagLength` {number} REQUIRED, the length of the key to generate. Must be greater than 4 and - less than `2**32-1`. - * `memory` {number} REQUIRED, memory cost in 1KiB blocks. Must be greater than - `8 * parallelism` and less than `2**32-1`. The actual number of blocks is rounded + can be run. Must be at least 1 and at most `2**24-1`. + * `tagLength` {number} REQUIRED, the length of the key to generate. Must be at least `4` and + at most `2**32-1`. + * `memory` {number} REQUIRED, memory cost in 1KiB blocks. Must be at least + `8 * parallelism` and at most `2**32-1`. The actual number of blocks is rounded down to the nearest multiple of `4 * parallelism`. - * `passes` {number} REQUIRED, number of passes (iterations). Must be greater than 1 and less - than `2**32-1`. + * `passes` {number} REQUIRED, number of passes (iterations). Must be at least `1` and at most + `2**32-1`. * `secret` {string|ArrayBuffer|Buffer|TypedArray|DataView|undefined} OPTIONAL, Random additional input, similar to the salt, that should **NOT** be stored with the derived key. This is known as pepper in password hashing applications. If used, must have a length not greater than `2**32-1` bytes.