Merge pull request #10 from epi052/add-stop-fuzzer-action

added action to stop fuzzing

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "feroxfuzz"
-version = "0.1.0-rc.0"
+version = "1.0.0-rc.1"
 edition = "2021"
 authors = ["Ben 'epi' Risher (@epi052)"]
 license = "Apache-2.0"

src/actions.rs

@@ -45,9 +45,13 @@ pub enum Action {
     /// resulting `Action` will still be passed to any configured
     /// [`Processor`]s.
     AddToCorpus(&'static str, FlowControl),
+
+    /// break out of the current fuzz loop; no more iterations other than
+    /// what's already in flight will be performed
+    StopFuzzing,
 }
 
-/// analogous to the [`Action::Keep`] and [`Action::Discard`] variants
+/// analogous to the [`Action::Keep`], [`Action::Discard`], and [`Action::StopFuzzing`] variants
 ///
 /// used when the [`Action`] isn't a flow control directive itself
 #[derive(Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, Debug)]
@@ -61,4 +65,8 @@ pub enum FlowControl {
     /// when used in a pre-send context, ignore the current [`Request`], if
     /// used in a post-send context, ignore the current [`Response`]
     Discard,
+
+    /// break out of the current fuzz loop; no more iterations other than
+    /// what's already in flight will be performed
+    StopFuzzing,
 }

src/error.rs

@@ -215,6 +215,14 @@ pub enum FeroxFuzzError {
     /// async fuzz_once loop.
     #[error("Discarded request based on user-provided criteria")]
     DiscardedRequest,
+
+    /// Represents a recommended [`Action::StopFuzzing`] during asynchronous fuzzing
+    ///
+    /// Note: this is only used because of how the async fuzz_once loop
+    /// is implemented. It is not intended to be used outside of the
+    /// async fuzz_once loop.
+    #[error("Stopped fuzzing based on user-provided criteria")]
+    FuzzingStopped,
 }
 
 /// Used to differentiate between different types of errors that occur when making requests.