2019-12-03 12:48:47 +00:00
|
|
|
# Introduction
|
|
|
|
|
|
|
|
|
|
`libnfuzz` is a wrapper library that exports to C, a set of fuzzing test cases
|
|
|
|
|
written in Nim and making use of nim-beacon-chain.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# Building
|
|
|
|
|
|
|
|
|
|
To build the wrapper library (for more details follow first the instructions from
|
|
|
|
|
[nim-beacon-chain](../README.md)):
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git clone https://github.com/status-im/nim-beacon-chain.git
|
|
|
|
|
cd nim-beacon-chain
|
|
|
|
|
make
|
|
|
|
|
# static library
|
|
|
|
|
make libnfuzz.a
|
|
|
|
|
# dynamic loaded library
|
|
|
|
|
make libnfuzz.so
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
For the library to be useful for fuzzing with libFuzzer (e.g. for
|
|
|
|
|
integration with [beacon-fuzz](https://github.com/sigp/beacon-fuzz)) we can pass
|
|
|
|
|
additional Nim arguments, e.g.:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
make libnfuzz.a NIMFLAGS="--cc:clang --passC:'-fsanitize=fuzzer' --passL='-fsanitize=fuzzer'"
|
|
|
|
|
```
|
2019-12-03 15:04:02 +00:00
|
|
|
To disable BLS verification on deserialization of SSZ objects add `-d:ssz_testing` to the NIMFLAGS.
|
2019-12-03 12:48:47 +00:00
|
|
|
|
|
|
|
|
Other useful options might include: `--clang.path:<path>`, `--clang.exe:<exe>`, `--clang.linkerexe:<exe>`.
|
|
|
|
|
|
|
|
|
|
It might also deem useful to lower the log level, e.g. by adding `-d:chronicles_log_level=fatal`.
|
|
|
|
|
|
|
|
|
|
# Usage
|
|
|
|
|
There is a `libnfuzz.h` file provided for easy including in C or C++ projects.
|
|
|
|
|
|
|
|
|
|
It is most important that before any of the exported tests are called, the
|
|
|
|
|
`NimMain()` call is done first. Additionally, all following library calls need
|
|
|
|
|
to be done from the same thread as from where the original `NimMain()` call was
|
|
|
|
|
done.
|
