refactor: module metadata

exein-io · May 15, 2024 · b29a945 · b29a945
1 parent 6d9502a
commit b29a945
Show file tree

Hide file tree

Showing 17 changed files with 64 additions and 174 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/modules/desktop-notifier/src/lib.rs b/crates/modules/desktop-notifier/src/lib.rs
@@ -8,29 +8,17 @@ use anyhow::{Context, Result};
 use pulsar_core::{
     event::Threat,
     pdk::{
-        CleanExit, ConfigError, Event, ModuleConfig, ModuleContext, ModuleDetails, ModuleError,
-        ModuleName, PulsarModule, ShutdownSignal, Version,
+        CleanExit, ConfigError, Event, ModuleConfig, ModuleContext, ModuleError, PulsarModule,
+        ShutdownSignal,
     },
 };
 
-const MODULE_NAME: &str = "desktop-notifier";
-
 pub struct DesktopNotifierModule;
 
 impl PulsarModule for DesktopNotifierModule {
+    const MODULE_NAME: &'static str = "desktop-notifier";
     const DEFAULT_ENABLED: bool = false;
 
-    fn name(&self) -> ModuleName {
-        MODULE_NAME.into()
-    }
-
-    fn details(&self) -> ModuleDetails {
-        ModuleDetails {
-            version: Version::parse(env!("CARGO_PKG_VERSION")).unwrap(),
-            enabled_by_default: Self::DEFAULT_ENABLED,
-        }
-    }
-
     fn start(
         &self,
         ctx: ModuleContext,

diff --git a/crates/modules/file-system-monitor/src/lib.rs b/crates/modules/file-system-monitor/src/lib.rs
@@ -83,28 +83,18 @@ pub mod pulsar {
     use pulsar_core::{
         event::FileFlags,
         pdk::{
-            CleanExit, ConfigError, Event, IntoPayload, ModuleConfig, ModuleContext, ModuleDetails,
-            ModuleError, ModuleName, ModuleSender, Payload, PulsarModule, ShutdownSignal, Version,
+            CleanExit, ConfigError, Event, IntoPayload, ModuleConfig, ModuleContext, ModuleError,
+            ModuleSender, Payload, PulsarModule, ShutdownSignal,
         },
     };
     use tokio::{fs::File, io::AsyncReadExt};
 
     pub struct FileSystemMonitorModule;
 
     impl PulsarModule for FileSystemMonitorModule {
+        const MODULE_NAME: &'static str = MODULE_NAME;
         const DEFAULT_ENABLED: bool = true;
 
-        fn name(&self) -> ModuleName {
-            MODULE_NAME.into()
-        }
-
-        fn details(&self) -> ModuleDetails {
-            ModuleDetails {
-                version: Version::parse(env!("CARGO_PKG_VERSION")).unwrap(),
-                enabled_by_default: Self::DEFAULT_ENABLED,
-            }
-        }
-
         fn start(
             &self,
             ctx: ModuleContext,

diff --git a/crates/modules/logger/src/lib.rs b/crates/modules/logger/src/lib.rs
@@ -1,6 +1,6 @@
 use pulsar_core::pdk::{
-    CleanExit, ConfigError, Event, ModuleConfig, ModuleContext, ModuleDetails, ModuleError,
-    ModuleName, PulsarModule, ShutdownSignal, Version,
+    CleanExit, ConfigError, Event, ModuleConfig, ModuleContext, ModuleError, PulsarModule,
+    ShutdownSignal,
 };
 use std::{
     borrow::Cow,
@@ -17,24 +17,13 @@ use std::{
 use thiserror::Error;
 
 const UNIX_SOCK_PATHS: [&str; 3] = ["/dev/log", "/var/run/syslog", "/var/run/log"];
-const MODULE_NAME: &str = "logger";
 
 pub struct LoggerModule;
 
 impl PulsarModule for LoggerModule {
+    const MODULE_NAME: &'static str = "threat-logger";
     const DEFAULT_ENABLED: bool = true;
 
-    fn name(&self) -> ModuleName {
-        MODULE_NAME.into()
-    }
-
-    fn details(&self) -> ModuleDetails {
-        ModuleDetails {
-            version: Version::parse(env!("CARGO_PKG_VERSION")).unwrap(),
-            enabled_by_default: Self::DEFAULT_ENABLED,
-        }
-    }
-
     fn start(
         &self,
         ctx: ModuleContext,

diff --git a/crates/modules/network-monitor/src/lib.rs b/crates/modules/network-monitor/src/lib.rs
@@ -178,27 +178,17 @@ pub mod pulsar {
     use pulsar_core::{
         event::{DnsAnswer, DnsQuestion, Host},
         pdk::{
-            CleanExit, IntoPayload, ModuleContext, ModuleDetails, ModuleError, ModuleName, Payload,
-            PulsarModule, ShutdownSignal, Version,
+            CleanExit, IntoPayload, ModuleContext, ModuleError, Payload, PulsarModule,
+            ShutdownSignal,
         },
     };
 
     pub struct NetworkMonitorModule;
 
     impl PulsarModule for NetworkMonitorModule {
+        const MODULE_NAME: &'static str = MODULE_NAME;
         const DEFAULT_ENABLED: bool = true;
 
-        fn name(&self) -> ModuleName {
-            MODULE_NAME.into()
-        }
-
-        fn details(&self) -> ModuleDetails {
-            ModuleDetails {
-                version: Version::parse(env!("CARGO_PKG_VERSION")).unwrap(),
-                enabled_by_default: Self::DEFAULT_ENABLED,
-            }
-        }
-
         fn start(
             &self,
             ctx: ModuleContext,

diff --git a/crates/modules/process-monitor/src/lib.rs b/crates/modules/process-monitor/src/lib.rs
@@ -145,27 +145,17 @@ pub mod pulsar {
     use super::*;
     use bpf_common::{containers::ContainerId, program::BpfEvent, BpfSenderWrapper};
     use pulsar_core::pdk::{
-        process_tracker::TrackerUpdate, CleanExit, IntoPayload, ModuleContext, ModuleDetails,
-        ModuleError, ModuleName, Payload, PulsarModule, ShutdownSignal, Version,
+        process_tracker::TrackerUpdate, CleanExit, IntoPayload, ModuleContext, ModuleError,
+        Payload, PulsarModule, ShutdownSignal,
     };
     use tokio::sync::mpsc;
 
     pub struct ProcessMonitorModule;
 
     impl PulsarModule for ProcessMonitorModule {
+        const MODULE_NAME: &'static str = MODULE_NAME;
         const DEFAULT_ENABLED: bool = true;
 
-        fn name(&self) -> ModuleName {
-            MODULE_NAME.into()
-        }
-
-        fn details(&self) -> ModuleDetails {
-            ModuleDetails {
-                version: Version::parse(env!("CARGO_PKG_VERSION")).unwrap(),
-                enabled_by_default: Self::DEFAULT_ENABLED,
-            }
-        }
-
         fn start(
             &self,
             ctx: ModuleContext,

diff --git a/crates/modules/rules-engine/src/lib.rs b/crates/modules/rules-engine/src/lib.rs
@@ -2,8 +2,7 @@ use std::path::PathBuf;
 
 use engine::PulsarEngine;
 use pulsar_core::pdk::{
-    CleanExit, ConfigError, ModuleConfig, ModuleContext, ModuleDetails, ModuleError, ModuleName,
-    PulsarModule, ShutdownSignal, Version,
+    CleanExit, ConfigError, ModuleConfig, ModuleContext, ModuleError, PulsarModule, ShutdownSignal,
 };
 
 mod dsl;
@@ -13,24 +12,13 @@ mod ruleset;
 pub use engine::RuleEngineData;
 
 const DEFAULT_RULES_PATH: &str = "/var/lib/pulsar/rules";
-const MODULE_NAME: &str = "rules-engine";
 
 pub struct RuleEngineModule;
 
 impl PulsarModule for RuleEngineModule {
+    const MODULE_NAME: &'static str = "rules-engine";
     const DEFAULT_ENABLED: bool = true;
 
-    fn name(&self) -> ModuleName {
-        MODULE_NAME.into()
-    }
-
-    fn details(&self) -> ModuleDetails {
-        ModuleDetails {
-            version: Version::parse(env!("CARGO_PKG_VERSION")).unwrap(),
-            enabled_by_default: Self::DEFAULT_ENABLED,
-        }
-    }
-
     fn start(
         &self,
         ctx: ModuleContext,

diff --git a/crates/modules/smtp-notifier/src/lib.rs b/crates/modules/smtp-notifier/src/lib.rs
@@ -9,31 +9,19 @@ use lettre::{
 use pulsar_core::{
     event::Threat,
     pdk::{
-        CleanExit, ConfigError, ModuleConfig, ModuleContext, ModuleDetails, ModuleError,
-        ModuleName, PulsarModule, ShutdownSignal, Version,
+        CleanExit, ConfigError, ModuleConfig, ModuleContext, ModuleError, PulsarModule,
+        ShutdownSignal,
     },
 };
 
 mod template;
 
-const MODULE_NAME: &str = "smtp-notifier";
-
 pub struct SmtpNotifierModule;
 
 impl PulsarModule for SmtpNotifierModule {
+    const MODULE_NAME: &'static str = "smtp-notifier";
     const DEFAULT_ENABLED: bool = false;
 
-    fn name(&self) -> ModuleName {
-        MODULE_NAME.into()
-    }
-
-    fn details(&self) -> ModuleDetails {
-        ModuleDetails {
-            version: Version::parse(env!("CARGO_PKG_VERSION")).unwrap(),
-            enabled_by_default: Self::DEFAULT_ENABLED,
-        }
-    }
-
     fn start(
         &self,
         ctx: ModuleContext,

diff --git a/crates/pulsar-core/Cargo.toml b/crates/pulsar-core/Cargo.toml
@@ -11,7 +11,6 @@ validatron = { path = "../validatron" }
 serde = { workspace = true, features = ["derive"] }
 toml_edit = { workspace = true, features = ["easy"] }
 tokio = { workspace = true, features = ["full"] }
-semver = { workspace = true, features = ["serde"] }
 anyhow = { workspace = true }
 log = { workspace = true }
 thiserror = { workspace = true }

diff --git a/crates/pulsar-core/src/pdk/daemon.rs b/crates/pulsar-core/src/pdk/daemon.rs
@@ -1,6 +1,5 @@
 use std::fmt;
 
-use semver::Version;
 use serde::{Deserialize, Serialize};
 use thiserror::Error;
 use tokio::sync::{mpsc, oneshot};
@@ -209,6 +208,5 @@ pub enum PulsarDaemonCommand {
 #[derive(Debug, Serialize, Deserialize, Clone)]
 pub struct ModuleOverview {
     pub name: String,
-    pub version: Version,
     pub status: ModuleStatus,
 }
diff --git a/crates/pulsar-core/src/pdk/mod.rs b/crates/pulsar-core/src/pdk/mod.rs
@@ -73,4 +73,3 @@ pub use config::*;
 pub use daemon::*;
 pub use module::*;
 pub use module_context::*;
-pub use semver::Version;
diff --git a/crates/pulsar-core/src/pdk/module.rs b/crates/pulsar-core/src/pdk/module.rs
@@ -6,7 +6,6 @@ use crate::{
 };
 use anyhow::Result;
 use bpf_common::{program::BpfEvent, time::Timestamp, Pid};
-use semver::Version;
 use serde::{Deserialize, Serialize};
 use tokio::sync::{
     broadcast::{self, error::RecvError},
@@ -25,10 +24,9 @@ pub type ModuleStartFn = dyn Fn(ModuleContext, ShutdownSignal) -> Box<PulsarModu
 
 /// Trait to implement to create a pulsar pluggable module
 pub trait PulsarModule: Send {
+    const MODULE_NAME: &'static str;
     const DEFAULT_ENABLED: bool;
 
-    fn name(&self) -> ModuleName;
-    fn details(&self) -> ModuleDetails;
     fn start(
         &self,
         ctx: ModuleContext,
@@ -92,14 +90,6 @@ impl Validatron for ModuleName {
     }
 }
 
-/// Contains module informations
-#[derive(Debug, Clone)]
-pub struct ModuleDetails {
-    pub version: Version,
-    pub enabled_by_default: bool,
-    // pub author: String,
-}
-
 /// Used to send events out from a module.
 ///
 #[derive(Clone)]

diff --git a/examples/pulsar-embedded-agent/proxy_module.rs b/examples/pulsar-embedded-agent/proxy_module.rs
@@ -1,30 +1,17 @@
 use pulsar_core::pdk::{
-    CleanExit, Event, ModuleContext, ModuleDetails, ModuleError, ModuleName, PulsarModule,
-    ShutdownSignal, Version,
+    CleanExit, Event, ModuleContext, ModuleError, PulsarModule, ShutdownSignal,
 };
 use std::sync::Arc;
 use tokio::sync::mpsc;
 
-const MODULE_NAME: &str = "proxy-module";
-
 pub struct ProxyModule {
     pub tx_proxy: mpsc::Sender<Arc<Event>>,
 }
 
 impl PulsarModule for ProxyModule {
+    const MODULE_NAME: &'static str = "proxy-module";
     const DEFAULT_ENABLED: bool = true;
 
-    fn name(&self) -> ModuleName {
-        MODULE_NAME.into()
-    }
-
-    fn details(&self) -> ModuleDetails {
-        ModuleDetails {
-            version: Version::parse(env!("CARGO_PKG_VERSION")).unwrap(),
-            enabled_by_default: Self::DEFAULT_ENABLED,
-        }
-    }
-
     fn start(
         &self,
         ctx: ModuleContext,

diff --git a/examples/pulsar-extension-module/my_custom_module.rs b/examples/pulsar-extension-module/my_custom_module.rs
@@ -2,28 +2,16 @@
 use std::{collections::HashMap, sync::Arc};
 
 use pulsar_core::pdk::{
-    CleanExit, ConfigError, Event, ModuleConfig, ModuleContext, ModuleDetails, ModuleError,
-    ModuleName, Payload, PulsarModule, ShutdownSignal, Version,
+    CleanExit, ConfigError, Event, ModuleConfig, ModuleContext, ModuleError, Payload, PulsarModule,
+    ShutdownSignal,
 };
 
-const MODULE_NAME: &str = "my-custom-module";
-
 pub struct MyCustomModule;
 
 impl PulsarModule for MyCustomModule {
+    const MODULE_NAME: &'static str = "my-custom-module";
     const DEFAULT_ENABLED: bool = true;
 
-    fn name(&self) -> ModuleName {
-        MODULE_NAME.into()
-    }
-
-    fn details(&self) -> ModuleDetails {
-        ModuleDetails {
-            version: Version::parse(env!("CARGO_PKG_VERSION")).unwrap(),
-            enabled_by_default: Self::DEFAULT_ENABLED,
-        }
-    }
-
     fn start(
         &self,
         ctx: ModuleContext,

diff --git a/src/pulsar/term_print.rs b/src/pulsar/term_print.rs
@@ -29,7 +29,6 @@ impl TermPrintable for Vec<ModuleOverview> {
 
         table.set_header(vec![
             Cell::new("MODULE").add_attribute(Attribute::Bold),
-            Cell::new("VERSION").add_attribute(Attribute::Bold),
             Cell::new("STATUS").add_attribute(Attribute::Bold),
         ]);
 
@@ -48,7 +47,6 @@ impl TermPrintable for Vec<ModuleOverview> {
                 Cell::new(module.name)
                     .fg(Color::Cyan)
                     .add_attribute(Attribute::Bold),
-                Cell::new(module.version),
                 Cell::new(status)
                     .fg(status_color)
                     .add_attribute(Attribute::Bold),