From 84a78807497a97a3921017e4aa4e74fb1e4eb544 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Wed, 14 Oct 2020 16:49:26 -0700 Subject: [PATCH] src: minor cleanup and simplification of crypto::Hash MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: James M Snell PR-URL: https://github.com/nodejs/node/pull/35651 Reviewed-By: Tobias Nießen Reviewed-By: Rich Trott --- src/crypto/crypto_hash.cc | 50 +++++++++++++++++---------------------- src/crypto/crypto_hash.h | 9 +++---- 2 files changed, 25 insertions(+), 34 deletions(-) diff --git a/src/crypto/crypto_hash.cc b/src/crypto/crypto_hash.cc index f858e6be9e9e3d..d49a7c5d022f0b 100644 --- a/src/crypto/crypto_hash.cc +++ b/src/crypto/crypto_hash.cc @@ -24,17 +24,13 @@ using v8::Uint32; using v8::Value; namespace crypto { -Hash::Hash(Environment* env, Local wrap) - : BaseObject(env, wrap), - mdctx_(nullptr), - has_md_(false), - md_value_(nullptr) { +Hash::Hash(Environment* env, Local wrap) : BaseObject(env, wrap) { MakeWeak(); } void Hash::MemoryInfo(MemoryTracker* tracker) const { tracker->TrackFieldWithSize("mdctx", mdctx_ ? kSizeOf_EVP_MD_CTX : 0); - tracker->TrackFieldWithSize("md", md_len_); + tracker->TrackFieldWithSize("md", digest_ ? md_len_ : 0); } void Hash::GetHashes(const FunctionCallbackInfo& args) { @@ -63,11 +59,6 @@ void Hash::Initialize(Environment* env, Local target) { HashJob::Initialize(env, target); } -Hash::~Hash() { - if (md_value_ != nullptr) - OPENSSL_clear_free(md_value_, md_len_); -} - void Hash::New(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); @@ -150,47 +141,50 @@ void Hash::HashDigest(const FunctionCallbackInfo& args) { encoding = ParseEncoding(env->isolate(), args[0], BUFFER); } + unsigned int len = hash->md_len_; + // TODO(tniessen): SHA3_squeeze does not work for zero-length outputs on all // platforms and will cause a segmentation fault if called. This workaround // causes hash.digest() to correctly return an empty buffer / string. // See https://github.com/openssl/openssl/issues/9431. - if (!hash->has_md_ && hash->md_len_ == 0) { - hash->has_md_ = true; - } - if (!hash->has_md_) { + if (!hash->digest_ && len > 0) { // Some hash algorithms such as SHA3 do not support calling // EVP_DigestFinal_ex more than once, however, Hash._flush // and Hash.digest can both be used to retrieve the digest, // so we need to cache it. // See https://github.com/nodejs/node/issues/28245. - hash->md_value_ = MallocOpenSSL(hash->md_len_); + char* md_value = MallocOpenSSL(len); + ByteSource digest = ByteSource::Allocated(md_value, len); size_t default_len = EVP_MD_CTX_size(hash->mdctx_.get()); int ret; - if (hash->md_len_ == default_len) { - ret = EVP_DigestFinal_ex(hash->mdctx_.get(), hash->md_value_, - &hash->md_len_); + if (len == default_len) { + ret = EVP_DigestFinal_ex( + hash->mdctx_.get(), + reinterpret_cast(md_value), + &len); + // The output length should always equal hash->md_len_ + CHECK_EQ(len, hash->md_len_); } else { - ret = EVP_DigestFinalXOF(hash->mdctx_.get(), hash->md_value_, - hash->md_len_); + ret = EVP_DigestFinalXOF( + hash->mdctx_.get(), + reinterpret_cast(md_value), + len); } - if (ret != 1) { - OPENSSL_free(hash->md_value_); - hash->md_value_ = nullptr; + if (ret != 1) return ThrowCryptoError(env, ERR_get_error()); - } - hash->has_md_ = true; + hash->digest_ = std::move(digest); } Local error; MaybeLocal rc = StringBytes::Encode(env->isolate(), - reinterpret_cast(hash->md_value_), - hash->md_len_, + hash->digest_.get(), + len, encoding, &error); if (rc.IsEmpty()) { diff --git a/src/crypto/crypto_hash.h b/src/crypto/crypto_hash.h index 15e83d0cd11b82..b2ecce0c5b8501 100644 --- a/src/crypto/crypto_hash.h +++ b/src/crypto/crypto_hash.h @@ -15,8 +15,6 @@ namespace node { namespace crypto { class Hash final : public BaseObject { public: - ~Hash() override; - static void Initialize(Environment* env, v8::Local target); void MemoryInfo(MemoryTracker* tracker) const override; @@ -36,10 +34,9 @@ class Hash final : public BaseObject { Hash(Environment* env, v8::Local wrap); private: - EVPMDPointer mdctx_; - bool has_md_; - unsigned int md_len_; - unsigned char* md_value_; + EVPMDPointer mdctx_ {}; + unsigned int md_len_ = 0; + ByteSource digest_; }; struct HashConfig final : public MemoryRetainer {