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

crypto: pass CryptoKey handles to KDF jobs · nodejs/node@3d05a1d · GitHub

/ node Public

Commit 3d05a1d

Browse files
panva
authored and
sxa
committed
crypto: pass CryptoKey handles to KDF jobs
Pass CryptoKey handles directly into KDF jobs instead of exporting secret bytes in lib. Normalize HKDF, PBKDF2, and Argon2 around the same job construction pattern so WebCrypto derivation paths avoid extra key material copies and keep operation failures in native job handling. Signed-off-by: Filip Skokan <panva.ip@gmail.com> PR-URL: #63363 Backport-PR-URL: #63563 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: René <contact.9a5d6388@renegade334.me.uk>
1 parent f9d10a3 commit 3d05a1d

9 files changed

Lines changed: 95 additions & 74 deletions

File tree

‎lib/internal/crypto/argon2.js‎

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -211,28 +211,16 @@ function argon2DeriveBits(algorithm, baseKey, length) {
211211
'Argon2id': kTypeArgon2id,
212212
}[algorithm.name];
213213

214-
let message;
215-
try {
216-
// TODO(panva): call the job directly without needing to re-export the handle
217-
message = getCryptoKeyHandle(baseKey).export();
218-
} catch (err) {
219-
throw lazyDOMException(
220-
'The operation failed for an operation-specific reason',
221-
{ name: 'OperationError', cause: err });
222-
}
223-
224-
const empty = new Uint8Array(0);
225-
226214
return jobPromise(() => new Argon2Job(
227215
kCryptoJobWebCrypto,
228-
message,
216+
getCryptoKeyHandle(baseKey),
229217
algorithm.nonce,
230218
algorithm.parallelism,
231219
length / 8,
232220
algorithm.memory,
233221
algorithm.passes,
234-
algorithm.secretValue === undefined ? empty : algorithm.secretValue,
235-
algorithm.associatedData === undefined ? empty : algorithm.associatedData,
222+
algorithm.secretValue === undefined ? new Uint8Array() : algorithm.secretValue,
223+
algorithm.associatedData === undefined ? new Uint8Array() : algorithm.associatedData,
236224
type));
237225
}
238226

‎lib/internal/crypto/hkdf.js‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,9 @@ const {
2929
} = require('internal/crypto/util');
3030

3131
const {
32-
createSecretKey,
3332
getCryptoKeyHandle,
34-
getKeyObjectHandle,
3533
isKeyObject,
34+
prepareSecretKey,
3635
} = require('internal/crypto/keys');
3736

