Commit 13f163e
doc: use secure key length for HMAC generateKey
The examples for generateKey() and generateKeySync() generate 64-bit
HMAC keys. That is inadequate for virtually any HMAC instance. As per
common NIST recommendations, the minimum should be roughly 112 bits, or
more commonly 128 bits.
Due to the design of HMAC itself, it is not unreasonable to choose the
underlying hash function's block size as the key length. For many
popular hash functions (SHA-256, SHA-224, SHA-1, MD5, ...) this happens
to be 64 bytes (bytes, not bits!). This is consistent with the HMAC
implementation in .NET, for example, even though it provides virtually
no benefit over a 256-bit key.
PR-URL: #48052
Reviewed-By: Filip Skokan <panva.ip@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>1 parent d95a5bb commit 13f163e
1 file changed
Lines changed: 4 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3648,7 +3648,7 @@ const { | |||
| 3648 | 3648 | generateKey, | |
| 3649 | 3649 | } = await import('node:crypto'); | |
| 3650 | 3650 | ||
| 3651 | - generateKey('hmac', { length: 64 }, (err, key) => { | ||
| 3651 | + generateKey('hmac', { length: 512 }, (err, key) => { | ||
| 3652 | 3652 | if (err) throw err; | |
| 3653 | 3653 | console.log(key.export().toString('hex')); // 46e..........620 | |
| 3654 | 3654 | }); | |
@@ -3659,7 +3659,7 @@ const { | |||
| 3659 | 3659 | generateKey, | |
| 3660 | 3660 | } = require('node:crypto'); | |
| 3661 | 3661 | ||
| 3662 | - generateKey('hmac', { length: 64 }, (err, key) => { | ||
| 3662 | + generateKey('hmac', { length: 512 }, (err, key) => { | ||
| 3663 | 3663 | if (err) throw err; | |
| 3664 | 3664 | console.log(key.export().toString('hex')); // 46e..........620 | |
| 3665 | 3665 | }); | |
@@ -3922,7 +3922,7 @@ const { | |||
| 3922 | 3922 | generateKeySync, | |
| 3923 | 3923 | } = await import('node:crypto'); | |
| 3924 | 3924 | ||
| 3925 | - const key = generateKeySync('hmac', { length: 64 }); | ||
| 3925 | + const key = generateKeySync('hmac', { length: 512 }); | ||
| 3926 | 3926 | console.log(key.export().toString('hex')); // e89..........41e | |
| 3927 | 3927 | ``` | |
| 3928 | 3928 | ||
@@ -3931,7 +3931,7 @@ const { | |||
| 3931 | 3931 | generateKeySync, | |
| 3932 | 3932 | } = require('node:crypto'); | |
| 3933 | 3933 | ||
| 3934 | - const key = generateKeySync('hmac', { length: 64 }); | ||
| 3934 | + const key = generateKeySync('hmac', { length: 512 }); | ||
| 3935 | 3935 | console.log(key.export().toString('hex')); // e89..........41e | |
| 3936 | 3936 | ``` | |
| 3937 | 3937 | ||
0 commit comments