Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	crypto/crypto_random.cc	Lines:	102	118	86.4 %
Date:	2022-05-05 04:15:08	Branches:	49	86	57.0 %


#include "crypto/crypto_random.h"
#include "crypto/crypto_util.h"
#include "allocated_buffer-inl.h"
#include "async_wrap-inl.h"
#include "env-inl.h"
#include "memory_tracker-inl.h"
#include "threadpoolwork-inl.h"
#include "v8.h"

#include <openssl/bn.h>
#include <openssl/rand.h>

namespace node {

using v8::ArrayBuffer;
using v8::BackingStore;
using v8::False;
using v8::FunctionCallbackInfo;
using v8::Just;
using v8::Local;
using v8::Maybe;
using v8::Nothing;
using v8::Object;
using v8::True;
using v8::Uint32;
using v8::Value;

namespace crypto {
Maybe<bool> RandomBytesTraits::EncodeOutput(
    Environment* env,
    const RandomBytesConfig& params,
    ByteSource* unused,
    v8::Local<v8::Value>* result) {
  *result = v8::Undefined(env->isolate());
  return Just(!result->IsEmpty());
}

Maybe<bool> RandomBytesTraits::AdditionalConfig(
    CryptoJobMode mode,
    const FunctionCallbackInfo<Value>& args,
    unsigned int offset,
    RandomBytesConfig* params) {
  Environment* env = Environment::GetCurrent(args);
  CHECK(IsAnyByteSource(args[offset]));  // Buffer to fill
  CHECK(args[offset + 1]->IsUint32());  // Offset
  CHECK(args[offset + 2]->IsUint32());  // Size

  ArrayBufferOrViewContents<unsigned char> in(args[offset]);

  const uint32_t byte_offset = args[offset + 1].As<Uint32>()->Value();
  const uint32_t size = args[offset + 2].As<Uint32>()->Value();
  CHECK_GE(byte_offset + size, byte_offset);  // Overflow check.
  CHECK_LE(byte_offset + size, in.size());  // Bounds check.

  if (UNLIKELY(size > INT_MAX)) {
    THROW_ERR_OUT_OF_RANGE(env, "buffer is too large");
    return Nothing<bool>();
  }

  params->buffer = in.data() + byte_offset;
  params->size = size;

  return Just(true);
}

bool RandomBytesTraits::DeriveBits(
    Environment* env,
    const RandomBytesConfig& params,
    ByteSource* unused) {
  CheckEntropy();  // Ensure that OpenSSL's PRNG is properly seeded.
  return RAND_bytes(params.buffer, params.size) != 0;
}

void RandomPrimeConfig::MemoryInfo(MemoryTracker* tracker) const {
  tracker->TrackFieldWithSize("prime", prime ? bits * 8 : 0);
}

Maybe<bool> RandomPrimeTraits::EncodeOutput(
    Environment* env,
    const RandomPrimeConfig& params,
    ByteSource* unused,
    v8::Local<v8::Value>* result) {
  size_t size = BN_num_bytes(params.prime.get());
  std::shared_ptr<BackingStore> store =
      ArrayBuffer::NewBackingStore(env->isolate(), size);
  BN_bn2binpad(
      params.prime.get(),
      reinterpret_cast<unsigned char*>(store->Data()),
      size);
  *result = ArrayBuffer::New(env->isolate(), store);
  return Just(true);
}

Maybe<bool> RandomPrimeTraits::AdditionalConfig(
    CryptoJobMode mode,
    const FunctionCallbackInfo<Value>& args,
    unsigned int offset,
    RandomPrimeConfig* params) {
  ClearErrorOnReturn clear_error;
  Environment* env = Environment::GetCurrent(args);
  CHECK(args[offset]->IsUint32());  // Size
  CHECK(args[offset + 1]->IsBoolean());  // Safe

  const uint32_t size = args[offset].As<Uint32>()->Value();
  bool safe = args[offset + 1]->IsTrue();

  if (!args[offset + 2]->IsUndefined()) {
    ArrayBufferOrViewContents<unsigned char> add(args[offset + 2]);
    params->add.reset(BN_bin2bn(add.data(), add.size(), nullptr));
    if (!params->add) {
      THROW_ERR_CRYPTO_OPERATION_FAILED(env, "could not generate prime");
      return Nothing<bool>();
    }
  }

  if (!args[offset + 3]->IsUndefined()) {
    ArrayBufferOrViewContents<unsigned char> rem(args[offset + 3]);
    params->rem.reset(BN_bin2bn(rem.data(), rem.size(), nullptr));
    if (!params->rem) {
      THROW_ERR_CRYPTO_OPERATION_FAILED(env, "could not generate prime");
      return Nothing<bool>();
    }
  }

  // The JS interface already ensures that the (positive) size fits into an int.
  int bits = static_cast<int>(size);
  CHECK_GT(bits, 0);

  if (params->add) {
    if (BN_num_bits(params->add.get()) > bits) {
      // If we allowed this, the best case would be returning a static prime
      // that wasn't generated randomly. The worst case would be an infinite
      // loop within OpenSSL, blocking the main thread or one of the threads
      // in the thread pool.
      THROW_ERR_OUT_OF_RANGE(env, "invalid options.add");
      return Nothing<bool>();
    }

    if (params->rem) {
      if (BN_cmp(params->add.get(), params->rem.get()) != 1) {
        // This would definitely lead to an infinite loop if allowed since
        // OpenSSL does not check this condition.
        THROW_ERR_OUT_OF_RANGE(env, "invalid options.rem");
        return Nothing<bool>();
      }
    }
  }

  params->bits = bits;
  params->safe = safe;
  params->prime.reset(BN_secure_new());
  if (!params->prime) {
    THROW_ERR_CRYPTO_OPERATION_FAILED(env, "could not generate prime");
    return Nothing<bool>();
  }

  return Just(true);
}

bool RandomPrimeTraits::DeriveBits(
    Environment* env,
    const RandomPrimeConfig& params,
    ByteSource* unused) {

  CheckEntropy();

  if (BN_generate_prime_ex(
          params.prime.get(),
          params.bits,
          params.safe ? 1 : 0,
          params.add.get(),
          params.rem.get(),
          nullptr) == 0) {
    return false;
  }

  return true;
}

void CheckPrimeConfig::MemoryInfo(MemoryTracker* tracker) const {
  tracker->TrackFieldWithSize(
      "prime", candidate ? BN_num_bytes(candidate.get()) : 0);
}

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

