feat: add UserData associated type in ModuleData trait

vthib · Apr 28, 2024 · 5f73583 · 5f73583
1 parent 02d6f8c
commit 5f73583
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 1 deletion.
diff --git a/boreal/src/module/console.rs b/boreal/src/module/console.rs
@@ -58,6 +58,7 @@ pub struct Data {
 
 impl ModuleData for Console {
     type PrivateData = Data;
+    type UserData = ();
 }
 
 impl Console {

diff --git a/boreal/src/module/dex.rs b/boreal/src/module/dex.rs
@@ -365,6 +365,7 @@ impl Data {
 
 impl ModuleData for Dex {
     type PrivateData = Data;
+    type UserData = ();
 }
 
 fn parse_file(mem: &[u8], data: &mut Data) -> Option<HashMap<&'static str, Value>> {

diff --git a/boreal/src/module/dotnet.rs b/boreal/src/module/dotnet.rs
@@ -177,6 +177,7 @@ pub struct Data {
 
 impl ModuleData for Dotnet {
     type PrivateData = Data;
+    type UserData = ();
 }
 
 fn parse_file<HEADERS: ImageNtHeaders>(

diff --git a/boreal/src/module/elf.rs b/boreal/src/module/elf.rs
@@ -265,6 +265,7 @@ impl Module for Elf {
 
 impl ModuleData for Elf {
     type PrivateData = Data;
+    type UserData = ();
 }
 
 #[derive(Default)]

diff --git a/boreal/src/module/hash.rs b/boreal/src/module/hash.rs
@@ -80,6 +80,7 @@ pub struct Cache {
 
 impl ModuleData for Hash {
     type PrivateData = Data;
+    type UserData = ();
 }
 
 fn compute_hash_from_bytes<D: Digest>(bytes: &[u8]) -> Value {

diff --git a/boreal/src/module/macho.rs b/boreal/src/module/macho.rs
@@ -718,6 +718,7 @@ struct FileData {
 
 impl ModuleData for MachO {
     type PrivateData = Data;
+    type UserData = ();
 }
 
 impl MachO {

diff --git a/boreal/src/module/magic.rs b/boreal/src/module/magic.rs
@@ -53,6 +53,7 @@ pub enum CacheEntry {
 
 impl ModuleData for Magic {
     type PrivateData = Data;
+    type UserData = ();
 }
 
 impl Magic {

diff --git a/boreal/src/module/mod.rs b/boreal/src/module/mod.rs
@@ -275,6 +275,7 @@ impl std::fmt::Debug for ModuleDataMap {
 ///
 /// impl ModuleData for Foo {
 ///     type PrivateData = FooData;
+///     type UserData = ();
 /// }
 ///
 /// impl Module for Foo {
@@ -308,8 +309,15 @@ impl std::fmt::Debug for ModuleDataMap {
 /// }
 /// ```
 pub trait ModuleData: Module {
-    /// Data to associate with the module.
+    /// Private Data to associate with the module.
+    ///
+    /// This is the data that the module can store and retrieve during a scan.
     type PrivateData: Any + Send + Sync;
+
+    /// Data that the user can provide to the module.
+    ///
+    /// The data can be provided by the user through the [`boreal::scanner::ScanParams`].
+    type UserData: Any + Send + Sync;
 }
 
 impl ModuleDataMap {

diff --git a/boreal/src/module/pe.rs b/boreal/src/module/pe.rs
@@ -1141,6 +1141,7 @@ impl Module for Pe {
 
 impl ModuleData for Pe {
     type PrivateData = Data;
+    type UserData = ();
 }
 
 impl Pe {