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/util/net.h>
6 : :
7 : : #include <compat/compat.h>
8 : : #include <netaddress.h>
9 : : #include <node/protocol_version.h>
10 : : #include <protocol.h>
11 : : #include <test/fuzz/FuzzedDataProvider.h>
12 : : #include <test/fuzz/util.h>
13 : : #include <test/util/net.h>
14 : : #include <util/check.h>
15 : : #include <util/sock.h>
16 : : #include <util/time.h>
17 : :
18 : : #include <array>
19 : : #include <cerrno>
20 : : #include <cstdint>
21 : : #include <cstdlib>
22 : : #include <cstring>
23 : : #include <ranges>
24 : : #include <thread>
25 : : #include <vector>
26 : :
27 : : class CNode;
28 : :
29 : 14949691 : CNetAddr ConsumeNetAddr(FuzzedDataProvider& fuzzed_data_provider, FastRandomContext* rand) noexcept
30 : : {
31 : 14949691 : struct NetAux {
32 : : Network net;
33 : : CNetAddr::BIP155Network bip155;
34 : : size_t len;
35 : : };
36 : :
37 : 14949691 : static constexpr std::array<NetAux, 6> nets{
38 : : NetAux{.net = Network::NET_IPV4, .bip155 = CNetAddr::BIP155Network::IPV4, .len = ADDR_IPV4_SIZE},
39 : : NetAux{.net = Network::NET_IPV6, .bip155 = CNetAddr::BIP155Network::IPV6, .len = ADDR_IPV6_SIZE},
40 : : NetAux{.net = Network::NET_ONION, .bip155 = CNetAddr::BIP155Network::TORV3, .len = ADDR_TORV3_SIZE},
41 : : NetAux{.net = Network::NET_I2P, .bip155 = CNetAddr::BIP155Network::I2P, .len = ADDR_I2P_SIZE},
42 : : NetAux{.net = Network::NET_CJDNS, .bip155 = CNetAddr::BIP155Network::CJDNS, .len = ADDR_CJDNS_SIZE},
43 : : NetAux{.net = Network::NET_INTERNAL, .bip155 = CNetAddr::BIP155Network{0}, .len = 0},
44 : : };
45 : :
46 : 14949691 : const size_t nets_index{rand == nullptr
47 [ + + ]: 14949691 : ? fuzzed_data_provider.ConsumeIntegralInRange<size_t>(0, nets.size() - 1)
48 : 9434978 : : static_cast<size_t>(rand->randrange(nets.size()))};
49 : :
50 : 14949691 : const auto& aux = nets[nets_index];
51 : :
52 : 14949691 : CNetAddr addr;
53 : :
54 [ + + ]: 14949691 : if (aux.net == Network::NET_INTERNAL) {
55 [ + + ]: 1841582 : if (rand == nullptr) {
56 : 271142 : addr.SetInternal(fuzzed_data_provider.ConsumeBytesAsString(32));
57 : : } else {
58 : 1570440 : const auto v = rand->randbytes(32);
59 : 1570440 : addr.SetInternal(std::string{v.begin(), v.end()});
60 : 1570440 : }
61 : : return addr;
62 : : }
63 : :
64 : 13108109 : DataStream s;
65 : :
66 : 13108109 : s << static_cast<uint8_t>(aux.bip155);
67 : :
68 : 13108109 : std::vector<uint8_t> addr_bytes;
69 [ + + ]: 13108109 : if (rand == nullptr) {
70 : 5243571 : addr_bytes = fuzzed_data_provider.ConsumeBytes<uint8_t>(aux.len);
71 : 5243571 : addr_bytes.resize(aux.len);
72 : : } else {
73 : 7864538 : addr_bytes = rand->randbytes(aux.len);
74 : : }
75 [ + + + + ]: 13108109 : if (aux.net == NET_IPV6 && addr_bytes[0] == CJDNS_PREFIX) { // Avoid generating IPv6 addresses that look like CJDNS.
76 : 16763 : addr_bytes[0] = 0x55; // Just an arbitrary number, anything != CJDNS_PREFIX would do.
77 : : }
78 [ + + ]: 13108109 : if (aux.net == NET_CJDNS) { // Avoid generating CJDNS addresses that don't start with CJDNS_PREFIX because those are !IsValid().
79 : 1608931 : addr_bytes[0] = CJDNS_PREFIX;
80 : : }
81 : 13108109 : s << addr_bytes;
82 : :
83 : 13108109 : s >> CAddress::V2_NETWORK(addr);
84 : :
85 : 13108109 : return addr;
86 : 13108109 : }
87 : :
88 : 3046567 : CAddress ConsumeAddress(FuzzedDataProvider& fuzzed_data_provider) noexcept
89 : : {
90 : 3046567 : return {ConsumeService(fuzzed_data_provider), ConsumeWeakEnum(fuzzed_data_provider, ALL_SERVICE_FLAGS), NodeSeconds{std::chrono::seconds{fuzzed_data_provider.ConsumeIntegral<uint32_t>()}}};
91 : : }
92 : :
93 : : template <typename P>
94 : 1916 : P ConsumeDeserializationParams(FuzzedDataProvider& fuzzed_data_provider) noexcept
95 : : {
96 : 1916 : constexpr std::array ADDR_ENCODINGS{
97 : : CNetAddr::Encoding::V1,
98 : : CNetAddr::Encoding::V2,
99 : : };
100 : 1916 : constexpr std::array ADDR_FORMATS{
101 : : CAddress::Format::Disk,
102 : : CAddress::Format::Network,
103 : : };
104 : : if constexpr (std::is_same_v<P, CNetAddr::SerParams>) {
105 : 1616 : return P{PickValue(fuzzed_data_provider, ADDR_ENCODINGS)};
106 : : }
107 : : if constexpr (std::is_same_v<P, CAddress::SerParams>) {
108 : 300 : return P{{PickValue(fuzzed_data_provider, ADDR_ENCODINGS)}, PickValue(fuzzed_data_provider, ADDR_FORMATS)};
109 : : }
110 : : }
111 : : template CNetAddr::SerParams ConsumeDeserializationParams(FuzzedDataProvider&) noexcept;
112 : : template CAddress::SerParams ConsumeDeserializationParams(FuzzedDataProvider&) noexcept;
113 : :
114 : 215956 : FuzzedSock::FuzzedSock(FuzzedDataProvider& fuzzed_data_provider, FakeSteadyClock& clock)
115 : : : Sock{fuzzed_data_provider.ConsumeIntegralInRange<SOCKET>(INVALID_SOCKET - 1, INVALID_SOCKET)},
116 : 215956 : m_fuzzed_data_provider{fuzzed_data_provider},
117 : 215956 : m_selectable{fuzzed_data_provider.ConsumeBool()},
118 : 215956 : m_clock{clock}
119 : : {
120 : 215956 : }
121 : :
122 : 328564 : FuzzedSock::~FuzzedSock()
123 : : {
124 : : // Sock::~Sock() will be called after FuzzedSock::~FuzzedSock() and it will call
125 : : // close(m_socket) if m_socket is not INVALID_SOCKET.
126 : : // Avoid closing an arbitrary file descriptor (m_socket is just a random very high number which
127 : : // theoretically may concide with a real opened file descriptor).
128 : 215956 : m_socket = INVALID_SOCKET;
129 : 328564 : }
130 : :
131 : 0 : FuzzedSock& FuzzedSock::operator=(Sock&& other)
132 : : {
133 : 0 : AssertUnreachable(); // Move of Sock into FuzzedSock not allowed.
134 : : }
135 : :
136 : 434631 : ssize_t FuzzedSock::Send(const void* data, size_t len, int flags) const
137 : : {
138 : 434631 : constexpr std::array send_errnos{
139 : : EACCES,
140 : : EAGAIN,
141 : : EALREADY,
142 : : EBADF,
143 : : ECONNRESET,
144 : : EDESTADDRREQ,
145 : : EFAULT,
146 : : EINTR,
147 : : EINVAL,
148 : : EISCONN,
149 : : EMSGSIZE,
150 : : ENOBUFS,
151 : : ENOMEM,
152 : : ENOTCONN,
153 : : ENOTSOCK,
154 : : EOPNOTSUPP,
155 : : EPIPE,
156 : : EWOULDBLOCK,
157 : : };
158 [ + + ]: 434631 : if (m_fuzzed_data_provider.ConsumeBool()) {
159 : 374041 : return len;
160 : : }
161 : 60590 : const ssize_t r = m_fuzzed_data_provider.ConsumeIntegralInRange<ssize_t>(-1, len);
162 [ + + ]: 60590 : if (r == -1) {
163 : 8030 : SetFuzzedErrNo(m_fuzzed_data_provider, send_errnos);
164 : : }
165 : : return r;
166 : : }
167 : :
168 : 66871 : ssize_t FuzzedSock::Recv(void* buf, size_t len, int flags) const
169 : : {
170 : : // Have a permanent error at recv_errnos[0] because when the fuzzed data is exhausted
171 : : // SetFuzzedErrNo() will always return the first element and we want to avoid Recv()
172 : : // returning -1 and setting errno to EAGAIN repeatedly.
173 : 66871 : constexpr std::array recv_errnos{
174 : : ECONNREFUSED,
175 : : EAGAIN,
176 : : EBADF,
177 : : EFAULT,
178 : : EINTR,
179 : : EINVAL,
180 : : ENOMEM,
181 : : ENOTCONN,
182 : : ENOTSOCK,
183 : : EWOULDBLOCK,
184 : : };
185 [ - + - - ]: 66871 : assert(buf != nullptr || len == 0);
186 : :
187 : : // Do the latency before any of the "return" statements.
188 [ + + - + ]: 66871 : if (m_fuzzed_data_provider.ConsumeBool() && std::getenv("FUZZED_SOCKET_FAKE_LATENCY") != nullptr) {
189 : 0 : std::this_thread::sleep_for(std::chrono::milliseconds{2});
190 : : }
191 : :
192 [ + - + + ]: 66871 : if (len == 0 || m_fuzzed_data_provider.ConsumeBool()) {
193 [ + + ]: 4748 : const ssize_t r = m_fuzzed_data_provider.ConsumeBool() ? 0 : -1;
194 : 3737 : if (r == -1) {
195 : 3737 : SetFuzzedErrNo(m_fuzzed_data_provider, recv_errnos);
196 : : }
197 : 4748 : return r;
198 : : }
199 : :
200 : 62123 : size_t copied_so_far{0};
201 : :
202 [ + + ]: 62123 : if (!m_peek_data.empty()) {
203 : : // `MSG_PEEK` was used in the preceding `Recv()` call, copy the first bytes from `m_peek_data`.
204 [ - + + + ]: 25738 : const size_t copy_len{std::min(len, m_peek_data.size())};
205 [ + + ]: 25738 : std::memcpy(buf, m_peek_data.data(), copy_len);
206 : 25738 : copied_so_far += copy_len;
207 [ + + ]: 25738 : if ((flags & MSG_PEEK) == 0) {
208 : 24828 : m_peek_data.erase(m_peek_data.begin(), m_peek_data.begin() + copy_len);
209 : : }
210 : : }
211 : :
212 [ + + ]: 62123 : if (copied_so_far == len) {
213 : 16893 : return copied_so_far;
214 : : }
215 : :
216 : 45230 : auto new_data = ConsumeRandomLengthByteVector(m_fuzzed_data_provider, len - copied_so_far);
217 [ + + ]: 45230 : if (new_data.empty()) return copied_so_far;
218 : :
219 [ - + - + ]: 41407 : std::memcpy(reinterpret_cast<uint8_t*>(buf) + copied_so_far, new_data.data(), new_data.size());
220 [ - + ]: 41407 : copied_so_far += new_data.size();
221 : :
222 [ + + ]: 41407 : if ((flags & MSG_PEEK) != 0) {
223 [ + - ]: 24807 : m_peek_data.insert(m_peek_data.end(), new_data.begin(), new_data.end());
224 : : }
225 : :
226 [ + + + + ]: 41407 : if (copied_so_far == len || m_fuzzed_data_provider.ConsumeBool()) {
227 : 17558 : return copied_so_far;
228 : : }
229 : :
230 : : // Pad to len bytes.
231 : 23849 : std::memset(reinterpret_cast<uint8_t*>(buf) + copied_so_far, 0x0, len - copied_so_far);
232 : :
233 : 23849 : return len;
234 : 45230 : }
235 : :
236 : 8948 : int FuzzedSock::Connect(const sockaddr*, socklen_t) const
237 : : {
238 : : // Have a permanent error at connect_errnos[0] because when the fuzzed data is exhausted
239 : : // SetFuzzedErrNo() will always return the first element and we want to avoid Connect()
240 : : // returning -1 and setting errno to EAGAIN repeatedly.
241 : 8948 : constexpr std::array connect_errnos{
242 : : ECONNREFUSED,
243 : : EAGAIN,
244 : : ECONNRESET,
245 : : EHOSTUNREACH,
246 : : EINPROGRESS,
247 : : EINTR,
248 : : ENETUNREACH,
249 : : ETIMEDOUT,
250 : : };
251 [ + + ]: 8948 : if (m_fuzzed_data_provider.ConsumeBool()) {
252 : 2086 : SetFuzzedErrNo(m_fuzzed_data_provider, connect_errnos);
253 : 2086 : return -1;
254 : : }
255 : : return 0;
256 : : }
257 : :
258 : 35435 : int FuzzedSock::Bind(const sockaddr*, socklen_t) const
259 : : {
260 : : // Have a permanent error at bind_errnos[0] because when the fuzzed data is exhausted
261 : : // SetFuzzedErrNo() will always set the global errno to bind_errnos[0]. We want to
262 : : // avoid this method returning -1 and setting errno to a temporary error (like EAGAIN)
263 : : // repeatedly because proper code should retry on temporary errors, leading to an
264 : : // infinite loop.
265 : 35435 : constexpr std::array bind_errnos{
266 : : EACCES,
267 : : EADDRINUSE,
268 : : EADDRNOTAVAIL,
269 : : EAGAIN,
270 : : };
271 [ + + ]: 35435 : if (m_fuzzed_data_provider.ConsumeBool()) {
272 : 24109 : SetFuzzedErrNo(m_fuzzed_data_provider, bind_errnos);
273 : 24109 : return -1;
274 : : }
275 : : return 0;
276 : : }
277 : :
278 : 11136 : int FuzzedSock::Listen(int) const
279 : : {
280 : : // Have a permanent error at listen_errnos[0] because when the fuzzed data is exhausted
281 : : // SetFuzzedErrNo() will always set the global errno to listen_errnos[0]. We want to
282 : : // avoid this method returning -1 and setting errno to a temporary error (like EAGAIN)
283 : : // repeatedly because proper code should retry on temporary errors, leading to an
284 : : // infinite loop.
285 : 11136 : constexpr std::array listen_errnos{
286 : : EADDRINUSE,
287 : : EINVAL,
288 : : EOPNOTSUPP,
289 : : };
290 [ + + ]: 11136 : if (m_fuzzed_data_provider.ConsumeBool()) {
291 : 2947 : SetFuzzedErrNo(m_fuzzed_data_provider, listen_errnos);
292 : 2947 : return -1;
293 : : }
294 : : return 0;
295 : : }
296 : :
297 : 2686 : std::unique_ptr<Sock> FuzzedSock::Accept(sockaddr* addr, socklen_t* addr_len) const
298 : : {
299 : 2686 : constexpr std::array accept_errnos{
300 : : ECONNABORTED,
301 : : EINTR,
302 : : ENOMEM,
303 : : };
304 [ + + ]: 2686 : if (m_fuzzed_data_provider.ConsumeBool()) {
305 : 117 : SetFuzzedErrNo(m_fuzzed_data_provider, accept_errnos);
306 : 117 : return std::unique_ptr<FuzzedSock>();
307 : : }
308 [ + - ]: 2569 : if (addr != nullptr) {
309 : : // Set a fuzzed address in the output argument addr.
310 : 2569 : memset(addr, 0x00, *addr_len);
311 [ + + ]: 2569 : if (m_fuzzed_data_provider.ConsumeBool()) {
312 : : // IPv4
313 : 405 : const socklen_t write_len = static_cast<socklen_t>(sizeof(sockaddr_in));
314 [ + - ]: 405 : if (*addr_len >= write_len) {
315 : 405 : *addr_len = write_len;
316 : 405 : auto addr4 = reinterpret_cast<sockaddr_in*>(addr);
317 : 405 : addr4->sin_family = AF_INET;
318 : 405 : const auto sin_addr_bytes{m_fuzzed_data_provider.ConsumeBytes<std::byte>(sizeof(addr4->sin_addr))};
319 : 405 : std::ranges::copy(sin_addr_bytes, reinterpret_cast<std::byte*>(&addr4->sin_addr));
320 : 405 : addr4->sin_port = m_fuzzed_data_provider.ConsumeIntegralInRange<uint16_t>(1, 65535);
321 : 405 : }
322 : : } else {
323 : : // IPv6
324 : 2164 : const socklen_t write_len = static_cast<socklen_t>(sizeof(sockaddr_in6));
325 [ + - ]: 2164 : if (*addr_len >= write_len) {
326 : 2164 : *addr_len = write_len;
327 : 2164 : auto addr6 = reinterpret_cast<sockaddr_in6*>(addr);
328 : 2164 : addr6->sin6_family = AF_INET6;
329 : 2164 : const auto sin_addr_bytes{m_fuzzed_data_provider.ConsumeBytes<std::byte>(sizeof(addr6->sin6_addr))};
330 : 2164 : std::ranges::copy(sin_addr_bytes, reinterpret_cast<std::byte*>(&addr6->sin6_addr));
331 : 2164 : addr6->sin6_port = m_fuzzed_data_provider.ConsumeIntegralInRange<uint16_t>(1, 65535);
332 : 2164 : }
333 : : }
334 : : }
335 : 2569 : return std::make_unique<FuzzedSock>(m_fuzzed_data_provider, m_clock);
336 : : }
337 : :
338 : 268 : int FuzzedSock::GetSockOpt(int level, int opt_name, void* opt_val, socklen_t* opt_len) const
339 : : {
340 : 268 : constexpr std::array getsockopt_errnos{
341 : : ENOMEM,
342 : : ENOBUFS,
343 : : };
344 [ + + ]: 268 : if (m_fuzzed_data_provider.ConsumeBool()) {
345 : 136 : SetFuzzedErrNo(m_fuzzed_data_provider, getsockopt_errnos);
346 : 136 : return -1;
347 : : }
348 [ + - ]: 132 : if (opt_val == nullptr) {
349 : : return 0;
350 : : }
351 : 132 : std::memcpy(opt_val,
352 : 132 : ConsumeFixedLengthByteVector(m_fuzzed_data_provider, *opt_len).data(),
353 : 132 : *opt_len);
354 : 132 : return 0;
355 : : }
356 : :
357 : 116759 : int FuzzedSock::SetSockOpt(int, int, const void*, socklen_t) const
358 : : {
359 : 116759 : constexpr std::array setsockopt_errnos{
360 : : ENOMEM,
361 : : ENOBUFS,
362 : : };
363 [ + + ]: 116759 : if (m_fuzzed_data_provider.ConsumeBool()) {
364 : 96619 : SetFuzzedErrNo(m_fuzzed_data_provider, setsockopt_errnos);
365 : 96619 : return -1;
366 : : }
367 : : return 0;
368 : : }
369 : :
370 : 4403 : int FuzzedSock::GetSockName(sockaddr* name, socklen_t* name_len) const
371 : : {
372 : 4403 : constexpr std::array getsockname_errnos{
373 : : ECONNRESET,
374 : : ENOBUFS,
375 : : };
376 [ + + ]: 4403 : if (m_fuzzed_data_provider.ConsumeBool()) {
377 : 2154 : SetFuzzedErrNo(m_fuzzed_data_provider, getsockname_errnos);
378 : 2154 : return -1;
379 : : }
380 [ - + ]: 2249 : assert(name_len);
381 : 2249 : const auto bytes{ConsumeRandomLengthByteVector(m_fuzzed_data_provider, *name_len)};
382 [ - + + + ]: 2249 : if (bytes.size() < (int)sizeof(sockaddr)) return -1;
383 [ - + ]: 866 : std::memcpy(name, bytes.data(), bytes.size());
384 [ - + ]: 866 : *name_len = bytes.size();
385 : 866 : return 0;
386 : 2249 : }
387 : :
388 : 0 : bool FuzzedSock::SetNonBlocking() const
389 : : {
390 : 0 : constexpr std::array setnonblocking_errnos{
391 : : EBADF,
392 : : EPERM,
393 : : };
394 [ # # ]: 0 : if (m_fuzzed_data_provider.ConsumeBool()) {
395 : 0 : SetFuzzedErrNo(m_fuzzed_data_provider, setnonblocking_errnos);
396 : 0 : return false;
397 : : }
398 : : return true;
399 : : }
400 : :
401 : 66017 : bool FuzzedSock::IsSelectable() const
402 : : {
403 : 66017 : return m_selectable;
404 : : }
405 : :
406 : 53483 : bool FuzzedSock::Wait(std::chrono::milliseconds timeout, Event requested, Event* occurred) const
407 : : {
408 : 53483 : constexpr std::array wait_errnos{
409 : : EBADF,
410 : : EINTR,
411 : : EINVAL,
412 : : };
413 [ + + ]: 53483 : if (m_fuzzed_data_provider.ConsumeBool()) {
414 : 12922 : SetFuzzedErrNo(m_fuzzed_data_provider, wait_errnos);
415 : 12922 : return false;
416 : : }
417 [ + + ]: 40561 : if (occurred != nullptr) {
418 : : // We simulate the requested event as occurred when ConsumeBool()
419 : : // returns false. This avoids simulating endless waiting if the
420 : : // FuzzedDataProvider runs out of data.
421 [ + + ]: 2510 : *occurred = m_fuzzed_data_provider.ConsumeBool() ? 0 : requested;
422 : : }
423 : 40561 : m_clock += timeout;
424 : 40561 : return true;
425 : : }
426 : :
427 : 25629 : bool FuzzedSock::WaitMany(std::chrono::milliseconds timeout, EventsPerSock& events_per_sock) const
428 : : {
429 [ + + ]: 60167 : for (auto& [sock, events] : events_per_sock) {
430 : 34538 : (void)sock;
431 : : // We simulate the requested event as occurred when ConsumeBool()
432 : : // returns false. This avoids simulating endless waiting if the
433 : : // FuzzedDataProvider runs out of data.
434 : 69076 : events.occurred = m_fuzzed_data_provider.ConsumeBool() ? 0 : events.requested;
435 : : }
436 : 25629 : m_clock += timeout;
437 : 25629 : return true;
438 : : }
439 : :
440 : 257 : bool FuzzedSock::IsConnected(std::string& errmsg) const
441 : : {
442 [ + + ]: 257 : if (m_fuzzed_data_provider.ConsumeBool()) {
443 : : return true;
444 : : }
445 : 206 : errmsg = "disconnected at random by the fuzzer";
446 : 206 : return false;
447 : : }
448 : :
449 : 21245 : void FillNode(FuzzedDataProvider& fuzzed_data_provider, ConnmanTestMsg& connman, CNode& node) noexcept
450 : : {
451 : 21245 : auto successfully_connected = fuzzed_data_provider.ConsumeBool();
452 : 21245 : auto remote_services = ConsumeWeakEnum(fuzzed_data_provider, ALL_SERVICE_FLAGS);
453 : 21245 : auto local_services = ConsumeWeakEnum(fuzzed_data_provider, ALL_SERVICE_FLAGS);
454 : 21245 : auto version = fuzzed_data_provider.ConsumeIntegralInRange<int32_t>(MIN_PEER_PROTO_VERSION, std::numeric_limits<int32_t>::max());
455 : 21245 : auto relay_txs = fuzzed_data_provider.ConsumeBool();
456 : 21245 : connman.Handshake(node, successfully_connected, remote_services, local_services, version, relay_txs);
457 : 21245 : }
|