Skip to content

Commit fa4baf0

Browse files
author
MarcoFalke
committed
fuzz: Rework ConsumeScript
This should make it easier for the fuzz engine to explore multisig code paths. See discussion in bitcoin#23105 The downside is that all fuzz inputs that use ConsumeScript are now invalidated and need to be re-generated. Another downside may be that most multisig scripts from ConsumeScript are using likely not fully valid pubkeys.
1 parent 077e98c commit fa4baf0

File tree

4 files changed

+61
-10
lines changed

4 files changed

+61
-10
lines changed

src/test/fuzz/script.cpp

+1-3
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,7 @@ void initialize_script()
4141
FUZZ_TARGET_INIT(script, initialize_script)
4242
{
4343
FuzzedDataProvider fuzzed_data_provider(buffer.data(), buffer.size());
44-
const std::optional<CScript> script_opt = ConsumeDeserializable<CScript>(fuzzed_data_provider);
45-
if (!script_opt) return;
46-
const CScript script{*script_opt};
44+
const CScript script{ConsumeScript(fuzzed_data_provider)};
4745

4846
CompressedScript compressed;
4947
if (CompressScript(script, compressed)) {

src/test/fuzz/signature_checker.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ FUZZ_TARGET_INIT(signature_checker, initialize_signature_checker)
5858
FuzzedDataProvider fuzzed_data_provider(buffer.data(), buffer.size());
5959
const unsigned int flags = fuzzed_data_provider.ConsumeIntegral<unsigned int>();
6060
const SigVersion sig_version = fuzzed_data_provider.PickValueInArray({SigVersion::BASE, SigVersion::WITNESS_V0});
61-
const auto script_1 = ConsumeScript(fuzzed_data_provider, 65536);
62-
const auto script_2 = ConsumeScript(fuzzed_data_provider, 65536);
61+
const auto script_1{ConsumeScript(fuzzed_data_provider)};
62+
const auto script_2{ConsumeScript(fuzzed_data_provider)};
6363
std::vector<std::vector<unsigned char>> stack;
6464
(void)EvalScript(stack, script_1, flags, FuzzedSignatureChecker(fuzzed_data_provider), sig_version, nullptr);
6565
if (!IsValidFlagCombination(flags)) {

src/test/fuzz/util.cpp

+57-4
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ CMutableTransaction ConsumeTransaction(FuzzedDataProvider& fuzzed_data_provider,
267267
const auto amount = fuzzed_data_provider.ConsumeIntegralInRange<CAmount>(-10, 50 * COIN + 10);
268268
const auto script_pk = p2wsh_op_true ?
269269
P2WSH_OP_TRUE :
270-
ConsumeScript(fuzzed_data_provider, /* max_length */ 128, /* maybe_p2wsh */ true);
270+
ConsumeScript(fuzzed_data_provider, /*maybe_p2wsh=*/true);
271271
tx_mut.vout.emplace_back(amount, script_pk);
272272
}
273273
return tx_mut;
@@ -283,10 +283,63 @@ CScriptWitness ConsumeScriptWitness(FuzzedDataProvider& fuzzed_data_provider, co
283283
return ret;
284284
}
285285

286-
CScript ConsumeScript(FuzzedDataProvider& fuzzed_data_provider, const std::optional<size_t>& max_length, const bool maybe_p2wsh) noexcept
286+
CScript ConsumeScript(FuzzedDataProvider& fuzzed_data_provider, const bool maybe_p2wsh) noexcept
287287
{
288-
const std::vector<uint8_t> b = ConsumeRandomLengthByteVector(fuzzed_data_provider, max_length);
289-
CScript r_script{b.begin(), b.end()};
288+
CScript r_script{};
289+
{
290+
// Keep a buffer of bytes to allow the fuzz engine to produce smaller
291+
// inputs to generate CScripts with repeated data.
292+
static constexpr unsigned MAX_BUFFER_SZ{128};
293+
std::vector<uint8_t> buffer(MAX_BUFFER_SZ, uint8_t{'a'});
294+
while (fuzzed_data_provider.ConsumeBool()) {
295+
CallOneOf(
296+
fuzzed_data_provider,
297+
[&] {
298+
// Insert byte vector directly to allow malformed or unparsable scripts
299+
r_script.insert(r_script.end(), buffer.begin(), buffer.begin() + fuzzed_data_provider.ConsumeIntegralInRange(0U, MAX_BUFFER_SZ));
300+
},
301+
[&] {
302+
// Push a byte vector from the buffer
303+
r_script << std::vector<uint8_t>{buffer.begin(), buffer.begin() + fuzzed_data_provider.ConsumeIntegralInRange(0U, MAX_BUFFER_SZ)};
304+
},
305+
[&] {
306+
// Push multisig
307+
// There is a special case for this to aid the fuzz engine
308+
// navigate the highly structured multisig format.
309+
r_script << fuzzed_data_provider.ConsumeIntegralInRange<int64_t>(0, 22);
310+
int num_data{fuzzed_data_provider.ConsumeIntegralInRange(1, 22)};
311+
std::vector<uint8_t> pubkey_comp{buffer.begin(), buffer.begin() + CPubKey::COMPRESSED_SIZE};
312+
pubkey_comp.front() = fuzzed_data_provider.ConsumeIntegralInRange(2, 3); // Set first byte for GetLen() to pass
313+
std::vector<uint8_t> pubkey_uncomp{buffer.begin(), buffer.begin() + CPubKey::SIZE};
314+
pubkey_uncomp.front() = fuzzed_data_provider.ConsumeIntegralInRange(4, 7); // Set first byte for GetLen() to pass
315+
while (num_data--) {
316+
auto& pubkey{fuzzed_data_provider.ConsumeBool() ? pubkey_uncomp : pubkey_comp};
317+
if (fuzzed_data_provider.ConsumeBool()) {
318+
pubkey.back() = num_data; // Make each pubkey different
319+
}
320+
r_script << pubkey;
321+
}
322+
r_script << fuzzed_data_provider.ConsumeIntegralInRange<int64_t>(0, 22);
323+
},
324+
[&] {
325+
// Mutate the buffer
326+
const auto vec{ConsumeRandomLengthByteVector(fuzzed_data_provider, /*max_length=*/MAX_BUFFER_SZ)};
327+
std::copy(vec.begin(), vec.end(), buffer.begin());
328+
},
329+
[&] {
330+
// Push an integral
331+
r_script << fuzzed_data_provider.ConsumeIntegral<int64_t>();
332+
},
333+
[&] {
334+
// Push an opcode
335+
r_script << ConsumeOpcodeType(fuzzed_data_provider);
336+
},
337+
[&] {
338+
// Push a scriptnum
339+
r_script << ConsumeScriptNum(fuzzed_data_provider);
340+
});
341+
}
342+
}
290343
if (maybe_p2wsh && fuzzed_data_provider.ConsumeBool()) {
291344
uint256 script_hash;
292345
CSHA256().Write(r_script.data(), r_script.size()).Finalize(script_hash.begin());

src/test/fuzz/util.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ template <typename WeakEnumType, size_t size>
132132

133133
[[nodiscard]] CScriptWitness ConsumeScriptWitness(FuzzedDataProvider& fuzzed_data_provider, const size_t max_stack_elem_size = 32) noexcept;
134134

135-
[[nodiscard]] CScript ConsumeScript(FuzzedDataProvider& fuzzed_data_provider, const std::optional<size_t>& max_length = std::nullopt, const bool maybe_p2wsh = false) noexcept;
135+
[[nodiscard]] CScript ConsumeScript(FuzzedDataProvider& fuzzed_data_provider, const bool maybe_p2wsh = false) noexcept;
136136

137137
[[nodiscard]] uint32_t ConsumeSequence(FuzzedDataProvider& fuzzed_data_provider) noexcept;
138138

0 commit comments

Comments
 (0)