Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 1.98 KB

building_running_fuzzers_external.md

File metadata and controls

56 lines (42 loc) · 1.98 KB
Raw

Building and Running External Fuzzers

This page documents building and running fuzzers defined as part of oss-fuzz repository, and not of the original OSS target. See Building and Running Fuzzers process for in-repository fuzzers.

Prerequisites

Install Docker. The toolchain setup necessary to build coverage-guided fuzzers is complicated. Docker is used to simplify distribution of the toolchain and to produce repeatable results for distributed execution.

Checkout

Checkout the oss-fuzz source tree as well as the target you are going to fuzz:

git clone git://github.com/google/oss-fuzz.git
# checkout the taregt into $target_name dir. e.g. 
# git clone git://git.sv.nongnu.org/freetype/freetype2.git freetype2
# export target_name=freetype2

Building Fuzzers

Building fuzzer is a two-step process:

  1. Building a container ready to compile fuzzers: 
     docker build -t ossfuzz/$target_name oss-fuzz/$target_name
  2. Running a container: 
     docker run -ti -v $PWD:/src/$target_name -v /tmp/out:/out ossfuzz/$target_name

/tmp/out will contain fuzzers.

Running Fuzzers

Fuzzers are statically linked executables and could be executed normally in Unbuntu-like environment:

$ /tmp/out/freetype2_fuzzer
INFO: Seed: 477892609
#0      READ   units: 1 exec/s: 0
#1      INITED cov: 29 bits: 2 indir: 14 units: 1 exec/s: 0
#2      NEW    cov: 289 bits: 280 indir: 61 units: 2 exec/s: 0 L: 64 MS: 0 
#3      NEW    cov: 291 bits: 280 indir: 61 units: 3 exec/s: 0 L: 64 MS: 1 ChangeBit-
#4      NEW    cov: 293 bits: 299 indir: 61 units: 4 exec/s: 0 L: 32 MS: 2 ChangeBit-EraseBytes-

When Ubuntu environment is not aviable (or restricted environemnt is desirable), the fuzzer can easly be run inside docker container:

docker run -ti -v /tmp/out:/out -t ossfuzz/libfuzzer-runner /out/$fuzzer --runs=100