status-im
/
nim-eth
mirror of https://github.com/status-im/nim-eth.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update fuzzing readme.md

This commit is contained in:
Kim De Mey 2020-07-21 10:58:14 +02:00 committed by GitHub
parent 4dd7ca1221
commit 38bf21b4f7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
tests/fuzzing/readme.md
View File

@ -1,8 +1,11 @@
# Fuzzing Tests
The fuzzing tests use the fuzzing templates from `nim-testutils`.
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](https://github.com/status-im/nim-testutils/tree/master/testutils/fuzzing).
Some of the subdirectories also hold corpus generation tooling in order to have some corpus files to start fuzzing from.
## Prerequisites
As [explained](https://github.com/status-im/nim-testutils/tree/master/testutils/fuzzing#supported-fuzzers)
in `nim-testutils` fuzzing readme, first install the fuzzer you want to run.
@ -15,10 +18,22 @@ nimble install testutils
```
## How to run
To start fuzzing a testcase run following command:
To start fuzzing a test case run following command:
```sh
# For libFuzzer
ntu fuzz --fuzzer:libFuzzer rlp/rlp_inspect
# For afl
ntu fuzz --fuzzer:afl rlp/rlp_inspect
# 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:
```sh
# 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](https://github.com/status-im/nim-testutils/blob/master/testutils/fuzzing/readme.md#manually-with-afl) and [here for libFuzzer](https://github.com/status-im/nim-testutils/blob/master/testutils/fuzzing/readme.md#manually-with-libfuzzer).