Jazzer.js

Coverage-guided, in-process fuzzing for the Node.js
GitHub
284
Created 2 years ago, last commit 4 months ago
13 contributors
920 commits
Stars added on GitHub, month by month
10
11
12
1
2
3
4
5
6
7
8
9
2023
2024
Stars added on GitHub, per day, on average
Yesterday
=
Last week
+0.3
/day
Last month
+0.2
/day
Last 12 months
+0.1
/day
Package on NPM
Monthly downloads on NPM
10
11
12
1
2
3
4
5
6
7
8
9
2023
2024
README

Important

Hello Jazzer/Jazzer.js users!

We stopped maintaining Jazzer/Jazzer.js as open source. But we'd be happy to try and understand what you're trying to achieve with it, and help you if we can!

We already added significant new value to our CI Fuzz solution, which includes Jazzer and Jazzer.js. You can see more here at code-intelligence.com, or get in contact with us via sales@code-intelligence.com

Thanks,

The Code Intelligence team

Jazzer.js is a coverage-guided, in-process fuzzer for the Node.js platform developed by Code Intelligence. It is based on libFuzzer and brings many of its instrumentation-powered mutation features to the JavaScript ecosystem.

Quickstart

To use Jazzer.js in your own project follow these few simple steps:

  1. Add the @jazzer.js/core dev-dependency

    npm install --save-dev @jazzer.js/core
  2. Create a fuzz target invoking your code

    // file "FuzzTarget.js"
    module.exports.fuzz = function (data /*: Buffer */) {
    	const fuzzerData = data.toString();
    	myAwesomeCode(fuzzerData);
    };
  3. Start the fuzzer using the fuzz target

    npx jazzer FuzzTarget
  4. Enjoy fuzzing!

Usage

Jazzer.js can be used in two ways: Creating dedicated fuzz targets, as shown in the Quickstart section, or integrated into the Jest test framework.

Using test framework integration

Note: Using the test framework integration is the easiest and most convenient way to fuzz your code, hence, it is recommended to use this approach whenever possible.

To use fuzzing in your normal development workflow, a tight integration with the Jest test framework is provided. This coupling allows the execution of fuzz tests alongside your normal unit tests and seamlessly detect problems on your local machine or in your CI, enabling you to check that found bugs stay resolved forever.

Furthermore, the Jest integration enables great IDE support, so that individual inputs can be run or even debugged, similar to what you would expect from normal Jest tests.

Note: Detailed explanation on how to use the Jest integration can be found at docs/jest-integration.md.

A Jest fuzz test, in this case written in TypeScript, looks similar to the following example:

// file: "Target.fuzz.ts"
import "@jazzer.js/jest-runner";
import * as target from "./target";

describe("Target", () => {
	it.fuzz("executes a method", (data: Buffer) => {
		target.fuzzMe(data);
	});
});

Note: Please take a look at Enabling TypeScript in Jest tests for further information on how to set up Jest fuzz tests written in TypeScript.

Using fuzz targets

Creating fuzz targets and executing those via CLI commands is straightforward and similar to what you would expect from other fuzzers. This approach offers the most control and can easily be integrated in your CI pipelines via npm/npx commands.

Note: Detailed explanation on how to create and use fuzz targets can be found at docs/fuzz-targets.md.

A fuzz target can look as simple as this example:

// file "FuzzTarget.js"
module.exports.fuzz = function (data /*: Buffer */) {
	const fuzzerData = data.toString();
	myAwesomeCode(fuzzerData);
};

Documentation

Further documentation is available at docs/readme.md.

Demo Video - Introduction to Jazzer.js

We recorded a live demo which shows how to get Jazzer.js up and running for your own projects. If you are just getting started, this might be helpful.

You can watch the recording here.

Supported Architectures

Jazzer.js supports Node.js LTS versions on the following platforms, other versions are best effort only:

  • Linux x86_64
  • macOS x86_64 and arm64
  • Windows x86_64

Credit

Jazzer.js is inspired by its namesake Jazzer, also developed by Code Intelligence.

Code Intelligence logo