FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc,lib: align WebCrypto names with spec · nodejs/node@1a4edb3 · GitHub

/ node Public

Commit 1a4edb3

Browse files
panva
authored and
aduh95
committed
doc,lib: align WebCrypto names with spec
Rename WebCrypto operation parameters and local variables to match the spec terminology. Use operation, algorithm, and key names consistently between the docs and implementation. Signed-off-by: Filip Skokan <panva.ip@gmail.com> PR-URL: #63518 Reviewed-By: René <contact.9a5d6388@renegade334.me.uk> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent 56bdd87 commit 1a4edb3

10 files changed

Lines changed: 327 additions & 226 deletions

File tree

‎doc/api/webcrypto.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -848,7 +848,7 @@ The algorithms currently supported include:
848848
* `'ML-KEM-768'`[^modern-algos]
849849
* `'ML-KEM-1024'`[^modern-algos]
850850
851-
### `subtle.decapsulateKey(decapsulationAlgorithm, decapsulationKey, ciphertext, sharedKeyAlgorithm, extractable, usages)`
851+
### `subtle.decapsulateKey(decapsulationAlgorithm, decapsulationKey, ciphertext, sharedKeyAlgorithm, extractable, keyUsages)`
852852
853853
<!-- YAML
854854
added: v24.7.0
@@ -861,7 +861,7 @@ added: v24.7.0
861861
* `ciphertext` {ArrayBuffer|TypedArray|DataView|Buffer}
862862
* `sharedKeyAlgorithm` {string|Algorithm|HmacImportParams|AesDerivedKeyParams|KmacImportParams}
863863
* `extractable` {boolean}
864-
* `usages` {string\[]} See [Key usages][].
864+
* `keyUsages` {string\[]} See [Key usages][].
865865
* Returns: {Promise} Fulfills with {CryptoKey} upon success.
866866
867867
A message recipient uses their asymmetric private key to decrypt an
@@ -959,7 +959,7 @@ The algorithms currently supported include:
959959
* `'X25519'`
960960
* `'X448'`[^secure-curves]
961961
962-
### `subtle.deriveKey(algorithm, baseKey, derivedKeyAlgorithm, extractable, keyUsages)`
962+
### `subtle.deriveKey(algorithm, baseKey, derivedKeyType, extractable, keyUsages)`
963963
964964
<!-- YAML
965965
added: v15.0.0
@@ -978,7 +978,7 @@ changes:
978978
979979
* `algorithm` {EcdhKeyDeriveParams|HkdfParams|Pbkdf2Params|Argon2Params}
980980
* `baseKey` {CryptoKey}
981-
* `derivedKeyAlgorithm` {string|Algorithm|HmacImportParams|AesDerivedKeyParams|KmacImportParams}
981+
* `derivedKeyType` {string|Algorithm|HmacImportParams|AesDerivedKeyParams|KmacImportParams}
982982
* `extractable` {boolean}
983983
* `keyUsages` {string\[]} See [Key usages][].
984984
* Returns: {Promise} Fulfills with a {CryptoKey} upon success.
@@ -987,11 +987,11 @@ changes:
987987
988988
Using the method and parameters specified in `algorithm`, and the keying
989989
material provided by `baseKey`, this method attempts to generate
990-
a new {CryptoKey} based on the method and parameters in `derivedKeyAlgorithm`.
990+
a new {CryptoKey} based on the method and parameters in `derivedKeyType`.
991991
992992
Calling this method is equivalent to calling [`subtle.deriveBits()`][] to
993993
generate raw keying material, then passing the result into the
994-
[`subtle.importKey()`][] method using the `derivedKeyAlgorithm`, `extractable`, and
994+
[`subtle.importKey()`][] method using the `derivedKeyType`, `extractable`, and
995995
`keyUsages` parameters as input.
996996
997997
The algorithms currently supported include:
@@ -1070,7 +1070,7 @@ The algorithms currently supported include:
10701070
* `'ML-KEM-768'`[^modern-algos]
10711071
* `'ML-KEM-1024'`[^modern-algos]
10721072
1073-
### `subtle.encapsulateKey(encapsulationAlgorithm, encapsulationKey, sharedKeyAlgorithm, extractable, usages)`
1073+
### `subtle.encapsulateKey(encapsulationAlgorithm, encapsulationKey, sharedKeyAlgorithm, extractable, keyUsages)`
10741074
10751075
<!-- YAML
10761076
added: v24.7.0
@@ -1082,7 +1082,7 @@ added: v24.7.0
10821082
* `encapsulationKey` {CryptoKey}
10831083
* `sharedKeyAlgorithm` {string|Algorithm|HmacImportParams|AesDerivedKeyParams|KmacImportParams}
10841084
* `extractable` {boolean}
1085-
* `usages` {string\[]} See [Key usages][].
1085+
* `keyUsages` {string\[]} See [Key usages][].
10861086
* Returns: {Promise} Fulfills with {EncapsulatedKey} upon success.
10871087
10881088
Uses a message recipient's asymmetric public key to encrypt a temporary symmetric key.
@@ -1414,7 +1414,7 @@ The algorithms currently supported include:
14141414
* `'RSA-PSS'`
14151415
* `'RSASSA-PKCS1-v1_5'`
14161416
1417-
### `subtle.unwrapKey(format, wrappedKey, unwrappingKey, unwrapAlgo, unwrappedKeyAlgo, extractable, keyUsages)`
1417+
### `subtle.unwrapKey(format, wrappedKey, unwrappingKey, unwrapAlgorithm, unwrappedKeyAlgorithm, extractable, keyUsages)`
14181418
14191419
<!-- YAML
14201420
added: v15.0.0
@@ -1434,8 +1434,8 @@ changes:
14341434
14351435
<!--lint disable maximum-line-length remark-lint-->
14361436
1437-
* `unwrapAlgo` {string|Algorithm|RsaOaepParams|AesCtrParams|AesCbcParams|AeadParams}
1438-
* `unwrappedKeyAlgo` {string|Algorithm|RsaHashedImportParams|EcKeyImportParams|HmacImportParams|KmacImportParams}
1437+
* `unwrapAlgorithm` {string|Algorithm|RsaOaepParams|AesCtrParams|AesCbcParams|AeadParams}
1438+
* `unwrappedKeyAlgorithm` {string|Algorithm|RsaHashedImportParams|EcKeyImportParams|HmacImportParams|KmacImportParams}
14391439
14401440
<!--lint enable maximum-line-length remark-lint-->
14411441
@@ -1447,8 +1447,8 @@ In cryptography, "wrapping a key" refers to exporting and then encrypting the
14471447
keying material. This method attempts to decrypt a wrapped
14481448
key and create a {CryptoKey} instance. It is equivalent to calling
14491449
[`subtle.decrypt()`][] first on the encrypted key data (using the `wrappedKey`,
1450-
`unwrapAlgo`, and `unwrappingKey` arguments as input) then passing the results
1451-
to the [`subtle.importKey()`][] method using the `unwrappedKeyAlgo`,
1450+
`unwrapAlgorithm`, and `unwrappingKey` arguments as input) then passing the results
1451+
to the [`subtle.importKey()`][] method using the `unwrappedKeyAlgorithm`,
14521452
`extractable`, and `keyUsages` arguments as inputs. If successful, the returned
14531453
promise is resolved with a {CryptoKey} object.
14541454
@@ -1536,7 +1536,7 @@ The algorithms currently supported include:
15361536
* `'RSA-PSS'`
15371537
* `'RSASSA-PKCS1-v1_5'`
15381538
1539-
### `subtle.wrapKey(format, key, wrappingKey, wrapAlgo)`
1539+
### `subtle.wrapKey(format, key, wrappingKey, wrapAlgorithm)`
15401540
15411541
<!-- YAML
15421542
added: v15.0.0
@@ -1555,18 +1555,18 @@ changes:
15551555
`'raw-public'`[^modern-algos], or `'raw-seed'`[^modern-algos].
15561556
* `key` {CryptoKey}
15571557
* `wrappingKey` {CryptoKey}
1558-
* `wrapAlgo` {string|Algorithm|RsaOaepParams|AesCtrParams|AesCbcParams|AeadParams}
1558+
* `wrapAlgorithm` {string|Algorithm|RsaOaepParams|AesCtrParams|AesCbcParams|AeadParams}
15591559
* Returns: {Promise} Fulfills with an {ArrayBuffer} upon success.
15601560
15611561
<!--lint enable maximum-line-length remark-lint-->
15621562
15631563
In cryptography, "wrapping a key" refers to exporting and then encrypting the
15641564
keying material. This method exports the keying material into
15651565
the format identified by `format`, then encrypts it using the method and
1566-
parameters specified by `wrapAlgo` and the keying material provided by
1566+
parameters specified by `wrapAlgorithm` and the keying material provided by
15671567
`wrappingKey`. It is the equivalent to calling [`subtle.exportKey()`][] using
15681568
`format` and `key` as the arguments, then passing the result to the
1569-
[`subtle.encrypt()`][] method using `wrappingKey` and `wrapAlgo` as inputs. If
1569+
[`subtle.encrypt()`][] method using `wrappingKey` and `wrapAlgorithm` as inputs. If
15701570
successful, the returned promise will be resolved with an {ArrayBuffer}
15711571
containing the encrypted key data.
15721572
@@ -2794,19 +2794,19 @@ added: v24.18.0
27942794
[Web Crypto API]: https://www.w3.org/TR/WebCryptoAPI/
27952795
[`SubtleCrypto.supports()`]: #static-method-subtlecryptosupportsoperation-algorithm-lengthoradditionalalgorithm
27962796
[`subtle.decapsulateBits()`]: #subtledecapsulatebitsdecapsulationalgorithm-decapsulationkey-ciphertext
2797-
[`subtle.decapsulateKey()`]: #subtledecapsulatekeydecapsulationalgorithm-decapsulationkey-ciphertext-sharedkeyalgorithm-extractable-usages
2797+
[`subtle.decapsulateKey()`]: #subtledecapsulatekeydecapsulationalgorithm-decapsulationkey-ciphertext-sharedkeyalgorithm-extractable-keyusages
27982798
[`subtle.decrypt()`]: #subtledecryptalgorithm-key-data
27992799
[`subtle.deriveBits()`]: #subtlederivebitsalgorithm-basekey-length
2800-
[`subtle.deriveKey()`]: #subtlederivekeyalgorithm-basekey-derivedkeyalgorithm-extractable-keyusages
2800+
[`subtle.deriveKey()`]: #subtlederivekeyalgorithm-basekey-derivedkeytype-extractable-keyusages
28012801
[`subtle.digest()`]: #subtledigestalgorithm-data
28022802
[`subtle.encapsulateBits()`]: #subtleencapsulatebitsencapsulationalgorithm-encapsulationkey
2803-
[`subtle.encapsulateKey()`]: #subtleencapsulatekeyencapsulationalgorithm-encapsulationkey-sharedkeyalgorithm-extractable-usages
2803+
[`subtle.encapsulateKey()`]: #subtleencapsulatekeyencapsulationalgorithm-encapsulationkey-sharedkeyalgorithm-extractable-keyusages
28042804
[`subtle.encrypt()`]: #subtleencryptalgorithm-key-data
28052805
[`subtle.exportKey()`]: #subtleexportkeyformat-key
28062806
[`subtle.generateKey()`]: #subtlegeneratekeyalgorithm-extractable-keyusages
28072807
[`subtle.getPublicKey()`]: #subtlegetpublickeykey-keyusages
28082808
[`subtle.importKey()`]: #subtleimportkeyformat-keydata-algorithm-extractable-keyusages
28092809
[`subtle.sign()`]: #subtlesignalgorithm-key-data
2810-
[`subtle.unwrapKey()`]: #subtleunwrapkeyformat-wrappedkey-unwrappingkey-unwrapalgo-unwrappedkeyalgo-extractable-keyusages
2810+
[`subtle.unwrapKey()`]: #subtleunwrapkeyformat-wrappedkey-unwrappingkey-unwrapalgorithm-unwrappedkeyalgorithm-extractable-keyusages
28112811
[`subtle.verify()`]: #subtleverifyalgorithm-key-signature-data
2812-
[`subtle.wrapKey()`]: #subtlewrapkeyformat-key-wrappingkey-wrapalgo
2812+
[`subtle.wrapKey()`]: #subtlewrapkeyformat-key-wrappingkey-wrapalgorithm

