Skip to content

Un-hide fuzz function flag #294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 26, 2023
Merged

Un-hide fuzz function flag #294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
135e30b
cli: transform the fuzz function flag into snake case
kyakdan Jan 26, 2023
186c23b
cli: use fuzz_function flag in the tests
kyakdan Jan 26, 2023
6885ac7
cli: un-hide fuzz_function flag
kyakdan Jan 26, 2023
009a634
docs: add fuzz_function flag to the docs
kyakdan Jan 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/fuzz-targets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,9 @@ flag, so that only the most important parameters are discussed here.
| ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `<fuzzTarget>` | Import path to the fuzz target module. |
| `[corpus...]` | Paths to the corpus directories. If not given, no initial seeds are used nor interesting inputs saved. |
| `-- <fuzzingEngineFlags>` | Parameters after `--` are forwarded to the internal fuzzing engine (`libFuzzer`). Available settings can be found in its [options documentation](https://www.llvm.org/docs/LibFuzzer.html#options). |
| `-f`, `--fuzz_function` | Name of the fuzz test entry point. It must be an exported function with a single [Buffer](https://nodejs.org/api/buffer.html) parameter. Default is `fuzz`. |
| `-i`, `--instrumentation_includes` / `-e`, `--instrumentation_excludes` | Part of filepath names to include/exclude in the instrumentation. A tailing `/` should be used to include directories and prevent confusion with filenames. `*` can be used to include all files. Can be specified multiple times. Default will include everything outside the `node_modules` directory. |
| `--sync` | Enables synchronous fuzzing. **May only be used for entirely synchronous code**. |
| `-h`, `--custom_hooks` | Filenames with custom hooks. Several hooks per file are possible. See further details in [docs/fuzz-settings.md](fuzz-settings.md). |
| `--help` | Detailed help message containing all flags. |
| `-- <fuzzingEngineFlags>` | Parameters after `--` are forwarded to the internal fuzzing engine (`libFuzzer`). Available settings can be found in its [options documentation](https://www.llvm.org/docs/LibFuzzer.html#options). |
10 changes: 6 additions & 4 deletions packages/core/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,15 @@ yargs(process.argv.slice(2))
type: "string",
})

.option("fuzzFunction", {
describe: "Name of the fuzz target function.",
.option("fuzz_function", {
describe:
"Name of the fuzz test entry point. It must be an exported " +
"function with a single Buffer parameter",
alias: "f",
type: "string",
default: "fuzz",
group: "Fuzzer:",
})
.hide("fuzzFunction")

.option("id_sync_file", {
describe:
Expand Down Expand Up @@ -169,7 +171,7 @@ yargs(process.argv.slice(2))
// noinspection JSIgnoredPromiseFromCall
startFuzzing({
fuzzTarget: ensureFilepath(args.fuzzTarget),
fuzzEntryPoint: args.fuzzFunction,
fuzzEntryPoint: args.fuzz_function,
includes: args.instrumentation_includes,
excludes: args.instrumentation_excludes,
dryRun: args.dry_run,
Expand Down
2 changes: 1 addition & 1 deletion tests/promise/fuzz.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ let invocationCount = lastInvocationCount + 1;
/**
* @param { Buffer } data
*/
module.exports.fuzz = function (data) {
module.exports.fuzz_promise = function (data) {
return new Promise((resolve, reject) => {
if (data.length < 3) {
resolve(invocationCount++);
Expand Down
4 changes: 2 additions & 2 deletions tests/promise/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
"version": "1.0.0",
"description": "An example showing how Jazzer.js handles promise based fuzz targets",
"scripts": {
"fuzz": "jazzer fuzz -x Error -- -max_total_time=60",
"dryRun": "jazzer fuzz -- -runs=1 -seed=123456789"
"fuzz": "jazzer fuzz --fuzz_function fuzz_promise -x Error -- -max_total_time=60",
"dryRun": "jazzer fuzz --fuzz_function fuzz_promise -- -runs=1 -seed=123456789"
},
"devDependencies": {
"@jazzer.js/core": "file:../../packages/core"
Expand Down