Skip to content

Commit e20745c

Browse files
committed
Merge bitcoin/bitcoin#22029: [fuzz] Improve transport deserialization fuzz test coverage
e337145 [fuzz] Occasional valid magic bytes for transport serialization test (Dhruv Mehta) 35571d8 [fuzz] Occasional valid checksum for transport serialization fuzz test (Dhruv Mehta) 654472a [fuzz] Add serialization to deserialization test (Dhruv Mehta) Pull request description: This PR has 3 commits that increase the fuzz test coverage: Before commit 1: ``` #306853 REDUCE cov: 798 ft: 5820 corp: 150/375Kb lim: 68333 exec/s: 1382 rss: 461Mb L: 254/63171 MS: 1 EraseBytes- #1453105 REDUCE cov: 798 ft: 5820 corp: 150/369Kb lim: 79613 exec/s: 1467 rss: 461Mb L: 6027/60873 MS: 1 EraseBytes- ``` After commit 1 (adds serialization to de-serialization test): ``` #303389 NEW cov: 1202 ft: 8382 corp: 157/382Kb lim: 68189 exec/s: 1451 rss: 447Mb L: 1386/65459 MS: 1 CopyPart- #1428759 REDUCE cov: 1202 ft: 8512 corp: 169/389Kb lim: 78749 exec/s: 1528 rss: 463Mb L: 1627/60488 MS: 1 EraseBytes- ``` After commit 2 (provides an occasional checksum assist to the fuzzer inputs): ``` #304820 NEW cov: 1440 ft: 4452 corp: 92/12551b lim: 2237 exec/s: 3386 rss: 486Mb L: 47/1111 MS: 1 ChangeByte- #1416181 REDUCE cov: 1442 ft: 5681 corp: 125/59Kb lim: 4096 exec/s: 3522 rss: 535Mb L: 2164/4049 MS: 1 EraseBytes- ``` After commit 3 (provides an occasional magic bytes assist to the fuzzer inputs): ``` #302684 NEW cov: 1454 ft: 3936 corp: 84/7056b lim: 2424 exec/s: 4146 rss: 477Mb L: 65/1108 MS: 3 CopyPart-CrossOver-CMP- DE: "\x0e\x00\x00\x00"- #1383925 REDUCE cov: 1454 ft: 4828 corp: 102/14573b lim: 4096 exec/s: 3954 rss: 534Mb L: 116/4050 MS: 2 EraseBytes-ChangeByte- ``` If reviewers only accept the first commit, the seeds are not invalidated and new seeds are at: bitcoin-core/qa-assets#61. In this case, we can also revert the test name change. If reviewers accept all three commits, the existing seeds are invalidated. ACKs for top commit: practicalswift: Tested ACK e337145 Tree-SHA512: d37f06eea0249322b00a99c4827359eb53aeb711751e5571f4681eeca06dc257e0c4cd4887150fc37cc2f689e26986112d768066ad274361615ba9b6a522c61a
2 parents 7076bba + e337145 commit e20745c

File tree

3 files changed

+86
-44
lines changed

3 files changed

+86
-44
lines changed

src/Makefile.test.include

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ test_fuzz_fuzz_SOURCES = \
258258
test/fuzz/netaddress.cpp \
259259
test/fuzz/netbase_dns_lookup.cpp \
260260
test/fuzz/node_eviction.cpp \
261-
test/fuzz/p2p_transport_deserializer.cpp \
261+
test/fuzz/p2p_transport_serialization.cpp \
262262
test/fuzz/parse_hd_keypath.cpp \
263263
test/fuzz/parse_iso8601.cpp \
264264
test/fuzz/parse_numbers.cpp \

src/test/fuzz/p2p_transport_deserializer.cpp

