Branch data Line data Source code
1 : : // Copyright (c) 2009-present 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 <test/fuzz/fuzz.h>
6 : :
7 : : #include <netaddress.h>
8 : : #include <netbase.h>
9 : : #include <test/fuzz/util/check_globals.h>
10 : : #include <test/util/coverage.h>
11 : : #include <test/util/random.h>
12 : : #include <test/util/setup_common.h>
13 : : #include <util/check.h>
14 : : #include <util/fs.h>
15 : : #include <util/sock.h>
16 : : #include <util/time.h>
17 : :
18 : : #include <csignal>
19 : : #include <cstdint>
20 : : #include <cstdio>
21 : : #include <cstdlib>
22 : : #include <cstring>
23 : : #include <exception>
24 : : #include <fstream>
25 : : #include <functional>
26 : : #include <iostream>
27 : : #include <map>
28 : : #include <memory>
29 : : #include <string>
30 : : #include <tuple>
31 : : #include <utility>
32 : : #include <vector>
33 : :
34 : : #if defined(PROVIDE_FUZZ_MAIN_FUNCTION) && defined(__AFL_FUZZ_INIT)
35 : : __AFL_FUZZ_INIT();
36 : : #endif
37 : :
38 : : const std::function<void(const std::string&)> G_TEST_LOG_FUN{};
39 : :
40 : : /**
41 : : * A copy of the command line arguments that start with `--`.
42 : : * First `LLVMFuzzerInitialize()` is called, which saves the arguments to `g_args`.
43 : : * Later, depending on the fuzz test, `G_TEST_COMMAND_LINE_ARGUMENTS()` may be
44 : : * called by `BasicTestingSetup` constructor to fetch those arguments and store
45 : : * them in `BasicTestingSetup::m_node::args`.
46 : : */
47 : : static std::vector<const char*> g_args;
48 : :
49 : 0 : static void SetArgs(int argc, char** argv) {
50 [ # # ]: 0 : for (int i = 1; i < argc; ++i) {
51 : : // Only take into account arguments that start with `--`. The others are for the fuzz engine:
52 : : // `fuzz -runs=1 fuzz_corpora/address_deserialize_v2 --checkaddrman=5`
53 [ # # # # : 0 : if (strlen(argv[i]) > 2 && argv[i][0] == '-' && argv[i][1] == '-') {
# # ]
54 : 0 : g_args.push_back(argv[i]);
55 : : }
56 : : }
57 : 0 : }
58 : :
59 : 901 : const std::function<std::vector<const char*>()> G_TEST_COMMAND_LINE_ARGUMENTS = []() {
60 : 901 : return g_args;
61 : : };
62 : :
63 : 96800 : struct FuzzTarget {
64 : : const TypeTestOneInput test_one_input;
65 : : const FuzzTargetOptions opts;
66 : : };
67 : :
68 : 48839 : auto& FuzzTargets()
69 : : {
70 [ + + + - ]: 49058 : static std::map<std::string_view, FuzzTarget> g_fuzz_targets;
71 : 48839 : return g_fuzz_targets;
72 : : }
73 : :
74 : 48400 : void FuzzFrameworkRegisterTarget(std::string_view name, TypeTestOneInput target, FuzzTargetOptions opts)
75 : : {
76 [ + - ]: 96800 : const auto [it, ins]{FuzzTargets().try_emplace(name, FuzzTarget /* temporary can be dropped after Apple-Clang-16 ? */ {std::move(target), std::move(opts)})};
77 : 48400 : Assert(ins);
78 : 48400 : }
79 : :
80 : : static std::string_view g_fuzz_target;
81 : : static const TypeTestOneInput* g_test_one_input{nullptr};
82 : :
83 : 117666 : static void test_one_input(FuzzBufferType buffer)
84 : : {
85 : 117666 : CheckGlobals check{};
86 [ + - + - ]: 117666 : (*Assert(g_test_one_input))(buffer);
87 : 117666 : }
88 : :
89 : 901 : const std::function<std::string()> G_TEST_GET_FULL_NAME{[]{
90 : 901 : return std::string{g_fuzz_target};
91 : : }};
92 : :
93 : 220 : static void initialize()
94 : : {
95 : : // By default, make the RNG deterministic with a fixed seed. This will affect all
96 : : // randomness during the fuzz test, except:
97 : : // - GetStrongRandBytes(), which is used for the creation of private key material.
98 : : // - Randomness obtained before this call in g_rng_temp_path_init
99 : 220 : SeedRandomStateForTest(SeedRand::ZEROS);
100 : :
101 : : // Set time to the genesis block timestamp for deterministic initialization.
102 : 220 : SetMockTime(1231006505);
103 : :
104 : : // Terminate immediately if a fuzzing harness ever tries to create a socket.
105 : : // Individual tests can override this by pointing CreateSock to a mocked alternative.
106 : 220 : CreateSock = [](int, int, int) -> std::unique_ptr<Sock> { std::terminate(); };
107 : :
108 : : // Terminate immediately if a fuzzing harness ever tries to perform a DNS lookup.
109 : 364769 : g_dns_lookup = [](const std::string& name, bool allow_lookup) {
110 [ - + ]: 364549 : if (allow_lookup) {
111 : 0 : std::terminate();
112 : : }
113 : 364549 : return WrappedGetAddrInfo(name, false);
114 : 220 : };
115 : :
116 : 220 : bool should_exit{false};
117 [ + + ]: 220 : if (std::getenv("PRINT_ALL_FUZZ_TARGETS_AND_ABORT")) {
118 [ + + + + ]: 221 : for (const auto& [name, t] : FuzzTargets()) {
119 [ + + ]: 220 : if (t.opts.hidden) continue;
120 : 219 : std::cout << name << std::endl;
121 : : }
122 : : should_exit = true;
123 : : }
124 [ - + ]: 220 : if (const char* out_path = std::getenv("WRITE_ALL_FUZZ_TARGETS_AND_ABORT")) {
125 : 0 : std::cout << "Writing all fuzz target names to '" << out_path << "'." << std::endl;
126 : 0 : std::ofstream out_stream{out_path, std::ios::binary};
127 [ # # # # : 0 : for (const auto& [name, t] : FuzzTargets()) {
# # ]
128 [ # # ]: 0 : if (t.opts.hidden) continue;
129 [ # # # # ]: 0 : out_stream << name << std::endl;
130 : : }
131 : 0 : should_exit = true;
132 : 0 : }
133 [ + + ]: 220 : if (should_exit) {
134 : 1 : std::exit(EXIT_SUCCESS);
135 : : }
136 [ + - ]: 219 : if (const auto* env_fuzz{std::getenv("FUZZ")}) {
137 : : // To allow for easier fuzz executable binary modification,
138 [ + - + - : 438 : static std::string g_copy{env_fuzz}; // create copy to avoid compiler optimizations, and
+ - ]
139 : 219 : g_fuzz_target = g_copy.c_str(); // strip string after the first null-char.
140 : : } else {
141 : 0 : std::cerr << "Must select fuzz target with the FUZZ env var." << std::endl;
142 : 0 : std::cerr << "Hint: Set the PRINT_ALL_FUZZ_TARGETS_AND_ABORT=1 env var to see all compiled targets." << std::endl;
143 : 0 : std::exit(EXIT_FAILURE);
144 : : }
145 : 219 : const auto it = FuzzTargets().find(g_fuzz_target);
146 [ - + ]: 219 : if (it == FuzzTargets().end()) {
147 : 0 : std::cerr << "No fuzz target compiled for " << g_fuzz_target << "." << std::endl;
148 : 0 : std::exit(EXIT_FAILURE);
149 : : }
150 : 219 : if constexpr (!G_FUZZING) {
151 : : std::cerr << "Must compile with -DBUILD_FOR_FUZZING=ON to execute a fuzz target." << std::endl;
152 : : std::exit(EXIT_FAILURE);
153 : : }
154 : 219 : Assert(!g_test_one_input);
155 : 219 : g_test_one_input = &it->second.test_one_input;
156 : 219 : it->second.opts.init();
157 : :
158 : 219 : ResetCoverageCounters();
159 : 219 : }
160 : :
161 : : #if defined(PROVIDE_FUZZ_MAIN_FUNCTION)
162 : 0 : static bool read_stdin(std::vector<uint8_t>& data)
163 : : {
164 : 0 : std::istream::char_type buffer[1024];
165 : 0 : std::streamsize length;
166 [ # # ]: 0 : while ((std::cin.read(buffer, 1024), length = std::cin.gcount()) > 0) {
167 : 0 : data.insert(data.end(), buffer, buffer + length);
168 : : }
169 : 0 : return length == 0;
170 : : }
171 : : #endif
172 : :
173 : : #if defined(PROVIDE_FUZZ_MAIN_FUNCTION) && !defined(__AFL_LOOP)
174 : 117666 : static bool read_file(fs::path p, std::vector<uint8_t>& data)
175 : : {
176 : 117666 : uint8_t buffer[1024];
177 : 117666 : FILE* f = fsbridge::fopen(p, "rb");
178 [ + - ]: 117666 : if (f == nullptr) return false;
179 : 2505010 : do {
180 : 2505010 : const size_t length = fread(buffer, sizeof(uint8_t), sizeof(buffer), f);
181 [ + - ]: 2505010 : if (ferror(f)) return false;
182 : 2505010 : data.insert(data.end(), buffer, buffer + length);
183 [ + + ]: 2505010 : } while (!feof(f));
184 : 117666 : fclose(f);
185 : 117666 : return true;
186 : : }
187 : : #endif
188 : :
189 : : #if defined(PROVIDE_FUZZ_MAIN_FUNCTION) && !defined(__AFL_LOOP)
190 : : static fs::path g_input_path;
191 : 0 : void signal_handler(int signal)
192 : : {
193 [ # # ]: 0 : if (signal == SIGABRT) {
194 : 0 : std::cerr << "Error processing input " << g_input_path << std::endl;
195 : : } else {
196 : 0 : std::cerr << "Unexpected signal " << signal << " received\n";
197 : : }
198 : 0 : std::_Exit(EXIT_FAILURE);
199 : : }
200 : : #endif
201 : :
202 : : // This function is used by libFuzzer
203 : 0 : extern "C" int LLVMFuzzerTestOneInput(const uint8_t* data, size_t size)
204 : : {
205 : 0 : test_one_input({data, size});
206 : 0 : return 0;
207 : : }
208 : :
209 : : // This function is used by libFuzzer
210 : 0 : extern "C" int LLVMFuzzerInitialize(int* argc, char*** argv)
211 : : {
212 : 0 : SetArgs(*argc, *argv);
213 : 0 : initialize();
214 : 0 : return 0;
215 : : }
216 : :
217 : : #if defined(PROVIDE_FUZZ_MAIN_FUNCTION)
218 : 220 : int main(int argc, char** argv)
219 : : {
220 : 220 : initialize();
221 : : #ifdef __AFL_LOOP
222 : : // Enable AFL persistent mode. Requires compilation using afl-clang-fast++.
223 : : // See fuzzing.md for details.
224 : : const uint8_t* buffer = __AFL_FUZZ_TESTCASE_BUF;
225 : : while (__AFL_LOOP(100000)) {
226 : : size_t buffer_len = __AFL_FUZZ_TESTCASE_LEN;
227 : : test_one_input({buffer, buffer_len});
228 : : }
229 : : #else
230 : 219 : std::vector<uint8_t> buffer;
231 [ - + ]: 219 : if (argc <= 1) {
232 [ # # # # ]: 0 : if (!read_stdin(buffer)) {
233 : : return 0;
234 : : }
235 [ # # ]: 0 : test_one_input(buffer);
236 : : return 0;
237 : : }
238 : 219 : std::signal(SIGABRT, signal_handler);
239 : 219 : const auto start_time{Now<SteadySeconds>()};
240 : 219 : int tested = 0;
241 [ + + ]: 438 : for (int i = 1; i < argc; ++i) {
242 [ + - ]: 219 : fs::path input_path(*(argv + i));
243 [ + - + - ]: 219 : if (fs::is_directory(input_path)) {
244 [ + - + + : 118104 : for (fs::directory_iterator it(input_path); it != fs::directory_iterator(); ++it) {
+ + ]
245 [ + - - + ]: 117666 : if (!fs::is_regular_file(it->path())) continue;
246 [ + - ]: 235332 : g_input_path = it->path();
247 [ + - + - : 352998 : Assert(read_file(it->path(), buffer));
+ - ]
248 [ + - ]: 117666 : test_one_input(buffer);
249 : 117666 : ++tested;
250 [ + - + - ]: 235332 : buffer.clear();
251 : 219 : }
252 : : } else {
253 [ # # ]: 0 : g_input_path = input_path;
254 [ # # # # : 0 : Assert(read_file(input_path, buffer));
# # ]
255 [ # # ]: 0 : test_one_input(buffer);
256 : 0 : ++tested;
257 [ - - ]: 219 : buffer.clear();
258 : : }
259 : 219 : }
260 : 219 : const auto end_time{Now<SteadySeconds>()};
261 [ + - + - : 219 : std::cout << g_fuzz_target << ": succeeded against " << tested << " files in " << count_seconds(end_time - start_time) << "s." << std::endl;
+ - + - +
- + - +
- ]
262 : : #endif
263 : : return 0;
264 : 219 : }
265 : : #endif
|
