fynx_platform/
traits.rs

1//! Core traits for Fynx security modules
2
3use crate::FynxResult;
4
5/// Security module interface
6///
7/// All Fynx modules implement this trait to provide unified management.
8pub trait SecurityModule: Send + Sync {
9    /// Unique module identifier
10    fn id(&self) -> &'static str;
11
12    /// Module version
13    fn version(&self) -> &'static str;
14
15    /// Module description
16    fn description(&self) -> &'static str;
17
18    /// Initialize the module
19    ///
20    /// # Errors
21    ///
22    /// Returns an error if initialization fails
23    fn init(&mut self) -> FynxResult<()> {
24        Ok(())
25    }
26
27    /// Shutdown the module
28    ///
29    /// # Errors
30    ///
31    /// Returns an error if shutdown fails
32    fn shutdown(&mut self) -> FynxResult<()> {
33        Ok(())
34    }
35}
36
37/// Scanner interface for security scanning modules
38#[async_trait::async_trait]
39pub trait Scanner: SecurityModule {
40    /// Scan a target
41    ///
42    /// # Arguments
43    ///
44    /// * `target` - Target to scan (IP, domain, file path, etc.)
45    ///
46    /// # Errors
47    ///
48    /// Returns an error if scanning fails
49    async fn scan(&self, target: &str) -> FynxResult<ScanResult>;
50}
51
52/// Analyzer interface for security analysis modules
53pub trait Analyzer: SecurityModule {
54    /// Analyze data
55    ///
56    /// # Arguments
57    ///
58    /// * `data` - Data to analyze
59    ///
60    /// # Errors
61    ///
62    /// Returns an error if analysis fails
63    fn analyze(&self, data: &[u8]) -> FynxResult<AnalysisResult>;
64}
65
66/// Scan result
67#[derive(Debug, Clone)]
68#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
69pub struct ScanResult {
70    /// Target that was scanned
71    pub target: String,
72    /// Findings from the scan
73    pub findings: Vec<Finding>,
74}
75
76/// A single finding from a scan
77#[derive(Debug, Clone)]
78#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
79pub struct Finding {
80    /// Severity level
81    pub severity: Severity,
82    /// Description of the finding
83    pub description: String,
84    /// Additional metadata (optional)
85    pub metadata: Option<String>,
86}
87
88/// Severity level
89#[derive(Debug, Clone, Copy, PartialEq, Eq)]
90#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
91pub enum Severity {
92    /// Informational
93    Info,
94    /// Low severity
95    Low,
96    /// Medium severity
97    Medium,
98    /// High severity
99    High,
100    /// Critical severity
101    Critical,
102}
103
104impl PartialOrd for Severity {
105    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
106        Some(self.cmp(other))
107    }
108}
109
110impl Ord for Severity {
111    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
112        let self_val = match self {
113            Severity::Info => 0,
114            Severity::Low => 1,
115            Severity::Medium => 2,
116            Severity::High => 3,
117            Severity::Critical => 4,
118        };
119        let other_val = match other {
120            Severity::Info => 0,
121            Severity::Low => 1,
122            Severity::Medium => 2,
123            Severity::High => 3,
124            Severity::Critical => 4,
125        };
126        self_val.cmp(&other_val)
127    }
128}
129
130/// Analysis result
131#[derive(Debug, Clone)]
132#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
133pub struct AnalysisResult {
134    /// Matches found during analysis
135    pub matches: Vec<Match>,
136}
137
138/// A single match from analysis
139#[derive(Debug, Clone)]
140#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
141pub struct Match {
142    /// Offset in the data
143    pub offset: usize,
144    /// Length of the match
145    pub length: usize,
146    /// Rule or pattern that matched
147    pub rule: String,
148}
149
150#[cfg(test)]
151mod tests {
152    use super::*;
153
154    struct TestModule;
155
156    impl SecurityModule for TestModule {
157        fn id(&self) -> &'static str {
158            "test_module"
159        }
160
161        fn version(&self) -> &'static str {
162            "0.1.0"
163        }
164
165        fn description(&self) -> &'static str {
166            "Test security module"
167        }
168    }
169
170    #[test]
171    fn test_security_module() {
172        let mut module = TestModule;
173        assert_eq!(module.id(), "test_module");
174        assert_eq!(module.version(), "0.1.0");
175        assert!(module.init().is_ok());
176        assert!(module.shutdown().is_ok());
177    }
178
179    #[test]
180    fn test_severity_ordering() {
181        assert!(Severity::Critical > Severity::High);
182        assert!(Severity::High > Severity::Medium);
183        assert!(Severity::Medium > Severity::Low);
184        assert!(Severity::Low > Severity::Info);
185    }
186
187    #[test]
188    fn test_scan_result() {
189        let result = ScanResult {
190            target: "example.com".to_string(),
191            findings: vec![Finding {
192                severity: Severity::High,
193                description: "Test finding".to_string(),
194                metadata: None,
195            }],
196        };
197
198        assert_eq!(result.target, "example.com");
199        assert_eq!(result.findings.len(), 1);
200    }
201}
fynx_platform/traits.rs

fynx_platform/
traits.rs
