Bitcoin Core 28.99.0
P2P Digital Currency
banman.cpp
Go to the documentation of this file.
1// Copyright (c) 2020-2022 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 <banman.h>
6#include <common/args.h>
7#include <netaddress.h>
9#include <test/fuzz/fuzz.h>
10#include <test/fuzz/util.h>
11#include <test/fuzz/util/net.h>
13#include <util/fs.h>
14#include <util/readwritefile.h>
15
16#include <cassert>
17#include <cstdint>
18#include <limits>
19#include <string>
20#include <vector>
21
22namespace {
23int64_t ConsumeBanTimeOffset(FuzzedDataProvider& fuzzed_data_provider) noexcept
24{
25 // Avoid signed integer overflow by capping to int32_t max:
26 // banman.cpp:137:73: runtime error: signed integer overflow: 1591700817 + 9223372036854775807 cannot be represented in type 'long'
27 return fuzzed_data_provider.ConsumeIntegralInRange<int64_t>(std::numeric_limits<int64_t>::min(), std::numeric_limits<int32_t>::max());
28}
29} // namespace
30
32{
33 static const auto testing_setup = MakeNoLogFileContext<>();
34}
35
36static bool operator==(const CBanEntry& lhs, const CBanEntry& rhs)
37{
38 return lhs.nVersion == rhs.nVersion &&
39 lhs.nCreateTime == rhs.nCreateTime &&
40 lhs.nBanUntil == rhs.nBanUntil;
41}
42
44{
46 FuzzedDataProvider fuzzed_data_provider{buffer.data(), buffer.size()};
47 SetMockTime(ConsumeTime(fuzzed_data_provider));
48 fs::path banlist_file = gArgs.GetDataDirNet() / "fuzzed_banlist";
49
50 const bool start_with_corrupted_banlist{fuzzed_data_provider.ConsumeBool()};
51 bool force_read_and_write_to_err{false};
52 if (start_with_corrupted_banlist) {
53 assert(WriteBinaryFile(banlist_file + ".json",
54 fuzzed_data_provider.ConsumeRandomLengthString()));
55 } else {
56 force_read_and_write_to_err = fuzzed_data_provider.ConsumeBool();
57 if (force_read_and_write_to_err) {
58 banlist_file = fs::path{"path"} / "to" / "inaccessible" / "fuzzed_banlist";
59 }
60 }
61
62 {
63 BanMan ban_man{banlist_file, /*client_interface=*/nullptr, /*default_ban_time=*/ConsumeBanTimeOffset(fuzzed_data_provider)};
64 // The complexity is O(N^2), where N is the input size, because each call
65 // might call DumpBanlist (or other methods that are at least linear
66 // complexity of the input size).
67 bool contains_invalid{false};
68 LIMITED_WHILE(fuzzed_data_provider.ConsumeBool(), 300)
69 {
71 fuzzed_data_provider,
72 [&] {
73 CNetAddr net_addr{ConsumeNetAddr(fuzzed_data_provider)};
74 if (!net_addr.IsCJDNS() || !net_addr.IsValid()) {
75 const std::optional<CNetAddr>& addr{LookupHost(net_addr.ToStringAddr(), /*fAllowLookup=*/false)};
76 if (addr.has_value() && addr->IsValid()) {
77 net_addr = *addr;
78 } else {
79 contains_invalid = true;
80 }
81 }
82 auto ban_time_offset = ConsumeBanTimeOffset(fuzzed_data_provider);
83 auto since_unix_epoch = fuzzed_data_provider.ConsumeBool();
84 ban_man.Ban(net_addr, ban_time_offset, since_unix_epoch);
85 },
86 [&] {
87 CSubNet subnet{ConsumeSubNet(fuzzed_data_provider)};
88 subnet = LookupSubNet(subnet.ToString());
89 if (!subnet.IsValid()) {
90 contains_invalid = true;
91 }
92 auto ban_time_offset = ConsumeBanTimeOffset(fuzzed_data_provider);
93 auto since_unix_epoch = fuzzed_data_provider.ConsumeBool();
94 ban_man.Ban(subnet, ban_time_offset, since_unix_epoch);
95 },
96 [&] {
97 ban_man.ClearBanned();
98 },
99 [&] {
100 ban_man.IsBanned(ConsumeNetAddr(fuzzed_data_provider));
101 },
102 [&] {
103 ban_man.IsBanned(ConsumeSubNet(fuzzed_data_provider));
104 },
105 [&] {
106 ban_man.Unban(ConsumeNetAddr(fuzzed_data_provider));
107 },
108 [&] {
109 ban_man.Unban(ConsumeSubNet(fuzzed_data_provider));
110 },
111 [&] {
112 banmap_t banmap;
113 ban_man.GetBanned(banmap);
114 },
115 [&] {
116 ban_man.DumpBanlist();
117 },
118 [&] {
119 ban_man.Discourage(ConsumeNetAddr(fuzzed_data_provider));
120 });
121 }
122 if (!force_read_and_write_to_err) {
123 ban_man.DumpBanlist();
124 SetMockTime(ConsumeTime(fuzzed_data_provider));
125 banmap_t banmap;
126 ban_man.GetBanned(banmap);
127 BanMan ban_man_read{banlist_file, /*client_interface=*/nullptr, /*default_ban_time=*/0};
128 banmap_t banmap_read;
129 ban_man_read.GetBanned(banmap_read);
130 if (!contains_invalid) {
131 assert(banmap == banmap_read);
132 }
133 }
134 }
135 fs::remove(fs::PathToString(banlist_file + ".json"));
136}
ArgsManager gArgs
Definition: args.cpp:42
fs::path GetDataDirNet() const
Get data directory path with appended network identifier.
Definition: args.h:234
Definition: banman.h:59
Definition: net_types.h:15
int64_t nCreateTime
Definition: net_types.h:19
int nVersion
Definition: net_types.h:18
int64_t nBanUntil
Definition: net_types.h:20
Network address.
Definition: netaddress.h:112
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
Definition: fs.h:33
#define LIMITED_WHILE(condition, limit)
Can be used to limit a theoretically unbounded loop.
Definition: fuzz.h:22
static std::string PathToString(const path &path)
Convert path object to a byte string.
Definition: fs.h:151
std::map< CSubNet, CBanEntry > banmap_t
Definition: net_types.h:41
CSubNet LookupSubNet(const std::string &subnet_str)
Parse and resolve a specified subnet string into the appropriate internal representation.
Definition: netbase.cpp:756
std::vector< CNetAddr > LookupHost(const std::string &name, unsigned int nMaxSolutions, bool fAllowLookup, DNSLookupFn dns_lookup_function)
Resolve a host string to its corresponding network addresses.
Definition: netbase.cpp:177
bool WriteBinaryFile(const fs::path &filename, const std::string &data)
Write contents of std::string to a file.
void initialize_banman()
Definition: banman.cpp:31
FUZZ_TARGET(banman,.init=initialize_banman)
Definition: banman.cpp:43
static bool operator==(const CBanEntry &lhs, const CBanEntry &rhs)
Definition: banman.cpp:36
CNetAddr ConsumeNetAddr(FuzzedDataProvider &fuzzed_data_provider, FastRandomContext *rand) noexcept
Create a CNetAddr.
Definition: net.cpp:28
CSubNet ConsumeSubNet(FuzzedDataProvider &fuzzed_data_provider) noexcept
Definition: net.h:208
int64_t ConsumeTime(FuzzedDataProvider &fuzzed_data_provider, const std::optional< int64_t > &min, const std::optional< int64_t > &max) noexcept
Definition: util.cpp:34
size_t CallOneOf(FuzzedDataProvider &fuzzed_data_provider, Callables... callables)
Definition: util.h:35
void SeedRandomStateForTest(SeedRand seedtype)
Seed the global RNG state for testing and log the seed value.
Definition: random.cpp:19
@ ZEROS
Seed with a compile time constant of zeros.
void SetMockTime(int64_t nMockTimeIn)
DEPRECATED Use SetMockTime with chrono type.
Definition: time.cpp:35
assert(!tx.IsCoinBase())