2025-06-24 21:43:26 +02:00
|
|
|
|
use crate::errors::NyxResult;
|
2025-06-24 20:27:06 +02:00
|
|
|
|
use crate::patterns::Severity;
|
|
|
|
|
|
use console::style;
|
2025-06-16 16:46:22 +02:00
|
|
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
|
|
use std::fs;
|
2025-06-24 20:27:06 +02:00
|
|
|
|
use std::path::Path;
|
2025-06-16 16:46:22 +02:00
|
|
|
|
use toml;
|
|
|
|
|
|
|
2025-06-24 21:43:26 +02:00
|
|
|
|
static DEFAULT_CONFIG_TOML: &str = include_str!("../../default-nyx.conf");
|
|
|
|
|
|
|
2025-06-16 16:46:22 +02:00
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
|
|
|
|
#[serde(default)]
|
|
|
|
|
|
pub struct ScannerConfig {
|
2025-06-17 01:17:48 +02:00
|
|
|
|
/// The minimum severity level to output
|
|
|
|
|
|
pub min_severity: Severity,
|
2025-06-24 20:27:06 +02:00
|
|
|
|
|
2025-06-23 16:51:39 +02:00
|
|
|
|
/// The maximum file size to scan, in megabytes.
|
|
|
|
|
|
pub max_file_size_mb: Option<u64>,
|
2025-06-24 20:27:06 +02:00
|
|
|
|
|
2025-06-23 16:51:39 +02:00
|
|
|
|
/// File extensions to exclude from scanning.
|
2025-06-16 16:46:22 +02:00
|
|
|
|
pub excluded_extensions: Vec<String>,
|
2025-06-24 20:27:06 +02:00
|
|
|
|
|
2025-06-23 16:51:39 +02:00
|
|
|
|
/// Directories to exclude from scanning.
|
2025-06-16 16:46:22 +02:00
|
|
|
|
pub excluded_directories: Vec<String>,
|
2025-06-24 20:27:06 +02:00
|
|
|
|
|
2025-06-16 23:47:50 +02:00
|
|
|
|
/// Excluded files
|
|
|
|
|
|
pub excluded_files: Vec<String>,
|
2025-06-16 16:46:22 +02:00
|
|
|
|
|
2025-06-23 16:51:39 +02:00
|
|
|
|
/// Whether to respect the global ignore file or not.
|
2025-06-16 16:46:22 +02:00
|
|
|
|
pub read_global_ignore: bool,
|
|
|
|
|
|
|
2025-06-23 16:51:39 +02:00
|
|
|
|
/// Whether to respect VCS ignore files (`.gitignore`, ..) or not.
|
2025-06-16 16:46:22 +02:00
|
|
|
|
pub read_vcsignore: bool,
|
|
|
|
|
|
|
2025-06-23 16:51:39 +02:00
|
|
|
|
/// Whether to require a `.git` directory to respect gitignore files.
|
2025-06-16 16:46:22 +02:00
|
|
|
|
pub require_git_to_read_vcsignore: bool,
|
|
|
|
|
|
|
2025-06-16 23:47:50 +02:00
|
|
|
|
/// Whether to limit the search to starting file system or not.
|
2025-06-16 16:46:22 +02:00
|
|
|
|
pub one_file_system: bool,
|
2025-06-24 20:27:06 +02:00
|
|
|
|
|
|
|
|
|
|
/// Whether to follow symlinks or not.
|
2025-06-16 16:46:22 +02:00
|
|
|
|
pub follow_symlinks: bool,
|
2025-06-24 20:27:06 +02:00
|
|
|
|
|
2025-06-23 16:51:39 +02:00
|
|
|
|
/// Whether to scan hidden files or not.
|
2025-06-16 16:46:22 +02:00
|
|
|
|
pub scan_hidden_files: bool,
|
|
|
|
|
|
}
|
|
|
|
|
|
impl Default for ScannerConfig {
|
|
|
|
|
|
fn default() -> Self {
|
|
|
|
|
|
Self {
|
2025-06-17 01:17:48 +02:00
|
|
|
|
min_severity: Severity::Low,
|
2025-06-23 16:51:39 +02:00
|
|
|
|
max_file_size_mb: None,
|
2025-06-16 16:46:22 +02:00
|
|
|
|
excluded_extensions: vec![
|
2025-06-24 20:27:06 +02:00
|
|
|
|
"jpg", "png", "gif", "mp4", "avi", "mkv", "zip", "tar", "gz", "exe", "dll", "so",
|
2025-06-16 16:46:22 +02:00
|
|
|
|
]
|
2025-06-24 20:27:06 +02:00
|
|
|
|
.into_iter()
|
|
|
|
|
|
.map(str::to_owned)
|
|
|
|
|
|
.collect(),
|
2025-06-16 16:46:22 +02:00
|
|
|
|
excluded_directories: vec![
|
2025-06-24 20:27:06 +02:00
|
|
|
|
"node_modules",
|
|
|
|
|
|
".git",
|
|
|
|
|
|
"target",
|
|
|
|
|
|
".vscode",
|
|
|
|
|
|
".idea",
|
|
|
|
|
|
"build",
|
|
|
|
|
|
"dist",
|
2025-06-16 16:46:22 +02:00
|
|
|
|
]
|
2025-06-24 20:27:06 +02:00
|
|
|
|
.into_iter()
|
|
|
|
|
|
.map(str::to_owned)
|
|
|
|
|
|
.collect(),
|
|
|
|
|
|
excluded_files: vec![].into_iter().map(str::to_owned).collect(),
|
2025-06-16 16:46:22 +02:00
|
|
|
|
read_global_ignore: false,
|
|
|
|
|
|
read_vcsignore: true,
|
|
|
|
|
|
require_git_to_read_vcsignore: true,
|
|
|
|
|
|
one_file_system: false,
|
|
|
|
|
|
follow_symlinks: false,
|
|
|
|
|
|
scan_hidden_files: false,
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
|
|
|
|
#[serde(default)]
|
|
|
|
|
|
pub struct DatabaseConfig {
|
2025-06-24 20:27:06 +02:00
|
|
|
|
/// Custom path for database
|
|
|
|
|
|
pub path: String,
|
|
|
|
|
|
|
2025-06-16 16:46:22 +02:00
|
|
|
|
/// The number of days to keep database files for. TODO: IMPLEMENT
|
|
|
|
|
|
pub auto_cleanup_days: u32,
|
2025-06-24 20:27:06 +02:00
|
|
|
|
|
2025-06-16 16:46:22 +02:00
|
|
|
|
/// The maximum size of the database, in megabytes. TODO: IMPLEMENT
|
|
|
|
|
|
pub max_db_size_mb: u64,
|
2025-06-24 20:27:06 +02:00
|
|
|
|
|
2025-06-16 16:46:22 +02:00
|
|
|
|
/// Whether to run a VACUUM on startup or not. TODO: IMPLEMENT
|
|
|
|
|
|
pub vacuum_on_startup: bool,
|
|
|
|
|
|
}
|
|
|
|
|
|
impl Default for DatabaseConfig {
|
|
|
|
|
|
fn default() -> Self {
|
|
|
|
|
|
Self {
|
2025-06-24 20:27:06 +02:00
|
|
|
|
path: String::from(""),
|
2025-06-16 16:46:22 +02:00
|
|
|
|
auto_cleanup_days: 30,
|
|
|
|
|
|
max_db_size_mb: 1024,
|
|
|
|
|
|
vacuum_on_startup: false,
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
|
|
|
|
#[serde(default)]
|
|
|
|
|
|
pub struct OutputConfig {
|
2025-06-17 16:46:45 +02:00
|
|
|
|
/// The default output format. TODO: IMPLEMENT others
|
2025-06-16 16:46:22 +02:00
|
|
|
|
pub default_format: String,
|
2025-06-24 20:27:06 +02:00
|
|
|
|
|
2025-06-24 21:43:26 +02:00
|
|
|
|
/// Whether to print anything to the console or not. TODO: IMPLEMENT
|
|
|
|
|
|
pub quiet: bool,
|
2025-06-24 20:27:06 +02:00
|
|
|
|
|
|
|
|
|
|
/// The maximum number of results to show.
|
|
|
|
|
|
pub max_results: Option<u32>,
|
2025-06-16 16:46:22 +02:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
impl Default for OutputConfig {
|
|
|
|
|
|
fn default() -> Self {
|
|
|
|
|
|
Self {
|
2025-06-17 16:46:45 +02:00
|
|
|
|
default_format: "console".into(),
|
2025-06-24 21:43:26 +02:00
|
|
|
|
quiet: false,
|
2025-06-16 16:46:22 +02:00
|
|
|
|
max_results: None,
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
|
|
|
|
#[serde(default)]
|
|
|
|
|
|
pub struct PerformanceConfig {
|
|
|
|
|
|
/// The maximum search depth, or `None` if no maximum search depth should be set.
|
|
|
|
|
|
///
|
|
|
|
|
|
/// A depth of `1` includes all files under the current directory, a depth of `2` also includes
|
2025-06-24 20:27:06 +02:00
|
|
|
|
/// all files under subdirectories of the current directory, etc.
|
2025-06-16 16:46:22 +02:00
|
|
|
|
pub max_depth: Option<usize>, // TODO: IMPLEMENT
|
|
|
|
|
|
|
|
|
|
|
|
/// The minimum depth for reported entries, or `None`.
|
|
|
|
|
|
pub min_depth: Option<usize>, // TODO: IMPLEMENT
|
|
|
|
|
|
|
|
|
|
|
|
/// Whether to stop traversing into matching directories.
|
2025-06-24 20:27:06 +02:00
|
|
|
|
pub prune: bool,
|
2025-06-16 16:46:22 +02:00
|
|
|
|
|
|
|
|
|
|
/// The maximum number of worker threads to use., or `None` to auto-detect.
|
2025-06-24 20:27:06 +02:00
|
|
|
|
pub worker_threads: Option<usize>,
|
|
|
|
|
|
|
2025-06-16 16:46:22 +02:00
|
|
|
|
/// The maximum number of entries to index in a single chunk.
|
2025-06-24 20:27:06 +02:00
|
|
|
|
pub batch_size: usize,
|
|
|
|
|
|
|
|
|
|
|
|
/// capacity = threads × this
|
|
|
|
|
|
pub channel_multiplier: usize,
|
|
|
|
|
|
|
|
|
|
|
|
/// Timeout on individual files // TODO: IMPLEMENT
|
|
|
|
|
|
pub scan_timeout_secs: Option<u64>,
|
|
|
|
|
|
|
2025-06-16 16:46:22 +02:00
|
|
|
|
/// The maximum amount of memory to use, in megabytes.
|
|
|
|
|
|
pub memory_limit_mb: u64, // TODO: IMPLEMENT
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
impl Default for PerformanceConfig {
|
|
|
|
|
|
fn default() -> Self {
|
|
|
|
|
|
Self {
|
|
|
|
|
|
max_depth: None,
|
|
|
|
|
|
min_depth: None,
|
|
|
|
|
|
prune: false,
|
|
|
|
|
|
worker_threads: None,
|
2025-06-24 20:27:06 +02:00
|
|
|
|
batch_size: 100usize,
|
|
|
|
|
|
channel_multiplier: 4usize,
|
|
|
|
|
|
scan_timeout_secs: None,
|
2025-06-16 16:46:22 +02:00
|
|
|
|
memory_limit_mb: 512,
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
|
|
|
|
#[serde(default)]
|
2025-06-16 23:52:39 +02:00
|
|
|
|
#[derive(Default)]
|
2025-06-16 16:46:22 +02:00
|
|
|
|
pub struct Config {
|
|
|
|
|
|
pub scanner: ScannerConfig,
|
|
|
|
|
|
pub database: DatabaseConfig,
|
|
|
|
|
|
pub output: OutputConfig,
|
|
|
|
|
|
pub performance: PerformanceConfig,
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
impl Config {
|
2025-06-24 21:43:26 +02:00
|
|
|
|
pub fn load(config_dir: &Path) -> NyxResult<Self> {
|
2025-06-16 16:46:22 +02:00
|
|
|
|
let mut config = Config::default();
|
|
|
|
|
|
|
2025-06-17 10:55:50 +02:00
|
|
|
|
let default_config_path = config_dir.join("nyx.conf");
|
2025-06-16 16:46:22 +02:00
|
|
|
|
if !default_config_path.exists() {
|
|
|
|
|
|
create_example_config(config_dir)?;
|
|
|
|
|
|
}
|
|
|
|
|
|
|
2025-06-17 10:55:50 +02:00
|
|
|
|
let user_config_path = config_dir.join("nyx.local");
|
2025-06-16 16:46:22 +02:00
|
|
|
|
if user_config_path.exists() {
|
|
|
|
|
|
let user_config_content = fs::read_to_string(&user_config_path)?;
|
|
|
|
|
|
let user_config: Config = toml::from_str(&user_config_content)?;
|
|
|
|
|
|
|
|
|
|
|
|
config = merge_configs(config, user_config);
|
2025-06-24 20:27:06 +02:00
|
|
|
|
|
|
|
|
|
|
println!(
|
|
|
|
|
|
"{}: Loaded user config from: {}\n",
|
|
|
|
|
|
style("note").green().bold(),
|
|
|
|
|
|
style(user_config_path.display())
|
|
|
|
|
|
.underlined()
|
|
|
|
|
|
.white()
|
|
|
|
|
|
.bold()
|
|
|
|
|
|
);
|
2025-06-16 16:46:22 +02:00
|
|
|
|
} else {
|
2025-06-24 20:27:06 +02:00
|
|
|
|
println!(
|
|
|
|
|
|
"{}: Using {} configuration.\n Create file in '{}'to customize.\n",
|
|
|
|
|
|
style("note").green().bold(),
|
|
|
|
|
|
style("default").bold(),
|
|
|
|
|
|
style(user_config_path.display())
|
|
|
|
|
|
.underlined()
|
|
|
|
|
|
.white()
|
|
|
|
|
|
.bold()
|
|
|
|
|
|
);
|
2025-06-16 16:46:22 +02:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
Ok(config)
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
|
2025-06-24 21:43:26 +02:00
|
|
|
|
fn create_example_config(config_dir: &Path) -> NyxResult<()> {
|
2025-06-17 10:55:50 +02:00
|
|
|
|
let example_path = config_dir.join("nyx.conf");
|
2025-06-24 21:43:26 +02:00
|
|
|
|
if !example_path.exists() {
|
|
|
|
|
|
fs::write(&example_path, DEFAULT_CONFIG_TOML)?;
|
|
|
|
|
|
tracing::debug!("Example config created at: {}", example_path.display());
|
|
|
|
|
|
}
|
2025-06-16 16:46:22 +02:00
|
|
|
|
Ok(())
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/// Merge user config into default config, preserving defaults where the user didn't
|
|
|
|
|
|
/// supply new exclusions and overriding everything else.
|
|
|
|
|
|
fn merge_configs(mut default: Config, user: Config) -> Config {
|
|
|
|
|
|
// --- ScannerConfig ---
|
2025-06-24 21:43:26 +02:00
|
|
|
|
default.scanner.min_severity = user.scanner.min_severity;
|
2025-06-24 20:27:06 +02:00
|
|
|
|
default.scanner.max_file_size_mb = user.scanner.max_file_size_mb;
|
|
|
|
|
|
default.scanner.read_global_ignore = user.scanner.read_global_ignore;
|
|
|
|
|
|
default.scanner.read_vcsignore = user.scanner.read_vcsignore;
|
|
|
|
|
|
default.scanner.require_git_to_read_vcsignore = user.scanner.require_git_to_read_vcsignore;
|
|
|
|
|
|
default.scanner.one_file_system = user.scanner.one_file_system;
|
|
|
|
|
|
default.scanner.follow_symlinks = user.scanner.follow_symlinks;
|
|
|
|
|
|
default.scanner.scan_hidden_files = user.scanner.scan_hidden_files;
|
2025-06-16 16:46:22 +02:00
|
|
|
|
|
|
|
|
|
|
// Merge exclusion lists (default ⊔ user), then sort & dedupe
|
2025-06-24 20:27:06 +02:00
|
|
|
|
default
|
|
|
|
|
|
.scanner
|
|
|
|
|
|
.excluded_extensions
|
|
|
|
|
|
.extend(user.scanner.excluded_extensions);
|
|
|
|
|
|
default
|
|
|
|
|
|
.scanner
|
|
|
|
|
|
.excluded_directories
|
|
|
|
|
|
.extend(user.scanner.excluded_directories);
|
2025-06-16 16:46:22 +02:00
|
|
|
|
default.scanner.excluded_extensions.sort_unstable();
|
|
|
|
|
|
default.scanner.excluded_extensions.dedup();
|
|
|
|
|
|
default.scanner.excluded_directories.sort_unstable();
|
|
|
|
|
|
default.scanner.excluded_directories.dedup();
|
|
|
|
|
|
|
|
|
|
|
|
// --- DatabaseConfig ---
|
2025-06-24 21:43:26 +02:00
|
|
|
|
default.database.path = user.database.path;
|
2025-06-24 20:27:06 +02:00
|
|
|
|
default.database.auto_cleanup_days = user.database.auto_cleanup_days;
|
|
|
|
|
|
default.database.max_db_size_mb = user.database.max_db_size_mb;
|
|
|
|
|
|
default.database.vacuum_on_startup = user.database.vacuum_on_startup;
|
2025-06-16 16:46:22 +02:00
|
|
|
|
|
|
|
|
|
|
// --- OutputConfig ---
|
2025-06-24 20:27:06 +02:00
|
|
|
|
default.output.default_format = user.output.default_format;
|
2025-06-24 21:43:26 +02:00
|
|
|
|
default.output.quiet = user.output.quiet;
|
2025-06-24 20:27:06 +02:00
|
|
|
|
default.output.max_results = user.output.max_results;
|
2025-06-16 16:46:22 +02:00
|
|
|
|
|
|
|
|
|
|
// --- PerformanceConfig ---
|
2025-06-24 20:27:06 +02:00
|
|
|
|
default.performance.max_depth = user.performance.max_depth;
|
|
|
|
|
|
default.performance.min_depth = user.performance.min_depth;
|
|
|
|
|
|
default.performance.prune = user.performance.prune;
|
|
|
|
|
|
default.performance.worker_threads = user.performance.worker_threads;
|
|
|
|
|
|
default.performance.batch_size = user.performance.batch_size;
|
|
|
|
|
|
default.performance.channel_multiplier = user.performance.channel_multiplier;
|
2025-06-24 21:43:26 +02:00
|
|
|
|
default.performance.scan_timeout_secs = user.performance.scan_timeout_secs;
|
2025-06-24 20:27:06 +02:00
|
|
|
|
default.performance.memory_limit_mb = user.performance.memory_limit_mb;
|
2025-06-16 16:46:22 +02:00
|
|
|
|
|
|
|
|
|
|
default
|
2025-06-24 20:27:06 +02:00
|
|
|
|
}
|