Add support for fuzzing using libFuzzer

Author: onethumb

README.md

@@ -474,6 +474,12 @@ In theory, much of the "heavy lifting" has been done, so it should be possible t
 
 PRs welcome!
 
+## Memory Safety
+
+Given the heavy use of hardware intrinsics, this crate uses a decent amount of `unsafe` code.
+
+To help ensure memory safety, this crate is validated using [Miri](https://github.com/rust-lang/miri) on `x86_64` as well as fuzz tested using [libFuzzer](https://github.com/rust-fuzz/libfuzzer) over millions of iterations.
+
 ## References
 
 * [Catalogue of parametrised CRC algorithms](https://reveng.sourceforge.io/crc-catalogue/all.htm)

fuzz/.gitignore

@@ -0,0 +1,4 @@
+target
+corpus
+artifacts
+coverage

fuzz/Cargo.lock

@@ -0,0 +1,98 @@
+[package]
+name = "crc-fast-rust-fuzz"
+version = "0.1.0"
+publish = false
+edition = "2021"
+
+[package.metadata]
+cargo-fuzz = true
+
+[dependencies]
+libfuzzer-sys = "0.4"
+
+[dependencies.crc-fast]
+path = ".."
+
+[[bin]]
+name = "digest_crc32_autosar"
+path = "fuzz_targets/digest_crc32_autosar.rs"
+test = false
+doc = false
+bench = false
+
+[[bin]]
+name = "digest_crc32_bzip2"
+path = "fuzz_targets/digest_crc32_bzip2.rs"
+test = false
+doc = false
+bench = false
+
+[[bin]]
+name = "digest_crc32_iscsi"
+path = "fuzz_targets/digest_crc32_iscsi.rs"
+test = false
+doc = false
+bench = false
+
+[[bin]]
+name = "digest_crc32_iso_hdlc"
+path = "fuzz_targets/digest_crc32_iso_hdlc.rs"
+test = false
+doc = false
+bench = false
+
+[[bin]]
+name = "digest_crc64_ecma_182"
+path = "fuzz_targets/digest_crc64_ecma_182.rs"
+test = false
+doc = false
+bench = false
+
+[[bin]]
+name = "digest_crc64_nvme"
+path = "fuzz_targets/digest_crc64_nvme.rs"
+test = false
+doc = false
+bench = false
+
+[[bin]]
+name = "checksum_crc32_autosar"
+path = "fuzz_targets/checksum_crc32_autosar.rs"
+test = false
+doc = false
+bench = false
+
+[[bin]]
+name = "checksum_crc32_bzip2"
+path = "fuzz_targets/checksum_crc32_bzip2.rs"
+test = false
+doc = false
+bench = false
+
+[[bin]]
+name = "checksum_crc32_iscsi"
+path = "fuzz_targets/checksum_crc32_iscsi.rs"
+test = false
+doc = false
+bench = false
+
+[[bin]]
+name = "checksum_crc32_iso_hdlc"
+path = "fuzz_targets/checksum_crc32_iso_hdlc.rs"
+test = false
+doc = false
+bench = false
+
+[[bin]]
+name = "checksum_crc64_ecma_182"
+path = "fuzz_targets/checksum_crc64_ecma_182.rs"
+test = false
+doc = false
+bench = false
+
+[[bin]]
+name = "checksum_crc64_nvme"
+path = "fuzz_targets/checksum_crc64_nvme.rs"
+test = false
+doc = false
+bench = false

fuzz/Cargo.toml

@@ -0,0 +1,10 @@
+//! Fuzz target for CRC-32/AUTOSAR checksum calculation, which is a reflected variant.
+
+#![no_main]
+
+use crc_fast::{CrcAlgorithm, checksum};
+use libfuzzer_sys::fuzz_target;
+
+fuzz_target!(|data: &[u8]| {
+    checksum(CrcAlgorithm::Crc32Autosar, data);
+});

fuzz/fuzz_targets/checksum_crc32_autosar.rs

@@ -0,0 +1,10 @@
+//! Fuzz target for CRC-32/BZIP2 checksum calculation, which is a forward variant.
+
+#![no_main]
+
+use crc_fast::{CrcAlgorithm, checksum};
+use libfuzzer_sys::fuzz_target;
+
+fuzz_target!(|data: &[u8]| {
+    checksum(CrcAlgorithm::Crc32Bzip2, data);
+});

fuzz/fuzz_targets/checksum_crc32_bzip2.rs

@@ -0,0 +1,11 @@
+//! Fuzz target for CRC-32/ISCSI checksum calculation, which is a reflected variant which can use
+//! fusion techniques on x86 and aarch64 architectures.
+
+#![no_main]
+
+use crc_fast::{CrcAlgorithm, checksum};
+use libfuzzer_sys::fuzz_target;
+
+fuzz_target!(|data: &[u8]| {
+    checksum(CrcAlgorithm::Crc32Iscsi, data);
+});

fuzz/fuzz_targets/checksum_crc32_iscsi.rs

@@ -0,0 +1,11 @@
+//! Fuzz target for CRC-32/ISO-HDLC checksum calculation, which is a reflected variant which can use
+//! fusion techniques on aarch64 architectures.
+
+#![no_main]
+
+use crc_fast::{CrcAlgorithm, checksum};
+use libfuzzer_sys::fuzz_target;
+
+fuzz_target!(|data: &[u8]| {
+    checksum(CrcAlgorithm::Crc32IsoHdlc, data);
+});

fuzz/fuzz_targets/checksum_crc32_iso_hdlc.rs

@@ -0,0 +1,10 @@
+//! Fuzz target for CRC-64/ECMA-182 checksum calculation, which is a forward variant.
+
+#![no_main]
+
+use crc_fast::{CrcAlgorithm, checksum};
+use libfuzzer_sys::fuzz_target;
+
+fuzz_target!(|data: &[u8]| {
+    checksum(CrcAlgorithm::Crc64Ecma182, data);
+});

fuzz/fuzz_targets/checksum_crc64_ecma_182.rs

@@ -0,0 +1,10 @@
+//! Fuzz target for CRC-64/NVME checksum calculation, which is a reflected variant.
+
+#![no_main]
+
+use crc_fast::{CrcAlgorithm, checksum};
+use libfuzzer_sys::fuzz_target;
+
+fuzz_target!(|data: &[u8]| {
+    checksum(CrcAlgorithm::Crc64Nvme, data);
+});