![Code Intelligence](https://github.com/docs/assets/logo.png)
cifuzz
makes fuzz tests as easy as unit tests
Docs | Glossary | Examples | Website | Blog | Twitter | YouTube
IMPORTANT: This project is under active development. Be aware that the behavior of the commands or the configuration can change.
What is cifuzz
cifuzz is a CLI tool that helps you to integrate and run fuzzing based tests into your project.
Features
- Easily set up, create and run fuzz tests
- Generate coverage reports that can be integrated in your IDE
- Supports multiple programming languages and build systems
Getting started
If you are new to the world of fuzzing, we recommend you to take a look at our Glossary and our example projects.
Read the getting started guide if you just want to learn how to fuzz your applications with cifuzz.
Installation
You can get the latest release from GitHub or by running our install script:
sh -c "$(curl -fsSL https://raw.githubusercontent.com/CodeIntelligenceTesting/cifuzz/main/install.sh)"
If you are using Windows you can download the latest release and execute it.
By default, cifuzz gets installed in your home directory under cifuzz
.
You can customize the installation directory with ./cifuzz_installer -i /target/dir
.
Do not forget to add the installation's bin
directory to your PATH
.
Prerequisites
Depending on your language / build system of choice cifuzz has different prerequisites:
C/C++ (with CMake)
Ubuntu / Debian
sudo apt install cmake clang llvm
Arch
sudo pacman -S cmake clang llvm
macOS
brew install cmake llvm
Windows
At least Visual Studio 2022 version 17 is required.
choco install cmake llvm
Java with Maven
Ubuntu / Debian
sudo apt install openjdk maven
Arch
sudo pacman -S jdk-openjdk maven
macOS
brew install openjdk maven
Windows
choco install microsoft-openjdk maven
Java with Gradle
Ubuntu / Debian
sudo apt install openjdk gradle
Arch
sudo pacman -S jdk-openjdk gradle
macOS
brew install openjdk gradle
Windows
choco install microsoft-openjdk gradle
Contributing
Want to help improve cifuzz? Check out our contributing documentation. There you will find instructions for building the tool locally.
If you find an issue, please report it on the issue tracker.