Lines changed: 0 additions & 43 deletions
This file was deleted.
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
// Copyright (c) 2019-2020 The Bitcoin Core developers
2+
// Distributed under the MIT software license, see the accompanying
3+
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4+
5+
#include <chainparams.h>
6+
#include <hash.h>
7+
#include <net.h>
8+
#include <netmessagemaker.h>
9+
#include <protocol.h>
10+
#include <test/fuzz/FuzzedDataProvider.h>
11+
#include <test/fuzz/fuzz.h>
12+
13+
#include <cassert>
14+
#include <cstdint>
15+
#include <limits>
16+
#include <optional>
17+
#include <vector>
18+
19+
void initialize_p2p_transport_serialization()
20+
{
21+
SelectParams(CBaseChainParams::REGTEST);
22+
}
23+
24+
FUZZ_TARGET_INIT(p2p_transport_serialization, initialize_p2p_transport_serialization)
25+
{
26+
// Construct deserializer, with a dummy NodeId
27+
V1TransportDeserializer deserializer{Params(), (NodeId)0, SER_NETWORK, INIT_PROTO_VERSION};
28+
V1TransportSerializer serializer{};
29+
FuzzedDataProvider fuzzed_data_provider{buffer.data(), buffer.size()};
30+
31+
auto checksum_assist = fuzzed_data_provider.ConsumeBool();
32+
auto magic_bytes_assist = fuzzed_data_provider.ConsumeBool();
33+
std::vector<uint8_t> mutable_msg_bytes;
34+
35+
auto header_bytes_remaining = CMessageHeader::HEADER_SIZE;
36+
if (magic_bytes_assist) {
37+
auto msg_start = Params().MessageStart();
38+
for (size_t i = 0; i < CMessageHeader::MESSAGE_SIZE_SIZE; ++i) {
39+
mutable_msg_bytes.push_back(msg_start[i]);
40+
}
41+
header_bytes_remaining -= CMessageHeader::MESSAGE_SIZE_SIZE;
42+
}
43+
44+
if (checksum_assist) {
45+
header_bytes_remaining -= CMessageHeader::CHECKSUM_SIZE;
46+
}
47+
48+
auto header_random_bytes = fuzzed_data_provider.ConsumeBytes<uint8_t>(header_bytes_remaining);
49+
mutable_msg_bytes.insert(mutable_msg_bytes.end(), header_random_bytes.begin(), header_random_bytes.end());
50+
auto payload_bytes = fuzzed_data_provider.ConsumeRemainingBytes<uint8_t>();
51+
52+
if (checksum_assist && mutable_msg_bytes.size() == CMessageHeader::CHECKSUM_OFFSET) {
53+
CHash256 hasher;
54+
unsigned char hsh[32];
55+
hasher.Write(payload_bytes);
56+
hasher.Finalize(hsh);
57+
for (size_t i = 0; i < CMessageHeader::CHECKSUM_SIZE; ++i) {
58+
mutable_msg_bytes.push_back(hsh[i]);
59+
}
60+
}
61+
62+
mutable_msg_bytes.insert(mutable_msg_bytes.end(), payload_bytes.begin(), payload_bytes.end());
63+
Span<const uint8_t> msg_bytes{mutable_msg_bytes};
64+
while (msg_bytes.size() > 0) {
65+
const int handled = deserializer.Read(msg_bytes);
66+
if (handled < 0) {
67+
break;
68+
}
69+
if (deserializer.Complete()) {
70+
const std::chrono::microseconds m_time{std::numeric_limits<int64_t>::max()};
71+
uint32_t out_err_raw_size{0};
72+
std::optional<CNetMessage> result{deserializer.GetMessage(m_time, out_err_raw_size)};
73+
if (result) {
74+
assert(result->m_command.size() <= CMessageHeader::COMMAND_SIZE);
75+
assert(result->m_raw_message_size <= mutable_msg_bytes.size());
76+
assert(result->m_raw_message_size == CMessageHeader::HEADER_SIZE + result->m_message_size);
77+
assert(result->m_time == m_time);
78+
79+
std::vector<unsigned char> header;
80+
auto msg = CNetMsgMaker{result->m_recv.GetVersion()}.Make(result->m_command, MakeUCharSpan(result->m_recv));
81+
serializer.prepareForTransport(msg, header);
82+
}
83+
}
84+
}
85+
}

0 commit comments

Comments
 (0)