  ArrayBufferOrViewContents<unsigned char> candidate(args[offset]);

  params->candidate =
      BignumPointer(BN_bin2bn(
          candidate.data(),
          candidate.size(),
          nullptr));

  CHECK(args[offset + 1]->IsUint32());  // Checks

  const int checks = static_cast<int>(args[offset + 1].As<Uint32>()->Value());
  if (checks < 0) {
    THROW_ERR_OUT_OF_RANGE(env, "invalid options.checks");
    return Nothing<bool>();
  }

  params->checks = checks;

  return Just(true);
}

bool CheckPrimeTraits::DeriveBits(
    Environment* env,
    const CheckPrimeConfig& params,
    ByteSource* out) {

  BignumCtxPointer ctx(BN_CTX_new());

  int ret = BN_is_prime_ex(
            params.candidate.get(),
            params.checks,
            ctx.get(),
            nullptr);
  if (ret < 0) return false;
  char* data = MallocOpenSSL<char>(1);
  data[0] = ret;
  *out = ByteSource::Allocated(data, 1);
  return true;
}

Maybe<bool> CheckPrimeTraits::EncodeOutput(
    Environment* env,
    const CheckPrimeConfig& params,
    ByteSource* out,
    v8::Local<v8::Value>* result) {
  *result = out->get()[0] ? True(env->isolate()) : False(env->isolate());
  return Just(true);
}

namespace Random {
void Initialize(Environment* env, Local<Object> target) {
  RandomBytesJob::Initialize(env, target);
  RandomPrimeJob::Initialize(env, target);
  CheckPrimeJob::Initialize(env, target);
}

void RegisterExternalReferences(ExternalReferenceRegistry* registry) {
  RandomBytesJob::RegisterExternalReferences(registry);
  RandomPrimeJob::RegisterExternalReferences(registry);
  CheckPrimeJob::RegisterExternalReferences(registry);
}
}  // namespace Random
}  // namespace crypto
}  // namespace node


Generated by: GCOVR (Version 4.2)

