Skip to content

crypto: add TurboSHAKE and KangarooTwelve Web Cryptography algorithms #62183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
panva wants to merge 5 commits into
base: main
Choose a base branch
from
Open

crypto: add TurboSHAKE and KangarooTwelve Web Cryptography algorithms #62183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f80cc1b
crypto: add TurboSHAKE and KangarooTwelve Web Cryptography algorithms
panva Mar 10, 2026
dfeb507
fixup! crypto: add TurboSHAKE and KangarooTwelve Web Cryptography alg…
panva Mar 10, 2026
e5d2566
fixup! crypto: add TurboSHAKE and KangarooTwelve Web Cryptography alg…
panva Mar 10, 2026
4408757
fixup! crypto: add TurboSHAKE and KangarooTwelve Web Cryptography alg…
panva Mar 10, 2026
95d3e32
fixup! crypto: add TurboSHAKE and KangarooTwelve Web Cryptography alg…
panva Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 85 additions & 1 deletion doc/api/webcrypto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

<!-- YAML
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/62183
description: TurboSHAKE and KangarooTwelve algorithms
are now supported.
- version: v24.8.0
pr-url: https://github.com/nodejs/node/pull/59647
description: KMAC algorithms are now supported.
Expand Down Expand Up @@ -122,6 +126,8 @@ Algorithms:
* `'cSHAKE256'`
* `'KMAC128'`[^openssl30]
* `'KMAC256'`[^openssl30]
* `'KT128'`
* `'KT256'`
* `'ML-DSA-44'`[^openssl35]
* `'ML-DSA-65'`[^openssl35]
* `'ML-DSA-87'`[^openssl35]
Expand All @@ -131,6 +137,8 @@ Algorithms:
* `'SHA3-256'`
* `'SHA3-384'`
* `'SHA3-512'`
* `'TurboSHAKE128'`
* `'TurboSHAKE256'`

Key Formats:

Expand Down Expand Up @@ -575,6 +583,8 @@ implementation and the APIs supported for each:
| `'HMAC'` | | ✔ | | | | |
| `'KMAC128'`[^modern-algos] | | ✔ | | | | |
| `'KMAC256'`[^modern-algos] | | ✔ | | | | |
| `'KT128'`[^modern-algos] | | | | | | ✔ |
| `'KT256'`[^modern-algos] | | | | | | ✔ |
| `'ML-DSA-44'`[^modern-algos] | | ✔ | | | | |
| `'ML-DSA-65'`[^modern-algos] | | ✔ | | | | |
| `'ML-DSA-87'`[^modern-algos] | | ✔ | | | | |
Expand All @@ -592,6 +602,8 @@ implementation and the APIs supported for each:
| `'SHA3-256'`[^modern-algos] | | | | | | ✔ |
| `'SHA3-384'`[^modern-algos] | | | | | | ✔ |
| `'SHA3-512'`[^modern-algos] | | | | | | ✔ |
| `'TurboSHAKE128'`[^modern-algos] | | | | | | ✔ |
| `'TurboSHAKE256'`[^modern-algos] | | | | | | ✔ |
| `'X25519'` | | | ✔ | | | |
| `'X448'`[^secure-curves] | | | ✔ | | | |
Expand Down Expand Up @@ -999,6 +1011,10 @@ The algorithms currently supported include:
<!-- YAML
added: v15.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/62183
description: TurboSHAKE and KangarooTwelve algorithms
are now supported.
- version: v24.7.0
pr-url: https://github.com/nodejs/node/pull/59365
description: SHA-3 algorithms are now supported.
Expand All @@ -1007,7 +1023,7 @@ changes:
description: SHAKE algorithms are now supported.
-->
* `algorithm` {string|Algorithm|CShakeParams}
* `algorithm` {string|Algorithm|CShakeParams|TurboShakeParams|KangarooTwelveParams}
* `data` {ArrayBuffer|TypedArray|DataView|Buffer}
* Returns: {Promise} Fulfills with an {ArrayBuffer} upon success.
Expand All @@ -1019,13 +1035,17 @@ If `algorithm` is provided as a {string}, it must be one of:
* `'cSHAKE128'`[^modern-algos]
* `'cSHAKE256'`[^modern-algos]
* `'KT128'`[^modern-algos]
* `'KT256'`[^modern-algos]
* `'SHA-1'`
* `'SHA-256'`
* `'SHA-384'`
* `'SHA-512'`
* `'SHA3-256'`[^modern-algos]
* `'SHA3-384'`[^modern-algos]
* `'SHA3-512'`[^modern-algos]
* `'TurboSHAKE128'`[^modern-algos]
* `'TurboSHAKE256'`[^modern-algos]
If `algorithm` is provided as an {Object}, it must have a `name` property
whose value is one of the above.
Expand Down Expand Up @@ -2308,6 +2328,38 @@ added: v15.0.0
* Type: {string}
### Class: `KangarooTwelveParams`
<!-- YAML
added: REPLACEME
-->
#### `kangarooTwelveParams.customization`
<!-- YAML
added: REPLACEME
-->
* Type: {ArrayBuffer|TypedArray|DataView|Buffer|undefined}
The optional customization string for KangarooTwelve.
#### `kangarooTwelveParams.name`
<!-- YAML
added: REPLACEME
-->
* Type: {string} Must be `'KT128'`[^modern-algos] or `'KT256'`[^modern-algos]
#### `kangarooTwelveParams.outputLength`
<!-- YAML
added: REPLACEME
-->
* Type: {number} represents the requested output length in bits.
### Class: `KmacImportParams`
<!-- YAML
Expand Down Expand Up @@ -2674,6 +2726,38 @@ added: v15.0.0
The length (in bytes) of the random salt to use.
### Class: `TurboShakeParams`
<!-- YAML
added: REPLACEME
-->
#### `turboShakeParams.domainSeparation`
<!-- YAML
added: REPLACEME
-->
* Type: {number|undefined}
The optional domain separation byte (0x01-0x7f). Defaults to `0x1f`.
#### `turboShakeParams.name`
<!-- YAML
added: REPLACEME
-->
* Type: {string} Must be `'TurboSHAKE128'`[^modern-algos] or `'TurboSHAKE256'`[^modern-algos]
#### `turboShakeParams.outputLength`
<!-- YAML
added: REPLACEME
-->
* Type: {number} represents the requested output length in bits.
[^secure-curves]: See [Secure Curves in the Web Cryptography API][]
[^modern-algos]: See [Modern Algorithms in the Web Cryptography API][]
Expand Down
20 changes: 20 additions & 0 deletions lib/internal/crypto/hash.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ const {
Hmac: _Hmac,
kCryptoJobAsync,
oneShotDigest,
TurboShakeJob,
KangarooTwelveJob,
} = internalBinding('crypto');

