Branch data Line data Source code
1 : : // Copyright (c) 2009-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 <test/fuzz/util/net.h>
6 : :
7 : : #include <compat/compat.h>
8 : : #include <netaddress.h>
9 : : #include <protocol.h>
10 : : #include <test/fuzz/FuzzedDataProvider.h>
11 : : #include <test/fuzz/util.h>
12 : : #include <test/util/net.h>
13 : : #include <util/sock.h>
14 : : #include <util/time.h>
15 : : #include <version.h>
16 : :
17 [ + - ]: 2 : #include <array>
18 [ + - ]: 2 : #include <cassert>
19 : : #include <cerrno>
20 : : #include <cstdint>
21 : : #include <cstdlib>
22 : : #include <cstring>
23 : : #include <thread>
24 : : #include <vector>
25 : :
26 : : class CNode;
27 : :
28 : 0 : CNetAddr ConsumeNetAddr(FuzzedDataProvider& fuzzed_data_provider) noexcept
29 : : {
30 [ # # ]: 0 : const Network network = fuzzed_data_provider.PickValueInArray({Network::NET_IPV4, Network::NET_IPV6, Network::NET_INTERNAL, Network::NET_ONION});
31 [ # # ]: 0 : CNetAddr net_addr;
32 [ # # ]: 0 : if (network == Network::NET_IPV4) {
33 : 0 : in_addr v4_addr = {};
34 [ # # ]: 0 : v4_addr.s_addr = fuzzed_data_provider.ConsumeIntegral<uint32_t>();
35 [ # # ]: 0 : net_addr = CNetAddr{v4_addr};
36 [ # # ]: 0 : } else if (network == Network::NET_IPV6) {
37 [ # # ][ # # ]: 0 : if (fuzzed_data_provider.remaining_bytes() >= 16) {
38 : 0 : in6_addr v6_addr = {};
39 [ # # ]: 0 : memcpy(v6_addr.s6_addr, fuzzed_data_provider.ConsumeBytes<uint8_t>(16).data(), 16);
40 [ # # ][ # # ]: 0 : net_addr = CNetAddr{v6_addr, fuzzed_data_provider.ConsumeIntegral<uint32_t>()};
41 : 0 : }
42 [ # # ]: 0 : } else if (network == Network::NET_INTERNAL) {
43 [ # # ][ # # ]: 0 : net_addr.SetInternal(fuzzed_data_provider.ConsumeBytesAsString(32));
44 [ # # ]: 0 : } else if (network == Network::NET_ONION) {
45 [ # # ]: 0 : auto pub_key{fuzzed_data_provider.ConsumeBytes<uint8_t>(ADDR_TORV3_SIZE)};
46 [ # # ]: 0 : pub_key.resize(ADDR_TORV3_SIZE);
47 [ # # ][ # # ]: 0 : const bool ok{net_addr.SetSpecial(OnionToString(pub_key))};
[ # # ]
48 [ # # ]: 0 : assert(ok);
49 : 0 : }
50 : 0 : return net_addr;
51 [ # # ]: 0 : }
52 : :
53 : 0 : CAddress ConsumeAddress(FuzzedDataProvider& fuzzed_data_provider) noexcept
54 : : {
55 [ # # ][ # # ]: 0 : return {ConsumeService(fuzzed_data_provider), ConsumeWeakEnum(fuzzed_data_provider, ALL_SERVICE_FLAGS), NodeSeconds{std::chrono::seconds{fuzzed_data_provider.ConsumeIntegral<uint32_t>()}}};
[ # # ][ # # ]
56 : : }
57 : :
58 : : template <typename P>
59 : 0 : P ConsumeDeserializationParams(FuzzedDataProvider& fuzzed_data_provider) noexcept
60 : : {
61 : 0 : constexpr std::array ADDR_ENCODINGS{
62 : : CNetAddr::Encoding::V1,
63 : : CNetAddr::Encoding::V2,
64 : : };
65 : 0 : constexpr std::array ADDR_FORMATS{
66 : : CAddress::Format::Disk,
67 : : CAddress::Format::Network,
68 : : };
69 : : if constexpr (std::is_same_v<P, CNetAddr::SerParams>) {
70 [ # # ]: 0 : return P{PickValue(fuzzed_data_provider, ADDR_ENCODINGS)};
71 : : }
72 : : if constexpr (std::is_same_v<P, CAddress::SerParams>) {
73 [ # # ][ # # ]: 0 : return P{{PickValue(fuzzed_data_provider, ADDR_ENCODINGS)}, PickValue(fuzzed_data_provider, ADDR_FORMATS)};
74 : : }
75 : : }
76 : : template CNetAddr::SerParams ConsumeDeserializationParams(FuzzedDataProvider&) noexcept;
77 : : template CAddress::SerParams ConsumeDeserializationParams(FuzzedDataProvider&) noexcept;
78 : :
79 : 0 : FuzzedSock::FuzzedSock(FuzzedDataProvider& fuzzed_data_provider)
80 : 0 : : Sock{fuzzed_data_provider.ConsumeIntegralInRange<SOCKET>(INVALID_SOCKET - 1, INVALID_SOCKET)},
81 : 0 : m_fuzzed_data_provider{fuzzed_data_provider},
82 [ # # ]: 0 : m_selectable{fuzzed_data_provider.ConsumeBool()}
83 [ + - ]: 2 : {
84 : 0 : }
85 : :
86 : 0 : FuzzedSock::~FuzzedSock()
87 : 0 : {
88 : : // Sock::~Sock() will be called after FuzzedSock::~FuzzedSock() and it will call
89 : : // close(m_socket) if m_socket is not INVALID_SOCKET.
90 : : // Avoid closing an arbitrary file descriptor (m_socket is just a random very high number which
91 : : // theoretically may concide with a real opened file descriptor).
92 : 0 : m_socket = INVALID_SOCKET;
93 : 0 : }
94 : :
95 : 0 : FuzzedSock& FuzzedSock::operator=(Sock&& other)
96 : : {
97 : 0 : assert(false && "Move of Sock into FuzzedSock not allowed.");
98 : : return *this;
99 : : }
100 : :
101 : 0 : ssize_t FuzzedSock::Send(const void* data, size_t len, int flags) const
102 : : {
103 : 0 : constexpr std::array send_errnos{
104 : : EACCES,
105 : : EAGAIN,
106 : : EALREADY,
107 : : EBADF,
108 : : ECONNRESET,
109 : : EDESTADDRREQ,
110 : : EFAULT,
111 : : EINTR,
112 : : EINVAL,
113 : : EISCONN,
114 : : EMSGSIZE,
115 : : ENOBUFS,
116 : : ENOMEM,
117 : : ENOTCONN,
118 : : ENOTSOCK,
119 : : EOPNOTSUPP,
120 : : EPIPE,
121 : : EWOULDBLOCK,
122 : : };
123 [ # # ]: 0 : if (m_fuzzed_data_provider.ConsumeBool()) {
124 : 0 : return len;
125 : : }
126 : 0 : const ssize_t r = m_fuzzed_data_provider.ConsumeIntegralInRange<ssize_t>(-1, len);
127 [ # # ]: 0 : if (r == -1) {
128 : 0 : SetFuzzedErrNo(m_fuzzed_data_provider, send_errnos);
129 : 0 : }
130 : 0 : return r;
131 : 0 : }
132 : :
133 : 0 : ssize_t FuzzedSock::Recv(void* buf, size_t len, int flags) const
134 : : {
135 : : // Have a permanent error at recv_errnos[0] because when the fuzzed data is exhausted
136 : : // SetFuzzedErrNo() will always return the first element and we want to avoid Recv()
137 : : // returning -1 and setting errno to EAGAIN repeatedly.
138 : 0 : constexpr std::array recv_errnos{
139 : : ECONNREFUSED,
140 : : EAGAIN,
141 : : EBADF,
142 : : EFAULT,
143 : : EINTR,
144 : : EINVAL,
145 : : ENOMEM,
146 : : ENOTCONN,
147 : : ENOTSOCK,
148 : : EWOULDBLOCK,
149 : : };
150 [ # # ][ # # ]: 0 : assert(buf != nullptr || len == 0);
151 [ # # ][ # # ]: 0 : if (len == 0 || m_fuzzed_data_provider.ConsumeBool()) {
152 : 0 : const ssize_t r = m_fuzzed_data_provider.ConsumeBool() ? 0 : -1;
153 [ # # ]: 0 : if (r == -1) {
154 : 0 : SetFuzzedErrNo(m_fuzzed_data_provider, recv_errnos);
155 : 0 : }
156 : 0 : return r;
157 : : }
158 : 0 : std::vector<uint8_t> random_bytes;
159 [ # # ]: 0 : bool pad_to_len_bytes{m_fuzzed_data_provider.ConsumeBool()};
160 [ # # ]: 0 : if (m_peek_data.has_value()) {
161 : : // `MSG_PEEK` was used in the preceding `Recv()` call, return `m_peek_data`.
162 [ # # ][ # # ]: 0 : random_bytes.assign({m_peek_data.value()});
163 [ # # ]: 0 : if ((flags & MSG_PEEK) == 0) {
164 : 0 : m_peek_data.reset();
165 : 0 : }
166 : 0 : pad_to_len_bytes = false;
167 [ # # ]: 0 : } else if ((flags & MSG_PEEK) != 0) {
168 : : // New call with `MSG_PEEK`.
169 [ # # ]: 0 : random_bytes = m_fuzzed_data_provider.ConsumeBytes<uint8_t>(1);
170 [ # # ]: 0 : if (!random_bytes.empty()) {
171 : 0 : m_peek_data = random_bytes[0];
172 : 0 : pad_to_len_bytes = false;
173 : 0 : }
174 : 0 : } else {
175 [ # # ]: 0 : random_bytes = m_fuzzed_data_provider.ConsumeBytes<uint8_t>(
176 [ # # ]: 0 : m_fuzzed_data_provider.ConsumeIntegralInRange<size_t>(0, len));
177 : : }
178 [ # # ]: 0 : if (random_bytes.empty()) {
179 [ # # ]: 0 : const ssize_t r = m_fuzzed_data_provider.ConsumeBool() ? 0 : -1;
180 [ # # ]: 0 : if (r == -1) {
181 [ # # ]: 0 : SetFuzzedErrNo(m_fuzzed_data_provider, recv_errnos);
182 : 0 : }
183 : 0 : return r;
184 : : }
185 : 0 : std::memcpy(buf, random_bytes.data(), random_bytes.size());
186 [ # # ]: 0 : if (pad_to_len_bytes) {
187 [ # # ]: 0 : if (len > random_bytes.size()) {
188 : 0 : std::memset((char*)buf + random_bytes.size(), 0, len - random_bytes.size());
189 : 0 : }
190 : 0 : return len;
191 : : }
192 [ # # ][ # # ]: 0 : if (m_fuzzed_data_provider.ConsumeBool() && std::getenv("FUZZED_SOCKET_FAKE_LATENCY") != nullptr) {
[ # # ]
193 [ # # ][ # # ]: 0 : std::this_thread::sleep_for(std::chrono::milliseconds{2});
194 : 0 : }
195 : 0 : return random_bytes.size();
196 : 0 : }
197 : :
198 : 0 : int FuzzedSock::Connect(const sockaddr*, socklen_t) const
199 : : {
200 : : // Have a permanent error at connect_errnos[0] because when the fuzzed data is exhausted
201 : : // SetFuzzedErrNo() will always return the first element and we want to avoid Connect()
202 : : // returning -1 and setting errno to EAGAIN repeatedly.
203 : 0 : constexpr std::array connect_errnos{
204 : : ECONNREFUSED,
205 : : EAGAIN,
206 : : ECONNRESET,
207 : : EHOSTUNREACH,
208 : : EINPROGRESS,
209 : : EINTR,
210 : : ENETUNREACH,
211 : : ETIMEDOUT,
212 : : };
213 [ # # ]: 0 : if (m_fuzzed_data_provider.ConsumeBool()) {
214 : 0 : SetFuzzedErrNo(m_fuzzed_data_provider, connect_errnos);
215 : 0 : return -1;
216 : : }
217 : 0 : return 0;
218 : 0 : }
219 : :
220 : 0 : int FuzzedSock::Bind(const sockaddr*, socklen_t) const
221 : : {
222 : : // Have a permanent error at bind_errnos[0] because when the fuzzed data is exhausted
223 : : // SetFuzzedErrNo() will always set the global errno to bind_errnos[0]. We want to
224 : : // avoid this method returning -1 and setting errno to a temporary error (like EAGAIN)
225 : : // repeatedly because proper code should retry on temporary errors, leading to an
226 : : // infinite loop.
227 : 0 : constexpr std::array bind_errnos{
228 : : EACCES,
229 : : EADDRINUSE,
230 : : EADDRNOTAVAIL,
231 : : EAGAIN,
232 : : };
233 [ # # ]: 0 : if (m_fuzzed_data_provider.ConsumeBool()) {
234 : 0 : SetFuzzedErrNo(m_fuzzed_data_provider, bind_errnos);
235 : 0 : return -1;
236 : : }
237 : 0 : return 0;
238 : 0 : }
239 : :
240 : 0 : int FuzzedSock::Listen(int) const
241 : : {
242 : : // Have a permanent error at listen_errnos[0] because when the fuzzed data is exhausted
243 : : // SetFuzzedErrNo() will always set the global errno to listen_errnos[0]. We want to
244 : : // avoid this method returning -1 and setting errno to a temporary error (like EAGAIN)
245 : : // repeatedly because proper code should retry on temporary errors, leading to an
246 : : // infinite loop.
247 : 0 : constexpr std::array listen_errnos{
248 : : EADDRINUSE,
249 : : EINVAL,
250 : : EOPNOTSUPP,
251 : : };
252 [ # # ]: 0 : if (m_fuzzed_data_provider.ConsumeBool()) {
253 : 0 : SetFuzzedErrNo(m_fuzzed_data_provider, listen_errnos);
254 : 0 : return -1;
255 : : }
256 : 0 : return 0;
257 : 0 : }
258 : :
259 : 0 : std::unique_ptr<Sock> FuzzedSock::Accept(sockaddr* addr, socklen_t* addr_len) const
260 : : {
261 : 0 : constexpr std::array accept_errnos{
262 : : ECONNABORTED,
263 : : EINTR,
264 : : ENOMEM,
265 : : };
266 [ # # ]: 0 : if (m_fuzzed_data_provider.ConsumeBool()) {
267 : 0 : SetFuzzedErrNo(m_fuzzed_data_provider, accept_errnos);
268 : 0 : return std::unique_ptr<FuzzedSock>();
269 : : }
270 : 0 : return std::make_unique<FuzzedSock>(m_fuzzed_data_provider);
271 : 0 : }
272 : :
273 : 0 : int FuzzedSock::GetSockOpt(int level, int opt_name, void* opt_val, socklen_t* opt_len) const
274 : : {
275 : 0 : constexpr std::array getsockopt_errnos{
276 : : ENOMEM,
277 : : ENOBUFS,
278 : : };
279 [ # # ]: 0 : if (m_fuzzed_data_provider.ConsumeBool()) {
280 : 0 : SetFuzzedErrNo(m_fuzzed_data_provider, getsockopt_errnos);
281 : 0 : return -1;
282 : : }
283 [ # # ]: 0 : if (opt_val == nullptr) {
284 : 0 : return 0;
285 : : }
286 : 0 : std::memcpy(opt_val,
287 : 0 : ConsumeFixedLengthByteVector(m_fuzzed_data_provider, *opt_len).data(),
288 : 0 : *opt_len);
289 : 0 : return 0;
290 : 0 : }
291 : :
292 : 0 : int FuzzedSock::SetSockOpt(int, int, const void*, socklen_t) const
293 : : {
294 : 0 : constexpr std::array setsockopt_errnos{
295 : : ENOMEM,
296 : : ENOBUFS,
297 : : };
298 [ # # ]: 0 : if (m_fuzzed_data_provider.ConsumeBool()) {
299 : 0 : SetFuzzedErrNo(m_fuzzed_data_provider, setsockopt_errnos);
300 : 0 : return -1;
301 : : }
302 : 0 : return 0;
303 : 0 : }
304 : :
305 : 0 : int FuzzedSock::GetSockName(sockaddr* name, socklen_t* name_len) const
306 : : {
307 : 0 : constexpr std::array getsockname_errnos{
308 : : ECONNRESET,
309 : : ENOBUFS,
310 : : };
311 [ # # ]: 0 : if (m_fuzzed_data_provider.ConsumeBool()) {
312 : 0 : SetFuzzedErrNo(m_fuzzed_data_provider, getsockname_errnos);
313 : 0 : return -1;
314 : : }
315 : 0 : *name_len = m_fuzzed_data_provider.ConsumeData(name, *name_len);
316 : 0 : return 0;
317 : 0 : }
318 : :
319 : 0 : bool FuzzedSock::SetNonBlocking() const
320 : : {
321 : 0 : constexpr std::array setnonblocking_errnos{
322 : : EBADF,
323 : : EPERM,
324 : : };
325 [ # # ]: 0 : if (m_fuzzed_data_provider.ConsumeBool()) {
326 : 0 : SetFuzzedErrNo(m_fuzzed_data_provider, setnonblocking_errnos);
327 : 0 : return false;
328 : : }
329 : 0 : return true;
330 : 0 : }
331 : :
332 : 0 : bool FuzzedSock::IsSelectable() const
333 : : {
334 : 0 : return m_selectable;
335 : : }
336 : :
337 : 0 : bool FuzzedSock::Wait(std::chrono::milliseconds timeout, Event requested, Event* occurred) const
338 : : {
339 : 0 : constexpr std::array wait_errnos{
340 : : EBADF,
341 : : EINTR,
342 : : EINVAL,
343 : : };
344 [ # # ]: 0 : if (m_fuzzed_data_provider.ConsumeBool()) {
345 : 0 : SetFuzzedErrNo(m_fuzzed_data_provider, wait_errnos);
346 : 0 : return false;
347 : : }
348 [ # # ]: 0 : if (occurred != nullptr) {
349 [ # # ]: 0 : *occurred = m_fuzzed_data_provider.ConsumeBool() ? requested : 0;
350 : 0 : }
351 : 0 : return true;
352 : 0 : }
353 : :
354 : 0 : bool FuzzedSock::WaitMany(std::chrono::milliseconds timeout, EventsPerSock& events_per_sock) const
355 : : {
356 [ # # ]: 0 : for (auto& [sock, events] : events_per_sock) {
357 : : (void)sock;
358 [ # # ]: 0 : events.occurred = m_fuzzed_data_provider.ConsumeBool() ? events.requested : 0;
359 : : }
360 : 0 : return true;
361 : : }
362 : :
363 : 0 : bool FuzzedSock::IsConnected(std::string& errmsg) const
364 : : {
365 [ # # ]: 0 : if (m_fuzzed_data_provider.ConsumeBool()) {
366 : 0 : return true;
367 : : }
368 : 0 : errmsg = "disconnected at random by the fuzzer";
369 : 0 : return false;
370 : 0 : }
371 : :
372 : 0 : void FillNode(FuzzedDataProvider& fuzzed_data_provider, ConnmanTestMsg& connman, CNode& node) noexcept
373 : : {
374 [ # # ]: 0 : connman.Handshake(node,
375 [ # # ]: 0 : /*successfully_connected=*/fuzzed_data_provider.ConsumeBool(),
376 : 0 : /*remote_services=*/ConsumeWeakEnum(fuzzed_data_provider, ALL_SERVICE_FLAGS),
377 : 0 : /*local_services=*/ConsumeWeakEnum(fuzzed_data_provider, ALL_SERVICE_FLAGS),
378 [ # # ]: 0 : /*version=*/fuzzed_data_provider.ConsumeIntegralInRange<int32_t>(MIN_PEER_PROTO_VERSION, std::numeric_limits<int32_t>::max()),
379 [ # # ]: 0 : /*relay_txs=*/fuzzed_data_provider.ConsumeBool());
380 : 0 : }
|
