Skip to content

Commit 782ad5d

Browse files
panvaaduh95
panva
authored and
aduh95
committed
src: implement MemoryRetainer protocol for ByteSource
Signed-off-by: Filip Skokan <panva.ip@gmail.com> PR-URL: #64660 Backport-PR-URL: #65087 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
1 parent 4afc15b commit 782ad5d

32 files changed

Lines changed: 135 additions & 201 deletions

‎src/crypto/crypto_aes.cc‎

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -491,8 +491,7 @@ void UseDefaultIV(AESCipherConfig* params) {
491491
} // namespace
492492

493493
AESCipherConfig::AESCipherConfig(AESCipherConfig&& other) noexcept
494-
: mode(other.mode),
495-
variant(other.variant),
494+
: variant(other.variant),
496495
cipher(other.cipher),
497496
length(other.length),
498497
iv(std::move(other.iv)),
@@ -505,12 +504,8 @@ AESCipherConfig& AESCipherConfig::operator=(AESCipherConfig&& other) noexcept {
505504
}
506505

507506
void AESCipherConfig::MemoryInfo(MemoryTracker* tracker) const {
508-
// If mode is sync, then the data in each of these properties
509-
// is not owned by the AESCipherConfig, so we ignore it.
510-
if (IsCryptoJobAsync(mode)) {
511-
tracker->TrackFieldWithSize("iv", iv.size());
512-
tracker->TrackFieldWithSize("additional_data", additional_data.size());
513-
}
507+
tracker->TraitTrackInline(iv, "iv");
508+
tracker->TraitTrackInline(additional_data, "additional_data");
514509
}
515510

