Skip to content

Remove unnecessary excluded flag on CLI #316

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
0xricksanchez merged 3 commits into from
Feb 13, 2023
Merged

Remove unnecessary excluded flag on CLI #316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eae3b2f
Remove unnecessary excluded flag on CLI
Feb 13, 2023
01f9af0
Merge branch 'main' into FUZZ-546_cleanup_cli
0xricksanchez Feb 13, 2023
16c3114
Merge branch 'main' into FUZZ-546_cleanup_cli
0xricksanchez Feb 13, 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
30 changes: 15 additions & 15 deletions docs/fuzz-targets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,16 +163,16 @@ jazzer <fuzzTarget> <fuzzerFlags> [corpus...] [-- <fuzzingEngineFlags>]
Detailed documentation and some example calls are available using the `--help`
flag, so that only the most important parameters are discussed here.

| Parameter | Description |
| ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `<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. |
| `-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). |
| Parameter | Description |
| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `<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. |
| `-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. If either of these flags are set the default value for the other is ignored. |
| `--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). |

## Coverage report generation

Expand All @@ -188,14 +188,14 @@ Alternatively, you can add a new script to your package.json:

```json
"scripts": {
"coverage": "jazzer -d -i target -i another_target -e nothing <fuzzer parameters> --corpus <corpus directories> --coverage -- <libFuzzer parameters>"
"coverage": "jazzer -d -i target -i another_target <fuzzer parameters> --corpus <corpus directories> --coverage -- <libFuzzer parameters>"
}
```

Files matched by the flags `--include` or `--custom_hooks`, and not matched by
the flag `--exclude` will be included in the coverage report. It is recommended
to disable coverage report generation during fuzzing, because of the substantial
overhead that it adds.
Files matched by the flags `--instrumentation_includes` or `--custom_hooks`, and
not matched by the flag `--instrumentation_excludes` will be included in the
coverage report. It is recommended to disable coverage report generation during
fuzzing, because of the substantial overhead that it adds.

### Coverage report directory

Expand Down
6 changes: 3 additions & 3 deletions examples/custom-hooks/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
"jpeg-js": "^0.4.4"
},
"scripts": {
"fuzz": "jazzer fuzz -i jpeg-js -e nothing -h custom-hooks --sync",
"dryRun": "jazzer fuzz -i jpeg-js -e nothing --sync -h custom-hooks -- -runs=100 -seed=123456789",
"coverage": "jazzer fuzz -i jpeg-js -i fuzz.js -i custom-hooks.js -e nothing -h custom-hooks --sync --coverage -- -max_total_time=10"
"fuzz": "jazzer fuzz -i jpeg-js -h custom-hooks --sync",
"dryRun": "jazzer fuzz -i jpeg-js --sync -h custom-hooks -- -runs=100 -seed=123456789",
"coverage": "jazzer fuzz -i jpeg-js -i fuzz.js -i custom-hooks.js -h custom-hooks --sync --coverage -- -max_total_time=10"
},
"devDependencies": {
"@jazzer.js/core": "file:../../packages/core"
Expand Down
6 changes: 3 additions & 3 deletions examples/jpeg/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
"jpeg-js": "^0.4.4"
},
"scripts": {
"fuzz": "jazzer fuzz -i jpeg-js -e nothing --sync",
"dryRun": "jazzer fuzz -i jpeg-js -e nothing --sync -- -runs=100 -seed=123456789",
"coverage": "jazzer fuzz -i jpeg-js/lib -i fuzz.js -e nothing --sync --coverage -- -max_total_time=1 -seed=123456789"
"fuzz": "jazzer fuzz -i jpeg-js --sync",
"dryRun": "jazzer fuzz -i jpeg-js --sync -- -runs=100 -seed=123456789",
"coverage": "jazzer fuzz -i jpeg-js/lib -i fuzz.js --sync --coverage -- -max_total_time=1 -seed=123456789"
},
"devDependencies": {
"@jazzer.js/core": "file:../../packages/core"
Expand Down
4 changes: 2 additions & 2 deletions examples/jpeg_es6/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
"jpeg-js": "^0.4.4"
},
"scripts": {
"fuzz": "jazzer fuzz -i jpeg-js -e nothing --sync",
"dryRun": "jazzer fuzz -i jpeg-js -e nothing --sync -- -runs=100 -seed=123456789"
"fuzz": "jazzer fuzz -i jpeg-js --sync",
"dryRun": "jazzer fuzz -i jpeg-js --sync -- -runs=100 -seed=123456789"
},
"devDependencies": {
"@jazzer.js/core": "file:../../packages/core"
Expand Down
4 changes: 2 additions & 2 deletions examples/js-yaml/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"description": "An example showing how Jazzer.js integrates with TypeScript to fuzz js-yaml",
"scripts": {
"build": "tsc",
"fuzz": "npm run build && jazzer dist/fuzz -i js-yaml -e nothing -- -use_value_profile=1",
"dryRun": "npm run build && jazzer dist/fuzz -i js-yaml -e nothing -- -use_value_profile=1 -runs=100 -seed=123456789"
"fuzz": "npm run build && jazzer dist/fuzz -i js-yaml -- -use_value_profile=1",
"dryRun": "npm run build && jazzer dist/fuzz -i js-yaml -- -use_value_profile=1 -runs=100 -seed=123456789"
},
"devDependencies": {
"@jazzer.js/core": "file:../../packages/core",
Expand Down
4 changes: 2 additions & 2 deletions examples/protobufjs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
"version": "0.0.0",
"type": "module",
"scripts": {
"fuzz": "npx jazzer fuzz --sync -i protobuf -e nothing",
"dryRun": "npx jazzer fuzz -d --sync -i protobuf -e nothing -- -runs=100 -seed=123456789"
"fuzz": "npx jazzer fuzz --sync -i protobuf",
"dryRun": "npx jazzer fuzz -d --sync -i protobuf -- -runs=100 -seed=123456789"
},
"dependencies": {
"protobufjs": "^7.0.0",
Expand Down
4 changes: 2 additions & 2 deletions examples/spectral/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"name": "jazzerjs-spectral-example",
"version": "1.0.0",
"scripts": {
"fuzz": "jazzer spectral-example -i spectral -e nothing --sync",
"dryRun": "jazzer spectral-example -i spectral -e nothing --sync -- -runs=100 -seed=123456789"
"fuzz": "jazzer spectral-example -i spectral --sync",
"dryRun": "jazzer spectral-example -i spectral --sync -- -runs=100 -seed=123456789"
},
"dependencies": {
"@stoplight/spectral-parsers": "^1.0.1"
Expand Down
4 changes: 2 additions & 2 deletions examples/xml/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
"xml2js": "^0.4.23"
},
"scripts": {
"fuzz": "jazzer fuzz -i xml -e nothing",
"dryRun": "jazzer fuzz -i xml -e nothing -- -runs=100 -seed=123456789"
"fuzz": "jazzer fuzz -i xml",
"dryRun": "jazzer fuzz -i xml -- -runs=100 -seed=123456789"
},
"devDependencies": {
"@jazzer.js/core": "file:../../packages/core"
Expand Down
8 changes: 4 additions & 4 deletions packages/core/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,11 @@ yargs(process.argv.slice(2))
"Part of filepath names to include in the instrumentation. " +
'A tailing "/" should be used to include directories and prevent ' +
'confusion with filenames. "*" can be used to include all files.\n' +
"Can be specified multiple times.",
"Can be specified multiple times. By default all files will be" +
"included.",
type: "string",
alias: "i",
group: "Fuzzer:",
default: ["*"],
})

.array("instrumentation_excludes")
Expand All @@ -111,11 +111,11 @@ yargs(process.argv.slice(2))
"Part of filepath names to exclude in the instrumentation. " +
'A tailing "/" should be used to exclude directories and prevent ' +
'confusion with filenames. "*" can be used to exclude all files.\n' +
"Can be specified multiple times.",
'Can be specified multiple times. By default, "node_modules/" will' +
"be excluded.",
type: "string",
alias: "e",
group: "Fuzzer:",
default: ["node_modules"],
})
.option("dry_run", {
describe:
Expand Down
6 changes: 3 additions & 3 deletions packages/instrumentor/instrument.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,16 @@ describe("shouldInstrument check", () => {
).toBeFalsy();
});

it("should include everything with *", () => {
const instrumentor = new Instrumentor(["*"], []);
it("should include everything by default", () => {
const instrumentor = new Instrumentor();
expect(instrumentor.shouldInstrumentForFuzzing("include")).toBeTruthy();
expect(
instrumentor.shouldInstrumentForFuzzing("/something/else")
).toBeTruthy();
});

it("should include nothing with emtpy string", () => {
const instrumentorWithEmptyInclude = new Instrumentor(["include", ""], []);
const instrumentorWithEmptyInclude = new Instrumentor(["include", ""]);
expect(
instrumentorWithEmptyInclude.shouldInstrumentForFuzzing("include")
).toBeTruthy();
Expand Down
23 changes: 14 additions & 9 deletions packages/instrumentor/instrument.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,21 @@ export {

export class Instrumentor {
constructor(
private readonly includes: string[] = ["*"],
private readonly excludes: string[] = ["node_modules"],
private readonly includes: string[] = [],
private readonly excludes: string[] = [],
private readonly customHooks: string[] = [],
private readonly shouldCollectSourceCodeCoverage = false,
private readonly isDryRun = false,
private readonly idStrategy: EdgeIdStrategy = new MemorySyncIdStrategy()
) {}
) {
// This is our default case where we want to include everthing and exclude the "node_modules" folder.
if (includes.length === 0 && excludes.length === 0) {
includes.push("*");
excludes.push("node_modules");
}
this.includes = Instrumentor.cleanup(includes);
this.excludes = Instrumentor.cleanup(excludes);
}

init(): () => void {
if (this.includes.includes("jazzer.js")) {
Expand Down Expand Up @@ -156,6 +164,7 @@ export class Instrumentor {
delete require.cache[require.resolve(module)];
});
}

shouldInstrumentForFuzzing(filepath: string): boolean {
return (
!this.isDryRun &&
Expand All @@ -176,14 +185,10 @@ export class Instrumentor {
includes: string[],
excludes: string[]
): boolean {
const cleanedIncludes = Instrumentor.cleanup(includes);
const cleanedExcludes = Instrumentor.cleanup(excludes);
const included =
cleanedIncludes.find((include) => filepath.includes(include)) !==
undefined;
includes.find((include) => filepath.includes(include)) !== undefined;
const excluded =
cleanedExcludes.find((exclude) => filepath.includes(exclude)) !==
undefined;
excludes.find((exclude) => filepath.includes(exclude)) !== undefined;
return included && !excluded;
}

Expand Down