diff --git a/tests/fuzz/README.md b/tests/fuzz/README.md index 2105ece49..f208800ab 100644 --- a/tests/fuzz/README.md +++ b/tests/fuzz/README.md @@ -1,4 +1,4 @@ -What is it ? +What is it? ------ This directory contains fuzz targets. @@ -9,10 +9,10 @@ These targets were meant to be used with oss-fuzz but can be used in other conte This code was contributed by Philippe Antoine ( Catena cyber ). -How to run ? +How to run? ------ -To run the fuzz targets like oss-fuzz : +To run the fuzz targets like oss-fuzz: ``` git clone https://github.com/google/oss-fuzz cd oss-fuzz @@ -20,11 +20,11 @@ python infra/helper.py build_image mbedtls python infra/helper.py build_fuzzers --sanitizer address mbedtls python infra/helper.py run_fuzzer mbedtls fuzz_client ``` -You can use `undefined` sanitizer as well as `address` sanitizer -And you can run any of the fuzz targets like `fuzz_client` +You can use `undefined` sanitizer as well as `address` sanitizer. +And you can run any of the fuzz targets like `fuzz_client`. -To run the fuzz targets without oss-fuzz, you first need to install one libFuzzingEngine (libFuzzer for instance) -Then you need to compile the code with the compiler flags of the wished sanitizer +To run the fuzz targets without oss-fuzz, you first need to install one libFuzzingEngine (libFuzzer for instance). +Then you need to compile the code with the compiler flags of the wished sanitizer. ``` perl scripts/config.pl set MBEDTLS_PLATFORM_TIME_ALT mkdir build @@ -32,4 +32,4 @@ cd build cmake .. make ``` -Finally, you can run the targets like `./test/fuzz/fuzz_client` +Finally, you can run the targets like `./test/fuzz/fuzz_client`.