516511
Maybe<void> AESCipherTraits::AdditionalConfig(
@@ -521,8 +516,6 @@ Maybe<void> AESCipherTraits::AdditionalConfig(
521516
AESCipherConfig* params) {
522517
Environment* env = Environment::GetCurrent(args);
523518

524-
params->mode = mode;
525-
526519
CHECK(args[offset]->IsUint32()); // Key Variant
527520
params->variant =
528521
static_cast<AESKeyVariant>(args[offset].As<Uint32>()->Value());

‎src/crypto/crypto_aes.h‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,6 @@ enum class AESKeyVariant {
5858
};
5959

6060
struct AESCipherConfig final : public MemoryRetainer {
61-
CryptoJobMode mode;
6261
AESKeyVariant variant;
6362
ncrypto::Cipher cipher;
6463
size_t length;

‎src/crypto/crypto_argon2.cc‎

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ using v8::Uint32;
2121
using v8::Value;
2222

2323
Argon2Config::Argon2Config(Argon2Config&& other) noexcept
24-
: mode{other.mode},
25-
key{std::move(other.key)},
24+
: key{std::move(other.key)},
2625
pass{std::move(other.pass)},
2726
salt{std::move(other.salt)},
2827
secret{std::move(other.secret)},
@@ -40,13 +39,13 @@ Argon2Config& Argon2Config::operator=(Argon2Config&& other) noexcept {
4039
}
4140

4241
void Argon2Config::MemoryInfo(MemoryTracker* tracker) const {
43-
if (key) tracker->TrackField("key", key);
44-
if (IsCryptoJobAsync(mode)) {
45-
if (!key) tracker->TrackFieldWithSize("pass", pass.size());
46-
tracker->TrackFieldWithSize("salt", salt.size());
47-
tracker->TrackFieldWithSize("secret", secret.size());
48-
tracker->TrackFieldWithSize("ad", ad.size());
49-
}
42+
if (key)
43+
tracker->TrackField("key", key);
44+
else
45+
tracker->TraitTrackInline(pass, "pass");
46+
tracker->TraitTrackInline(salt, "salt");
47+
tracker->TraitTrackInline(secret, "secret");
48+
tracker->TraitTrackInline(ad, "ad");
5049
}
5150

5251
MaybeLocal<Value> Argon2Traits::EncodeOutput(Environment* env,
@@ -62,8 +61,6 @@ Maybe<void> Argon2Traits::AdditionalConfig(
6261
Argon2Config* config) {
6362
Environment* env = Environment::GetCurrent(args);
6463

65-
config->mode = mode;
66-
6764
CHECK(KeyObjectHandle::HasInstance(env, args[offset]) ||
6865
IsAnyBufferSource(args[offset])); // pass
6966
ArrayBufferOrViewContents<char> salt(args[offset + 1]);

‎src/crypto/crypto_argon2.h‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ namespace node::crypto {
2222
// at least 16 bytes in length.
2323

2424
struct Argon2Config final : public MemoryRetainer {
25-
CryptoJobMode mode;
2625
KeyObjectData key;
2726
ByteSource pass;
2827
ByteSource salt;

‎src/crypto/crypto_chacha20_poly1305.cc‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,7 @@ bool ValidateAdditionalData(Environment* env,
8181

8282
ChaCha20Poly1305CipherConfig::ChaCha20Poly1305CipherConfig(
8383
ChaCha20Poly1305CipherConfig&& other) noexcept
84-
: mode(other.mode),
85-
cipher(other.cipher),
84+
: cipher(other.cipher),
8685
iv(std::move(other.iv)),
8786
additional_data(std::move(other.additional_data)) {}
8887

@@ -94,12 +93,8 @@ ChaCha20Poly1305CipherConfig& ChaCha20Poly1305CipherConfig::operator=(
9493
}
9594

9695
void ChaCha20Poly1305CipherConfig::MemoryInfo(MemoryTracker* tracker) const {
97-
// If mode is sync, then the data in each of these properties
98-
// is not owned by the ChaCha20Poly1305CipherConfig, so we ignore it.
99-
if (IsCryptoJobAsync(mode)) {
100-
tracker->TrackFieldWithSize("iv", iv.size());
101-
tracker->TrackFieldWithSize("additional_data", additional_data.size());
102-
}
96+
tracker->TraitTrackInline(iv, "iv");
97+
tracker->TraitTrackInline(additional_data, "additional_data");
10398
}
10499

105100
Maybe<void> ChaCha20Poly1305CipherTraits::AdditionalConfig(
@@ -110,7 +105,6 @@ Maybe<void> ChaCha20Poly1305CipherTraits::AdditionalConfig(
110105
ChaCha20Poly1305CipherConfig* params) {
111106
Environment* env = Environment::GetCurrent(args);
112107

113-
params->mode = mode;
114108
params->cipher = ncrypto::Cipher::CHACHA20_POLY1305;
115109

116110
#ifndef OPENSSL_IS_BORINGSSL

‎src/crypto/crypto_chacha20_poly1305.h‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ namespace node::crypto {
1313
constexpr unsigned kChaCha20Poly1305AuthTagLength = 16;
1414

1515
struct ChaCha20Poly1305CipherConfig final : public MemoryRetainer {
16-
CryptoJobMode mode;
1716
ncrypto::Cipher cipher;
1817
ByteSource iv;
1918
ByteSource additional_data;

‎src/crypto/crypto_cipher.h‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -268,9 +268,8 @@ class CipherJob final : public CryptoJob<CipherTraits> {
268268

269269
SET_SELF_SIZE(CipherJob)
270270
void MemoryInfo(MemoryTracker* tracker) const override {
271-
if (IsCryptoJobAsync(CryptoJob<CipherTraits>::mode()))
272-
tracker->TrackFieldWithSize("in", in_.size());
273-
tracker->TrackFieldWithSize("out", out_.size());
271+
tracker->TraitTrackInline(in_, "in");
272+
tracker->TraitTrackInline(out_, "out");
274273
CryptoJob<CipherTraits>::MemoryInfo(tracker);
275274
}
276275

‎src/crypto/crypto_hash.cc‎

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Hash::Hash(Environment* env, Local<Object> wrap) : BaseObject(env, wrap) {
5858

5959
void Hash::MemoryInfo(MemoryTracker* tracker) const {
6060
tracker->TrackFieldWithSize("mdctx", mdctx_ ? kSizeOf_EVP_MD_CTX : 0);
61-
tracker->TrackFieldWithSize("md", digest_ ? md_len_ : 0);
61+
tracker->TraitTrackInline(digest_, "md");
6262
}
6363

6464
#if NCRYPTO_USE_BORINGSSL_EVP_DO_ALL_FALLBACK
@@ -524,10 +524,7 @@ void Hash::HashDigest(const FunctionCallbackInfo<Value>& args) {
524524
}
525525

526526
HashConfig::HashConfig(HashConfig&& other) noexcept
527-
: mode(other.mode),
528-
in(std::move(other.in)),
529-
digest(other.digest),
530-
length(other.length) {}
527+
: in(std::move(other.in)), digest(other.digest), length(other.length) {}
531528

532529
HashConfig& HashConfig::operator=(HashConfig&& other) noexcept {
533530
if (&other == this) return *this;
@@ -536,8 +533,7 @@ HashConfig& HashConfig::operator=(HashConfig&& other) noexcept {
536533
}
537534

538535
void HashConfig::MemoryInfo(MemoryTracker* tracker) const {
539-
// If the Job is sync, then the HashConfig does not own the data.
540-
if (IsCryptoJobAsync(mode)) tracker->TrackFieldWithSize("in", in.size());
536+
tracker->TraitTrackInline(in, "in");
541537
}
542538

543539
MaybeLocal<Value> HashTraits::EncodeOutput(Environment* env,
@@ -553,8 +549,6 @@ Maybe<void> HashTraits::AdditionalConfig(
553549
HashConfig* params) {
554550
Environment* env = Environment::GetCurrent(args);
555551

556-
params->mode = mode;
557-
558552
CHECK(args[offset]->IsString()); // Hash algorithm
559553
Utf8Value digest(env->isolate(), args[offset]);
560554
params->digest = ncrypto::getDigestByName(*digest);
@@ -782,8 +776,7 @@ bool DigestUpdateBytepad(ncrypto::EVPMDCtxPointer* ctx,
782776
} // namespace
783777

784778
CShakeConfig::CShakeConfig(CShakeConfig&& other) noexcept
785-
: mode(other.mode),
786-
in(std::move(other.in)),
779+
: in(std::move(other.in)),
787780
function_name(std::move(other.function_name)),
788781
customization(std::move(other.customization)),
789782
variant(other.variant),
@@ -796,12 +789,9 @@ CShakeConfig& CShakeConfig::operator=(CShakeConfig&& other) noexcept {
796789
}
797790

798791
void CShakeConfig::MemoryInfo(MemoryTracker* tracker) const {
799-
// If the Job is sync, then the CShakeConfig does not own the data.
800-
if (IsCryptoJobAsync(mode)) {
801-
tracker->TrackFieldWithSize("in", in.size());
802-
tracker->TrackFieldWithSize("function_name", function_name.size());
803-
tracker->TrackFieldWithSize("customization", customization.size());
804-
}
792+
tracker->TraitTrackInline(in, "in");
793+
tracker->TraitTrackInline(function_name, "function_name");
794+
tracker->TraitTrackInline(customization, "customization");
805795
}
806796

807797
MaybeLocal<Value> CShakeTraits::EncodeOutput(Environment* env,
@@ -817,8 +807,6 @@ Maybe<void> CShakeTraits::AdditionalConfig(
817807
CShakeConfig* params) {
818808
Environment* env = Environment::GetCurrent(args);
819809

820-
params->mode = mode;
821-
822810
CHECK(args[offset]->IsString()); // Algorithm name
823811
Utf8Value algorithm_name(env->isolate(), args[offset]);
824812
std::string_view algorithm_str = algorithm_name.ToStringView();

‎src/crypto/crypto_hash.h‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ class Hash final : public BaseObject {
4242
};
4343

4444
struct HashConfig final : public MemoryRetainer {
45-
CryptoJobMode mode;
4645
ByteSource in;
4746
const EVP_MD* digest;
4847
unsigned int length;
@@ -107,7 +106,6 @@ struct CShakeParams final {
107106
bool DeriveCShakeBits(const CShakeParams& params, ByteSource* out);
108107

109108
struct CShakeConfig final : public MemoryRetainer {
110-
CryptoJobMode mode;
111109
ByteSource in;
112110
ByteSource function_name;
113111
ByteSource customization;

‎src/crypto/crypto_hkdf.cc‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@ using v8::Value;
2020

2121
namespace crypto {
2222
HKDFConfig::HKDFConfig(HKDFConfig&& other) noexcept
23-
: mode(other.mode),
24-
length(other.length),
23+
: length(other.length),
2524
digest(other.digest),
2625
key(std::move(other.key)),
2726
key_data(std::move(other.key_data)),
@@ -47,8 +46,6 @@ Maybe<void> HKDFTraits::AdditionalConfig(
4746
HKDFConfig* params) {
4847
Environment* env = Environment::GetCurrent(args);
4948

50-
params->mode = mode;
51-
5249
CHECK(args[offset]->IsString()); // Hash
5350
CHECK(KeyObjectHandle::HasInstance(env, args[offset + 1]) ||
5451
IsAnyBufferSource(args[offset + 1])); // Key
@@ -136,13 +133,12 @@ bool HKDFTraits::DeriveBits(Environment* env,
136133
}
137134

138135
void HKDFConfig::MemoryInfo(MemoryTracker* tracker) const {
139-
if (key) tracker->TrackField("key", key);
140-
// If the job is sync, then the HKDFConfig does not own the data
141-
if (IsCryptoJobAsync(mode)) {
142-
if (!key) tracker->TrackFieldWithSize("key", key_data.size());
143-
tracker->TrackFieldWithSize("salt", salt.size());
144-
tracker->TrackFieldWithSize("info", info.size());
145-
}
136+
if (key)
137+
tracker->TrackField("key", key);
138+
else
139+
tracker->TraitTrackInline(key_data, "key");
140+
tracker->TraitTrackInline(salt, "salt");
141+
tracker->TraitTrackInline(info, "info");
146142
}
147143

148144
} // namespace crypto

0 commit comments

Comments
 (0)