Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	crypto/crypto_hkdf.cc	Lines:	64	81	79.0 %
Date:	2022-09-21 04:23:13	Branches:	38	70	54.3 %


#include "crypto/crypto_hkdf.h"
#include "async_wrap-inl.h"
#include "base_object-inl.h"
#include "crypto/crypto_keys.h"
#include "env-inl.h"
#include "memory_tracker-inl.h"
#include "threadpoolwork-inl.h"
#include "v8.h"

namespace node {

using v8::FunctionCallbackInfo;
using v8::Just;
using v8::Maybe;
using v8::Nothing;
using v8::Uint32;
using v8::Value;

namespace crypto {
HKDFConfig::HKDFConfig(HKDFConfig&& other) noexcept
    : mode(other.mode),
      length(other.length),
      digest(other.digest),
      key(other.key),
      salt(std::move(other.salt)),
      info(std::move(other.info)) {}

HKDFConfig& HKDFConfig::operator=(HKDFConfig&& other) noexcept {
  if (&other == this) return *this;
  this->~HKDFConfig();
  return *new (this) HKDFConfig(std::move(other));
}

Maybe<bool> HKDFTraits::EncodeOutput(
    Environment* env,
    const HKDFConfig& params,
    ByteSource* out,
    v8::Local<v8::Value>* result) {
  *result = out->ToArrayBuffer(env);
  return Just(!result->IsEmpty());
}

Maybe<bool> HKDFTraits::AdditionalConfig(
    CryptoJobMode mode,
    const FunctionCallbackInfo<Value>& args,
    unsigned int offset,
    HKDFConfig* params) {
  Environment* env = Environment::GetCurrent(args);

  params->mode = mode;

  CHECK(args[offset]->IsString());  // Hash
  CHECK(args[offset + 1]->IsObject());  // Key
  CHECK(IsAnyByteSource(args[offset + 2]));  // Salt
  CHECK(IsAnyByteSource(args[offset + 3]));  // Info
  CHECK(args[offset + 4]->IsUint32());  // Length

  Utf8Value hash(env->isolate(), args[offset]);
  params->digest = EVP_get_digestbyname(*hash);
  if (params->digest == nullptr) {
    THROW_ERR_CRYPTO_INVALID_DIGEST(env, "Invalid digest: %s", *hash);
    return Nothing<bool>();
  }

  KeyObjectHandle* key;
  ASSIGN_OR_RETURN_UNWRAP(&key, args[offset + 1], Nothing<bool>());
  params->key = key->Data();

  ArrayBufferOrViewContents<char> salt(args[offset + 2]);
  ArrayBufferOrViewContents<char> info(args[offset + 3]);

  if (UNLIKELY(!salt.CheckSizeInt32())) {
    THROW_ERR_OUT_OF_RANGE(env, "salt is too big");
    return Nothing<bool>();
  }
  if (UNLIKELY(!info.CheckSizeInt32())) {
    THROW_ERR_OUT_OF_RANGE(env, "info is too big");
    return Nothing<bool>();
  }

  params->salt = mode == kCryptoJobAsync
      ? salt.ToCopy()
      : salt.ToByteSource();

  params->info = mode == kCryptoJobAsync
      ? info.ToCopy()
      : info.ToByteSource();

  params->length = args[offset + 4].As<Uint32>()->Value();
  size_t max_length = EVP_MD_size(params->digest) * kMaxDigestMultiplier;
  if (params->length > max_length) {
    THROW_ERR_CRYPTO_INVALID_KEYLEN(env);
    return Nothing<bool>();
  }

  return Just(true);
}

bool HKDFTraits::DeriveBits(
    Environment* env,
    const HKDFConfig& params,
    ByteSource* out) {
  EVPKeyCtxPointer ctx =
      EVPKeyCtxPointer(EVP_PKEY_CTX_new_id(EVP_PKEY_HKDF, nullptr));
  if (!ctx || !EVP_PKEY_derive_init(ctx.get()) ||
      !EVP_PKEY_CTX_set_hkdf_md(ctx.get(), params.digest) ||
      !EVP_PKEY_CTX_add1_hkdf_info(
          ctx.get(), params.info.data<unsigned char>(), params.info.size())) {
    return false;
  }

  // TODO(panva): Once support for OpenSSL 1.1.1 is dropped the whole
  // of HKDFTraits::DeriveBits can be refactored to use
  // EVP_KDF which does handle zero length key.

  std::string_view salt;
  if (params.salt.size() != 0) {
    salt = {params.salt.data<char>(), params.salt.size()};
  } else {
    static const char default_salt[EVP_MAX_MD_SIZE] = {0};
    salt = {default_salt, static_cast<unsigned>(EVP_MD_size(params.digest))};
  }

  // We do not use EVP_PKEY_HKDEF_MODE_EXTRACT_AND_EXPAND and instead implement
  // the extraction step ourselves because EVP_PKEY_derive does not handle
  // zero-length keys, which are required for Web Crypto.
  unsigned char pseudorandom_key[EVP_MAX_MD_SIZE];
  unsigned int prk_len = sizeof(pseudorandom_key);
  if (HMAC(
          params.digest,
          salt.data(),
          salt.size(),
          reinterpret_cast<const unsigned char*>(params.key->GetSymmetricKey()),
          params.key->GetSymmetricKeySize(),
          pseudorandom_key,
          &prk_len) == nullptr) {
    return false;
  }
  if (!EVP_PKEY_CTX_hkdf_mode(ctx.get(), EVP_PKEY_HKDEF_MODE_EXPAND_ONLY) ||
      !EVP_PKEY_CTX_set1_hkdf_key(ctx.get(), pseudorandom_key, prk_len)) {
    return false;
  }

  size_t length = params.length;
  ByteSource::Builder buf(length);
  if (EVP_PKEY_derive(ctx.get(), buf.data<unsigned char>(), &length) <= 0)
    return false;

  *out = std::move(buf).release();
  return true;
}

void HKDFConfig::MemoryInfo(MemoryTracker* tracker) const {
  tracker->TrackField("key", key);
  // If the job is sync, then the HKDFConfig does not own the data
  if (mode == kCryptoJobAsync) {
    tracker->TrackFieldWithSize("salt", salt.size());
    tracker->TrackFieldWithSize("info", info.size());
  }
}

}  // namespace crypto
}  // namespace node