const {
Expand Down Expand Up @@ -224,6 +226,24 @@ async function asyncDigest(algorithm, data) {
normalizeHashName(algorithm.name),
data,
algorithm.length));
case 'TurboSHAKE128':
// Fall through
case 'TurboSHAKE256':
return await jobPromise(() => new TurboShakeJob(
kCryptoJobAsync,
algorithm.name,
algorithm.domainSeparation ?? 0x1f,
algorithm.outputLength / 8,
data));
case 'KT128':
// Fall through
case 'KT256':
return await jobPromise(() => new KangarooTwelveJob(
kCryptoJobAsync,
algorithm.name,
algorithm.customization,
algorithm.outputLength / 8,
data));
}

throw lazyDOMException('Unrecognized algorithm name', 'NotSupportedError');
Expand Down
12 changes: 12 additions & 0 deletions lib/internal/crypto/util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,10 @@ const kAlgorithmDefinitions = {
},
'cSHAKE128': { 'digest': 'CShakeParams' },
'cSHAKE256': { 'digest': 'CShakeParams' },
'KT128': { 'digest': 'KangarooTwelveParams' },
'KT256': { 'digest': 'KangarooTwelveParams' },
'TurboSHAKE128': { 'digest': 'TurboShakeParams' },
'TurboSHAKE256': { 'digest': 'TurboShakeParams' },
'ECDH': {
'generateKey': 'EcKeyGenParams',
'exportKey': null,
Expand Down Expand Up @@ -441,6 +445,10 @@ const experimentalAlgorithms = [
'SHA3-256',
'SHA3-384',
'SHA3-512',
'TurboSHAKE128',
'TurboSHAKE256',
'KT128',
'KT256',
'X448',
];

Expand Down Expand Up @@ -513,6 +521,10 @@ const simpleAlgorithmDictionaries = {
KmacParams: {
customization: 'BufferSource',
},
KangarooTwelveParams: {
customization: 'BufferSource',
},
TurboShakeParams: {},
};

function validateMaxBufferLength(data, name) {
Expand Down
46 changes: 46 additions & 0 deletions lib/internal/crypto/webidl.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -895,6 +895,52 @@ converters.KmacParams = createDictionaryConverter(
},
]);

converters.KangarooTwelveParams = createDictionaryConverter(
'KangarooTwelveParams', [
...new SafeArrayIterator(dictAlgorithm),
{
key: 'outputLength',
converter: (V, opts) =>
converters['unsigned long'](V, { ...opts, enforceRange: true }),
validator: (V, opts) => {
if (V === 0 || V % 8)
throw lazyDOMException('Invalid KangarooTwelveParams outputLength', 'OperationError');
},
required: true,
},
{
key: 'customization',
converter: converters.BufferSource,
},
]);

converters.TurboShakeParams = createDictionaryConverter(
'TurboShakeParams', [
...new SafeArrayIterator(dictAlgorithm),
{
key: 'outputLength',
converter: (V, opts) =>
converters['unsigned long'](V, { ...opts, enforceRange: true }),
validator: (V, opts) => {
if (V === 0 || V % 8)
throw lazyDOMException('Invalid TurboShakeParams outputLength', 'OperationError');
},
required: true,
},
{
key: 'domainSeparation',
converter: (V, opts) =>
converters.octet(V, { ...opts, enforceRange: true }),
validator: (V) => {
if (V < 0x01 || V > 0x7F) {
throw lazyDOMException(
'TurboShakeParams.domainSeparation must be in range 0x01-0x7f',
'OperationError');
}
},
},
]);

module.exports = {
converters,
requiredArguments,
Expand Down
2 changes: 2 additions & 0 deletions node.gyp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,7 @@
'src/crypto/crypto_kem.cc',
'src/crypto/crypto_hmac.cc',
'src/crypto/crypto_kmac.cc',
'src/crypto/crypto_turboshake.cc',
'src/crypto/crypto_random.cc',
'src/crypto/crypto_rsa.cc',
'src/crypto/crypto_spkac.cc',
Expand All @@ -408,6 +409,7 @@
'src/crypto/crypto_dh.h',
'src/crypto/crypto_hmac.h',
'src/crypto/crypto_kmac.h',
'src/crypto/crypto_turboshake.h',
'src/crypto/crypto_rsa.h',
'src/crypto/crypto_spkac.h',
'src/crypto/crypto_util.h',
Expand Down
Loading
Loading