You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Remove references to multi-engine support (afl, honggfuzz) that were
part of the original fuzzing PR #1153 but removed in the minimal
fuzzer PR #1310. The current implementation only supports cargo-fuzz
(libFuzzer).
Changes:
- Remove engine selection syntax from usage examples
- Add explicit link to cargo-fuzz repository
- Fix typos (morhped, resepctively)
Copy file name to clipboardExpand all lines: fuzz/README.md
+7-11Lines changed: 7 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,11 @@
4
4
Payjoin-fuzz
5
5
</h1>
6
6
7
-
Fuzz tests work by generating a ton of random noise that is morhped into parameter arguments for tests to run and validate that none of it causes it to have unhandled crashes.
7
+
Fuzz tests work by generating a ton of random noise that is morphed into parameter arguments for tests to run and validate that none of it causes unhandled crashes.
8
8
9
9
### Bootstrapping
10
10
11
-
#### cargo-fuzz / libFuzzer
12
-
13
-
To use simply start a nix dev shell
11
+
This fuzzer uses [cargo-fuzz](https://github.com/rust-fuzz/cargo-fuzz) (libFuzzer). To get started, enter the nix dev shell and run the fuzzer:
14
12
15
13
```shell
16
14
nix develop
@@ -20,21 +18,19 @@ cd fuzz/
20
18
21
19
### Running fuzzers
22
20
23
-
Note for some users the fuzz engine optionality is limited as there may not be any active maintenance for a fuzzer on that system. Namely MacOS and NixOS users should prefer `libfuzzer` as `honggfuzz` is not actively maintained for those systems.
24
-
25
-
The `fuzz.sh` and `cycle.sh` shell scripts allow for single pass fuzzing and continuous long term fuzzing resepctively.
21
+
The `fuzz.sh` and `cycle.sh` shell scripts allow for single pass fuzzing and continuous long term fuzzing respectively.
26
22
27
23
#### Using `fuzz.sh`
28
24
29
-
This scripts accepts an optional fuzz target. It run all available targets when this option is omitted.
25
+
This script accepts an optional fuzz target. It runs all available targets when this option is omitted.
30
26
31
-
`./fuzz.sh <fuzz-target>`
27
+
`./fuzz.sh [fuzz-target]`
32
28
33
-
for example the command `.fuzz.sh afl uri_deserialize_pjuri`selects the afl engine and runs only the `uri_deserialize_pjuri` for 30 seconds.
29
+
For example, `./fuzz.sh uri_deserialize_pjuri` runs only the `uri_deserialize_pjuri` target for 30 seconds.
34
30
35
31
#### Using `cycle.sh`
36
32
37
-
This command will run over all targets continuously changing targets every hour.
33
+
This command will run over all targets continuously, changing targets every hour.
0 commit comments