README.md

yFuzz Scripts

Image containing scripts used by containers in yFuzz.

Table of Contents

• yFuzz Scripts
  • Table of Contents
  • Usage
    • Environment Variables

Usage

Create an image that runs a fuzz target (e.g. with Libfuzzer), and add the yfuzz_init script:

COPY --from=yfuzz/scripts yfuzz_init.sh /
CMD /yfuzz_init.sh

Environment Variables

Variables needed by the script:

• YFUZZ_PROJECT: Name of the yFuzz Project.
• YFUZZ_TARGET: Name of the target within the yFuzz project.
• FUZZER_COMMAND: Command to run the fuzzer.

Optional variables:

• SEED_CORPUS_DIR: Path to a folder of seed inputs to be copied to the corpus.

yFuzz will set the following environment variables for use by the fuzzer:

• CORPUS_DIR: Path to a directory for corpus files to be shared between pods.
• CRASH_FILE: Location to write a file with information about a crash, when one is found.