refactor: comprehensive codebase improvements and documentation

- Enhanced error handling with expanded GhostError variants and From impls
- Fixed race conditions in TUI (ui.rs unwrap calls)
- Added comprehensive module documentation with doc comments
- Improved type safety with proper validation in DetectionConfig
- Implemented Linux process enumeration via procfs
- Refactored TUI for better state management and removed emojis
- Enhanced CLI with proper logging initialization
- Added example configuration file (examples/ghost.toml)
- Updated README with complete feature documentation
- Added performance optimizations (saturating arithmetic, reduced clones)
- Improved testing framework with proper struct initialization
- Added validation and preset modes to DetectionConfig
This commit is contained in:
pandaadir05
2025-11-17 21:28:37 +02:00
parent 9ef666ba9d
commit 96b0d12099
14 changed files with 879 additions and 236 deletions

View File

@@ -1,16 +1,38 @@
//! Configuration management for the Ghost detection engine.
//!
//! This module provides configuration structures for customizing detection
//! behavior, process filtering, and performance tuning.
use crate::GhostError;
use serde::{Deserialize, Serialize};
use std::fs;
use std::path::Path;
/// Configuration options for the detection engine.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DetectionConfig {
/// Enable shellcode pattern detection.
pub shellcode_detection: bool,
/// Enable process hollowing detection.
pub hollowing_detection: bool,
/// Enable Windows hook injection detection.
pub hook_detection: bool,
/// Minimum confidence threshold for suspicious classification (0.0 - 1.0).
pub confidence_threshold: f32,
/// Skip known safe system processes.
pub skip_system_processes: bool,
/// Maximum memory size to scan per process in bytes.
pub max_memory_scan_size: usize,
/// Enable thread behavior analysis.
pub thread_analysis_enabled: bool,
/// Enable evasion technique detection.
pub evasion_detection: bool,
/// Enable MITRE ATT&CK mapping.
pub mitre_mapping: bool,
/// Scan interval in milliseconds for continuous monitoring.
pub scan_interval_ms: u64,
/// Process filter configuration.
pub process_filter: Option<ProcessFilter>,
}
impl Default for DetectionConfig {
@@ -19,29 +41,98 @@ impl Default for DetectionConfig {
shellcode_detection: true,
hollowing_detection: true,
hook_detection: true,
confidence_threshold: 0.7,
confidence_threshold: 0.3,
skip_system_processes: true,
max_memory_scan_size: 1024 * 1024 * 100, // 100MB
max_memory_scan_size: 100 * 1024 * 1024, // 100MB
thread_analysis_enabled: true,
evasion_detection: true,
mitre_mapping: true,
scan_interval_ms: 2000,
process_filter: None,
}
}
}
impl DetectionConfig {
pub fn load_from_file<P: AsRef<Path>>(path: P) -> Result<Self, Box<dyn std::error::Error>> {
/// Loads configuration from a TOML file.
///
/// # Errors
///
/// Returns an error if the file cannot be read or parsed.
pub fn load<P: AsRef<Path>>(path: P) -> Result<Self, GhostError> {
let content = fs::read_to_string(path)?;
let config: DetectionConfig = toml::from_str(&content)?;
config.validate()?;
Ok(config)
}
pub fn save_to_file<P: AsRef<Path>>(&self, path: P) -> Result<(), Box<dyn std::error::Error>> {
let content = toml::to_string_pretty(self)?;
/// Loads configuration from a file, returning default on error.
pub fn load_or_default<P: AsRef<Path>>(path: P) -> Self {
Self::load(path).unwrap_or_default()
}
/// Saves configuration to a TOML file.
///
/// # Errors
///
/// Returns an error if the file cannot be written.
pub fn save<P: AsRef<Path>>(&self, path: P) -> Result<(), GhostError> {
let content = toml::to_string_pretty(self).map_err(|e| GhostError::Configuration {
message: e.to_string(),
})?;
fs::write(path, content)?;
Ok(())
}
pub fn load_or_default<P: AsRef<Path>>(path: P) -> Self {
Self::load_from_file(path).unwrap_or_default()
/// Validates the configuration values.
fn validate(&self) -> Result<(), GhostError> {
if self.confidence_threshold < 0.0 || self.confidence_threshold > 1.0 {
return Err(GhostError::Configuration {
message: "confidence_threshold must be between 0.0 and 1.0".into(),
});
}
if self.max_memory_scan_size == 0 {
return Err(GhostError::Configuration {
message: "max_memory_scan_size must be greater than 0".into(),
});
}
Ok(())
}
/// Creates a configuration optimized for high performance (less thorough).
pub fn performance_mode() -> Self {
Self {
shellcode_detection: true,
hollowing_detection: false,
hook_detection: false,
confidence_threshold: 0.5,
skip_system_processes: true,
max_memory_scan_size: 10 * 1024 * 1024, // 10MB
thread_analysis_enabled: false,
evasion_detection: false,
mitre_mapping: false,
scan_interval_ms: 5000,
process_filter: None,
}
}
/// Creates a configuration optimized for thorough detection (slower).
pub fn thorough_mode() -> Self {
Self {
shellcode_detection: true,
hollowing_detection: true,
hook_detection: true,
confidence_threshold: 0.2,
skip_system_processes: false,
max_memory_scan_size: 500 * 1024 * 1024, // 500MB
thread_analysis_enabled: true,
evasion_detection: true,
mitre_mapping: true,
scan_interval_ms: 1000,
process_filter: None,
}
}
}