mirror of
https://github.com/lightningdevkit/rust-lightning.git
synced 2025-03-26 21:42:35 +01:00
Fuzz test for parsing Invoice
An invoice is serialized as a TLV stream and encoded as bytes. Add a fuzz test that parses the TLV stream and deserializes the underlying Invoice. Then compare the original bytes with those obtained by re-serializing the Invoice.
This commit is contained in:
parent
e049e97993
commit
16168d4c07
5 changed files with 147 additions and 0 deletions
|
@ -9,6 +9,7 @@ GEN_TEST() {
|
||||||
GEN_TEST chanmon_deser
|
GEN_TEST chanmon_deser
|
||||||
GEN_TEST chanmon_consistency
|
GEN_TEST chanmon_consistency
|
||||||
GEN_TEST full_stack
|
GEN_TEST full_stack
|
||||||
|
GEN_TEST invoice_deser
|
||||||
GEN_TEST invoice_request_deser
|
GEN_TEST invoice_request_deser
|
||||||
GEN_TEST offer_deser
|
GEN_TEST offer_deser
|
||||||
GEN_TEST onion_message
|
GEN_TEST onion_message
|
||||||
|
|
113
fuzz/src/bin/invoice_deser_target.rs
Normal file
113
fuzz/src/bin/invoice_deser_target.rs
Normal file
|
@ -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 <LICENSE-APACHE
|
||||||
|
// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
||||||
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, 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::invoice_deser::*;
|
||||||
|
|
||||||
|
#[cfg(feature = "afl")]
|
||||||
|
#[macro_use] extern crate afl;
|
||||||
|
#[cfg(feature = "afl")]
|
||||||
|
fn main() {
|
||||||
|
fuzz!(|data| {
|
||||||
|
invoice_deser_run(data.as_ptr(), data.len());
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "honggfuzz")]
|
||||||
|
#[macro_use] extern crate honggfuzz;
|
||||||
|
#[cfg(feature = "honggfuzz")]
|
||||||
|
fn main() {
|
||||||
|
loop {
|
||||||
|
fuzz!(|data| {
|
||||||
|
invoice_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]| {
|
||||||
|
invoice_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();
|
||||||
|
invoice_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<u8> = vec![0];
|
||||||
|
invoice_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/invoice_deser") {
|
||||||
|
for test in tests {
|
||||||
|
let mut data: Vec<u8> = 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 || {
|
||||||
|
invoice_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!();
|
||||||
|
}
|
||||||
|
}
|
31
fuzz/src/invoice_deser.rs
Normal file
31
fuzz/src/invoice_deser.rs
Normal file
|
@ -0,0 +1,31 @@
|
||||||
|
// This file is Copyright its original authors, visible in version control
|
||||||
|
// history.
|
||||||
|
//
|
||||||
|
// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
|
||||||
|
// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
||||||
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
|
||||||
|
// You may not use this file except in accordance with one or both of these
|
||||||
|
// licenses.
|
||||||
|
|
||||||
|
use crate::utils::test_logger;
|
||||||
|
use lightning::offers::invoice::Invoice;
|
||||||
|
use lightning::util::ser::Writeable;
|
||||||
|
use std::convert::TryFrom;
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
pub fn do_test<Out: test_logger::Output>(data: &[u8], _out: Out) {
|
||||||
|
if let Ok(invoice) = Invoice::try_from(data.to_vec()) {
|
||||||
|
let mut bytes = Vec::with_capacity(data.len());
|
||||||
|
invoice.write(&mut bytes).unwrap();
|
||||||
|
assert_eq!(data, bytes);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn invoice_deser_test<Out: test_logger::Output>(data: &[u8], out: Out) {
|
||||||
|
do_test(data, out);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[no_mangle]
|
||||||
|
pub extern "C" fn invoice_deser_run(data: *const u8, datalen: usize) {
|
||||||
|
do_test(unsafe { std::slice::from_raw_parts(data, datalen) }, test_logger::DevNull {});
|
||||||
|
}
|
|
@ -18,6 +18,7 @@ pub mod chanmon_deser;
|
||||||
pub mod chanmon_consistency;
|
pub mod chanmon_consistency;
|
||||||
pub mod full_stack;
|
pub mod full_stack;
|
||||||
pub mod indexedmap;
|
pub mod indexedmap;
|
||||||
|
pub mod invoice_deser;
|
||||||
pub mod invoice_request_deser;
|
pub mod invoice_request_deser;
|
||||||
pub mod offer_deser;
|
pub mod offer_deser;
|
||||||
pub mod onion_message;
|
pub mod onion_message;
|
||||||
|
|
|
@ -2,6 +2,7 @@
|
||||||
void chanmon_deser_run(const unsigned char* data, size_t data_len);
|
void chanmon_deser_run(const unsigned char* data, size_t data_len);
|
||||||
void chanmon_consistency_run(const unsigned char* data, size_t data_len);
|
void chanmon_consistency_run(const unsigned char* data, size_t data_len);
|
||||||
void full_stack_run(const unsigned char* data, size_t data_len);
|
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 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 offer_deser_run(const unsigned char* data, size_t data_len);
|
||||||
void onion_message_run(const unsigned char* data, size_t data_len);
|
void onion_message_run(const unsigned char* data, size_t data_len);
|
||||||
|
|
Loading…
Add table
Reference in a new issue