3837
const {
@@ -78,10 +77,10 @@ const validateParameters = hideStackFrames((hash, key, salt, info, length) => {
7877

7978
function prepareKey(key) {
8079
if (isKeyObject(key))
81-
return getKeyObjectHandle(key);
80+
return prepareSecretKey(key);
8281

8382
if (isAnyArrayBuffer(key))
84-
return getKeyObjectHandle(createSecretKey(key));
83+
return key;
8584

8685
key = toBuf(key);
8786

@@ -99,7 +98,7 @@ function prepareKey(key) {
9998
key);
10099
}
101100

102-
return getKeyObjectHandle(createSecretKey(key));
101+
return key;
103102
}
104103

105104
function hkdf(hash, key, salt, info, length, callback) {
@@ -157,18 +156,9 @@ function hkdfDeriveBits(algorithm, baseKey, length) {
157156
if (length === 0)
158157
return PromiseResolve(new ArrayBuffer(0));
159158

160-
let normalizedHash;
161-
try {
162-
normalizedHash = normalizeHashName(hash.name);
163-
} catch (err) {
164-
throw lazyDOMException(
165-
'The operation failed for an operation-specific reason',
166-
{ name: 'OperationError', cause: err });
167-
}
168-
169159
return jobPromise(() => new HKDFJob(
170160
kCryptoJobWebCrypto,
171-
normalizedHash,
161+
normalizeHashName(hash.name),
172162
getCryptoKeyHandle(baseKey),
173163
salt,
174164
info,

‎lib/internal/crypto/pbkdf2.js‎

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -116,25 +116,13 @@ function pbkdf2DeriveBits(algorithm, baseKey, length) {
116116
if (length === 0)
117117
return PromiseResolve(new ArrayBuffer(0));
118118

119-
let password;
120-
let normalizedHash;
121-
try {
122-
// TODO(panva): call the job directly without needing to re-export the handle
123-
password = getCryptoKeyHandle(baseKey).export();
124-
normalizedHash = normalizeHashName(hash.name);
125-
} catch (err) {
126-
throw lazyDOMException(
127-
'The operation failed for an operation-specific reason',
128-
{ name: 'OperationError', cause: err });
129-
}
130-
131119
return jobPromise(() => new PBKDF2Job(
132120
kCryptoJobWebCrypto,
133-
password,
121+
getCryptoKeyHandle(baseKey),
134122
salt,
135123
iterations,
136124
length / 8,
137-
normalizedHash));
125+
normalizeHashName(hash.name)));
138126
}
139127

140128
module.exports = {

‎src/crypto/crypto_argon2.cc‎

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
#include "crypto/crypto_argon2.h"
22
#include "async_wrap-inl.h"
3+
#include "base_object-inl.h"
4+
#include "crypto/crypto_keys.h"
5+
#include "memory_tracker-inl.h"
36
#include "threadpoolwork-inl.h"
47

58
#if OPENSSL_WITH_ARGON2
@@ -19,6 +22,7 @@ using v8::Value;
1922

2023
Argon2Config::Argon2Config(Argon2Config&& other) noexcept
2124
: mode{other.mode},
25+
key{std::move(other.key)},
2226
pass{std::move(other.pass)},
2327
salt{std::move(other.salt)},
2428
secret{std::move(other.secret)},
@@ -36,8 +40,9 @@ Argon2Config& Argon2Config::operator=(Argon2Config&& other) noexcept {
3640
}
3741

3842
void Argon2Config::MemoryInfo(MemoryTracker* tracker) const {
43+
if (key) tracker->TrackField("key", key);
3944
if (IsCryptoJobAsync(mode)) {
40-
tracker->TrackFieldWithSize("pass", pass.size());
45+
if (!key) tracker->TrackFieldWithSize("pass", pass.size());
4146
tracker->TrackFieldWithSize("salt", salt.size());
4247
tracker->TrackFieldWithSize("secret", secret.size());
4348
tracker->TrackFieldWithSize("ad", ad.size());
@@ -59,14 +64,23 @@ Maybe<void> Argon2Traits::AdditionalConfig(
5964

6065
config->mode = mode;
6166

62-
ArrayBufferOrViewContents<char> pass(args[offset]);
67+
CHECK(KeyObjectHandle::HasInstance(env, args[offset]) ||
68+
IsAnyBufferSource(args[offset])); // pass
6369
ArrayBufferOrViewContents<char> salt(args[offset + 1]);
6470
ArrayBufferOrViewContents<char> secret(args[offset + 6]);
6571
ArrayBufferOrViewContents<char> ad(args[offset + 7]);
6672

67-
if (!pass.CheckSizeInt32()) [[unlikely]] {
68-
THROW_ERR_OUT_OF_RANGE(env, "pass is too large");
69-
return Nothing<void>();
73+
if (KeyObjectHandle::HasInstance(env, args[offset])) {
74+
KeyObjectHandle* key;
75+
ASSIGN_OR_RETURN_UNWRAP(&key, args[offset], Nothing<void>());
76+
config->key = key->Data().addRef();
77+
} else {
78+
ArrayBufferOrViewContents<char> pass(args[offset]);
79+
if (!pass.CheckSizeInt32()) [[unlikely]] {
80+
THROW_ERR_OUT_OF_RANGE(env, "pass is too large");
81+
return Nothing<void>();
82+
}
83+
config->pass = IsCryptoJobAsync(mode) ? pass.ToCopy() : pass.ToByteSource();
7084
}
7185

7286
if (!salt.CheckSizeInt32()) [[unlikely]] {
@@ -85,7 +99,6 @@ Maybe<void> Argon2Traits::AdditionalConfig(
8599
}
86100

87101
const bool isAsync = IsCryptoJobAsync(mode);
88-
config->pass = isAsync ? pass.ToCopy() : pass.ToByteSource();
89102
config->salt = isAsync ? salt.ToCopy() : salt.ToByteSource();
90103
config->secret = isAsync ? secret.ToCopy() : secret.ToByteSource();
91104
config->ad = isAsync ? ad.ToCopy() : ad.ToByteSource();
@@ -118,7 +131,13 @@ bool Argon2Traits::DeriveBits(Environment* env,
118131
}
119132

120133
// Both the pass and salt may be zero-length at this point
121-
auto dp = ncrypto::argon2(config.pass,
134+
const ncrypto::Buffer<const char> pass{
135+
.data = config.key ? config.key.GetSymmetricKey()
136+
: config.pass.data<const char>(),
137+
.len = config.key ? config.key.GetSymmetricKeySize() : config.pass.size(),
138+
};
139+
140+
auto dp = ncrypto::argon2(pass,
122141
config.salt,
123142
config.lanes,
124143
config.keylen,

‎src/crypto/crypto_argon2.h‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
55

6+
#include "crypto/crypto_keys.h"
67
#include "crypto/crypto_util.h"
78

89
namespace node::crypto {
@@ -22,6 +23,7 @@ namespace node::crypto {
2223

2324
struct Argon2Config final : public MemoryRetainer {
2425
CryptoJobMode mode;
26+
KeyObjectData key;
2527
ByteSource pass;
2628
ByteSource salt;
2729
ByteSource secret;

‎src/crypto/crypto_hkdf.cc‎

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ HKDFConfig::HKDFConfig(HKDFConfig&& other) noexcept
2424
length(other.length),
2525
digest(other.digest),
2626
key(std::move(other.key)),
27+
key_data(std::move(other.key_data)),
2728
salt(std::move(other.salt)),
2829
info(std::move(other.info)) {}
2930

@@ -49,7 +50,8 @@ Maybe<void> HKDFTraits::AdditionalConfig(
4950
params->mode = mode;
5051

5152
CHECK(args[offset]->IsString()); // Hash
52-
CHECK(args[offset + 1]->IsObject()); // Key
53+
CHECK(KeyObjectHandle::HasInstance(env, args[offset + 1]) ||
54+
IsAnyBufferSource(args[offset + 1])); // Key
5355
CHECK(IsAnyBufferSource(args[offset + 2])); // Salt
5456
CHECK(IsAnyBufferSource(args[offset + 3])); // Info
5557
CHECK(args[offset + 4]->IsUint32()); // Length
@@ -61,9 +63,19 @@ Maybe<void> HKDFTraits::AdditionalConfig(
6163
return Nothing<void>();
6264
}
6365

64-
KeyObjectHandle* key;
65-
ASSIGN_OR_RETURN_UNWRAP(&key, args[offset + 1], Nothing<void>());
66-
params->key = key->Data().addRef();
66+
if (KeyObjectHandle::HasInstance(env, args[offset + 1])) {
67+
KeyObjectHandle* key;
68+
ASSIGN_OR_RETURN_UNWRAP(&key, args[offset + 1], Nothing<void>());
69+
params->key = key->Data().addRef();
70+
} else {
71+
ArrayBufferOrViewContents<char> key_data(args[offset + 1]);
72+
if (!key_data.CheckSizeInt32()) [[unlikely]] {
73+
THROW_ERR_OUT_OF_RANGE(env, "key is too big");
74+
return Nothing<void>();
75+
}
76+
params->key_data =
77+
IsCryptoJobAsync(mode) ? key_data.ToCopy() : key_data.ToByteSource();
78+
}
6779

6880
ArrayBufferOrViewContents<char> salt(args[offset + 2]);
6981
ArrayBufferOrViewContents<char> info(args[offset + 3]);
@@ -97,12 +109,16 @@ bool HKDFTraits::DeriveBits(Environment* env,
97109
const HKDFConfig& params,
98110
ByteSource* out,
99111
CryptoJobMode mode) {
112+
const ncrypto::Buffer<const unsigned char> key_data{
113+
.data = params.key ? reinterpret_cast<const unsigned char*>(
114+
params.key.GetSymmetricKey())
115+
: params.key_data.data<unsigned char>(),
116+
.len = params.key ? params.key.GetSymmetricKeySize()
117+
: params.key_data.size(),
118+
};
119+
100120
auto dp = ncrypto::hkdf(params.digest,
101-
ncrypto::Buffer<const unsigned char>{
102-
.data = reinterpret_cast<const unsigned char*>(
103-
params.key.GetSymmetricKey()),
104-
.len = params.key.GetSymmetricKeySize(),
105-
},
121+
key_data,
106122
ncrypto::Buffer<const unsigned char>{
107123
.data = params.info.data<const unsigned char>(),
108124
.len = params.info.size(),
@@ -120,9 +136,10 @@ bool HKDFTraits::DeriveBits(Environment* env,
120136
}
121137

122138
void HKDFConfig::MemoryInfo(MemoryTracker* tracker) const {
123-
tracker->TrackField("key", key);
139+
if (key) tracker->TrackField("key", key);
124140
// If the job is sync, then the HKDFConfig does not own the data
125141
if (IsCryptoJobAsync(mode)) {
142+
if (!key) tracker->TrackFieldWithSize("key", key_data.size());
126143
tracker->TrackFieldWithSize("salt", salt.size());
127144
tracker->TrackFieldWithSize("info", info.size());
128145
}

‎src/crypto/crypto_hkdf.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ struct HKDFConfig final : public MemoryRetainer {
1616
size_t length;
1717
ncrypto::Digest digest;
1818
KeyObjectData key;
19+
ByteSource key_data;
1920
ByteSource salt;
2021
ByteSource info;
2122

‎src/crypto/crypto_pbkdf2.cc‎

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
#include "crypto/crypto_pbkdf2.h"
22
#include "async_wrap-inl.h"
3+
#include "base_object-inl.h"
4+
#include "crypto/crypto_keys.h"
35
#include "crypto/crypto_util.h"
46
#include "env-inl.h"
57
#include "memory_tracker-inl.h"
@@ -21,6 +23,7 @@ using v8::Value;
2123
namespace crypto {
2224
PBKDF2Config::PBKDF2Config(PBKDF2Config&& other) noexcept
2325
: mode(other.mode),
26+
key(std::move(other.key)),
2427
pass(std::move(other.pass)),
2528
salt(std::move(other.salt)),
2629
iterations(other.iterations),
@@ -34,9 +37,10 @@ PBKDF2Config& PBKDF2Config::operator=(PBKDF2Config&& other) noexcept {
3437
}
3538

3639
void PBKDF2Config::MemoryInfo(MemoryTracker* tracker) const {
37-
// The job is sync, the PBKDF2Config does not own the data.
40+
// If the job is sync, PBKDF2Config does not own the data.
41+
if (key) tracker->TrackField("key", key);
3842
if (IsCryptoJobAsync(mode)) {
39-
tracker->TrackFieldWithSize("pass", pass.size());
43+
if (!key) tracker->TrackFieldWithSize("pass", pass.size());
4044
tracker->TrackFieldWithSize("salt", salt.size());
4145
}
4246
}
@@ -63,21 +67,28 @@ Maybe<void> PBKDF2Traits::AdditionalConfig(
6367

6468
params->mode = mode;
6569

66-
ArrayBufferOrViewContents<char> pass(args[offset]);
70+
CHECK(KeyObjectHandle::HasInstance(env, args[offset]) ||
71+
IsAnyBufferSource(args[offset])); // pass
6772
ArrayBufferOrViewContents<char> salt(args[offset + 1]);
6873

69-
if (!pass.CheckSizeInt32()) [[unlikely]] {
70-
THROW_ERR_OUT_OF_RANGE(env, "pass is too large");
71-
return Nothing<void>();
74+
if (KeyObjectHandle::HasInstance(env, args[offset])) {
75+
KeyObjectHandle* key;
76+
ASSIGN_OR_RETURN_UNWRAP(&key, args[offset], Nothing<void>());
77+
params->key = key->Data().addRef();
78+
} else {
79+
ArrayBufferOrViewContents<char> pass(args[offset]);
80+
if (!pass.CheckSizeInt32()) [[unlikely]] {
81+
THROW_ERR_OUT_OF_RANGE(env, "pass is too large");
82+
return Nothing<void>();
83+
}
84+
params->pass = IsCryptoJobAsync(mode) ? pass.ToCopy() : pass.ToByteSource();
7285
}
7386

7487
if (!salt.CheckSizeInt32()) [[unlikely]] {
7588
THROW_ERR_OUT_OF_RANGE(env, "salt is too large");
7689
return Nothing<void>();
7790
}
7891

79-
params->pass = IsCryptoJobAsync(mode) ? pass.ToCopy() : pass.ToByteSource();
80-
8192
params->salt = IsCryptoJobAsync(mode) ? salt.ToCopy() : salt.ToByteSource();
8293

8394
CHECK(args[offset + 2]->IsInt32()); // iteration_count
@@ -111,11 +122,14 @@ bool PBKDF2Traits::DeriveBits(Environment* env,
111122
ByteSource* out,
112123
CryptoJobMode mode) {
113124
// Both pass and salt may be zero length here.
125+
const ncrypto::Buffer<const char> pass{
126+
.data = params.key ? params.key.GetSymmetricKey()
127+
: params.pass.data<const char>(),
128+
.len = params.key ? params.key.GetSymmetricKeySize() : params.pass.size(),
129+
};
130+
114131
auto dp = ncrypto::pbkdf2(params.digest,
115-
ncrypto::Buffer<const char>{
116-
.data = params.pass.data<const char>(),
117-
.len = params.pass.size(),
118-
},
132+
pass,
119133
ncrypto::Buffer<const unsigned char>{
120134
.data = params.salt.data<unsigned char>(),
121135
.len = params.salt.size(),

‎src/crypto/crypto_pbkdf2.h‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33

44
#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
55

6-
#include "crypto/crypto_util.h"
76
#include "async_wrap.h"
7+
#include "crypto/crypto_keys.h"
8+
#include "crypto/crypto_util.h"
89
#include "env.h"
910
#include "memory_tracker.h"
1011
#include "v8.h"
@@ -26,6 +27,7 @@ namespace crypto {
2627

2728
struct PBKDF2Config final : public MemoryRetainer {
2829
CryptoJobMode mode;
30+
KeyObjectData key;
2931
ByteSource pass;
3032
ByteSource salt;
3133
int32_t iterations;

0 commit comments

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