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

crypto: share WebCrypto method and usage helpers · nodejs/node@788a66e · GitHub

/ node Public

Commit 788a66e

Browse files
panva
authored and
aduh95
committed
crypto: share WebCrypto method and usage helpers
Introduce prepareSubtleMethod() and convertSubtleArgument() for the common SubtleCrypto call prelude. Methods now reuse the same receiver check, required-argument check, error prefix construction, argument context selection, and WebIDL conversion path. Introduce WebCrypto key usage helpers for common usage validation and key pair usage splitting. Algorithm modules now define their allowed public, private, and key generation usages once, then call the shared helpers from generateKey() and importKey() paths. This removes repeated function-invocation setup in webcrypto.js and repeated key usage checks across the WebCrypto algorithm modules while preserving the existing validation behavior. Mark normalized-algorithm fallback branches as unreachable assertions. Signed-off-by: Filip Skokan <panva.ip@gmail.com> PR-URL: #63975 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
1 parent b62d569 commit 788a66e

12 files changed

Lines changed: 541 additions & 772 deletions

File tree

‎lib/internal/crypto/aes.js‎

Lines changed: 17 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,5 @@
11
'use strict';
22

3-
const {
4-
ArrayPrototypePush,
5-
SafeSet,
6-
} = primordials;
7-
83
const {
94
AESCipherJob,
105
kCryptoJobWebCrypto,
@@ -28,7 +23,6 @@ const {
2823

2924
const {
3025
getUsagesMask,
31-
hasAnyNotIn,
3226
jobPromise,
3327
} = require('internal/crypto/util');
3428

@@ -46,8 +40,22 @@ const {
4640
importJwkSecretKey,
4741
importSecretKey,
4842
validateJwk,
43+
validateKeyUsages,
44+
validateUsagesNotEmpty,
4945
} = require('internal/crypto/webcrypto_util');
5046

47+
const kCipherUsages = ['encrypt', 'decrypt', 'wrapKey', 'unwrapKey'];
48+
const kWrapUsages = ['wrapKey', 'unwrapKey'];
49+
50+
const kUsages = {
51+
'__proto__': null,
52+
'AES-CBC': kCipherUsages,
53+
'AES-CTR': kCipherUsages,
54+
'AES-GCM': kCipherUsages,
55+
'AES-KW': kWrapUsages,
56+
'AES-OCB': kCipherUsages,
57+
};
58+
5159
function getAlgorithmName(name, length) {
5260
switch (name) {
5361
case 'AES-CBC': return `A${length}CBC`;
@@ -176,21 +184,8 @@ function aesCipher(mode, key, data, algorithm) {
176184
function aesGenerateKey(algorithm, extractable, usages) {
177185
const { name, length } = algorithm;
178186

179-
const checkUsages = ['wrapKey', 'unwrapKey'];
180-
if (name !== 'AES-KW')
181-
ArrayPrototypePush(checkUsages, 'encrypt', 'decrypt');
182-
183-
const usagesSet = new SafeSet(usages);
184-
if (hasAnyNotIn(usagesSet, checkUsages)) {
185-
throw lazyDOMException(
186-
'Unsupported key usage for an AES key',
187-
'SyntaxError');
188-
}
189-
if (usagesSet.size === 0) {
190-
throw lazyDOMException(
191-
'Usages cannot be empty when creating a key.',
192-
'SyntaxError');
193-
}
187+
const usagesSet = validateUsagesNotEmpty(
188+
validateKeyUsages(usages, kUsages[name], name));
194189

195190
return jobPromise(() => new SecretKeyGenJob(
196191
kCryptoJobWebCrypto,
@@ -207,16 +202,7 @@ function aesImportKey(
207202
extractable,
208203
usages) {
209204
const { name } = algorithm;
210-
const checkUsages = ['wrapKey', 'unwrapKey'];
211-
if (name !== 'AES-KW')
212-
ArrayPrototypePush(checkUsages, 'encrypt', 'decrypt');
213-
214-
const usagesSet = new SafeSet(usages);
215-
if (hasAnyNotIn(usagesSet, checkUsages)) {
216-
throw lazyDOMException(
217-
'Unsupported key usage for an AES key',
218-
'SyntaxError');
219-
}
205+
const usagesSet = validateKeyUsages(usages, kUsages[name], name);
220206

221207
let handle;
222208
let length;

‎lib/internal/crypto/cfrg.js‎

Lines changed: 36 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@ const {
2626

2727
const {
2828
getUsagesMask,
29-
getUsagesUnion,
30-
hasAnyNotIn,
3129
jobPromise,
3230
} = require('internal/crypto/util');
3331

@@ -42,60 +40,33 @@ const {
4240
} = require('internal/crypto/keys');
4341

4442
const {
43+
createKeyUsages,
44+
getKeyPairUsages,
4545
importDerKey,
4646
importJwkKey,
4747
importRawKey,
4848
validateJwk,
49+
validateKeyUsages,
50+
validateUsagesNotEmpty,
51+
verifyAcceptableKeyUse,
4952
} = require('internal/crypto/webcrypto_util');
5053

51-
function verifyAcceptableCfrgKeyUse(name, isPublic, usages) {
52-
let checkSet;
53-
switch (name) {
54-
case 'X25519':
55-
// Fall through
56-
case 'X448':
57-
checkSet = isPublic ? [] : ['deriveKey', 'deriveBits'];
58-
break;
59-
case 'Ed25519':
60-
// Fall through
61-
case 'Ed448':
62-
checkSet = isPublic ? ['verify'] : ['sign'];
63-
break;
64-
default:
65-
throw lazyDOMException(
66-
'The algorithm is not supported', 'NotSupportedError');
67-
}
68-
if (hasAnyNotIn(usages, checkSet)) {
69-
throw lazyDOMException(
70-
`Unsupported key usage for a ${name} key`,
71-
'SyntaxError');
72-
}
73-
}
54+
const kDeriveUsages = createKeyUsages([], ['deriveKey', 'deriveBits']);
55+
56+
const kSignVerifyUsages = createKeyUsages(['verify'], ['sign']);
57+
58+
const kUsages = {
59+
'__proto__': null,
60+
'X25519': kDeriveUsages,
61+
'X448': kDeriveUsages,
62+
'Ed25519': kSignVerifyUsages,
63+
'Ed448': kSignVerifyUsages,
64+
};
7465

7566
function cfrgGenerateKey(algorithm, extractable, usages) {
7667
const { name } = algorithm;
77-
78-
const usageSet = new SafeSet(usages);
79-
switch (name) {
80-
case 'Ed25519':
81-
// Fall through
82-
case 'Ed448':
83-
if (hasAnyNotIn(usageSet, ['sign', 'verify'])) {
84-
throw lazyDOMException(
85-
`Unsupported key usage for an ${name} key`,
86-
'SyntaxError');
87-
}
88-
break;
89-
case 'X25519':
90-
// Fall through
91-
case 'X448':
92-
if (hasAnyNotIn(usageSet, ['deriveKey', 'deriveBits'])) {
93-
throw lazyDOMException(
94-
`Unsupported key usage for an ${name} key`,
95-
'SyntaxError');
96-
}
97-
break;
98-
}
68+
const allowedUsages = kUsages[name];
69+
const usagesSet = validateKeyUsages(usages, allowedUsages.keygen, name);
9970
const nid = {
10071
'__proto__': null,
10172
'Ed25519': EVP_PKEY_ED25519,
@@ -104,37 +75,16 @@ function cfrgGenerateKey(algorithm, extractable, usages) {
10475
'X448': EVP_PKEY_X448,
10576
}[name];
10677

107-
let publicUsages;
108-
let privateUsages;
109-
switch (name) {
110-
case 'Ed25519':
111-
// Fall through
112-
case 'Ed448':
113-
publicUsages = getUsagesUnion(usageSet, 'verify');
114-
privateUsages = getUsagesUnion(usageSet, 'sign');
115-
break;
116-
case 'X25519':
117-
// Fall through
118-
case 'X448':
119-
publicUsages = new SafeSet();
120-
privateUsages = getUsagesUnion(usageSet, 'deriveKey', 'deriveBits');
121-
break;
122-
}
123-
12478
const keyAlgorithm = { name };
125-
126-
if (privateUsages.size === 0) {
127-
throw lazyDOMException(
128-
'Usages cannot be empty when creating a key.',
129-
'SyntaxError');
130-
}
79+
const keyUsages = getKeyPairUsages(usagesSet, allowedUsages);
80+
validateUsagesNotEmpty(keyUsages.private);
13181

13282
return jobPromise(() => new NidKeyPairGenJob(
13383
kCryptoJobWebCrypto,
13484
nid,
13585
keyAlgorithm,
136-
getUsagesMask(publicUsages),
137-
getUsagesMask(privateUsages),
86+
getUsagesMask(keyUsages.public),
87+
getUsagesMask(keyUsages.private),
13888
extractable));
13989
}
14090

@@ -173,20 +123,25 @@ function cfrgImportKey(
173123

174124
const { name } = algorithm;
175125
let handle;
126+
const allowedUsages = kUsages[name];
176127
const usagesSet = new SafeSet(usages);
177128
switch (format) {
178129
case 'KeyObjectHandle':
179-
verifyAcceptableCfrgKeyUse(
180-
name, keyData.getKeyType() === kKeyTypePublic, usagesSet);
130+
verifyAcceptableKeyUse(
131+
name,
132+
usagesSet,
133+
keyData.getKeyType() === kKeyTypePublic ?
134+
allowedUsages.public :
135+
allowedUsages.private);
181136
handle = keyData;
182137
break;
183138
case 'spki': {
184-
verifyAcceptableCfrgKeyUse(name, true, usagesSet);
139+
verifyAcceptableKeyUse(name, usagesSet, allowedUsages.public);
185140
handle = importDerKey(keyData, true);
186141
break;
187142
}
188143
case 'pkcs8': {
189-
verifyAcceptableCfrgKeyUse(name, false, usagesSet);
144+
verifyAcceptableKeyUse(name, usagesSet, allowedUsages.private);
190145
handle = importDerKey(keyData, false);
191146
break;
192147
}
@@ -205,12 +160,15 @@ function cfrgImportKey(
205160
}
206161

207162
const isPublic = keyData.d === undefined;
208-
verifyAcceptableCfrgKeyUse(name, isPublic, usagesSet);
163+
verifyAcceptableKeyUse(
164+
name,
165+
usagesSet,
166+
isPublic ? allowedUsages.public : allowedUsages.private);
209167
handle = importJwkKey(isPublic, keyData);
210168
break;
211169
}
212170
case 'raw': {
213-
verifyAcceptableCfrgKeyUse(name, true, usagesSet);
171+
verifyAcceptableKeyUse(name, usagesSet, allowedUsages.public);
214172
handle = importRawKey(true, keyData, kKeyFormatRawPublic, name);
215173
break;
216174
}

‎lib/internal/crypto/chacha20_poly1305.js‎

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
'use strict';
22

3-
const {
4-
SafeSet,
5-
} = primordials;
6-
73
const {
84
ChaCha20Poly1305CipherJob,
95
SecretKeyGenJob,
@@ -12,7 +8,6 @@ const {
128

139
const {
1410
getUsagesMask,
15-
hasAnyNotIn,
1611
jobPromise,
1712
} = require('internal/crypto/util');
1813

@@ -29,8 +24,12 @@ const {
2924
importJwkSecretKey,
3025
importSecretKey,
3126
validateJwk,
27+
validateKeyUsages,
28+
validateUsagesNotEmpty,
3229
} = require('internal/crypto/webcrypto_util');
3330

31+
const kUsages = ['encrypt', 'decrypt', 'wrapKey', 'unwrapKey'];
32+
3433
function validateKeyLength(length) {
3534
if (length !== 256)
3635
throw lazyDOMException('Invalid key length', 'DataError');
@@ -49,19 +48,8 @@ function c20pCipher(mode, key, data, algorithm) {
4948
function c20pGenerateKey(algorithm, extractable, usages) {
5049
const { name } = algorithm;
5150

52-
const checkUsages = ['encrypt', 'decrypt', 'wrapKey', 'unwrapKey'];
53-
54-
const usagesSet = new SafeSet(usages);
55-
if (hasAnyNotIn(usagesSet, checkUsages)) {
56-
throw lazyDOMException(
57-
`Unsupported key usage for a ${algorithm.name} key`,
58-
'SyntaxError');
59-
}
60-
if (usagesSet.size === 0) {
61-
throw lazyDOMException(
62-
'Usages cannot be empty when creating a key.',
63-
'SyntaxError');
64-
}
51+
const usagesSet = validateUsagesNotEmpty(
52+
validateKeyUsages(usages, kUsages, name));
6553

6654
return jobPromise(() => new SecretKeyGenJob(
6755
kCryptoJobWebCrypto,
@@ -78,14 +66,9 @@ function c20pImportKey(
7866
extractable,
7967
usages) {
8068
const { name } = algorithm;
81-
const checkUsages = ['encrypt', 'decrypt', 'wrapKey', 'unwrapKey'];
8269

83-
const usagesSet = new SafeSet(usages);
84-
if (hasAnyNotIn(usagesSet, checkUsages)) {
85-
throw lazyDOMException(
86-
`Unsupported key usage for a ${algorithm.name} key`,
87-
'SyntaxError');
88-
}
70+
const usagesSet = validateKeyUsages(
71+
usages, kUsages, name);
8972

9073
let handle;
9174
switch (format) {

0 commit comments

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