Line	Branch	Exec	Source
1			#include "crypto/crypto_random.h"
2			#include "crypto/crypto_util.h"
3			#include "allocated_buffer-inl.h"
4			#include "async_wrap-inl.h"
5			#include "env-inl.h"
6			#include "memory_tracker-inl.h"
7			#include "threadpoolwork-inl.h"
8			#include "v8.h"
9
10			#include <openssl/bn.h>
11			#include <openssl/rand.h>
12
13			namespace node {
14
15			using v8::ArrayBuffer;
16			using v8::BackingStore;
17			using v8::False;
18			using v8::FunctionCallbackInfo;
19			using v8::Just;
20			using v8::Local;
21			using v8::Maybe;
22			using v8::Nothing;
23			using v8::Object;
24			using v8::True;
25			using v8::Uint32;
26			using v8::Value;
27
28			namespace crypto {
29		430	Maybe<bool> RandomBytesTraits::EncodeOutput(
30			Environment* env,
31			const RandomBytesConfig& params,
32			ByteSource* unused,
33			v8::Local<v8::Value>* result) {
34		860	*result = v8::Undefined(env->isolate());
35		430	return Just(!result->IsEmpty());
36			}
37
38		430	Maybe<bool> RandomBytesTraits::AdditionalConfig(
39			CryptoJobMode mode,
40			const FunctionCallbackInfo<Value>& args,
41			unsigned int offset,
42			RandomBytesConfig* params) {
43		430	Environment* env = Environment::GetCurrent(args);
44	✓✗✗✓	860	CHECK(IsAnyByteSource(args[offset])); // Buffer to fill
45	✓✗✗✓	860	CHECK(args[offset + 1]->IsUint32()); // Offset
46	✓✗✗✓	860	CHECK(args[offset + 2]->IsUint32()); // Size
47
48	✓✗	1290	ArrayBufferOrViewContents<unsigned char> in(args[offset]);
49
50	✓✗	1290	const uint32_t byte_offset = args[offset + 1].As<Uint32>()->Value();
51	✓✗	1290	const uint32_t size = args[offset + 2].As<Uint32>()->Value();
52	✗✓	430	CHECK_GE(byte_offset + size, byte_offset); // Overflow check.
53	✗✓	430	CHECK_LE(byte_offset + size, in.size()); // Bounds check.
54
55	✗✓	430	if (UNLIKELY(size > INT_MAX)) {
56			THROW_ERR_OUT_OF_RANGE(env, "buffer is too large");
57			return Nothing<bool>();
58			}
59
60		430	params->buffer = in.data() + byte_offset;
61		430	params->size = size;
62
63		430	return Just(true);
64			}
65
66		430	bool RandomBytesTraits::DeriveBits(
67			Environment* env,
68			const RandomBytesConfig& params,
69			ByteSource* unused) {
70		430	CheckEntropy(); // Ensure that OpenSSL's PRNG is properly seeded.
71		430	return RAND_bytes(params.buffer, params.size) != 0;
72			}
73
74			void RandomPrimeConfig::MemoryInfo(MemoryTracker* tracker) const {
75			tracker->TrackFieldWithSize("prime", prime ? bits * 8 : 0);
76			}
77
78		15	Maybe<bool> RandomPrimeTraits::EncodeOutput(
79			Environment* env,
80			const RandomPrimeConfig& params,
81			ByteSource* unused,
82			v8::Local<v8::Value>* result) {
83		15	size_t size = BN_num_bytes(params.prime.get());
84			std::shared_ptr<BackingStore> store =
85		15	ArrayBuffer::NewBackingStore(env->isolate(), size);
86		15	BN_bn2binpad(
87		15	params.prime.get(),
88		15	reinterpret_cast<unsigned char*>(store->Data()),
89			size);
90		30	*result = ArrayBuffer::New(env->isolate(), store);
91		15	return Just(true);
92			}
93
94		21	Maybe<bool> RandomPrimeTraits::AdditionalConfig(
95			CryptoJobMode mode,
96			const FunctionCallbackInfo<Value>& args,
97			unsigned int offset,
98			RandomPrimeConfig* params) {
99		21	ClearErrorOnReturn clear_error;
100		21	Environment* env = Environment::GetCurrent(args);
101	✓✗✗✓	42	CHECK(args[offset]->IsUint32()); // Size
102	✓✗✗✓	42	CHECK(args[offset + 1]->IsBoolean()); // Safe
103
104	✓✗	63	const uint32_t size = args[offset].As<Uint32>()->Value();
105	✓✗	42	bool safe = args[offset + 1]->IsTrue();
106
107	✓✗✓✓	63	if (!args[offset + 2]->IsUndefined()) {
108	✓✗	24	ArrayBufferOrViewContents<unsigned char> add(args[offset + 2]);
109		12	params->add.reset(BN_bin2bn(add.data(), add.size(), nullptr));
110	✗✓	12	if (!params->add) {
111			THROW_ERR_CRYPTO_OPERATION_FAILED(env, "could not generate prime");
112			return Nothing<bool>();
113			}
114			}
115
116	✓✗✓✓	63	if (!args[offset + 3]->IsUndefined()) {
117	✓✗	16	ArrayBufferOrViewContents<unsigned char> rem(args[offset + 3]);
118		8	params->rem.reset(BN_bin2bn(rem.data(), rem.size(), nullptr));
119	✗✓	8	if (!params->rem) {
120			THROW_ERR_CRYPTO_OPERATION_FAILED(env, "could not generate prime");
121			return Nothing<bool>();
122			}
123			}
124
125			// The JS interface already ensures that the (positive) size fits into an int.
126		21	int bits = static_cast<int>(size);
127	✗✓	21	CHECK_GT(bits, 0);
128
129	✓✓	21	if (params->add) {
130	✓✓	12	if (BN_num_bits(params->add.get()) > bits) {
131			// If we allowed this, the best case would be returning a static prime
132			// that wasn't generated randomly. The worst case would be an infinite
133			// loop within OpenSSL, blocking the main thread or one of the threads
134			// in the thread pool.
135		3	THROW_ERR_OUT_OF_RANGE(env, "invalid options.add");
136		3	return Nothing<bool>();
137			}
138
139	✓✓	9	if (params->rem) {
140	✓✓	7	if (BN_cmp(params->add.get(), params->rem.get()) != 1) {
141			// This would definitely lead to an infinite loop if allowed since
142			// OpenSSL does not check this condition.
143		3	THROW_ERR_OUT_OF_RANGE(env, "invalid options.rem");
144		3	return Nothing<bool>();
145			}
146			}
147			}
148
149		15	params->bits = bits;
150		15	params->safe = safe;
151		15	params->prime.reset(BN_secure_new());
152	✗✓	15	if (!params->prime) {
153			THROW_ERR_CRYPTO_OPERATION_FAILED(env, "could not generate prime");
154			return Nothing<bool>();
155			}
156
157		15	return Just(true);
158			}
159
160		15	bool RandomPrimeTraits::DeriveBits(
161			Environment* env,
162			const RandomPrimeConfig& params,
163			ByteSource* unused) {
164
165		15	CheckEntropy();
166
167		30	if (BN_generate_prime_ex(
168			params.prime.get(),
169		15	params.bits,
170	✓✓	15	params.safe ? 1 : 0,
171		15	params.add.get(),
172		15	params.rem.get(),
173	✗✓	15	nullptr) == 0) {
174			return false;
175			}
176
177		15	return true;
178			}
179
180			void CheckPrimeConfig::MemoryInfo(MemoryTracker* tracker) const {
181			tracker->TrackFieldWithSize(
182			"prime", candidate ? BN_num_bytes(candidate.get()) : 0);
183			}
184
185		24	Maybe<bool> CheckPrimeTraits::AdditionalConfig(
186			CryptoJobMode mode,
187			const FunctionCallbackInfo<Value>& args,
188			unsigned int offset,
189			CheckPrimeConfig* params) {
190		24	Environment* env = Environment::GetCurrent(args);
191
192	✓✗	72	ArrayBufferOrViewContents<unsigned char> candidate(args[offset]);
193
194			params->candidate =
195		48	BignumPointer(BN_bin2bn(
196		24	candidate.data(),
197		24	candidate.size(),
198		24	nullptr));
199
200	✓✗✗✓	48	CHECK(args[offset + 1]->IsUint32()); // Checks
201
202	✓✗	72	const int checks = static_cast<int>(args[offset + 1].As<Uint32>()->Value());
203	✗✓	24	if (checks < 0) {
204			THROW_ERR_OUT_OF_RANGE(env, "invalid options.checks");
205			return Nothing<bool>();
206			}
207
208		24	params->checks = checks;
209
210		24	return Just(true);
211			}
212
213		24	bool CheckPrimeTraits::DeriveBits(
214			Environment* env,
215			const CheckPrimeConfig& params,
216			ByteSource* out) {
217
218		48	BignumCtxPointer ctx(BN_CTX_new());
219
220		48	int ret = BN_is_prime_ex(
221		24	params.candidate.get(),
222		24	params.checks,
223			ctx.get(),
224			nullptr);
225	✗✓	24	if (ret < 0) return false;
226		24	char* data = MallocOpenSSL<char>(1);
227		24	data[0] = ret;
228		24	*out = ByteSource::Allocated(data, 1);
229		24	return true;
230			}
231
232		24	Maybe<bool> CheckPrimeTraits::EncodeOutput(
233			Environment* env,
234			const CheckPrimeConfig& params,
235			ByteSource* out,
236			v8::Local<v8::Value>* result) {
237	✓✓	24	*result = out->get()[0] ? True(env->isolate()) : False(env->isolate());
238		24	return Just(true);
239			}
240
241			namespace Random {
242		639	void Initialize(Environment* env, Local<Object> target) {
243		639	RandomBytesJob::Initialize(env, target);
244		639	RandomPrimeJob::Initialize(env, target);
245		639	CheckPrimeJob::Initialize(env, target);
246		639	}
247
248		5046	void RegisterExternalReferences(ExternalReferenceRegistry* registry) {
249		5046	RandomBytesJob::RegisterExternalReferences(registry);
250		5046	RandomPrimeJob::RegisterExternalReferences(registry);
251		5046	CheckPrimeJob::RegisterExternalReferences(registry);
252		5046	}
253			} // namespace Random
254			} // namespace crypto
255			} // namespace node