 |
Bitcoin Core
22.99.0
P2P Digital Currency
|
Go to the documentation of this file.
5 #ifndef BITCOIN_TEST_FUZZ_UTIL_H
6 #define BITCOIN_TEST_FUZZ_UTIL_H
59 void Reset()
override;
61 ssize_t
Send(
const void* data,
size_t len,
int flags)
const override;
63 ssize_t
Recv(
void* buf,
size_t len,
int flags)
const override;
65 int Connect(
const sockaddr*, socklen_t)
const override;
67 std::unique_ptr<Sock>
Accept(sockaddr* addr, socklen_t* addr_len)
const override;
69 int GetSockOpt(
int level,
int opt_name,
void* opt_val, socklen_t* opt_len)
const override;
71 bool Wait(std::chrono::milliseconds timeout,
Event requested,
Event* occurred =
nullptr)
const override;
73 bool IsConnected(std::string& errmsg)
const override;
81 template <
typename... Callables>
84 constexpr
size_t call_size{
sizeof...(callables)};
85 static_assert(call_size >= 1);
89 ((i++ == call_index ? callables() : void()), ...);
93 template <
typename Collection>
96 const auto sz = col.size();
98 auto it = col.begin();
105 const std::string s = max_length ?
106 fuzzed_data_provider.ConsumeRandomLengthString(*max_length) :
107 fuzzed_data_provider.ConsumeRandomLengthString();
108 return {s.begin(), s.end()};
124 std::vector<std::string> r;
125 for (
size_t i = 0; i < n_elements; ++i) {
131 template <
typename T>
136 for (
size_t i = 0; i < n_elements; ++i) {
142 template <
typename T>
150 }
catch (
const std::ios_base::failure&) {
156 template <
typename WeakEnumType,
size_t size>
161 WeakEnumType(fuzzed_data_provider.
ConsumeIntegral<
typename std::underlying_type<WeakEnumType>::type>());
171 [[nodiscard]] int64_t
ConsumeTime(
FuzzedDataProvider& fuzzed_data_provider,
const std::optional<int64_t>& min = std::nullopt,
const std::optional<int64_t>& max = std::nullopt) noexcept;
183 return CScriptNum{fuzzed_data_provider.ConsumeIntegral<int64_t>()};
188 const std::vector<uint8_t> v160 = fuzzed_data_provider.
ConsumeBytes<uint8_t>(160 / 8);
189 if (v160.size() != 160 / 8) {
197 const std::vector<uint8_t> v256 = fuzzed_data_provider.
ConsumeBytes<uint8_t>(256 / 8);
198 if (v256.size() != 256 / 8) {
213 template <
typename T>
216 static_assert(std::is_integral<T>::value,
"Integral required.");
217 if (std::numeric_limits<T>::is_signed) {
220 return i > (std::numeric_limits<T>::max() / j);
222 return j < (std::numeric_limits<T>::min() / i);
226 return i < (std::numeric_limits<T>::min() / j);
228 return i != 0 && (j < (std::numeric_limits<T>::max() / i));
232 return j != 0 && i > std::numeric_limits<T>::max() / j;
241 template <
typename T,
size_t size>
263 std::vector<uint8_t> result(length);
264 const std::vector<uint8_t> random_bytes = fuzzed_data_provider.
ConsumeBytes<uint8_t>(length);
265 if (!random_bytes.empty()) {
266 std::memcpy(result.data(), random_bytes.data(), random_bytes.size());
288 template <
bool ReturnUniquePtr = false>
293 const auto sock = std::make_shared<FuzzedSock>(fuzzed_data_provider);
295 const uint64_t keyed_net_group = fuzzed_data_provider.
ConsumeIntegral<uint64_t>();
296 const uint64_t local_host_nonce = fuzzed_data_provider.
ConsumeIntegral<uint64_t>();
301 if constexpr (ReturnUniquePtr) {
302 return std::make_unique<CNode>(node_id,
313 return CNode{node_id,
341 static ssize_t
read(
void* cookie,
char* buf,
size_t size);
343 static ssize_t
write(
void* cookie,
const char* buf,
size_t size);
345 static int seek(
void* cookie, int64_t* offset,
int whence);
347 static int close(
void* cookie);
352 return {fuzzed_data_provider};
373 return {fuzzed_data_provider};
376 #define WRITE_TO_STREAM_CASE(type, consume) \
381 template <
typename Stream>
387 fuzzed_data_provider,
398 WRITE_TO_STREAM_CASE(std::vector<uint8_t>, ConsumeRandomLengthIntegralVector<uint8_t>(fuzzed_data_provider)));
399 }
catch (
const std::ios_base::failure&) {
405 #define READ_FROM_STREAM_CASE(type) \
410 template <
typename Stream>
416 fuzzed_data_provider,
428 }
catch (
const std::ios_base::failure&) {
434 #endif // BITCOIN_TEST_FUZZ_UTIL_H
std::vector< std::string > ConsumeRandomLengthStringVector(FuzzedDataProvider &fuzzed_data_provider, const size_t max_vector_size=16, const size_t max_string_length=16) noexcept
uint256 ConsumeUInt256(FuzzedDataProvider &fuzzed_data_provider) noexcept
A combination of a network address (CNetAddr) and a (TCP) port.
int64_t ConsumeTime(FuzzedDataProvider &fuzzed_data_provider, const std::optional< int64_t > &min=std::nullopt, const std::optional< int64_t > &max=std::nullopt) noexcept
void Reset() override
Close if non-empty.
CScript ConsumeScript(FuzzedDataProvider &fuzzed_data_provider, const bool maybe_p2wsh=false) noexcept
ssize_t Send(const void *data, size_t len, int flags) const override
send(2) wrapper.
256-bit unsigned big integer.
static int seek(void *cookie, int64_t *offset, int whence)
FuzzedSock ConsumeSock(FuzzedDataProvider &fuzzed_data_provider)
Information about a peer.
static ssize_t write(void *cookie, const char *buf, size_t size)
std::string ConsumeRandomLengthString(size_t max_length)
T PickValueInArray(const T(&array)[size])
FuzzedDataProvider & m_fuzzed_data_provider
opcodetype
Script opcodes.
FuzzedFileProvider m_fuzzed_file_provider
ServiceFlags
nServices flags
uint32_t ConsumeSequence(FuzzedDataProvider &fuzzed_data_provider) noexcept
opcodetype ConsumeOpcodeType(FuzzedDataProvider &fuzzed_data_provider) noexcept
#define WRITE_TO_STREAM_CASE(type, consume)
The basic transaction that is broadcasted on the network and contained in blocks.
RAII helper class that manages a socket.
CNetAddr ConsumeNetAddr(FuzzedDataProvider &fuzzed_data_provider) noexcept
std::vector< bool > ConsumeRandomLengthBitVector(FuzzedDataProvider &fuzzed_data_provider, const std::optional< size_t > &max_length=std::nullopt) noexcept
void SetFuzzedErrNo(FuzzedDataProvider &fuzzed_data_provider, const std::array< T, size > &errnos)
Sets errno to a value selected from the given std::array errnos.
Non-refcounted RAII wrapper for FILE*.
@ INBOUND
Inbound connections are those initiated by a peer.
CSubNet ConsumeSubNet(FuzzedDataProvider &fuzzed_data_provider) noexcept
bool MultiplicationOverflow(const T i, const T j) noexcept
std::variant< CNoDestination, PKHash, ScriptHash, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessV1Taproot, WitnessUnknown > CTxDestination
A txout script template with a specific destination.
CTxMemPoolEntry ConsumeTxMemPoolEntry(FuzzedDataProvider &fuzzed_data_provider, const CTransaction &tx) noexcept
FuzzedFileProvider ConsumeFile(FuzzedDataProvider &fuzzed_data_provider) noexcept
size_t CallOneOf(FuzzedDataProvider &fuzzed_data_provider, Callables... callables)
CDataStream ConsumeDataStream(FuzzedDataProvider &fuzzed_data_provider, const std::optional< size_t > &max_length=std::nullopt) noexcept
int GetSockOpt(int level, int opt_name, void *opt_val, socklen_t *opt_len) const override
getsockopt(2) wrapper.
constexpr ServiceFlags ALL_SERVICE_FLAGS[]
arith_uint256 ConsumeArithUInt256(FuzzedDataProvider &fuzzed_data_provider) noexcept
FuzzedDataProvider & m_fuzzed_data_provider
int64_t CAmount
Amount in satoshis (Can be negative)
std::vector< uint8_t > ConsumeRandomLengthByteVector(FuzzedDataProvider &fuzzed_data_provider, const std::optional< size_t > &max_length=std::nullopt) noexcept
FuzzedFileProvider(FuzzedDataProvider &fuzzed_data_provider)
#define READ_FROM_STREAM_CASE(type)
uint160 ConsumeUInt160(FuzzedDataProvider &fuzzed_data_provider) noexcept
auto ConsumeNode(FuzzedDataProvider &fuzzed_data_provider, const std::optional< NodeId > &node_id_in=std::nullopt) noexcept
constexpr ConnectionType ALL_CONNECTION_TYPES[]
std::vector< bool > BytesToBits(const std::vector< unsigned char > &bytes)
CAmount ConsumeMoney(FuzzedDataProvider &fuzzed_data_provider, const std::optional< CAmount > &max=std::nullopt) noexcept
CService ConsumeService(FuzzedDataProvider &fuzzed_data_provider) noexcept
Serialized script, used inside transaction inputs and outputs.
bool IsConnected(std::string &errmsg) const override
Check if still connected.
void FillNode(FuzzedDataProvider &fuzzed_data_provider, ConnmanTestMsg &connman, PeerManager &peerman, CNode &node) noexcept
static ssize_t read(void *cookie, char *buf, size_t size)
static int close(void *cookie)
A CService with information about it as peer.
CMutableTransaction ConsumeTransaction(FuzzedDataProvider &fuzzed_data_provider, const std::optional< std::vector< uint256 >> &prevout_txids, const int max_num_in=10, const int max_num_out=10) noexcept
CCoinsView that adds a memory cache for transactions to another CCoinsView.
std::optional< uint8_t > m_peek_data
Data to return when MSG_PEEK is used as a Recv() flag.
FuzzedAutoFileProvider ConsumeAutoFile(FuzzedDataProvider &fuzzed_data_provider) noexcept
FuzzedAutoFileProvider(FuzzedDataProvider &fuzzed_data_provider)
bool ContainsSpentInput(const CTransaction &tx, const CCoinsViewCache &inputs) noexcept
arith_uint256 UintToArith256(const uint256 &a)
std::unique_ptr< Sock > Accept(sockaddr *addr, socklen_t *addr_len) const override
accept(2) wrapper.
void ReadFromStream(FuzzedDataProvider &fuzzed_data_provider, Stream &stream) noexcept
std::unique_ptr< CNode > ConsumeNodeAsUniquePtr(FuzzedDataProvider &fdp, const std::optional< NodeId > &node_id_in=std::nullopt)
CScriptWitness ConsumeScriptWitness(FuzzedDataProvider &fuzzed_data_provider, const size_t max_stack_elem_size=32) noexcept
void WriteToStream(FuzzedDataProvider &fuzzed_data_provider, Stream &stream) noexcept
FuzzedSock(FuzzedDataProvider &fuzzed_data_provider)
ssize_t Recv(void *buf, size_t len, int flags) const override
recv(2) wrapper.
Double ended buffer combining vector and stream-like interfaces.
bool Wait(std::chrono::milliseconds timeout, Event requested, Event *occurred=nullptr) const override
Wait for readiness for input (recv) or output (send).
CTxDestination ConsumeTxDestination(FuzzedDataProvider &fuzzed_data_provider) noexcept
std::optional< T > ConsumeDeserializable(FuzzedDataProvider &fuzzed_data_provider, const std::optional< size_t > &max_length=std::nullopt) noexcept
std::vector< uint8_t > ConsumeFixedLengthByteVector(FuzzedDataProvider &fuzzed_data_provider, const size_t length) noexcept
Returns a byte vector of specified size regardless of the number of remaining bytes available from th...
WeakEnumType ConsumeWeakEnum(FuzzedDataProvider &fuzzed_data_provider, const WeakEnumType(&all_types)[size]) noexcept
A mutable version of CTransaction.
FuzzedSock & operator=(Sock &&other) override
Move assignment operator, grab the socket from another object and close ours (if set).
int Connect(const sockaddr *, socklen_t) const override
connect(2) wrapper.
#define T(expected, seed, data)
CScriptNum ConsumeScriptNum(FuzzedDataProvider &fuzzed_data_provider) noexcept
FuzzedDataProvider & m_fuzzed_data_provider
ConnectionType
Different types of connections to a peer.
std::vector< T > ConsumeRandomLengthIntegralVector(FuzzedDataProvider &fuzzed_data_provider, const size_t max_vector_size=16) noexcept
T ConsumeIntegralInRange(T min, T max)
std::vector< T > ConsumeBytes(size_t num_bytes)
CAddress ConsumeAddress(FuzzedDataProvider &fuzzed_data_provider) noexcept
auto & PickValue(FuzzedDataProvider &fuzzed_data_provider, Collection &col)
static const int INIT_PROTO_VERSION
initial proto version, to be increased after version/verack negotiation
static const unsigned int MAX_OPCODE