From d14ea82b5dfe98236b75f0e6fe5c4bb041748b0e Mon Sep 17 00:00:00 2001 From: Matt Corallo Date: Tue, 30 Apr 2024 13:58:21 +0000 Subject: [PATCH] Move existing BOLT11 fuzz test to the `fuzz` crate --- .github/workflows/build.yml | 3 - fuzz/Cargo.toml | 1 + fuzz/src/bin/bolt11_deser_target.rs | 113 ++++++++++++++++++ fuzz/src/bin/gen_target.sh | 1 + fuzz/src/bolt11_deser.rs | 39 ++++++ fuzz/src/lib.rs | 1 + fuzz/targets.h | 1 + lightning-invoice/fuzz/.gitignore | 2 - lightning-invoice/fuzz/Cargo.toml | 28 ----- lightning-invoice/fuzz/ci-fuzz.sh | 19 --- .../fuzz/fuzz_targets/serde_data_part.rs | 69 ----------- rustfmt_excluded_files | 1 + 12 files changed, 157 insertions(+), 121 deletions(-) create mode 100644 fuzz/src/bin/bolt11_deser_target.rs create mode 100644 fuzz/src/bolt11_deser.rs delete mode 100644 lightning-invoice/fuzz/.gitignore delete mode 100644 lightning-invoice/fuzz/Cargo.toml delete mode 100755 lightning-invoice/fuzz/ci-fuzz.sh delete mode 100644 lightning-invoice/fuzz/fuzz_targets/serde_data_part.rs diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 951691e96..eb930f6fc 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -191,13 +191,10 @@ jobs: - name: Pin the regex dependency run: | cd fuzz && cargo update -p regex --precise "1.9.6" --verbose && cd .. - cd lightning-invoice/fuzz && cargo update -p regex --precise "1.9.6" --verbose - name: Sanity check fuzz targets on Rust ${{ env.TOOLCHAIN }} run: cd fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose --color always - name: Run fuzzers run: cd fuzz && ./ci-fuzz.sh && cd .. - - name: Run lightning-invoice fuzzers - run: cd lightning-invoice/fuzz && RUSTFLAGS="--cfg=fuzzing" cargo test --verbose && ./ci-fuzz.sh linting: runs-on: ubuntu-latest diff --git a/fuzz/Cargo.toml b/fuzz/Cargo.toml index d87be2ef6..c14fce790 100644 --- a/fuzz/Cargo.toml +++ b/fuzz/Cargo.toml @@ -19,6 +19,7 @@ stdin_fuzz = [] [dependencies] lightning = { path = "../lightning", features = ["regex", "hashbrown", "_test_utils"] } +lightning-invoice = { path = "../lightning-invoice" } lightning-rapid-gossip-sync = { path = "../lightning-rapid-gossip-sync" } bitcoin = { version = "0.30.2", features = ["secp-lowmemory"] } hex = { package = "hex-conservative", version = "0.1.1", default-features = false } diff --git a/fuzz/src/bin/bolt11_deser_target.rs b/fuzz/src/bin/bolt11_deser_target.rs new file mode 100644 index 000000000..626a46510 --- /dev/null +++ b/fuzz/src/bin/bolt11_deser_target.rs @@ -0,0 +1,113 @@ +// This file is Copyright its original authors, visible in version control +// history. +// +// This file is licensed under the Apache License, Version 2.0 or the MIT license +// , at your option. +// You may not use this file except in accordance with one or both of these +// licenses. + +// This file is auto-generated by gen_target.sh based on target_template.txt +// To modify it, modify target_template.txt and run gen_target.sh instead. + +#![cfg_attr(feature = "libfuzzer_fuzz", no_main)] + +#[cfg(not(fuzzing))] +compile_error!("Fuzz targets need cfg=fuzzing"); + +extern crate lightning_fuzz; +use lightning_fuzz::bolt11_deser::*; + +#[cfg(feature = "afl")] +#[macro_use] extern crate afl; +#[cfg(feature = "afl")] +fn main() { + fuzz!(|data| { + bolt11_deser_run(data.as_ptr(), data.len()); + }); +} + +#[cfg(feature = "honggfuzz")] +#[macro_use] extern crate honggfuzz; +#[cfg(feature = "honggfuzz")] +fn main() { + loop { + fuzz!(|data| { + bolt11_deser_run(data.as_ptr(), data.len()); + }); + } +} + +#[cfg(feature = "libfuzzer_fuzz")] +#[macro_use] extern crate libfuzzer_sys; +#[cfg(feature = "libfuzzer_fuzz")] +fuzz_target!(|data: &[u8]| { + bolt11_deser_run(data.as_ptr(), data.len()); +}); + +#[cfg(feature = "stdin_fuzz")] +fn main() { + use std::io::Read; + + let mut data = Vec::with_capacity(8192); + std::io::stdin().read_to_end(&mut data).unwrap(); + bolt11_deser_run(data.as_ptr(), data.len()); +} + +#[test] +fn run_test_cases() { + use std::fs; + use std::io::Read; + use lightning_fuzz::utils::test_logger::StringBuffer; + + use std::sync::{atomic, Arc}; + { + let data: Vec = vec![0]; + bolt11_deser_run(data.as_ptr(), data.len()); + } + let mut threads = Vec::new(); + let threads_running = Arc::new(atomic::AtomicUsize::new(0)); + if let Ok(tests) = fs::read_dir("test_cases/bolt11_deser") { + for test in tests { + let mut data: Vec = Vec::new(); + let path = test.unwrap().path(); + fs::File::open(&path).unwrap().read_to_end(&mut data).unwrap(); + threads_running.fetch_add(1, atomic::Ordering::AcqRel); + + let thread_count_ref = Arc::clone(&threads_running); + let main_thread_ref = std::thread::current(); + threads.push((path.file_name().unwrap().to_str().unwrap().to_string(), + std::thread::spawn(move || { + let string_logger = StringBuffer::new(); + + let panic_logger = string_logger.clone(); + let res = if ::std::panic::catch_unwind(move || { + bolt11_deser_test(&data, panic_logger); + }).is_err() { + Some(string_logger.into_string()) + } else { None }; + thread_count_ref.fetch_sub(1, atomic::Ordering::AcqRel); + main_thread_ref.unpark(); + res + }) + )); + while threads_running.load(atomic::Ordering::Acquire) > 32 { + std::thread::park(); + } + } + } + let mut failed_outputs = Vec::new(); + for (test, thread) in threads.drain(..) { + if let Some(output) = thread.join().unwrap() { + println!("\nOutput of {}:\n{}\n", test, output); + failed_outputs.push(test); + } + } + if !failed_outputs.is_empty() { + println!("Test cases which failed: "); + for case in failed_outputs { + println!("{}", case); + } + panic!(); + } +} diff --git a/fuzz/src/bin/gen_target.sh b/fuzz/src/bin/gen_target.sh index 62381622f..f124c1e0e 100755 --- a/fuzz/src/bin/gen_target.sh +++ b/fuzz/src/bin/gen_target.sh @@ -13,6 +13,7 @@ GEN_TEST full_stack GEN_TEST invoice_deser GEN_TEST invoice_request_deser GEN_TEST offer_deser +GEN_TEST bolt11_deser GEN_TEST onion_message GEN_TEST peer_crypt GEN_TEST process_network_graph diff --git a/fuzz/src/bolt11_deser.rs b/fuzz/src/bolt11_deser.rs new file mode 100644 index 000000000..105235a7b --- /dev/null +++ b/fuzz/src/bolt11_deser.rs @@ -0,0 +1,39 @@ +// This file is Copyright its original authors, visible in version control +// history. +// +// This file is licensed under the Apache License, Version 2.0 or the MIT license +// , at your option. +// You may not use this file except in accordance with one or both of these +// licenses. + +use bitcoin::bech32::{u5, FromBase32, ToBase32}; +use crate::utils::test_logger; +use lightning_invoice::RawDataPart; + +#[inline] +pub fn do_test(data: &[u8], _out: Out) { + let bech32 = data.iter().map(|x| u5::try_from_u8(x % 32).unwrap()).collect::>(); + let invoice = match RawDataPart::from_base32(&bech32) { + Ok(invoice) => invoice, + Err(_) => return, + }; + + // Our encoding is not worse than the input + assert!(invoice.to_base32().len() <= bech32.len()); + + // Our serialization is loss-less + assert_eq!( + RawDataPart::from_base32(&invoice.to_base32()).expect("faild parsing out own encoding"), + invoice + ); +} + +pub fn bolt11_deser_test(data: &[u8], out: Out) { + do_test(data, out); +} + +#[no_mangle] +pub extern "C" fn bolt11_deser_run(data: *const u8, datalen: usize) { + do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull {}); +} diff --git a/fuzz/src/lib.rs b/fuzz/src/lib.rs index 5b5cd69cf..6efdd94df 100644 --- a/fuzz/src/lib.rs +++ b/fuzz/src/lib.rs @@ -22,6 +22,7 @@ pub mod indexedmap; pub mod invoice_deser; pub mod invoice_request_deser; pub mod offer_deser; +pub mod bolt11_deser; pub mod onion_message; pub mod peer_crypt; pub mod process_network_graph; diff --git a/fuzz/targets.h b/fuzz/targets.h index 841ed55ce..d8b755c1a 100644 --- a/fuzz/targets.h +++ b/fuzz/targets.h @@ -6,6 +6,7 @@ void full_stack_run(const unsigned char* data, size_t data_len); void invoice_deser_run(const unsigned char* data, size_t data_len); void invoice_request_deser_run(const unsigned char* data, size_t data_len); void offer_deser_run(const unsigned char* data, size_t data_len); +void bolt11_deser_run(const unsigned char* data, size_t data_len); void onion_message_run(const unsigned char* data, size_t data_len); void peer_crypt_run(const unsigned char* data, size_t data_len); void process_network_graph_run(const unsigned char* data, size_t data_len); diff --git a/lightning-invoice/fuzz/.gitignore b/lightning-invoice/fuzz/.gitignore deleted file mode 100644 index 38a900860..000000000 --- a/lightning-invoice/fuzz/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -target -hfuzz_* diff --git a/lightning-invoice/fuzz/Cargo.toml b/lightning-invoice/fuzz/Cargo.toml deleted file mode 100644 index 746fe63ba..000000000 --- a/lightning-invoice/fuzz/Cargo.toml +++ /dev/null @@ -1,28 +0,0 @@ -[package] -name = "lightning-invoice-fuzz" -version = "0.0.1" -authors = ["Automatically generated"] -publish = false -edition = "2021" - -[package.metadata] -cargo-fuzz = true - -[features] -afl_fuzz = ["afl"] -honggfuzz_fuzz = ["honggfuzz"] - -[dependencies] -honggfuzz = { version = "0.5", optional = true, default-features = false } -afl = { version = "0.4", optional = true } -lightning-invoice = { path = ".." } -lightning = { path = "../../lightning", features = ["regex"] } -bech32 = "0.9.0" - -# Prevent this from interfering with workspaces -[workspace] -members = ["."] - -[[bin]] -name = "serde_data_part" -path = "fuzz_targets/serde_data_part.rs" diff --git a/lightning-invoice/fuzz/ci-fuzz.sh b/lightning-invoice/fuzz/ci-fuzz.sh deleted file mode 100755 index db1b9eb38..000000000 --- a/lightning-invoice/fuzz/ci-fuzz.sh +++ /dev/null @@ -1,19 +0,0 @@ -#!/bin/bash -set -e -cargo install --force honggfuzz --no-default-features -for TARGET in fuzz_targets/*; do - FILENAME=$(basename $TARGET) - FILE="${FILENAME%.*}" - if [ -d hfuzz_input/$FILE ]; then - HFUZZ_INPUT_ARGS="-f hfuzz_input/$FILE/input" - fi - HFUZZ_BUILD_ARGS="--features honggfuzz_fuzz" HFUZZ_RUN_ARGS="-N1000000 --exit_upon_crash -v $HFUZZ_INPUT_ARGS" cargo hfuzz run $FILE - - if [ -f hfuzz_workspace/$FILE/HONGGFUZZ.REPORT.TXT ]; then - cat hfuzz_workspace/$FILE/HONGGFUZZ.REPORT.TXT - for CASE in hfuzz_workspace/$FILE/SIG*; do - cat $CASE | xxd -p - done - exit 1 - fi -done diff --git a/lightning-invoice/fuzz/fuzz_targets/serde_data_part.rs b/lightning-invoice/fuzz/fuzz_targets/serde_data_part.rs deleted file mode 100644 index 871c6c7d7..000000000 --- a/lightning-invoice/fuzz/fuzz_targets/serde_data_part.rs +++ /dev/null @@ -1,69 +0,0 @@ -extern crate lightning_invoice; -extern crate bech32; - -use lightning_invoice::RawDataPart; -use bech32::{FromBase32, ToBase32, u5}; - -fn do_test(data: &[u8]) { - let bech32 = data.iter().map(|x| u5::try_from_u8(x % 32).unwrap()).collect::>(); - let invoice = match RawDataPart::from_base32(&bech32) { - Ok(invoice) => invoice, - Err(_) => return, - }; - - // Our encoding is not worse than the input - assert!(invoice.to_base32().len() <= bech32.len()); - - // Our serialization is loss-less - assert_eq!( - RawDataPart::from_base32(&invoice.to_base32()).expect("faild parsing out own encoding"), - invoice - ); -} - -#[cfg(feature = "afl")] -#[macro_use] extern crate afl; -#[cfg(feature = "afl")] -fn main() { - fuzz!(|data| { - do_test(&data); - }); -} - -#[cfg(feature = "honggfuzz")] -#[macro_use] extern crate honggfuzz; -#[cfg(feature = "honggfuzz")] -fn main() { - loop { - fuzz!(|data| { - do_test(data); - }); - } -} - -#[cfg(test)] -mod tests { - fn extend_vec_from_hex(hex: &str, out: &mut Vec) { - let mut b = 0; - for (idx, c) in hex.as_bytes().iter().filter(|&&c| c != b'\n').enumerate() { - b <<= 4; - match *c { - b'A'..=b'F' => b |= c - b'A' + 10, - b'a'..=b'f' => b |= c - b'a' + 10, - b'0'..=b'9' => b |= c - b'0', - _ => panic!("Bad hex"), - } - if (idx & 1) == 1 { - out.push(b); - b = 0; - } - } - } - - #[test] - fn duplicate_crash() { - let mut a = Vec::new(); - extend_vec_from_hex("000000", &mut a); - super::do_test(&a); - } -} diff --git a/rustfmt_excluded_files b/rustfmt_excluded_files index 51731c40d..4069cbe79 100644 --- a/rustfmt_excluded_files +++ b/rustfmt_excluded_files @@ -3,6 +3,7 @@ ./fuzz/src/bech32_parse.rs ./fuzz/src/bin/base32_target.rs ./fuzz/src/bin/bech32_parse_target.rs +./fuzz/src/bin/bolt11_deser_target.rs ./fuzz/src/bin/chanmon_consistency_target.rs ./fuzz/src/bin/chanmon_deser_target.rs ./fuzz/src/bin/fromstr_to_netaddress_target.rs -- 2.39.5