Skip to content

Commit

Permalink
docs(fuzz): add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hulkoba committed Dec 12, 2023
1 parent 85bea89 commit 7a41b55
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
node_modules/
npm*
test/lib/
test/typescript/definitions.js
dist/
openpgp.store/
coverage
Expand Down
71 changes: 71 additions & 0 deletions test/fuzz/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Fuzz Testing

Fuzz testing is

> An automated software testing technique that involves providing invalid, unexpected, or random data as inputs to a program.
This `fuzz/` directory contains the fuzz tests for openpgp.js.
To generate and run fuzz tests, we use the [Jazzer.js](https://github.com/CodeIntelligenceTesting/jazzer.js/) library.

## Running a fuzzer

This directory contains fuzz targets like for example `createMessageBinary`.

You can run this fuzz target without options:
```sh
npx jazzer test/fuzz/createMessageBinary.cjs
```
(You will notice the `.cjs` file ending. This is because jazzer does not support esm, yet)

or with the given settings at your package.json:

```sh
TARGET=createMessageBinary npm run fuzz
```

Notice, that `TARGET` is the path to your fuzz target module.

You should see the fuzzer that looks similar to this:

```
#128 pulse corp: 1/1b lim: 4 exec/s: 64 rss: 173Mb
#256 pulse corp: 1/1b lim: 6 exec/s: 51 rss: 173Mb
#512 pulse corp: 1/1b lim: 8 exec/s: 46 rss: 174Mb
#1024 pulse corp: 1/1b lim: 14 exec/s: 40 rss: 178Mb
#2048 pulse corp: 1/1b lim: 21 exec/s: 40 rss: 179Mb
```

It will continue to generate random inputs forever, until it finds a bug or is terminated.
The testcases for bugs it finds can be seen in the form of `crash-*`, `timeout-*` or `oom-*` at `test/fuzz/reports`.

## Running with coverage
To generate a coverage report, run the `fuzz-coverage` script from the package.json:
```sh
TARGET=createMessageBinary npm run fuzz-coverage
```

The coverage reports can be found in `test/fuzz/coverage`.


## The fuzz target module
All functions that need to be fuzz-tested are here, at the `test/fuzz/` directory.

A fuzz target module needs to export a function called fuzz,
which takes a Buffer parameter and executes the actual code under test.

Jazzer.js provides the wrapper class FuzzedDataProvider, which allows reading primitive types from the Buffer.

See further details in [Fuzzing using fuzz targets and the CLI](https://github.com/CodeIntelligenceTesting/jazzer.js/blob/main/docs/fuzz-targets.md) or [Advanced Fuzzing Settings](https://github.com/CodeIntelligenceTesting/jazzer.js/blob/main/docs/fuzz-settings.md#advanced-fuzzing-settings)


### Run limitations

You can pass the `-max_total_time` flag to the internal fuzzing engine to stop the fuzzing run after 10 seconds.
```sh
npx jazzer test/fuzz/createMessageBinary.cjs -- -max_total_time=10
```

Or you can limit the number of runs:
```sh
npx jazzer test/fuzz/createMessageBinary.cjs -- -runs=4000000
```
File renamed without changes.

0 comments on commit 7a41b55

Please sign in to comment.