‎lib/internal/crypto/aes.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -175,14 +175,14 @@ function aesCipher(mode, key, data, algorithm) {
175175
}
176176
}
177177

178-
function aesGenerateKey(algorithm, extractable, keyUsages) {
178+
function aesGenerateKey(algorithm, extractable, usages) {
179179
const { name, length } = algorithm;
180180

181181
const checkUsages = ['wrapKey', 'unwrapKey'];
182182
if (name !== 'AES-KW')
183183
ArrayPrototypePush(checkUsages, 'encrypt', 'decrypt');
184184

185-
const usagesSet = new SafeSet(keyUsages);
185+
const usagesSet = new SafeSet(usages);
186186
if (hasAnyNotIn(usagesSet, checkUsages)) {
187187
throw lazyDOMException(
188188
'Unsupported key usage for an AES key',
@@ -207,13 +207,13 @@ function aesImportKey(
207207
format,
208208
keyData,
209209
extractable,
210-
keyUsages) {
210+
usages) {
211211
const { name } = algorithm;
212212
const checkUsages = ['wrapKey', 'unwrapKey'];
213213
if (name !== 'AES-KW')
214214
ArrayPrototypePush(checkUsages, 'encrypt', 'decrypt');
215215

216-
const usagesSet = new SafeSet(keyUsages);
216+
const usagesSet = new SafeSet(usages);
217217
if (hasAnyNotIn(usagesSet, checkUsages)) {
218218
throw lazyDOMException(
219219
'Unsupported key usage for an AES key',

‎lib/internal/crypto/cfrg.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,10 @@ function verifyAcceptableCfrgKeyUse(name, isPublic, usages) {
7575
}
7676
}
7777

78-
function cfrgGenerateKey(algorithm, extractable, keyUsages) {
78+
function cfrgGenerateKey(algorithm, extractable, usages) {
7979
const { name } = algorithm;
8080

81-
const usageSet = new SafeSet(keyUsages);
81+
const usageSet = new SafeSet(usages);
8282
switch (name) {
8383
case 'Ed25519':
8484
// Fall through
@@ -172,11 +172,11 @@ function cfrgImportKey(
172172
keyData,
173173
algorithm,
174174
extractable,
175-
keyUsages) {
175+
usages) {
176176

177177
const { name } = algorithm;
178178
let handle;
179-
const usagesSet = new SafeSet(keyUsages);
179+
const usagesSet = new SafeSet(usages);
180180
switch (format) {
181181
case 'KeyObject': {
182182
verifyAcceptableCfrgKeyUse(

‎lib/internal/crypto/chacha20_poly1305.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ function c20pCipher(mode, key, data, algorithm) {
4747
algorithm.additionalData));
4848
}
4949

50-
function c20pGenerateKey(algorithm, extractable, keyUsages) {
50+
function c20pGenerateKey(algorithm, extractable, usages) {
5151
const { name } = algorithm;
5252

5353
const checkUsages = ['encrypt', 'decrypt', 'wrapKey', 'unwrapKey'];
5454

55-
const usagesSet = new SafeSet(keyUsages);
55+
const usagesSet = new SafeSet(usages);
5656
if (hasAnyNotIn(usagesSet, checkUsages)) {
5757
throw lazyDOMException(
5858
`Unsupported key usage for a ${algorithm.name} key`,
@@ -77,11 +77,11 @@ function c20pImportKey(
7777
format,
7878
keyData,
7979
extractable,
80-
keyUsages) {
80+
usages) {
8181
const { name } = algorithm;
8282
const checkUsages = ['encrypt', 'decrypt', 'wrapKey', 'unwrapKey'];
8383

84-
const usagesSet = new SafeSet(keyUsages);
84+
const usagesSet = new SafeSet(usages);
8585
if (hasAnyNotIn(usagesSet, checkUsages)) {
8686
throw lazyDOMException(
8787
`Unsupported key usage for a ${algorithm.name} key`,

‎lib/internal/crypto/ec.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,10 @@ function verifyAcceptableEcKeyUse(name, isPublic, usages) {
7777
}
7878
}
7979

80-
function ecGenerateKey(algorithm, extractable, keyUsages) {
80+
function ecGenerateKey(algorithm, extractable, usages) {
8181
const { name, namedCurve } = algorithm;
8282

83-
const usageSet = new SafeSet(keyUsages);
83+
const usageSet = new SafeSet(usages);
8484
switch (name) {
8585
case 'ECDSA':
8686
if (hasAnyNotIn(usageSet, ['sign', 'verify'])) {
@@ -178,12 +178,12 @@ function ecImportKey(
178178
keyData,
179179
algorithm,
180180
extractable,
181-
keyUsages,
181+
usages,
182182
) {
183183
const { name, namedCurve } = algorithm;
184184

185185
let handle;
186-
const usagesSet = new SafeSet(keyUsages);
186+
const usagesSet = new SafeSet(usages);
187187
switch (format) {
188188
case 'KeyObject': {
189189
verifyAcceptableEcKeyUse(

‎lib/internal/crypto/mac.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,14 @@ const {
4040
validateJwk,
4141
} = require('internal/crypto/webcrypto_util');
4242

43-
function hmacGenerateKey(algorithm, extractable, keyUsages) {
43+
function hmacGenerateKey(algorithm, extractable, usages) {
4444
const {
4545
hash,
4646
name,
4747
length = getBlockSize(hash.name),
4848
} = algorithm;
4949

50-
const usageSet = new SafeSet(keyUsages);
50+
const usageSet = new SafeSet(usages);
5151
if (hasAnyNotIn(usageSet, ['sign', 'verify'])) {
5252
throw lazyDOMException(
5353
'Unsupported key usage for an HMAC key',
@@ -67,7 +67,7 @@ function hmacGenerateKey(algorithm, extractable, keyUsages) {
6767
extractable));
6868
}
6969

70-
function kmacGenerateKey(algorithm, extractable, keyUsages) {
70+
function kmacGenerateKey(algorithm, extractable, usages) {
7171
const {
7272
name,
7373
length = {
@@ -77,7 +77,7 @@ function kmacGenerateKey(algorithm, extractable, keyUsages) {
7777
}[name],
7878
} = algorithm;
7979

80-
const usageSet = new SafeSet(keyUsages);
80+
const usageSet = new SafeSet(usages);
8181
if (hasAnyNotIn(usageSet, ['sign', 'verify'])) {
8282
throw lazyDOMException(
8383
`Unsupported key usage for ${name} key`,
@@ -102,10 +102,10 @@ function macImportKey(
102102
keyData,
103103
algorithm,
104104
extractable,
105-
keyUsages,
105+
usages,
106106
) {
107107
const isHmac = algorithm.name === 'HMAC';
108-
const usagesSet = new SafeSet(keyUsages);
108+
const usagesSet = new SafeSet(usages);
109109
if (hasAnyNotIn(usagesSet, ['sign', 'verify'])) {
110110
throw lazyDOMException(
111111
`Unsupported key usage for ${algorithm.name} key`,

‎lib/internal/crypto/ml_dsa.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,10 @@ function verifyAcceptableMlDsaKeyUse(name, isPublic, usages) {
6363
}
6464
}
6565

66-
function mlDsaGenerateKey(algorithm, extractable, keyUsages) {
66+
function mlDsaGenerateKey(algorithm, extractable, usages) {
6767
const { name } = algorithm;
6868

69-
const usageSet = new SafeSet(keyUsages);
69+
const usageSet = new SafeSet(usages);
7070
if (hasAnyNotIn(usageSet, ['sign', 'verify'])) {
7171
throw lazyDOMException(
7272
`Unsupported key usage for an ${name} key`,
@@ -144,11 +144,11 @@ function mlDsaImportKey(
144144
keyData,
145145
algorithm,
146146
extractable,
147-
keyUsages) {
147+
usages) {
148148

149149
const { name } = algorithm;
150150
let handle;
151-
const usagesSet = new SafeSet(keyUsages);
151+
const usagesSet = new SafeSet(usages);
152152
switch (format) {
153153
case 'KeyObject': {
154154
verifyAcceptableMlDsaKeyUse(

‎lib/internal/crypto/ml_kem.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ const {
5151
validateJwk,
5252
} = require('internal/crypto/webcrypto_util');
5353

54-
function mlKemGenerateKey(algorithm, extractable, keyUsages) {
54+
function mlKemGenerateKey(algorithm, extractable, usages) {
5555
const { name } = algorithm;
5656

57-
const usageSet = new SafeSet(keyUsages);
57+
const usageSet = new SafeSet(usages);
5858
if (hasAnyNotIn(usageSet, ['encapsulateKey', 'encapsulateBits', 'decapsulateKey', 'decapsulateBits'])) {
5959
throw lazyDOMException(
6060
`Unsupported key usage for an ${name} key`,
@@ -143,11 +143,11 @@ function mlKemImportKey(
143143
keyData,
144144
algorithm,
145145
extractable,
146-
keyUsages) {
146+
usages) {
147147

148148
const { name } = algorithm;
149149
let handle;
150-
const usagesSet = new SafeSet(keyUsages);
150+
const usagesSet = new SafeSet(usages);
151151
switch (format) {
152152
case 'KeyObject': {
153153
verifyAcceptableMlKemKeyUse(

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL