History

Kim De Mey bd8d9c65a3 Seperate discv5 protocol message encoding from packet encoding (#539 ) And some additional clean-ups		2022-10-10 12:13:20 +02:00
..
discovery	Add bind ip and bind port for eth1 rlpx and discovery protocols (#485 )	2022-03-15 18:08:15 +01:00
discoveryv5	Seperate discv5 protocol message encoding from packet encoding (#539 )	2022-10-10 12:13:20 +02:00
enr	Build fuzzing tests in CI and fix current fuzzing tests (#396 )	2021-09-07 16:00:01 +02:00
rlp	Style fixes according to --styleCheck:usages (#452 )	2021-12-20 13:14:50 +01:00
rlpx	Delete Whisper remains (moved to nim-waku) (#386 )	2022-06-20 19:10:50 +03:00
fuzzing_helpers.nim	Build fuzzing tests in CI and fix current fuzzing tests (#396 )	2021-09-07 16:00:01 +02:00
readme.md	Update fuzzing readme.md	2020-07-21 10:58:14 +02:00

readme.md

Fuzzing Tests

This directory contains a set of subdirectories which hold one or more test cases that can be used for fuzzing. The fuzzing test cases use the fuzzing templates from nim-testutils.

For more details see the fuzzing readme of nim-testutils.

Some of the subdirectories also hold corpus generation tooling in order to have some corpus files to start fuzzing from.

Prerequisites

As explained in nim-testutils fuzzing readme, first install the fuzzer you want to run.

Next install nim-testutils its ntu application.

E.g. by running the nim-testutils nimble install:

nimble install testutils

How to run

To start fuzzing a test case run following command:

# Rlp fuzzing with libFuzzer
ntu fuzz --fuzzer:libFuzzer rlp/rlp_decode
# Rlp fuzzing with afl
ntu fuzz --fuzzer:afl rlp/rlp_decode

Or another example:

# ENR fuzzing with libFuzzer
ntu fuzz --fuzzer:libFuzzer enr/fuzz_enr
# ENR fuzzing with afl
ntu fuzz --fuzzer:afl enr/fuzz_enr

Manual adjustments

The ntu application is still very limited in its functionality. Many of the underlying fuzzer functionality is not available for adjustment so you might want to configure the setup in a more manual way.

How to do this is briefly explained here for afl and here for libFuzzer.