From a01863696e186c0d57acdc6789e16d59ce96c01f Mon Sep 17 00:00:00 2001 From: Andrea Fioraldi Date: Thu, 30 Mar 2023 14:35:58 +0200 Subject: [PATCH] Implement restarting without serializing the corpus (#1182) * Restart without serializing state option * libfuzzer libpng example * clippy * libfuzzer_libpng_norestart * fix --- fuzzers/libfuzzer_libpng_norestart/.gitignore | 3 + fuzzers/libfuzzer_libpng_norestart/Cargo.toml | 31 ++ .../libfuzzer_libpng_norestart/Makefile.toml | 130 ++++++++ fuzzers/libfuzzer_libpng_norestart/README.md | 47 +++ fuzzers/libfuzzer_libpng_norestart/harness.cc | 188 ++++++++++++ .../seeds/not_kitty.png | Bin 0 -> 218 bytes .../seeds/not_kitty_alpha.png | Bin 0 -> 376 bytes .../seeds/not_kitty_gamma.png | Bin 0 -> 228 bytes .../seeds/not_kitty_icc.png | Bin 0 -> 427 bytes .../src/bin/libafl_cc.rs | 36 +++ .../src/bin/libafl_cxx.rs | 5 + fuzzers/libfuzzer_libpng_norestart/src/lib.rs | 282 ++++++++++++++++++ libafl/src/bolts/launcher.rs | 7 + libafl/src/events/llmp.rs | 80 +++-- libafl/src/monitors/mod.rs | 14 +- libafl/src/mutators/token_mutations.rs | 4 +- 16 files changed, 797 insertions(+), 30 deletions(-) create mode 100644 fuzzers/libfuzzer_libpng_norestart/.gitignore create mode 100644 fuzzers/libfuzzer_libpng_norestart/Cargo.toml create mode 100644 fuzzers/libfuzzer_libpng_norestart/Makefile.toml create mode 100644 fuzzers/libfuzzer_libpng_norestart/README.md create mode 100644 fuzzers/libfuzzer_libpng_norestart/harness.cc create mode 100644 fuzzers/libfuzzer_libpng_norestart/seeds/not_kitty.png create mode 100644 fuzzers/libfuzzer_libpng_norestart/seeds/not_kitty_alpha.png create mode 100644 fuzzers/libfuzzer_libpng_norestart/seeds/not_kitty_gamma.png create mode 100644 fuzzers/libfuzzer_libpng_norestart/seeds/not_kitty_icc.png create mode 100644 fuzzers/libfuzzer_libpng_norestart/src/bin/libafl_cc.rs create mode 100644 fuzzers/libfuzzer_libpng_norestart/src/bin/libafl_cxx.rs create mode 100644 fuzzers/libfuzzer_libpng_norestart/src/lib.rs diff --git a/fuzzers/libfuzzer_libpng_norestart/.gitignore b/fuzzers/libfuzzer_libpng_norestart/.gitignore new file mode 100644 index 0000000000..1590352184 --- /dev/null +++ b/fuzzers/libfuzzer_libpng_norestart/.gitignore @@ -0,0 +1,3 @@ +fuzzer_stats.toml +libpng-* +corpus diff --git a/fuzzers/libfuzzer_libpng_norestart/Cargo.toml b/fuzzers/libfuzzer_libpng_norestart/Cargo.toml new file mode 100644 index 0000000000..2e1d87883d --- /dev/null +++ b/fuzzers/libfuzzer_libpng_norestart/Cargo.toml @@ -0,0 +1,31 @@ +[package] +name = "libfuzzer_libpng_launcher" +version = "0.9.0" +authors = ["Andrea Fioraldi ", "Dominik Maier "] +edition = "2021" + +[features] +default = ["std"] +std = [] + +[profile.release] +lto = true +codegen-units = 1 +opt-level = 3 +debug = true + +[build-dependencies] +cc = { version = "1.0", features = ["parallel"] } +which = { version = "4.0.2" } + +[dependencies] +libafl = { path = "../../libafl/" } +libafl_targets = { path = "../../libafl_targets/", features = ["sancov_pcguard_hitcounts", "libfuzzer"] } +# TODO Include it only when building cc +libafl_cc = { path = "../../libafl_cc/" } +clap = { version = "4.1", features = ["derive"] } +mimalloc = { version = "*", default-features = false } + +[lib] +name = "libfuzzer_libpng" +crate-type = ["staticlib"] diff --git a/fuzzers/libfuzzer_libpng_norestart/Makefile.toml b/fuzzers/libfuzzer_libpng_norestart/Makefile.toml new file mode 100644 index 0000000000..05b72bd218 --- /dev/null +++ b/fuzzers/libfuzzer_libpng_norestart/Makefile.toml @@ -0,0 +1,130 @@ +# Variables +[env] +FUZZER_NAME='fuzzer_libpng_launcher' +CARGO_TARGET_DIR = { value = "${PROJECT_DIR}/target", condition = { env_not_set = ["CARGO_TARGET_DIR"] } } +LIBAFL_CC = '${CARGO_TARGET_DIR}/release/libafl_cc' +LIBAFL_CXX = '${CARGO_TARGET_DIR}/release/libafl_cxx' +FUZZER = '${CARGO_TARGET_DIR}/release/${FUZZER_NAME}' +PROJECT_DIR = { script = ["pwd"] } + +[tasks.unsupported] +script_runner="@shell" +script=''' +echo "Cargo-make not integrated yet on this platform" +''' + +# libpng +[tasks.libpng] +linux_alias = "libpng_unix" +mac_alias = "libpng_unix" +windows_alias = "unsupported" + +[tasks.libpng_unix] +condition = { files_not_exist = ["./libpng-1.6.37"]} +script_runner="@shell" +script=''' +wget https://deac-fra.dl.sourceforge.net/project/libpng/libpng16/1.6.37/libpng-1.6.37.tar.xz +tar -xvf libpng-1.6.37.tar.xz +''' + +# Compilers +[tasks.cxx] +linux_alias = "cxx_unix" +mac_alias = "cxx_unix" +windows_alias = "unsupported" + +[tasks.cxx_unix] +command = "cargo" +args = ["build" , "--release"] + +[tasks.cc] +linux_alias = "cc_unix" +mac_alias = "cc_unix" +windows_alias = "unsupported" + +[tasks.cc_unix] +command = "cargo" +args = ["build" , "--release"] + +# Library +[tasks.lib] +linux_alias = "lib_unix" +mac_alias = "lib_unix" +windows_alias = "unsupported" + +[tasks.lib_unix] +script_runner="@shell" +script=''' +cd libpng-1.6.37 && ./configure --enable-shared=no --with-pic=yes --enable-hardware-optimizations=yes +cd "${PROJECT_DIR}" +make -C libpng-1.6.37 CC="${CARGO_TARGET_DIR}/release/libafl_cc" CXX="${CARGO_TARGET_DIR}/release/libafl_cxx" +''' +dependencies = [ "libpng", "cxx", "cc" ] + + +# Harness +[tasks.fuzzer] +linux_alias = "fuzzer_unix" +mac_alias = "fuzzer_unix" +windows_alias = "unsupported" + +[tasks.fuzzer_unix] +command = "${CARGO_TARGET_DIR}/release/libafl_cxx" +args = ["${PROJECT_DIR}/harness.cc", "${PROJECT_DIR}/libpng-1.6.37/.libs/libpng16.a", "-I", "${PROJECT_DIR}/libpng-1.6.37/", "-o", "${FUZZER_NAME}", "-lm", "-lz"] +dependencies = [ "lib", "cxx", "cc" ] + +# Run the fuzzer +[tasks.run] +linux_alias = "run_unix" +mac_alias = "run_unix" +windows_alias = "unsupported" + +[tasks.run_unix] +script_runner = "@shell" +script=''' +rm -rf corpus/ || true +mkdir corpus/ || true +cp seeds/* corpus/ || true +./${FUZZER_NAME} --cores 0 --input ./corpus +''' +dependencies = [ "fuzzer" ] + +# Test +[tasks.test] +linux_alias = "test_unix" +mac_alias = "test_unix" +windows_alias = "unsupported" + +[tasks.test_unix] +script_runner = "@shell" +script=''' +rm -rf libafl_unix_shmem_server || true +rm -rf corpus/ || true +mkdir corpus/ || true +cp seeds/* corpus/ || true +timeout 11s ./${FUZZER_NAME} --cores 0 --input ./corpus 2>/dev/null >fuzz_stdout.log || true +if [ -z "$(grep "corpus: 30" fuzz_stdout.log)" ]; then + echo "Fuzzer does not generate any testcases or any crashes" + exit 1 +else + echo "Fuzzer is working" +fi +''' +dependencies = [ "fuzzer" ] + +# Clean up +[tasks.clean] +linux_alias = "clean_unix" +mac_alias = "clean_unix" +windows_alias = "unsupported" + +[tasks.clean_unix] +# Disable default `clean` definition +clear = true +script_runner="@shell" +script=''' +rm -rf corpus/ || true +rm -f ./${FUZZER_NAME} +make -C libpng-1.6.37 clean +cargo clean +''' diff --git a/fuzzers/libfuzzer_libpng_norestart/README.md b/fuzzers/libfuzzer_libpng_norestart/README.md new file mode 100644 index 0000000000..b96b0e851c --- /dev/null +++ b/fuzzers/libfuzzer_libpng_norestart/README.md @@ -0,0 +1,47 @@ +# Libfuzzer for libpng, with launcher + +This folder contains an example fuzzer for libpng, using LLMP for fast multi-process fuzzing and crash detection. +To show off crash detection, we added a `ud2` instruction to the harness, edit harness.cc if you want a non-crashing example. +It has been tested on Linux. + +In contrast to the normal libfuzzer libpng example, this uses the `launcher` feature, that automatically spawns `n` child processes, and binds them to a free core. + +## Build + +To build this example, run + +```bash +cargo build --release +``` + +This will build the library with the fuzzer (src/lib.rs) with the libfuzzer compatibility layer and the SanitizerCoverage runtime functions for coverage feedback. +In addition, it will also build two C and C++ compiler wrappers (bin/libafl_c(libafl_c/xx).rs) that you must use to compile the target. + +Then download libpng, and unpack the archive: +```bash +wget https://deac-fra.dl.sourceforge.net/project/libpng/libpng16/1.6.37/libpng-1.6.37.tar.xz +tar -xvf libpng-1.6.37.tar.xz +``` + +Now compile libpng, using the libafl_cc compiler wrapper: + +```bash +cd libpng-1.6.37 +./configure +make CC=../target/release/libafl_cc CXX=../target/release/libafl_cxx -j `nproc` +``` + +You can find the static lib at `libpng-1.6.37/.libs/libpng16.a`. + +Now, we have to build the libfuzzer harness and link all together to create our fuzzer binary. + +``` +cd .. +./target/release/libafl_cxx ./harness.cc libpng-1.6.37/.libs/libpng16.a -I libpng-1.6.37/ -o fuzzer_libpng -lz -lm +``` + +Afterwards, the fuzzer will be ready to run. + +## Run + +Just run once, the launcher feature should do the rest. \ No newline at end of file diff --git a/fuzzers/libfuzzer_libpng_norestart/harness.cc b/fuzzers/libfuzzer_libpng_norestart/harness.cc new file mode 100644 index 0000000000..e26e707e17 --- /dev/null +++ b/fuzzers/libfuzzer_libpng_norestart/harness.cc @@ -0,0 +1,188 @@ +// libpng_read_fuzzer.cc +// Copyright 2017-2018 Glenn Randers-Pehrson +// Copyright 2015 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that may +// be found in the LICENSE file https://cs.chromium.org/chromium/src/LICENSE + +// Last changed in libpng 1.6.35 [July 15, 2018] + +// The modifications in 2017 by Glenn Randers-Pehrson include +// 1. addition of a PNG_CLEANUP macro, +// 2. setting the option to ignore ADLER32 checksums, +// 3. adding "#include " which is needed on some platforms +// to provide memcpy(). +// 4. adding read_end_info() and creating an end_info structure. +// 5. adding calls to png_set_*() transforms commonly used by browsers. + +#include +#include +#include + +#include + +#define PNG_INTERNAL +#include "png.h" + +#define PNG_CLEANUP \ + if (png_handler.png_ptr) { \ + if (png_handler.row_ptr) \ + png_free(png_handler.png_ptr, png_handler.row_ptr); \ + if (png_handler.end_info_ptr) \ + png_destroy_read_struct(&png_handler.png_ptr, &png_handler.info_ptr, \ + &png_handler.end_info_ptr); \ + else if (png_handler.info_ptr) \ + png_destroy_read_struct(&png_handler.png_ptr, &png_handler.info_ptr, \ + nullptr); \ + else \ + png_destroy_read_struct(&png_handler.png_ptr, nullptr, nullptr); \ + png_handler.png_ptr = nullptr; \ + png_handler.row_ptr = nullptr; \ + png_handler.info_ptr = nullptr; \ + png_handler.end_info_ptr = nullptr; \ + } + +struct BufState { + const uint8_t *data; + size_t bytes_left; +}; + +struct PngObjectHandler { + png_infop info_ptr = nullptr; + png_structp png_ptr = nullptr; + png_infop end_info_ptr = nullptr; + png_voidp row_ptr = nullptr; + BufState *buf_state = nullptr; + + ~PngObjectHandler() { + if (row_ptr) { png_free(png_ptr, row_ptr); } + if (end_info_ptr) + png_destroy_read_struct(&png_ptr, &info_ptr, &end_info_ptr); + else if (info_ptr) + png_destroy_read_struct(&png_ptr, &info_ptr, nullptr); + else + png_destroy_read_struct(&png_ptr, nullptr, nullptr); + delete buf_state; + } +}; + +void user_read_data(png_structp png_ptr, png_bytep data, size_t length) { + BufState *buf_state = static_cast(png_get_io_ptr(png_ptr)); + if (length > buf_state->bytes_left) { png_error(png_ptr, "read error"); } + memcpy(data, buf_state->data, length); + buf_state->bytes_left -= length; + buf_state->data += length; +} + +static const int kPngHeaderSize = 8; + +// Entry point for LibFuzzer. +// Roughly follows the libpng book example: +// http://www.libpng.org/pub/png/book/chapter13.html +extern "C" int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) { + if (size < kPngHeaderSize) { return 0; } + + std::vector v(data, data + size); + if (png_sig_cmp(v.data(), 0, kPngHeaderSize)) { + // not a PNG. + return 0; + } + + PngObjectHandler png_handler; + png_handler.png_ptr = nullptr; + png_handler.row_ptr = nullptr; + png_handler.info_ptr = nullptr; + png_handler.end_info_ptr = nullptr; + + png_handler.png_ptr = + png_create_read_struct(PNG_LIBPNG_VER_STRING, nullptr, nullptr, nullptr); + if (!png_handler.png_ptr) { return 0; } + + png_handler.info_ptr = png_create_info_struct(png_handler.png_ptr); + if (!png_handler.info_ptr) { + PNG_CLEANUP + return 0; + } + + png_handler.end_info_ptr = png_create_info_struct(png_handler.png_ptr); + if (!png_handler.end_info_ptr) { + PNG_CLEANUP + return 0; + } + + png_set_crc_action(png_handler.png_ptr, PNG_CRC_QUIET_USE, PNG_CRC_QUIET_USE); +#ifdef PNG_IGNORE_ADLER32 + png_set_option(png_handler.png_ptr, PNG_IGNORE_ADLER32, PNG_OPTION_ON); +#endif + + // Setting up reading from buffer. + png_handler.buf_state = new BufState(); + png_handler.buf_state->data = data + kPngHeaderSize; + png_handler.buf_state->bytes_left = size - kPngHeaderSize; + png_set_read_fn(png_handler.png_ptr, png_handler.buf_state, user_read_data); + png_set_sig_bytes(png_handler.png_ptr, kPngHeaderSize); + + if (setjmp(png_jmpbuf(png_handler.png_ptr))) { + PNG_CLEANUP + return 0; + } + + // Reading. + png_read_info(png_handler.png_ptr, png_handler.info_ptr); + + // reset error handler to put png_deleter into scope. + if (setjmp(png_jmpbuf(png_handler.png_ptr))) { + PNG_CLEANUP + return 0; + } + + png_uint_32 width, height; + int bit_depth, color_type, interlace_type, compression_type; + int filter_type; + + if (!png_get_IHDR(png_handler.png_ptr, png_handler.info_ptr, &width, &height, + &bit_depth, &color_type, &interlace_type, &compression_type, + &filter_type)) { + PNG_CLEANUP + return 0; + } + + // This is going to be too slow. + if (width && height > 100000000 / width) { + PNG_CLEANUP +#ifdef HAS_DUMMY_CRASH + #ifdef __aarch64__ + asm volatile(".word 0xf7f0a000\n"); + #else + asm("ud2"); + #endif +#endif + return 0; + } + + // Set several transforms that browsers typically use: + png_set_gray_to_rgb(png_handler.png_ptr); + png_set_expand(png_handler.png_ptr); + png_set_packing(png_handler.png_ptr); + png_set_scale_16(png_handler.png_ptr); + png_set_tRNS_to_alpha(png_handler.png_ptr); + + int passes = png_set_interlace_handling(png_handler.png_ptr); + + png_read_update_info(png_handler.png_ptr, png_handler.info_ptr); + + png_handler.row_ptr = + png_malloc(png_handler.png_ptr, + png_get_rowbytes(png_handler.png_ptr, png_handler.info_ptr)); + + for (int pass = 0; pass < passes; ++pass) { + for (png_uint_32 y = 0; y < height; ++y) { + png_read_row(png_handler.png_ptr, + static_cast(png_handler.row_ptr), nullptr); + } + } + + png_read_end(png_handler.png_ptr, png_handler.end_info_ptr); + + PNG_CLEANUP + return 0; +} diff --git a/fuzzers/libfuzzer_libpng_norestart/seeds/not_kitty.png b/fuzzers/libfuzzer_libpng_norestart/seeds/not_kitty.png new file mode 100644 index 0000000000000000000000000000000000000000..eff7c1707b936a8f8df725814f604d454b78b5c3 GIT binary patch literal 218 zcmeAS@N?(olHy`uVBq!ia0vp^3LwnE3?yBabR7dyk|nMYCBgY=CFO}lsSJ)O`AMk? zp1FzXsX?iUDV2pMQ*D5X_yc@GT+_~+`TzevkY_wIZRYx+5&y#hyq+?%!C8<`)MX5lF!N|bSRM)^r*U&J;z}U*bz{;0L z1Vuw`eoAIqC5i?kD`P_|6GMoGiCWXn12ss3YzWRzD=AMbN@Z|N$xljE@XSq2PYp^< WOsOn9nQ8-6#Ng@b=d#Wzp$PyV*n0l} literal 0 HcmV?d00001 diff --git a/fuzzers/libfuzzer_libpng_norestart/seeds/not_kitty_gamma.png b/fuzzers/libfuzzer_libpng_norestart/seeds/not_kitty_gamma.png new file mode 100644 index 0000000000000000000000000000000000000000..939d9d29a9b9f95bac5e9a72854361ee85469921 GIT binary patch literal 228 zcmeAS@N?(olHy`uVBq!ia0vp^3LwnE3?yBabR7dyEa{HEjtmTQ929t;oCfmw1AIbU z)6Sgv|NlRbXFM})=KnKxKI=t+9LW;bh?3y^w370~qErUQl>DSr1<%~X^wgl##FWay zlc_d9MbVxvjv*GO?@o5)YH;9THa`3B|5>?^8?LvjJ}xLe>!7e@k)r^sLedir0mCVe z=5sMjEm$*~tHD+}{NS_$nMdb|ABqg-@UGMMsZ=uY-X%Cq@&3vmZ%&@H{P?6&+U!yq VvuXWlo?M_c44$rjF6*2UngF4cP+$N6 literal 0 HcmV?d00001 diff --git a/fuzzers/libfuzzer_libpng_norestart/seeds/not_kitty_icc.png b/fuzzers/libfuzzer_libpng_norestart/seeds/not_kitty_icc.png new file mode 100644 index 0000000000000000000000000000000000000000..f0c7804d99829cc6307c1c6ae9915cf42d555414 GIT binary patch literal 427 zcmV;c0aX5pP)9xSWu9|B*4Isn^#g47m^r~thH)GiR<@yX0fO)OF<2Kt#qCldyUF#H?{4jV?XGw9)psxE&K1B1m^ z1_tH{2(hG@3=G>_85ksPA;eS`Ffj19FfeR8pIlm01~rBeWCZ{dbvfq;rA3DT000kA zOjJc?%*_A){{R30GnreSaefwW^{L9a%BKPWN%_+AW3auXJt}l zVPtu6$z?nM003J_L_t(I%iWVf3V=Wi12fJ3|IHp$*hSlV@t||fKp?cDK@bHXV&o_g zF_hw;3ILUGteXmeJsVfSmcVJno)^MdQwU3bFHCtNG)uY>mLcD%`0UBaIq~Fq8#dBr V12uok3~c}a002ovPDHLkV1nKBo!S5Z literal 0 HcmV?d00001 diff --git a/fuzzers/libfuzzer_libpng_norestart/src/bin/libafl_cc.rs b/fuzzers/libfuzzer_libpng_norestart/src/bin/libafl_cc.rs new file mode 100644 index 0000000000..69f3766586 --- /dev/null +++ b/fuzzers/libfuzzer_libpng_norestart/src/bin/libafl_cc.rs @@ -0,0 +1,36 @@ +use std::env; + +use libafl_cc::{ClangWrapper, CompilerWrapper}; + +pub fn main() { + let args: Vec = env::args().collect(); + if args.len() > 1 { + let mut dir = env::current_exe().unwrap(); + let wrapper_name = dir.file_name().unwrap().to_str().unwrap(); + + let is_cpp = match wrapper_name[wrapper_name.len()-2..].to_lowercase().as_str() { + "cc" => false, + "++" | "pp" | "xx" => true, + _ => panic!("Could not figure out if c or c++ wrapper was called. Expected {dir:?} to end with c or cxx"), + }; + + dir.pop(); + + let mut cc = ClangWrapper::new(); + if let Some(code) = cc + .cpp(is_cpp) + // silence the compiler wrapper output, needed for some configure scripts. + .silence(true) + .parse_args(&args) + .expect("Failed to parse the command line") + .link_staticlib(&dir, "libfuzzer_libpng") + .add_arg("-fsanitize-coverage=trace-pc-guard") + .run() + .expect("Failed to run the wrapped compiler") + { + std::process::exit(code); + } + } else { + panic!("LibAFL CC: No Arguments given"); + } +} diff --git a/fuzzers/libfuzzer_libpng_norestart/src/bin/libafl_cxx.rs b/fuzzers/libfuzzer_libpng_norestart/src/bin/libafl_cxx.rs new file mode 100644 index 0000000000..dabd22971a --- /dev/null +++ b/fuzzers/libfuzzer_libpng_norestart/src/bin/libafl_cxx.rs @@ -0,0 +1,5 @@ +pub mod libafl_cc; + +fn main() { + libafl_cc::main(); +} diff --git a/fuzzers/libfuzzer_libpng_norestart/src/lib.rs b/fuzzers/libfuzzer_libpng_norestart/src/lib.rs new file mode 100644 index 0000000000..cabc4a5354 --- /dev/null +++ b/fuzzers/libfuzzer_libpng_norestart/src/lib.rs @@ -0,0 +1,282 @@ +//! A libfuzzer-like fuzzer with llmp-multithreading support and restarts +//! The example harness is built for libpng. +//! In this example, you will see the use of the `launcher` feature. +//! The `launcher` will spawn new processes for each cpu core. +use mimalloc::MiMalloc; +#[global_allocator] +static GLOBAL: MiMalloc = MiMalloc; + +use core::time::Duration; +use std::{env, net::SocketAddr, path::PathBuf}; + +use clap::{self, Parser}; +use libafl::{ + bolts::{ + core_affinity::Cores, + current_nanos, + launcher::Launcher, + rands::StdRand, + shmem::{ShMemProvider, StdShMemProvider}, + tuples::{tuple_list, Merge}, + AsSlice, + }, + corpus::{Corpus, InMemoryOnDiskCorpus, OnDiskCorpus}, + events::{EventConfig, EventRestarter, LlmpRestartingEventManager}, + executors::{inprocess::InProcessExecutor, ExitKind, TimeoutExecutor}, + feedback_or, feedback_or_fast, + feedbacks::{CrashFeedback, MaxMapFeedback, TimeFeedback, TimeoutFeedback}, + fuzzer::{Fuzzer, StdFuzzer}, + inputs::{BytesInput, HasTargetBytes}, + monitors::{MultiMonitor, OnDiskTOMLMonitor}, + mutators::{ + scheduled::{havoc_mutations, tokens_mutations, StdScheduledMutator}, + token_mutations::Tokens, + }, + observers::{HitcountsMapObserver, TimeObserver}, + schedulers::{IndexesLenTimeMinimizerScheduler, QueueScheduler}, + stages::mutational::StdMutationalStage, + state::{HasCorpus, HasMetadata, StdState}, + Error, +}; +use libafl_targets::{libfuzzer_initialize, libfuzzer_test_one_input, std_edges_map_observer}; + +/// Parse a millis string to a [`Duration`]. Used for arg parsing. +fn timeout_from_millis_str(time: &str) -> Result { + Ok(Duration::from_millis(time.parse()?)) +} + +/// The commandline args this fuzzer accepts +#[derive(Debug, Parser)] +#[command( + name = "libfuzzer_libpng_launcher", + about = "A libfuzzer-like fuzzer for libpng with llmp-multithreading support and a launcher", + author = "Andrea Fioraldi , Dominik Maier " +)] +struct Opt { + #[arg( + short, + long, + value_parser = Cores::from_cmdline, + help = "Spawn a client in each of the provided cores. Broker runs in the 0th core. 'all' to select all available cores. 'none' to run a client without binding to any core. eg: '1,2-4,6' selects the cores 1,2,3,4,6.", + name = "CORES" + )] + cores: Cores, + + #[arg( + short = 'p', + long, + help = "Choose the broker TCP port, default is 1337", + name = "PORT", + default_value = "1337" + )] + broker_port: u16, + + #[arg(short = 'a', long, help = "Specify a remote broker", name = "REMOTE")] + remote_broker_addr: Option, + + #[arg(short, long, help = "Set an the corpus directories", name = "INPUT")] + input: Vec, + + #[arg( + short, + long, + help = "Set the output directory, default is ./out", + name = "OUTPUT", + default_value = "./out" + )] + output: PathBuf, + + #[arg( + value_parser = timeout_from_millis_str, + short, + long, + help = "Set the exeucution timeout in milliseconds, default is 10000", + name = "TIMEOUT", + default_value = "10000" + )] + timeout: Duration, + + #[arg( + short, + long, + help = "Do not deserialize state on restart", + name = "RELOAD_CORPUS", + default_value = "false" + )] + reload_corpus: bool, + + #[arg( + short, + long, + help = "Fuzz loop iterations", + name = "LOOP_ITERS", + default_value = "1000000" + )] + loop_iters: u64, + /* + /// This fuzzer has hard-coded tokens + #[arg( + + short = "x", + long, + help = "Feed the fuzzer with an user-specified list of tokens (often called \"dictionary\"", + name = "TOKENS", + multiple = true + )] + tokens: Vec, + */ +} + +/// The main fn, `no_mangle` as it is a C symbol +#[no_mangle] +pub fn libafl_main() { + // Registry the metadata types used in this fuzzer + // Needed only on no_std + //RegistryBuilder::register::(); + let opt = Opt::parse(); + + let broker_port = opt.broker_port; + let cores = opt.cores; + + println!( + "Workdir: {:?} {}", + env::current_dir().unwrap().to_string_lossy().to_string(), + opt.reload_corpus + ); + + let shmem_provider = StdShMemProvider::new().expect("Failed to init shared memory"); + + let monitor = OnDiskTOMLMonitor::new( + "./fuzzer_stats.toml", + MultiMonitor::new(|s| println!("{s}")), + ); + + let mut run_client = |state: Option<_>, + mut restarting_mgr: LlmpRestartingEventManager<_, _>, + _core_id| { + // Create an observation channel using the coverage map + let edges_observer = HitcountsMapObserver::new(unsafe { std_edges_map_observer("edges") }); + + // Create an observation channel to keep track of the execution time + let time_observer = TimeObserver::new("time"); + + // Feedback to rate the interestingness of an input + // This one is composed by two Feedbacks in OR + let mut feedback = feedback_or!( + // New maximization map feedback linked to the edges observer and the feedback state + MaxMapFeedback::tracking(&edges_observer, true, false), + // Time feedback, this one does not need a feedback state + TimeFeedback::with_observer(&time_observer) + ); + + // A feedback to choose if an input is a solution or not + let mut objective = feedback_or_fast!(CrashFeedback::new(), TimeoutFeedback::new()); + + // If not restarting, create a State from scratch + let mut state = state.unwrap_or_else(|| { + StdState::new( + // RNG + StdRand::with_seed(current_nanos()), + // Corpus that will be evolved, we keep it in memory for performance + InMemoryOnDiskCorpus::new(&opt.input[0]).unwrap(), + // Corpus in which we store solutions (crashes in this example), + // on disk so the user can get them after stopping the fuzzer + OnDiskCorpus::new(&opt.output).unwrap(), + // States of the feedbacks. + // The feedbacks can report the data that should persist in the State. + &mut feedback, + // Same for objective feedbacks + &mut objective, + ) + .unwrap() + }); + + println!("We're a client, let's fuzz :)"); + + // Create a PNG dictionary if not existing + if state.metadata_map().get::().is_none() { + state.add_metadata(Tokens::from([ + vec![137, 80, 78, 71, 13, 10, 26, 10], // PNG header + "IHDR".as_bytes().to_vec(), + "IDAT".as_bytes().to_vec(), + "PLTE".as_bytes().to_vec(), + "IEND".as_bytes().to_vec(), + ])); + } + + // Setup a basic mutator with a mutational stage + let mutator = StdScheduledMutator::new(havoc_mutations().merge(tokens_mutations())); + let mut stages = tuple_list!(StdMutationalStage::new(mutator)); + + // A minimization+queue policy to get testcasess from the corpus + let scheduler = IndexesLenTimeMinimizerScheduler::new(QueueScheduler::new()); + + // A fuzzer with feedbacks and a corpus scheduler + let mut fuzzer = StdFuzzer::new(scheduler, feedback, objective); + + // The wrapped harness function, calling out to the LLVM-style harness + let mut harness = |input: &BytesInput| { + let target = input.target_bytes(); + let buf = target.as_slice(); + libfuzzer_test_one_input(buf); + ExitKind::Ok + }; + + // Create the executor for an in-process function with one observer for edge coverage and one for the execution time + let mut executor = TimeoutExecutor::new( + InProcessExecutor::new( + &mut harness, + tuple_list!(edges_observer, time_observer), + &mut fuzzer, + &mut state, + &mut restarting_mgr, + )?, + // 10 seconds timeout + opt.timeout, + ); + + // The actual target run starts here. + // Call LLVMFUzzerInitialize() if present. + let args: Vec = env::args().collect(); + if libfuzzer_initialize(&args) == -1 { + println!("Warning: LLVMFuzzerInitialize failed with -1"); + } + + // In case the corpus is empty (on first run), reset + if state.must_load_initial_inputs() { + state + .load_initial_inputs(&mut fuzzer, &mut executor, &mut restarting_mgr, &opt.input) + .unwrap_or_else(|_| panic!("Failed to load initial corpus at {:?}", &opt.input)); + println!("We imported {} inputs from disk.", state.corpus().count()); + } + + fuzzer.fuzz_loop_for( + &mut stages, + &mut executor, + &mut state, + &mut restarting_mgr, + opt.loop_iters, + )?; + restarting_mgr.on_restart(&mut state)?; + + Ok(()) + }; + + match Launcher::builder() + .shmem_provider(shmem_provider) + .configuration(EventConfig::from_name("default")) + .monitor(monitor) + .run_client(&mut run_client) + .cores(&cores) + .broker_port(broker_port) + .remote_broker_addr(opt.remote_broker_addr) + .stdout_file(Some("/dev/null")) + .serialize_state(!opt.reload_corpus) + .build() + .launch() + { + Ok(()) => (), + Err(Error::ShuttingDown) => println!("Fuzzing stopped by user. Good bye."), + Err(err) => panic!("Failed to run launcher: {err:?}"), + } +} diff --git a/libafl/src/bolts/launcher.rs b/libafl/src/bolts/launcher.rs index b46bae8071..48721f77d2 100644 --- a/libafl/src/bolts/launcher.rs +++ b/libafl/src/bolts/launcher.rs @@ -89,6 +89,9 @@ where /// Then, clients launched by this [`Launcher`] can connect to the original `broker`. #[builder(default = true)] spawn_broker: bool, + /// Tell the manager to serialize or not the state on restart + #[builder(default = true)] + serialize_state: bool, #[builder(setter(skip), default = PhantomData)] phantom_data: PhantomData<(&'a S, &'a SP)>, } @@ -186,6 +189,7 @@ where cpu_core: Some(*bind_to), }) .configuration(self.configuration) + .serialize_state(self.serialize_state) .build() .launch()?; @@ -208,6 +212,7 @@ where .remote_broker_addr(self.remote_broker_addr) .exit_cleanly_after(Some(NonZeroUsize::try_from(self.cores.ids.len()).unwrap())) .configuration(self.configuration) + .serialize_state(self.serialize_state) .build() .launch()?; @@ -255,6 +260,7 @@ where cpu_core: Some(CoreId(core_id)), }) .configuration(self.configuration) + .serialize_state(self.serialize_state) .build() .launch()?; @@ -315,6 +321,7 @@ where .remote_broker_addr(self.remote_broker_addr) .exit_cleanly_after(Some(NonZeroUsize::try_from(self.cores.ids.len()).unwrap())) .configuration(self.configuration) + .serialize_state(self.serialize_state) .build() .launch()?; diff --git a/libafl/src/events/llmp.rs b/libafl/src/events/llmp.rs index 8936b49c83..89ae844363 100644 --- a/libafl/src/events/llmp.rs +++ b/libafl/src/events/llmp.rs @@ -663,6 +663,8 @@ where llmp_mgr: LlmpEventManager, /// The staterestorer to serialize the state for the next runner staterestorer: StateRestorer, + /// Decide if the state restorer must save the serialized state + save_state: bool, } #[cfg(feature = "std")] @@ -721,8 +723,10 @@ where fn on_restart(&mut self, state: &mut S) -> Result<(), Error> { // First, reset the page to 0 so the next iteration can read read from the beginning of this page self.staterestorer.reset(); - self.staterestorer - .save(&(state, &self.llmp_mgr.describe()?)) + self.staterestorer.save(&( + if self.save_state { Some(state) } else { None }, + &self.llmp_mgr.describe()?, + )) } fn send_exiting(&mut self) -> Result<(), Error> { @@ -787,6 +791,20 @@ where Self { llmp_mgr, staterestorer, + save_state: true, + } + } + + /// Create a new runner specifying if it must save the serialized state on restart. + pub fn with_save_state( + llmp_mgr: LlmpEventManager, + staterestorer: StateRestorer, + save_state: bool, + ) -> Self { + Self { + llmp_mgr, + staterestorer, + save_state, } } @@ -877,6 +895,9 @@ where /// but it will quit after client 2 connected and disconnected. #[builder(default = None)] exit_cleanly_after: Option, + /// Tell the manager to serialize or not the state on restart + #[builder(default = true)] + serialize_state: bool, #[builder(setter(skip), default = PhantomData)] phantom_data: PhantomData, } @@ -1027,7 +1048,7 @@ where compiler_fence(Ordering::SeqCst); #[allow(clippy::manual_assert)] - if !staterestorer.has_content() { + if !staterestorer.has_content() && self.serialize_state { #[cfg(unix)] if child_status == 137 { // Out of Memory, see https://tldp.org/LDP/abs/html/exitcodes.html @@ -1062,29 +1083,38 @@ where } // If we're restarting, deserialize the old state. - let (state, mut mgr) = if let Some((state, mgr_description)) = staterestorer.restore()? { - ( - Some(state), - LlmpRestartingEventManager::new( - LlmpEventManager::existing_client_from_description( - new_shmem_provider, - &mgr_description, - self.configuration, - )?, - staterestorer, - ), - ) - } else { - log::info!("First run. Let's set it all up"); - // Mgr to send and receive msgs from/to all other fuzzer instances - let mgr = LlmpEventManager::::existing_client_from_env( - new_shmem_provider, - _ENV_FUZZER_BROKER_CLIENT_INITIAL, - self.configuration, - )?; + let (state, mut mgr) = + if let Some((state_opt, mgr_description)) = staterestorer.restore()? { + ( + state_opt, + LlmpRestartingEventManager::with_save_state( + LlmpEventManager::existing_client_from_description( + new_shmem_provider, + &mgr_description, + self.configuration, + )?, + staterestorer, + self.serialize_state, + ), + ) + } else { + log::info!("First run. Let's set it all up"); + // Mgr to send and receive msgs from/to all other fuzzer instances + let mgr = LlmpEventManager::::existing_client_from_env( + new_shmem_provider, + _ENV_FUZZER_BROKER_CLIENT_INITIAL, + self.configuration, + )?; - (None, LlmpRestartingEventManager::new(mgr, staterestorer)) - }; + ( + None, + LlmpRestartingEventManager::with_save_state( + mgr, + staterestorer, + self.serialize_state, + ), + ) + }; // We reset the staterestorer, the next staterestorer and receiver (after crash) will reuse the page from the initial message. mgr.staterestorer.reset(); diff --git a/libafl/src/monitors/mod.rs b/libafl/src/monitors/mod.rs index b104284661..c4b8f9febc 100644 --- a/libafl/src/monitors/mod.rs +++ b/libafl/src/monitors/mod.rs @@ -90,6 +90,8 @@ pub struct ClientStats { pub corpus_size: u64, /// The total executions for this client pub executions: u64, + /// The number of executions of the previous state in case a client decrease the number of execution (e.g when restarting without saving the state) + pub prev_state_executions: u64, /// The size of the objectives corpus for this client pub objective_size: u64, /// The last reported executions for this client @@ -119,13 +121,21 @@ impl ClientStats { self.last_window_time = cur_time; self.last_window_executions = self.executions; } - self.executions = executions; + if self.executions > self.prev_state_executions + executions { + // Something is strange here, sum the executions + self.prev_state_executions = self.executions; + } + self.executions = self.prev_state_executions + executions; } /// We got a new information about executions for this client, insert them. #[cfg(not(feature = "afl_exec_sec"))] pub fn update_executions(&mut self, executions: u64, _cur_time: Duration) { - self.executions = executions; + if self.executions > self.prev_state_executions + executions { + // Something is strange here, sum the executions + self.prev_state_executions = self.executions; + } + self.executions = self.prev_state_executions + executions; } /// We got a new information about corpus size for this client, insert them. diff --git a/libafl/src/mutators/token_mutations.rs b/libafl/src/mutators/token_mutations.rs index 1db75c0099..675f1aaf66 100644 --- a/libafl/src/mutators/token_mutations.rs +++ b/libafl/src/mutators/token_mutations.rs @@ -46,9 +46,7 @@ impl Tokens { /// Creates a new tokens metadata (old-skool afl name: `dictornary`) #[must_use] pub fn new() -> Self { - Self { - ..Tokens::default() - } + Tokens::default() } /// Add tokens from a slice of Vecs of bytes