Generated by: GCOVR (Version 4.2)

Line	Branch	Exec	Source
1			#include "crypto/crypto_hkdf.h"
2			#include "async_wrap-inl.h"
3			#include "base_object-inl.h"
4			#include "crypto/crypto_keys.h"
5			#include "env-inl.h"
6			#include "memory_tracker-inl.h"
7			#include "threadpoolwork-inl.h"
8			#include "v8.h"
9
10			namespace node {
11
12			using v8::FunctionCallbackInfo;
13			using v8::Just;
14			using v8::Maybe;
15			using v8::Nothing;
16			using v8::Uint32;
17			using v8::Value;
18
19			namespace crypto {
20		1284	HKDFConfig::HKDFConfig(HKDFConfig&& other) noexcept
21		1284	: mode(other.mode),
22		1284	length(other.length),
23		1284	digest(other.digest),
24		1284	key(other.key),
25		1284	salt(std::move(other.salt)),
26		1284	info(std::move(other.info)) {}
27
28			HKDFConfig& HKDFConfig::operator=(HKDFConfig&& other) noexcept {
29			if (&other == this) return *this;
30			this->~HKDFConfig();
31			return *new (this) HKDFConfig(std::move(other));
32			}
33
34		1284	Maybe<bool> HKDFTraits::EncodeOutput(
35			Environment* env,
36			const HKDFConfig& params,
37			ByteSource* out,
38			v8::Local<v8::Value>* result) {
39		2568	*result = out->ToArrayBuffer(env);
40		1284	return Just(!result->IsEmpty());
41			}
42
43		1288	Maybe<bool> HKDFTraits::AdditionalConfig(
44			CryptoJobMode mode,
45			const FunctionCallbackInfo<Value>& args,
46			unsigned int offset,
47			HKDFConfig* params) {
48		1288	Environment* env = Environment::GetCurrent(args);
49
50		1288	params->mode = mode;
51
52	✓✗✗✓	3864	CHECK(args[offset]->IsString()); // Hash
53	✓✗✗✓	2576	CHECK(args[offset + 1]->IsObject()); // Key
54	✓✗✗✓	2576	CHECK(IsAnyByteSource(args[offset + 2])); // Salt
55	✓✗✗✓	2576	CHECK(IsAnyByteSource(args[offset + 3])); // Info
56	✓✗✗✓	2576	CHECK(args[offset + 4]->IsUint32()); // Length
57
58	✓✗	3864	Utf8Value hash(env->isolate(), args[offset]);
59		1288	params->digest = EVP_get_digestbyname(*hash);
60	✓✓	1288	if (params->digest == nullptr) {
61		2	THROW_ERR_CRYPTO_INVALID_DIGEST(env, "Invalid digest: %s", *hash);
62		2	return Nothing<bool>();
63			}
64
65			KeyObjectHandle* key;
66	✓✗✗✓	2572	ASSIGN_OR_RETURN_UNWRAP(&key, args[offset + 1], Nothing<bool>());
67		1286	params->key = key->Data();
68
69	✓✗	2572	ArrayBufferOrViewContents<char> salt(args[offset + 2]);
70	✓✗	2572	ArrayBufferOrViewContents<char> info(args[offset + 3]);
71
72	✗✓	1286	if (UNLIKELY(!salt.CheckSizeInt32())) {
73			THROW_ERR_OUT_OF_RANGE(env, "salt is too big");
74			return Nothing<bool>();
75			}
76	✗✓	1286	if (UNLIKELY(!info.CheckSizeInt32())) {
77			THROW_ERR_OUT_OF_RANGE(env, "info is too big");
78			return Nothing<bool>();
79			}
80
81			params->salt = mode == kCryptoJobAsync
82	✓✓	2572	? salt.ToCopy()
83		1286	: salt.ToByteSource();
84
85			params->info = mode == kCryptoJobAsync
86	✓✓	2572	? info.ToCopy()
87		1286	: info.ToByteSource();
88
89	✓✗	3858	params->length = args[offset + 4].As<Uint32>()->Value();
90		1286	size_t max_length = EVP_MD_size(params->digest) * kMaxDigestMultiplier;
91	✓✓	1286	if (params->length > max_length) {
92		2	THROW_ERR_CRYPTO_INVALID_KEYLEN(env);
93		2	return Nothing<bool>();
94			}
95
96		1284	return Just(true);
97			}
98
99		1284	bool HKDFTraits::DeriveBits(
100			Environment* env,
101			const HKDFConfig& params,
102			ByteSource* out) {
103			EVPKeyCtxPointer ctx =
104		2568	EVPKeyCtxPointer(EVP_PKEY_CTX_new_id(EVP_PKEY_HKDF, nullptr));
105	✓✗✓✗	3852	if (!ctx \|\| !EVP_PKEY_derive_init(ctx.get()) \|\|
106	✓✗✗✓ ✗✓	3852	!EVP_PKEY_CTX_set_hkdf_md(ctx.get(), params.digest) \|\|
107		1284	!EVP_PKEY_CTX_add1_hkdf_info(
108		1284	ctx.get(), params.info.data<unsigned char>(), params.info.size())) {
109			return false;
110			}
111
112			// TODO(panva): Once support for OpenSSL 1.1.1 is dropped the whole
113			// of HKDFTraits::DeriveBits can be refactored to use
114			// EVP_KDF which does handle zero length key.
115
116		1284	std::string_view salt;
117	✓✓	1284	if (params.salt.size() != 0) {
118		650	salt = {params.salt.data<char>(), params.salt.size()};
119			} else {
120			static const char default_salt[EVP_MAX_MD_SIZE] = {0};
121		634	salt = {default_salt, static_cast<unsigned>(EVP_MD_size(params.digest))};
122			}
123
124			// We do not use EVP_PKEY_HKDEF_MODE_EXTRACT_AND_EXPAND and instead implement
125			// the extraction step ourselves because EVP_PKEY_derive does not handle
126			// zero-length keys, which are required for Web Crypto.
127			unsigned char pseudorandom_key[EVP_MAX_MD_SIZE];
128		1284	unsigned int prk_len = sizeof(pseudorandom_key);
129		1284	if (HMAC(
130		1284	params.digest,
131		1284	salt.data(),
132		1284	salt.size(),
133		1284	reinterpret_cast<const unsigned char*>(params.key->GetSymmetricKey()),
134		1284	params.key->GetSymmetricKeySize(),
135			pseudorandom_key,
136	✗✓	1284	&prk_len) == nullptr) {
137			return false;
138			}
139	✓✗✗✓ ✗✓	2568	if (!EVP_PKEY_CTX_hkdf_mode(ctx.get(), EVP_PKEY_HKDEF_MODE_EXPAND_ONLY) \|\|
140		1284	!EVP_PKEY_CTX_set1_hkdf_key(ctx.get(), pseudorandom_key, prk_len)) {
141			return false;
142			}
143
144		1284	size_t length = params.length;
145		2568	ByteSource::Builder buf(length);
146	✗✓	1284	if (EVP_PKEY_derive(ctx.get(), buf.data<unsigned char>(), &length) <= 0)
147			return false;
148
149		1284	*out = std::move(buf).release();
150		1284	return true;
151			}
152
153			void HKDFConfig::MemoryInfo(MemoryTracker* tracker) const {
154			tracker->TrackField("key", key);
155			// If the job is sync, then the HKDFConfig does not own the data
156			if (mode == kCryptoJobAsync) {
157			tracker->TrackFieldWithSize("salt", salt.size());
158			tracker->TrackFieldWithSize("info", info.size());
159			}
160			}
161
162			} // namespace crypto
163			} // namespace node