diff options
author | Fabian Meumertzheim <meumertzheim@code-intelligence.com> | 2021-03-10 09:52:02 +0100 |
---|---|---|
committer | Fabian Meumertzheim <fabian@meumertzhe.im> | 2021-03-24 11:53:16 +0100 |
commit | e3b66f79b9268461acc3d49c98560c6ebc4a187f (patch) | |
tree | 9230411f0dbc69f0e1c5f10f798dde7d8feaf3bc /README.md | |
parent | 1bc102a78a70c1be0e9e981310b1d0d38957fae4 (diff) | |
download | jazzer-api-e3b66f79b9268461acc3d49c98560c6ebc4a187f.tar.gz |
Adapt README for macOS support
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 14 |
1 files changed, 8 insertions, 6 deletions
@@ -11,6 +11,8 @@ It is based on [libFuzzer](https://llvm.org/docs/LibFuzzer.html) and brings many The JVM bytecode is executed inside the fuzzer process, which ensures fast execution speeds and allows seamless fuzzing of native libraries. +Jazzer supports x64 Linux and (experimentally) macOS 10.15. + ## News: Jazzer available in OSS-Fuzz [Code Intelligence](https://code-intelligence.com) and Google have teamed up to bring support for Java, Kotlin, and other JVM-based languages to [OSS-Fuzz](https://github.com/google/oss-fuzz), Google's project for large-scale fuzzing of open-souce software. Read [the blogpost](https://security.googleblog.com/2021/03/fuzzing-java-in-oss-fuzz.html) over at the Google Security Blog. @@ -20,7 +22,7 @@ If you want to learn more about Jazzer, OSS-Fuzz, and the role fuzzing plays in ## Installation The preferred way to install Jazzer is to compile it from source using [Bazel](https://bazel.build), but binary distributions -are also available. At the moment Jazzer is only available for x64 Linux. +for x64 Linux are also available. ### Using Bazel @@ -29,18 +31,18 @@ Jazzer has the following dependencies when being built from source: * JDK 8 or later (e.g. [OpenJDK](https://openjdk.java.net/)) * [Clang](https://clang.llvm.org/) 9.0 or later (using a recent version is strongly recommended) -Jazzer uses [Bazelisk](https://github.com/bazelbuild/bazelisk) to automatically download and install Bazel. Building -Jazzer from source and running it thus only requires the following assuming the dependencies are installed: +Jazzer uses [Bazelisk](https://github.com/bazelbuild/bazelisk) to automatically download and install Bazel on Linux. +Building Jazzer from source and running it thus only requires the following assuming the dependencies are installed: ```bash git clone https://github.com/CodeIntelligenceTesting/jazzer cd jazzer -# If Bazel is installed, use (note the double dash): -bazel run //:jazzer -- <arguments> -# If Bazel is not installed, use (note the double dash): +# Note the double dash used to pass <arguments> to Jazzer rather than Bazel. ./bazelisk-linux-amd64 run //:jazzer -- <arguments> ``` +On macOS, Bazel needs to be installed manually as described in the [official instructions](https://docs.bazel.build/versions/4.0.0/install-os-x.html). + ### Using the provided binaries Binary releases are available under [Releases](https://github.com/CodeIntelligenceTesting/jazzer/releases) and are built |